Fields

High Systems has many different field types. In this guide, we'll look at the different field types, what their data looks like and how to describe their schema.

Each field have Data and Schema panels where you can switch between the type of and an example of either Data and Schema.

Checkbox

A Checkbox field represents a boolean value, being either true or false.

Valid, accepted inputs: true, yes, on, 1 and false, no, off, 0.

Data

const checkbox = true;

Schema

{
  "type": "checkbox",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Checkbox",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": '',
    "required": false,
    "unique": false,
    "default": false,
    "displayTotal": false,
    "displayAverage": false
  }
}

Date

A Date field represents a date value in ISO format, YYYY-MM-DD.

Other accepted values:

Input String	Description
epoch	1970-01-01
infinity	Later than all other date values
-infinity	Earlier than all other date values
now	today's date
today	today's date
tomorrow	tomorrow's date
yesterday	yesterday's date

Data

const date = '2016-02-24';

Schema

{
  "type": "date",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Date",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": false,
    "unique": false,
    "default": null,
    "displayFormat": "D",
    "defaultToNow": false,
    "isForeignKey": false
  }
}

Date Time

A Date Time field is a string that represents a timestamp in UTC. Accepted as and returned as an ISO date and time string: YYYY-MM-DDThh:mm:ssZ.

A string submitted with a timezone will be converted to UTC. For example, a value of 2024-01-11T01:45:00.000-05:00 will be stored or queried in UTC as 2024-01-11T06:45:00.000Z.

Other accepted values:

Input String	Description
YYYY-MM-DD HH:MM:SS	1970-01-01 00:00:00
epoch	1970-01-01 00:00:00
infinity	Later than all other date time values
-infinity	Earlier than all other date time values
now	current date time
today	midnight today
tomorrow	midnight tomorrow
yesterday	midnight yesterday

Data

const datetime = '2016-02-24T19:00:00.000Z';

Schema

{
  "type": "datetime",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Date/Time",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": false,
    "unique": false,
    "default": "now",
    "displayFormat": "_appDefault",
    "defaultToNow": false,
    "isForeignKey": false
  }
}

Duration

A value that represents a duration in milliseconds.

Data

const duration = 1180000;

Schema

{
  "type": "duration",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Duration",
  "data": {
      "displayAsBold": false,
      "displayNoWrap": false,
      "reportable": true,
      "searchable": true,
      "copyData": true,
      "helpText": "",
      "required": false,
      "unique": false,
      "default": null,
      "displayFormat": "hh:mm:ss",
      "isForeignKey": false
  }
}

Email Address

An Email Address field represents an email address value as a string.

Data

const emailAddress = 'demo@highsystems.io';

Schema

{
  "type": "emailAddress",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Email Address",
  "data": {
    "default": "",
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": false,
    "unique": false,
    "isForeignKey": false
  }
}

File

A field that stores a file.

Data

const file = {
  filename: "Example.png",
  location: {
    appid: "grin4pcqq5uude",
    tableid: "azxolythy7okon",
    fieldid: "t14fk371duwqdi",
    recordid: "id36fuoyz01ezd"
  },
  size: 13420
};

Schema

{
  "type": "file",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "File",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": false,
    "isSignature": false,
    "displayThumbnail": false,
    "thumbnailStyle": "normal",
    "thumbnailHeight": -1,
    "thumbnailWidth": -1
  }
}

Formula

A formula field is a calculated field that allows you to derive values from other fields.

Data

const formula = 'Hello World!';

Schema

{
  "type": "formula",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Formula",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "helpText": "",
    "required": false,
    "unique": false,
    "formula": "return 'Hello World!';",
    "formulaType": "sql",
    "returnType": "text",
    "isForeignKey": false
  }
}

GPS

A field that represents Latitude and Longitude coordinates.

Data

const gps = '-71.05916833045872 42.354448972758725';

Schema

{
  "type": "gps",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "GPS",
  "data": {
      "reportable": true,
      "searchable": true,
      "copyData": true,
      "helpText": "",
      "required": false,
      "unique": false,
      "default": null,
      "isForeignKey": false
  }
}

Lookup

A lookup field represents a value from another table via an established foreign key.

Data

const lookup = 'A text value';

Schema

{
  "type": "lookup",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Lookup - Text",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "helpText": "",
    "foreignFieldId": "i53a8pa16jls4i",
    "referenceFieldId": "t14fk371duwqdi",
    "rootFieldType": "text",
    "linkToParent": true,
    "isForeignKey": false,
    "unique": true,
    "default": "Some Value",
    "maxLength": -1,
    "foreignField": {
      "tableId": "azxolythy7okon",
      "fieldId": "id"
    },
    "isProxyField": true
  }
}

Number

A field that represents a number value.

This could be a normal number, currency, percent, star rating or progress bar.

Data

const number = 123;

Schema

