Solution Designer has been deprecated in favor of Opus Solution Environment (OSE).

Customize a data model

In the data model, Solution Developers can customize object types, attributes, and rules, which supply the data and data logic for the apps that the company owns.

Object types represent the business concepts within the app (e.g. products, shipments), and fall into two categories:

  • Base object types, which are created by TraceLink specifically for the app, and cannot be modified or removed.

  • Sub-object types, which are created by Solution Developers by extending base object types (i.e. creating a new copy of a base object type and modifying its attributes and rules).

The data model in Solution Builder displays only the data elements that the app's developer chooses to expose for customization. Some data elements developed with the app might not be available for customization.

Select object types for the solution

Object types are one of the assets that solutions use, which means that they are added independently of a solution and can be reused across many solutions. Select object types for the solution to determine which object types the solution uses.

Object types—with their associated attributes and rules—can be shared across solutions within an environment, as long as the solutions are for the same app. For example, Object Type X can be used by both Solution A and Solution B, as long as Solution A and Solution B are both for the same app.
  1. Select Customize in the side menu.
  2. Select Solutions.
  3. Select the Application with the solutions to view.
  4. Select the Action icon for the solution on the Installed Solutions tab.
  5. Select Edit.

Tips

Select an object type to use in the solution if the base object type or one of its sub-object types is not currently in use.

If the base object type or one of its sub-object types is currently in use, switch which of the object types is applied.

  1. Select Customize in the side menu.
  2. Select Solutions.
  3. Select the Application with the solutions to view.
  4. Select the Action icon for the solution on the Installed Solutions tab.
  5. Select Edit.
  6. Select Data Model.

    Select Show Studios if the Data Model tab does not display.

  7. Select Not Connected.
  8. Select the Connect Object Type icon to select whether to use the corresponding base object type or one of its sub-object types in the solution.
  9. Select the base object type or sub-object type to use in the solution.
  10. Select Connect.

    The solution uses the selected object type, which displays on the Connected tab as the Applied Object Type.

  1. Select Customize in the side menu.
  2. Select Solutions.
  3. Select the Application with the solutions to view.
  4. Select the Action icon for the solution on the Installed Solutions tab.
  5. Select Edit.
  6. Select Data Model.

    Select Show Studios if the Data Model tab does not display.

  7. Select the Action icon for the Applied Object Type to disconnect from the solution.
  8. Select Disconnect Object Type.
  9. Select Disconnect in the confirmation dialog.

    The solution no longer uses the selected object type. The object type now displays on the Not Connected tab as an Available Object Type.

Extend the base object types

Solution Developers cannot modify base object types. In order to customize object types, Solution Developers must create sub-object types, which are extended from base object types and can be modified as needed.

  1. Select Customize in the side menu.
  2. Select Solutions.
  3. Select the Application with the solutions to view.
  4. Select the Action icon for the solution on the Installed Solutions tab.
  5. Select Edit.
  6. Select Data Model.

    Select Show Studios if the Data Model tab does not display.

  7. Select the Add icon on the Connected or Not Connected tabs.
  8. Fill in the following fields in the New Sub-Object Type panel:
    • Base Object Type drop-down – Required. The base object type to extend the sub-object type from. The sub-object type inherits the same standard attributes as the base object type.
    • Sub-Object Type Name field – Required. The identifying name for the new sub-object type, which must use camel case (e.g. "subObjectTypeName") and be unique across all object types in the current environment.
    • Display Name field – Required. The name that displays in the Web UI for the new sub-object type.

      The Display Name does not need to be unique.

    • Audited radio button – Indicates whether the sub-object type is captured in the audit trail:
      • Yes – The sub-object type is captured in the audit trail.
      • No – The sub-object type is not captured in the audit trail.
  9. Select Add.

    The sub-object type is added. The new sub-object type inherits the standard attributes of the Base Object Type it is extended from.

  10. If necessary, use the sub-object type in the solution:
    • If the solution is currently using the Base Object Type that the new sub-object type was extended from or is using one of the base object type's sub-object types, switch the Applied Object Type to the new sub-object type.

      or

    • If the solution is not currently using the Base Object Type that the new sub-object type was extended from or any of its sub-object types, select the newly added sub-object type to use it in the solution.

Modify a sub-object type

