Dynamic Form Items

Dynamic form items allows you to create form items dynamically through the onLoad script in the activity template's settings.

Navigation

Create an activity template. See Activity template.

Then click on Edit Template, expand the Scripts drawer.

Click on the Calculator icon to the right of the Onload Script's input field. When a modal appears, this is where we will be putting in our JSON-based script. JSON, or JavaScript Object Notation, is a widely used format for storing and exchanging data. It’s both human-readable and machine-parsable.

Add Form Items

Let’s break down these examples into simple, easy-to-understand terms. Even if you're not familiar with coding or JSON, think of this as filling out a form, where each part defines what the form will look like and how it will behave.

Here’s an example script that adds two form items:

• A number input (Field 1, not required)

• A text input (Field 2, required)

$formItems.push(
  {
    "name": "Field 1",
    "hint": "Fill in",
    "itemKey": "Field1",
    "itemType": "DATA_ENTRY",
    "dataType": "NUMBER",
    "active": true
  },
  {
    "name": "Field 2",
    "itemKey": "Field2",
    "itemType": "DATA_ENTRY",
    "dataType": "STRING",
    "active": true,
    "isRequired": true
  }
);

Explanation

• Field 1:

  • Label: "Field 1."

  • Hint: A hint to the users.

  • Type: Accepts numbers only.

  • Active: It’s visible to users.

• Field 2:

  • Label: "Field 2."

  • Type: Accepts text only (e.g., letters, words).

  • Active: It’s visible to users.

  • Required: Users must fill this field before submitting the form.

1. Click Save to close the modal and Save again to apply your changes.

1. The form will now include the items you just configured, these items' properties aren't editable through the UI but must be changed through the onLoad script that we just wrote.

Now feel free to use the references tables below to help you write your scripts, with examples included at the end.

Configuration Reference Tables

Understanding the References Table

The references tables' purposes is to help you understand how different fields and properties are structured and what kinds of information they accept. Each table provides essential details about the properties, their data types, and any associated custom types or options. Here's how to read and use it effectively:

1. Table Structure

Each table has the following columns:

• Property Name: The name of the property used in the system. Think of it as a label or identifier for a specific part of the form or data.

• Property: A simplified version of the property name, often the one you'd see or reference in usage.

• Data Type: The kind of information this property accepts. For example:

  • STRING: Text-based information like words or phrases.

  • NUMBER: Numeric values.

  • Custom data types (e.g., TREE, SINGLE): Specific categories or types explained in another table.

2. Example: Option Group (Table 5)

This table explains the properties of an Option Group, a part of the form that lets users make selections:

• name Property:

  • Data Type: STRING

  • This means the property accepts text, such as "Preferred Colors" or "Favorite Fruit."

• type Property:

  • Data Type: Reference to Table 6.

  • You must select a predefined type from the Option Group Types table, which lists the available categories for this property.

3. Understanding Custom Data types (Table 6)

Some properties use custome data types, which are predefined values that you must choose from. For instance, the type property in Table 5 refers to these Option Group Types:

• How to Use Custom Enums:

  • Match the description to your use case.

  • Use the custom data types (e.g., SINGLE or MULTIPLE and not String, Text or Number) in your configuration.

4. Connecting the Tables

When a property references another table (like how type in Table 5 points to Table 6), it means the value for that property must come from the options in the referenced table. This ensures consistency and clarity in how the data is defined and used.

Tips for Using the References Table

1. Identify Required Properties: Look at the Property Name and Property columns to see what information you need to provide.

2. Match Data Types: Make sure the values you provide match the required data type (e.g., text for STRING, numbers for NUMBER, or specific date types for custom types).

3. Follow References: If a property points to another table, review the referenced table to understand what values are valid.

4. Use Descriptions for Context: The descriptions in the custom enums (like Tree Type or Downtime reason) help you decide which value fits your scenario.

5. Don't forget $formItems.push(): Don't forget to add $formItems.push(insert your form items here) in order to actually add the items dynamically through the script.

Table 1: Activity Item Properties

Table 2: Item Types Data Type

Table 3: Data Type Data Type

Table 4: Tolerance Type Data Type

Table 5: Option Group Properties

Table 6: Option Group Data Types

See Option list to learn more.

Table 7: Option Item Properties

Table 8: Attribute Properties

See Attributes

Table 9: Event Type Properties

See Event Type for more information.

Table 11: System Event Data Type

Table 12: Material Properties

See Materials for more.

Other types and properties

Examples

Data entry

    { //Number field
        "name": "Number field with hint",
        "hint": "Fill in",
        "itemKey": "Numberfield",
        "itemType": "DATA_ENTRY",
        "dataType": "NUMBER",
        "active": true
    }

{ // Text field
    "name": "Text field",
    "hint": "Textfield",
    "itemKey": "Textfield",
    "itemType": "DATA_ENTRY",
    "dataType": "STRING",
    "active": true
}

Unit of Measurement

{ // Number field with UOM
    "name": "Number field with unit of measurement",
    "hint": "Fill in",
    "itemKey": "Numberfieldwithuom",
    "itemType": "DATA_ENTRY",
    "dataType": "NUMBER",
    "uom": { "name": "mL" },
    "active": true
}

Single Option Groups

{ // Single option group
    "name": "Single Option Group",
    "hint": "Fill in",
    "itemKey": "Single Option Group",
    "itemType": "DATA_ENTRY",
    "dataType": "OPTION",
    "options": { "name": "Options to choose" },
    "itemOptions": [
        { "name": "option1", "value": "Option 1" }, 
        { "name": "option2", "value": "Option 2" }
        ],
    "active": true
},

Adding Tolerances and Limits

{ //Number field with tolerances
    "name": "Number field with tolerances",
    "hint": "Fill in",
    "itemKey": "NumberfieldTolerances",
    "itemType": "DATA_ENTRY",
    "dataType": "NUMBER",
    "uom": { "name": "mL" },
    "toleranceType": "ORDER",
    "target": "30",
    "upperLimit": "50",
    "lowerLimit": "20",
    "active": true
}

Read-only notes

{ // Ready only note field
    "name": "NoteField",
    "itemKey": "NoteField",
    "itemType": "DATA_ENTRY",
    "dataType": "NOTE",
    "calculation": "'Notes go here'", // Enclose the content in single quotes
    "active": true
}

Enable Image Capture

{ // Text field with image capture
    "name": "Text field with image capture",
    "itemKey": "TextfieldImageCapture",
    "itemType": "DATA_ENTRY",
    "dataType": "STRING",
    "enableImageCapture": true,
    "active": true
}

Enable OCR

{ // Text field with OCR
    "name": "Text field with OCR",
    "itemKey": "TextfieldOCR",
    "itemType": "DATA_ENTRY",
    "dataType": "STRING",
    "enableOcr": true,
    "active": true
}

Raise Event - Pass / Fail type

{ // Text field with Raise Pass/Fail Event
    "name": "Text field with Raise Pass/Fail Event",
    "itemKey": "TextfieldOCR",
    "itemType": "RAISE_EVENT",
    "dataType": "PASS_FAIL",
    "enableOcr": true,
    "active": true
}