{
  "type": "number",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Number",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": false,
    "unique": false,
    "default": null,
    "displayTotal": true,
    "displayAverage": true,
    "numDecimalPlaces": 2,
    "displayAs": "number",
    "currency": "_appDefault",
    "isForeignKey": false
  }
}

Phone Number

A value that represents a phone number.

Data

const phoneNumber = '(555) 555-5555';

Schema

{
  "type": "phoneNumber",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Phone Number",
  "data": {
      "displayAsBold": false,
      "displayNoWrap": false,
      "reportable": true,
      "searchable": true,
      "copyData": true,
      "helpText": "",
      "required": false,
      "unique": false,
      "default": "(555) 555-5555",
      "allowExtensions": false,
      "isForeignKey": false
  }
}

Report

A field that represents a report

Data

// This field has no value

Schema

{
  "type": "report",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Report",
  "data": {
    "rootFieldType": "text",
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "helpText": "",
    "summary": {
        "tableId": "u458vx4gm9nl1s",
        "fieldId": "i53a8pa06jls4i",
        "targetField": "id",
        "func": "count",
        "query": ""
    }
  }
}

Rich Text

A field that represents a HTML value.

Data

const richText = 'Hello <b>World!</b>';

Schema

{
  "type": "richText",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Rich Text",
  "data": {
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": false,
    "unique": false,
    "default": null,
    "isForeignKey": false
  }
}

Summary

A field that summarizes values from a child table.

Data

const summary = 42;

Schema

{
  "type": "summary",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Summary",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "helpText": "",
    "summary": {
        "tableId": "u458vx4gm9nl1s",
        "fieldId": "i53a8pa06jls4i",
        "targetField": "id",
        "func": "count",
        "query": ""
    },
    "rootFieldType": "text",
    "isForeignKey": false
  }
}

Text

A field that represents a text value.

Data

const text = 'A text value';

Schema

{
  "type": "text",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Text",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": true,
    "unique": true,
    "default": "Some Value",
    "maxLength": -1,
    "isForeignKey": false
  }
}

Text Multi-Choice

A field with multiple possible values.

Data

const textMultiChoice = 'Choice A';

Schema

{
  "type": "textMultiChoice",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Text Multi-Choice",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": false,
    "unique": false,
    "default": "Choice B",
    "choices": [
        "Choice A",
        "Choice B",
        "Choice C"
    ],
    "multiple": false,
    "allowNewChoices": false,
    "sortChoices": "alphabetical",
    "autoComplete": false,
    "isForeignKey": false
  }
}

Text Multi-Line

A text value with multiple lines.

Data

const textMultiLine = 'Line 1\nLine 2';

Schema

{
  "type": "textMultiLine",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Text Multi-Line",
  "data": {
      "displayAsBold": false,
      "displayNoWrap": false,
      "reportable": true,
      "searchable": true,
      "copyData": true,
      "helpText": "",
      "required": false,
      "unique": false,
      "default": "",
      "numLines": 3,
      "isForeignKey": false
  }
}

Time of Day

A Time of Day field represents a time value in the hh:mm:ss format with a 24-hour clock in UTC.

Other accepted values:

Input String	Description
now	current time (UTC)
allballs	00:00:00.00

Data

const timeofday = '21:42:30+00';

Schema

{
  "type": "timeofday",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "Time of Day",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": false,
    "unique": false,
    "default": "now",
    "displayFormat": "_appDefault",
    "defaultToNow": false,
    "isForeignKey": false
  }
}

URL

A field that represents a URL value.

Data

const url = 'https://www.highsystems.io/';

Schema

{
  "type": "url",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "URL",
  "data": {
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": false,
    "unique": false,
    "default": "https://highsystems.io/",
    "displayAs": "link",
    "linkText": "",
    "buttonColor": "primary",
    "target": "self",
    "isForeignKey": false
  }
}

User

A User field represents the selection of a High Systems User.

Each User has a unique ID within a given High Systems Instance. For example, within the demo.highsystems.io instance, the user example@mail.com would have the same User ID in every application within demo.highsystems.io.

Data

const user = 'v5b13nuazvcpfw';

Schema

{
  "type": "user",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "User Field",
  "data": {
    "default": "",
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": false,
    "unique": false,
    "isForeignKey": false
  }
}

User Multi-Choice

A User Multi-Choice field represents the selection of one or more High Systems Users.

Data

const userMultiChoice = [
  'v5b13nuazvcpfw',
  's1gslmnizewe7h'
];

Schema

{
  "type": "userMultiChoice",
  "id": "t14fk371duwqdi",
  "relatedTable": "azxolythy7okon",
  "name": "User Multi-Choice",
  "data": {
    "default": [],
    "displayAsBold": false,
    "displayNoWrap": false,
    "reportable": true,
    "searchable": true,
    "copyData": true,
    "helpText": "",
    "required": false,
    "unique": false
  }
}