Solution Developers customize their sub-object types by adding custom attributes (e.g. data fields) and adding rules to any of the sub-object type's attributes, in order to add additional information or logic to the sub-object type.

  1. Select Customize in the side menu.
  2. Select Solutions.
  3. Select the Application with the solutions to view.
  4. Select the Action icon for the solution on the Installed Solutions tab.
  5. Select Edit.
  6. Select Data Model.

    Select Show Studios if the Data Model tab does not display.

  7. On the Connected tab, select the Action icon for the Applied Object Type to add a custom attribute to. The applied object must be a sub-object type.
  8. Select Edit Applied Object Type.
  9. Select Custom.
    • Attribute – The identifying name of the attribute.
    • Display Name – The display name of the attribute.
    • Required – Indicates whether the attribute is required: 
      • Yes – The attribute is required.
      • No – The attribute is not required.
    • Audited – Indicates whether the attribute is captured in the audit trail:
      • Yes – The attribute is captured in the audit trail.
      • No – The attribute is not captured in the audit trail.

    • Reportable & Searchable - Indicates whether the attribute is indexed, which allows it to be used in tables and charts:

      • Not Reportable or Searchable – The attribute cannot be used in tables or charts, and does not appear in search results.
      • Reportable – The attribute can be used in tables and charts.
      • Searchable – The attribute appears in search results when it is a partial or exact match for the search term.
      • Searchable on exact text – The attribute appears in search results when it is an exact match for the search term.
      • Searchable on partial text – The attribute appears in search results when it is a partial match for the search term.
    • Data Type – The data type of the attribute:
      • Boolean – Data is stored as one of two possible values (i.e. true or false).
      • Integer – Data is stored as whole numbers, ranging from -32,768 to 32,767.
      • Long – Data is stored as whole numbers, ranging from -2,147,483,648 to 2,147,483,647.

        Date-time values are stored using the Long data type.

      • Number – Data is stored as fractional or whole numbers, which can be positive or negative. Supports integers, floating-point numbers, and exponential notation.
      • String – Data is stored as ASCII characters (e.g. letters on a keyboard, special characters).
  10. Select the Add Attribute icon.
  11. Specify details about the new attribute:
    1. Select Add From Existing.
    2. Fill in the following fields:
      • Attribute Name field – Required. The name of the existing attribute to reference. The Data Type of the existing attribute displays below the field.

        Attribute names are unique across the environment.

      • Audited radio button – Indicates whether the attribute is captured in the audit trail:
        • Yes – The attribute is captured in the audit trail.
        • No – The attribute is not captured in the audit trail.
    1. Select Add New.
    2. Fill in the following fields:
      • Attribute Name field – Required. The name of the new attribute, which must be unique across all attributes in the environment.
      • Data Type drop-down– Required. The data type for the new attribute:
        • Boolean – Data is stored as one of two possible values (i.e. true or false).
        • Integer – Data is stored as whole numbers, ranging from -32,768 to 32,767.
        • Long – Data is stored as whole numbers, ranging from -2,147,483,648 to 2,147,483,647.

          Date-time values are stored using the Long data type.

        • Number – Data is stored as fractional or whole numbers, which can be positive or negative. Supports integers, floating-point numbers, and exponential notation.
        • String – Data is stored as ASCII characters (e.g. letters on a keyboard, special characters).
      • Audited radio button – Indicates whether the attribute is captured in the audit trail:
        • Yes – The attribute is captured in the audit trail.
        • No – The attribute is not captured in the audit trail.
      • Reportable radio button – Optional. Indicates whether the attribute can be used in tables and charts:
        • Yes – The attribute can be used in tables and charts.
        • No – (default) The attribute cannot be used in tables and charts.
      • Searchable radio button – Optional. Indicates whether the attribute appears in search results:
        • Yes, on both partial and exact text – The attribute appears in search results when it is a partial or exact match for the search term.
        • Yes, on exact text only – The attribute appears in search results when it is an exact match for the search term.
        • Yes, on partial text only – The attribute appears in search results when it is a partial match for the search term.
        • No – (default) The attribute cannot be used in tables or charts, and does not appear in search results.
  12. Select Add.

    The attribute is added and displays in the table on the Custom tab.

  1. Select Customize in the side menu.
  2. Select Solutions.
  3. Select the Application with the solutions to view.
  4. Select the Action icon for the solution on the Installed Solutions tab.
  5. Select Edit.
  6. Select Data Model.

    Select Show Studios if the Data Model tab does not display.

  7. On the Connected tab, select the Action icon for the Applied Object Type to edit, which must be a sub-object type.
  8. Select Edit Applied Object Type.
  9. Select the Action icon for the attribute to add the rule to on the Standard or Custom tabs.
  10. Select Add Rule.
  11. Select the type of rule to add from the Rule Type drop-down:
    • Allowed Value List – Displays only if the attribute has a Data Type of String. Provides a list of allowed values for the attribute that display in the Web UI. An attribute can have only one rule with a Rule Type of Allowed Value List.
    • Conditionally Allowed List – Displays only if the attribute has a Data Type of Enumeration or has a Data Type of String and a rule with a Rule Type of Allowed Value List. Restricts the list of allowed values for the attribute, based on another attribute's value (e.g. restricts the list of allowed values for attribute A when a value of B1 is present for attribute B). An attribute can have multiple rules with a Rule Type of Conditionally Allowed List, however, all rules of this type must specify a unique Triggering Attribute and Triggering Value combination.
    • Do Not Use – Displays only for standard attributes. Prevents the attribute from displaying in the Web UI. An attribute can have only one rule with a Rule Type of Do Not Use.
    • Enumeration List Exclusion – Displays only for standard attributes with a Data Type of Enumeration. Hides one or more list items from the enumeration list developed for the standard attribute. An attribute can have only one rule with a Rule Type of Enumeration List Exclusion.
    • Enumeration List Item Display Name – Displays only for standard attributes with a Data Type of Enumeration. Provides a display name for the list items in the attribute's enumeration list, rather than displaying the identifying names for the list items in the Web UI. An attribute can have only one rule with a Rule Type of Enumeration List Item Display Name.
    • Field Control On Condition – Sets the behavior for the attribute that the rule is applied to, based on the value for another attribute (e.g. sets attribute A as required when a value is present for attribute B).
    • Has a Display Name – Provides a display name for the attribute, rather than displaying the attribute's identifying name in the Web UI. For standard attributes, this overrides the Display Name if present. An attribute can have only one rule with a Rule Type of Display Name.
    • Value Always Required – For standard attributes, displays only if the attribute is not Required, and overrides the standard attribute's requirement status, if present. Indicates that a value must be present for the attribute. An attribute can have only one rule with a Rule Type of Value Always Required.
    • Value Format Validation – Displays only if the attribute has a Data Type other than Boolean, and overrides any validation developed for the standard attribute, if present. Restricts the allowed format for values (e.g. to set a character limit). An attribute can have only one rule with a Rule Type of Value Format.

    The name of the Attribute to add the rule to displays.

  12. Specify details for the new rule (required if the Rule Type is Allowed Value List, Conditionally Allowed List, Enumeration List Exclusion, Enumeration List Item Display Name, Field Control on Validation, Has a Display Name, or Value Format Validation):
    1. Fill in the following fields to determine the available list items:
      • Name field – Required. The identifying name for the item in the value list.
      • Display Name field – Required. The name that displays in the Web UI for the associated Name.
    2. If necessary, select the Add icon to add another Name and Display Name.

      Tips:

      • Select the Up and Down icons to reorder the value list items.
      • Select the Remove icon to remove a Name and Display Name row.
    1. Fill in the following fields to determine when the rule is triggered:
      • Triggering Attribute field – Required. The attribute that enables the conditionally allowed list for the attribute that this rule is applied to.
      • Triggering Value field – Required. The value for the Triggering Attribute that enables the conditionally allowed list for the attribute that this rule is applied to.
    2. Enter the identifying Name and Display Name for the item to include in the value list, which must be present in the enumeration or allowed value list for the attribute that this rule is applied to.

    3. If necessary, select the Add icon to add another Name and Display Name.

      Tips:

      • Select the Up and Down icons to reorder the value list items.
      • Select the Remove icon to remove a Name and Display Name row.
    1. Enter the identifying Name and Display Name for the item to conditionally exclude from the list.

    2. If necessary, select the Add icon to add another Name and Display Name.

      Tips:

      • Select the Up and Down icons to reorder the value list items.
      • Select the Remove icon to remove a Name and Display Name row.
    1. Fill in the following fields to identify the list items and their display names:
      • Name field – Required. The identifying name for the item in the value list.
      • Display Name field – Required. The name that displays in the Web UI for the associated Name.
    2. If necessary, select the Add icon to add another Name and Display Name.

      Tips:

      • Select the Up and Down icons to reorder the value list items.
      • Select the Remove icon to remove a Name and Display Name row.
    • Fill in the following fields:
      • Triggering Attribute field – Required. The attribute that enables the conditional behavior for the attribute that the rule is applied to.
      • Condition drop-down – Required. The criteria for the Triggering Attribute that must be met to enable the conditional behavior for the attribute that the rule is applied to:
        • IS – The conditional behavior occurs when a specific value is present for the Triggering Attribute (e.g. the Triggering Attribute has a value of A).
        • IS NOT – The conditional behavior occurs when a value other than a specific value is present for the Triggering Attribute (e.g. the Triggering Attribute has a value that is not A).
        • IS NOT EMPTY – The conditional behavior occurs when a value is present for the Triggering Attribute.
      • Triggering Value field – Conditionally required if the Condition is IS or IS NOT). The value that determines the conditional behavior for the attribute that the rule is applied to.
      • Attribute Control drop-down – Required. The behavior for the attribute that the rule is assigned to, which occurs when the Condition is met for the Triggering Attribute:
        • Read-Only – The attribute displays but is not active.
        • Hidden – The attribute does not display.
        • Required – The attribute is required.
    • Enter the Display Name to display for the attribute in the Web UI.
    • Enter the Regular Expression that restricts the allowed format for values.
  13. Select Add.

    The rule is added to the attribute.