Skip to main content

Type Creation Guidelines

To create good types, make sure to follow the guidance in the following sections for each part of the type.

Type Name​

AnyDB supports dynamic item naming, allowing you to create types whose instances have meaningful, context-specific names. You can use any valid formulas as part of type names. Dynamic names make items instantly recognizable in lists and search results. It is recommended to set dynamic item names whenever possible.

Examples​

This expression sets the name as 'Employee - John Smith', otherwise 'Employee - Unknown'

CONCAT('Employee - ', IF({{Name}}, {{Name}}, 'Not Set'))

Type Description​

Set a useful AnyDB item description that appears in the item listing.

A good description:

  • is concise (recommended less than 100 characters)
  • Clearly identifies the purpose of the type
  • Mentions key capabilities or features

Example for a Customer Type: "Tracks contact details, interaction history, and purchase data with automated follow-up reminders."

Badges​

AnyDB supports badges to summarize important data in the item. Add badges as needed to summarize the most important information in your item.

Effective badge uses:

  • Status indicators (Active/Inactive, Complete/Pending)
  • Priority levels (High/Medium/Low)
  • Key metrics (Budget utilization, Days remaining)
  • Counts (Number of tasks, open issues)

Example badge for a document approval type would show document approval priority.

Priority: {{Priority}}

Recommendation for Badges

  • Is short and usually one word names. For example, use 'Risk' rather than 'Status Risk'
  • Should have a background color
  • Limit to 3-4 badges and a max of 5 badges

Cells​

The cells of the type contain the content.

Recommendation for Content

  • Ensure each cell has a label. You can set a 'Display Label' for a cell or use F2 key to set the name.
  • Avoid setting background colors unless absolutely needed. Use Styling Guidelines below
  • Lock cells that shouldn't be modified by the user
  • Hide cells that have calculations
  • Use 'Hide in Forms' to hide cells that shouldn't show up in forms
  • Description: Add descriptions to cells to clarify the data to be entered
  • Readonly: Mark cells as readonly if it is a computed field using a formula
  • Hidden: Mark cells as hidden to hide these cell contents from users
  • When possible, keep types to no more than 6 cells in span so they fit typical monitor resolutions and are easier to print and export as PDF.

Styling Guidelines​

AnyDB uses a minimalistic aesthetic. To maintain consistency, adhere to the following design principles:

Headers​

  • When possible, start the type at cell A1 with the type name in UPPERCASE and BOLD.

Text Formatting​

  • Headings: Use bold text for section headers
  • Instructions: Use slightly smaller italic text for user guidance

Cell Colors​

Use cell colors sparingly

  • Accent Color or Heading Color: Background with light gray (#FAFAFA)
  • Key User Input Cells: Highlight with a light pastel blue (#E9F3F7 )
  • Computed, Non-Editable Cells: Use "Locked" property to mark these as uneditable

When cell background colors need to show status like error, success etc use these colors

  • Success State Cells: Use pastel green (#EEF3ED)
  • Failure State Cells: Use pastel red (#FAECEC)
  • Warning State Cells: Use pastel yellow (#FAF3DD)
  • Uncommon Danger Failure State Cells: Use darker red (#EFC2C2)
Conditional Formatting for Cells​

Use conditional formatting to visually highlight important information:

URGENT, HIGH, MEDIUM, LOW

IF(CURRCELL=='Urgent', '#EFC2C2', IF(CURRCELL=='High', '#FAECEC', IF(CURRCELL=='Medium', '#FAF3DD', '#FFFFFF')))

OPEN, CLOSED, OTHER

IF(CURRCELL=='OPEN', '#FAECEC', IF(CURRCELL=='CLOSED', '#EEF3ED', '#FFFFF'))

< 50%, < 70%>, above 70%

IF(CURRCELL < 0.5, '#FAECEC', IF(CURRCELL < 0.7, '#FAF3DD', '#EEF3ED'))

Badge Colors​

  • Success Badge: Use Green (#A6DBC7)
  • Urgent Badge: Use dark red (#FF7575)
  • Failure Badge: Use Red (#FFB5A6)
  • Warning Badge: Use yellow (#FFF9C4)
  • Unknown Badge: Use gray (#F1F1EF)
  • Informational Badge: Use Blue (#ACC7E9)
Conditional Formatting for Badges​

Use conditional formatting to visually highlight important information:

URGENT, HIGH, MEDIUM, LOW

IF(CURRCELL=='Urgent', '#FF7575', IF(CURRCELL=='High', '#FFB5A6', IF(CURRCELL=='Medium', '#FFF9C4', '#F1F1EF')))

OPEN, CLOSED, OTHER

IF(CURRCELL=='OPEN', '#FFB5A6', IF(CURRCELL=='CLOSED', '#A6DBC7', '#F1F1EF'))

Layout Best Practices​

  • Data Summarization: Include key data summaries at the top of the type for quick insights
  • Logical Grouping: Organize related fields together for better readability
  • Progressive Disclosure: Place most common fields first, followed by less frequently used fields
  • Consistent Spacing: Maintain consistent row heights and column widths
  • Field Alignment: Right-align numbers, left-align text, center short status values

Type Checklist​

Before sharing your type, test it thoroughly to ensure it works as expected:

  • Name: Check if the name has a dynamic formula
  • Name: Check if the name matches the type correctly
  • Description: Check if the description is short and concise and does not use words like 'type'
  • Badges: Check if there is atleast 1 badge at the minimum and not more than 5 badges
  • Badges: Check if badges have background color
  • Badges: Check if badges have dynamic background color support
  • Badges: Check if Badge Display Names are short and one word if possible
  • Badges: Check if Badge colors match badge color schemes
  • Content: Check if A1 cell has the type name in UPPERCASE and BOLD
  • Content: Check if colors match cell color schemes
  • Content: Check if description is added to required cells especially where user input is needed

Publishing your Type​

Before publishing your type, ensure you have the following three required components:

1. Exported Type JSON​

  • Navigate to the Export Menu in AnyDB.
  • Select "JSON" format and choose "Type only."
  • Save the file as TEMPLATEID.json which would look like example '67c5bb8fb4da497ff08eb69a.json'

2. Screenshot for Preview​

  • Take a JPEG screenshot of the completed type.
  • Ensure the image resolution is 1080x720 pixels.
  • Save the file as preview.jpg.

3. Metadata File (meta.md)​

  • This Markdown file should include the following sections
- Overview
- Description
- Key Data Stored
- Business Use Cases
- Why This Type is Powerful

Example shown here:

# AnyDB Job Application Type

## Overview

The AnyDB Job Application type is designed to streamline the job application process,
allowing potential candidates to directly submit their information into the AnyDB system.
This type facilitates efficient data capture and management, enabling
HR teams to process applications effectively and systematically.

## Description

This type provides a structured form for job applicants to enter their personal
and professional information. It includes fields for names, contact details,
LinkedIn profile URLs, and resume uploads. The type also features
administrative sections, such as tracking the application stage and assigning
applications to hiring managers, which are hidden from the applicants.
The type is designed to be customizable, allowing for job-specific
details to be included, such as location preferences and job descriptions.

## Key Data Stored

- **Job Title:** The title of the job being applied for.
- **Location:** The preferred location type (On Site, Hybrid, Remote).
- **Onsite Location:** The specific location if the role is on-site.
- and more

## Business Use Cases

- **Efficient Applicant Tracking:** Centralizes applicant data, making it easy
to track and manage applications.
- **Streamlined Recruitment:** Simplifies the application process, reducing manual data entry
and administrative overhead.
- **Improved Candidate Experience:** Provides a user-friendly form for applicants to submit their information.
- and more

## Why This Type is Powerful

- **Direct Data Input:** Allows candidates to submit information directly into the system, reducing errors.
- **Customizable Job Descriptions:** Enables the tailoring of job descriptions within the application form.

4. Select the categories in which this type should appear​

Either provide the existing categories or subcategories or provide new ones. Note that a type can be listed in more than one category or subcategory.

For example, an invoice type can be under sales, financials->accounts receivables, and customer.

5. Send all the 3 files along with the categories to support@anydb.com​

You can zip these files up in case you are sending multiple types.