Fields

Fields are where most user defined data is stored on documents in Bipsync. The type of data stored and how it’s stored depends on how a field is set up.

Fields are defined in the admin app for each type of content and displayed in the apps like this

Basic Field Types

Free Text

Simple field type for inputting plain text. Values are stored as strings.

Options include: Adding a suffix/prefix to strings after editing, for example, wrapping an address in a url.

HTML

Text field with support for HTML - shows a html toolbar on focus. Values are stored as strings.

Yes/No

A boolean field. The user chooses Yes or No. Stored as a boolean in the DB

Date

The user is presented with a date picker to choose a date. Date fields are stored as mongo date times - although the time is ignored.

Options include: Setting a default date using these relative date formats https://www.php.net/manual/en/datetime.formats.relative.php and the date format

Number

Number fields, stored as ints.

Options include:

• Number types - which can be currency, percentage.
• Default value
• Decimal places and thousands separator
• Math functions

List

List fields allow the user to select one or more of a set of predefined values. Available options are given a name and an auto generated ID. It is the ID that is stored as the value in the database.

Options include:

• Default value
• An option to display the values as a checklist

Lookup

Lookup fields allow the linking to other documents within Bipsync, eg. categories, projects, users. The values are stored as foreign keys.

Options include:

• Lookup type - what type of document to lookup
• Lookup flags - for limiting those documents, eg. to certain classifications

Image

A field for uploading an image for display on a dashboard

Group control

A control element for Grouped fields below.

Grouped Fields

Grouped fields are a hashmap of fields which are designed to be represented in a row/column table format with an intrinsic link between neighbouring fields. Fields within a group are represented as a row on a dashboard where users can add and remove rows of the field group.

Group can consist of: text, lists, lookups, dates, and number fields. A Group Control field allows new rows to be added/removed.

Dynamic Fields

Read only fields that display values from other sources. These are Calculation, Data Lookup, Fixed Data Lookup fields. The values are not stored on the document itself but elsewhere on the document source.

Dependent Fields

Fields can be dependent on other field values, meaning they only show if another field value on the same document has a certain value.

Example:

Showing a meeting date field if the Note Type is “Meeting”.

Other things to know

Allow multiple

List and lookup fields can be set up to either allow only one value or multiple values. If only one value, the value is stored as a string, if multiple, as an array.

Categories

Category fields are stored on the document, keyed by the team ID. This is because entityapp synced categories (e.g.: industries, geographies, companies) are shared across the installation, so this keeps field values isolated per team.

Display order

Fields can be reordered in the admin app by dragging and dropping in the field grid window.