› Workflow › Variables › Create process variables › Create a data object variable

Create a data object variable

You can create a data object variable based on a data model (local or global).

You can create multiple data object variables referring to the same or different data models.

Once a data object variable is created, it can be used in integration to REST APIs where the response/request can be passed as an object. The object can also be used in other integrations, form actions, and process activities to store the request sent and/or response received from a RESTful service.

You can use the entire object, such as a person, or parts of the object by selecting a part of a model, such as person spouse.

Similarly, a data object variable can be used as a string to access or update it at runtime. On building or regenerating a Create new job form or activity form that uses a data object variable, the data object variable value is retrieved and displayed in a multi-line text field on the form.

You can also use the repeating data within a data object variable and access the list (array) and use it as a complex/dynamic complex variable. When you define the data object variable that contains a field of type list, it behaves in the same manner as a complex/dynamic complex variable. For example, you can map the list field of a data object as input to a .Net method. When you select the variable, the fields within the array are available for mapping. When executed, the collection of mapped fields of the list is passed into the .Net call.

The list field of a data object can be mapped as an output from a .Net method. When you set the variable as the output, you can map the fields within the list to the returned values.

If you use a JSON file and if JSON is a list, you cannot return it into the data object you created but must instead map to the list field within the JSON that has been created.

  1. Open the process map in which to create the variable.
  2. On the process modeling bar, click Variables and click New.

    The New variable dialog box is displayed.

  3. Enter a unique Name for the variable.
    By default, the name of the variable becomes the ID of the variable; however, you can change the ID if needed.
  4. On the Type list, select Data object. (Default: String)
  5. To use the variable for process initialization, select Initialization.
  6. On the Value list, select a data model (global or local) or a field from a data model.

    You can drill into the object and see the fields along with their data type. Being able to see data types makes it easier to map the correct field.

    For more information on how to use fields within a data object variable, see Access fields available within a data object variable.

  7. Click Add and close.

    The variable appears on the Variables list page.

  8. Save the process.

    Data objects cannot be overridden in skins.

Access fields available within a data object variable

You can use fields within a data object variable and access them by expanding the object. Once a field is selected, it is displayed as dot notation.

You can drill into the variable and see the fields. When a field is used, the path from which it came is displayed.

For example, a data object could contain the following fields:

Company Name

CompanyID

Address

  • Street

  • Postcode

  • Country

    • Code

    • Name

If you use the CompanyID, then the path is displayed as VariableName.CompanyID.

If you select the nested object, such as Country Name, then the path is displayed as VariableName.Address.Country.Name.

The fields can be used anywhere that variables can be used as single values to set/get the value. For example, you can use a field in the following ways:

  • As part of an input to a .Net activity, you can pass in the VariableName.Address.Country.Name field.

  • In an Expression node, you can set the value of the Postcode field using an expression.

  • In a manual activity, you can use the fields as input and output.

See also: