› Workflow › Business processes › Design a basic process › Add an activity › Activity types › Other activities › Data list activity › Configure a Data list activity

Configure a Data list activity

Use the following procedure to configure a Data list activity. You can add, delete, get rows, and update the field values using the data list activity. You can map the data model variable either at the object level or field level. For a field-level mapping, all the columns configured in the data list along with the nested object fields up to nine levels are listed. You can specify the value for nested object fields. You can then map each field (including nested object fields) using an inline value or variables. You can also search to match the items in a data object list using operators.

  1. Add an activity to the map.

    By default, the Configuration tab is open in the properties panel of the activity.

  2. Change the default Name of the activity to something meaningful.
  3. On the Type list, select Other > Data list.
  4. Click Configure.

    The Data list configuration dialog box is displayed with the activity name.

  5. On the Data list list, select a Data object variable.
  6. On the Action list, select the appropriate option for adding, deleting, or getting rows, or updating the field values.
  7. Save the process map.

    Configure other properties for this activity. See Activity properties.

Add row

Add rows to a data list by mapping the fields or an object.

  1. For Mapping, select either option.

    Field(s)(default)

    The list of fields along with the field types from the selected data model is displayed in a table. Map the field to a process or server variable or provide an inline value. At runtime, a row is added to the data list by the field name. You can map a field to a String variable, Document variable or a Data object process variable.

    If you select a document variable, you can pass a Capture document or return a document to a field in a data object variable as an instance ID or as a base 64 string.

    If you select the Data as base64 string option, the following mime types are displayed in another list: Default, PDF, BMP, GIF, PNG, TIFF, WMP, JBIG2, JPEG2000, DICOM, DOCX, MHTML, HTML, MSG, PCX, PPT, PPTX, RTF, TXT, and XLS. The "Default" option means that no type is considered and you get the file data.

    Object

    The name of the object based on the selected list is displayed as a label. For example, if you have a data model with a list named Pages, and you map that list , the name will be displayed as Pages.

    On the List, select a data object process variable, or provide an inline value (JSON string).

  2. Click OK.

Delete rows

Delete rows from a data list either using index or custom search.

Delete rows using index

  1. Select Index (default).
  2. Provide a value in Row index for the row you want to delete. For example, to delete the second row select 2 as row index. Alternatively, select a Data object process variable.
  3. Click OK.

    When you execute this activity, the row is deleted from the array at the specified index. If the row does not exist, no action is performed.

Delete row using custom search

  1. Select Custom search.
  2. Define the search criteria either mapping fields or an object.

    Field(s)

    1. Click .

    2. On the Name list, select a field.

      The corresponding field type is automatically added.

    3. On the Operator list, select an operator.

      The list of options displayed in the Operator list depends on the selected field type. For example:

      • For Bool, List, and Object, only the Equals operator is displayed.

      • For String, the Equals, Not equal to, In, Like, and Not like operators are displayed. (Default: Equals)

      • For Number and Date, the Equals, Greater than, Greater than equal to, Less than, Less than equal to, and Not equal to operators are displayed. (Default: Equals)

    4. On the Value list, select a process or server variable, or provide an inline value.

    5. Click Add.

    6. Map more fields as needed.

    Object

    On the List, select a Data object process variable, or provide an inline value (JSON string).

  3. Click OK.

    When you execute this activity, any row that matches the search criteria is deleted from the array. If the row does not exist, no action is performed.

Update field values

Update the field values either using index or custom search.

Update field values using index

You can add more than one column to update.

  1. Select Index (default).
  2. In Row index, select a value, or select a process or server variable.
  3. Under Update fields, for Mapping, select either option.

    Field(s)

    To map a field, do the following:

    1. Click .

    2. On the Name list, select the field for which to update the value.

      The corresponding field type is automatically added.

    3. On the Value list, provide an inline value or select a process or server variable.

      If you select a document variable, you can pass a Capture document or return a document to a field in a data object variable as an instance ID or as a base 64 string.

      If you select the Data as base64 string option, you can select a mime type.

    4. Click Add.

    Similarly, add multiple columns to update.

    Object

    		On the List, select the Data object process or server variable, or provide an inline value (JSON string).

  4. Click OK.

    When you execute this activity, at runtime, the columns in the row are updated with the specified values at the specified index. If the row does not exist, no action is performed.

Update field values using custom search

Define the search criteria and select the field values to update. You can select the combination of object and fields for the custom search and updating fields. For example, you can use fields in "Search criteria" and object in "Update fields".

  1. Select Custom search.
  2. Under Search criteria, for Mapping, select either option. You can add multiple search criteria using fields or an object.

    Field(s)

    1. Click .

    2. On the Name list, select a field.

      The corresponding field type is automatically added.

    3. On the Operator list, select an operator.

      The list of options displayed in the Operator list depend on the selected field type. For example:

      • For Bool, List, and Object, only the Equals operator is displayed.

      • For String, the Equals, Not equal to, In, Like, and Not like operators are displayed. (Default: Equals)

      • For Number and Date, the Equals, Greater than, Greater than equal to, Less than, Less than equal to, and Not equal to operators are displayed. (Default: Equals)

    4. On the Value list, select a process or server variable, or provide an inline value.

    5. Click Add.

    You can add multiple columns to update.

    Object On the List, select the Data object process or server variable, or provide an inline value (JSON string).

  3. Update the values for fields or an object. Under Update fields, for Mapping, select either option.

    Field(s)

    1. Click .

    2. On the Name list, select the field.

      The corresponding field type is automatically added.

    3. Provide the field value using an inline value or process or server variable.

    4. Click Add.

      You can add multiple fields to update.

    Object On the List, select the Data object process variable, or provide an inline value (JSON string).

  4. Click OK.

    When you execute this activity, at runtime, any row that meets the search criteria is updated. If the row does not exist, no action is performed.

Get rows

Get row(s) either using index or custom search.

Get rows using index

  1. Select Index (default).
  2. In Row index, select a value, or select a process or server variable.
  3. UnderReturn data, for Mapping, select either option to add rows to be returned as fields or object.

    Field(s)

    1. Click .

    2. On the Source list, select a child field and on the Target list, select the process or server variable or provide an inline value.

      The corresponding field type is automatically added.

      If you select a document variable, you can pass a Capture document or return a document to a field in a data object variable as an instance ID or as a base 64 string.

      If you select the Data as base64 string option, option, you can select a mime type.

    3. Click Add.

    Object

    		On the List, select the Data object process variable, or provide an inline value (JSON string).

  4. Click OK.

    When you execute this activity, the data from the row is returned with the correct variables at the specified index. If the row does not exist, no action is performed.

Get rows using custom search

Define the search criteria and configure return data to get only the first row or multiple rows. You can add multiple search criteria based on fields or an object.

  1. Select Custom search.
  2. Define the search criteria either using fields or an object. Under Search criteria, for Mapping, select either option.

    Field(s)

    1. Click .

    2. Provide the Name, Operator, and Value using an inline value or process or server variable.

      The field type is automatically added when you select the field name to add to the search criteria.

    3. Click Add. You can add multiple columns to update.

    Object On the List, select the Data object process variable, or provide an inline value (JSON string).

    You can select the combination of object and fields for the custom search and return data. For example, you can use fields in "Search criteria" and object in "Return data".

  3. Configure the return data using fields or an object. Under Return data, for Mapping, select either option.

    Field(s)

    1. On the Return variable list, select the list process variable.

    2. Click .

    3. On the Source list, select a child field.

    4. On the Target list, select the process or server variable, or provide an inline value.

      The corresponding field type is automatically added.

      If you select a document variable, you can to pass a Capture document or return a document to a field in a data object variable as an instance ID or as a base 64 string.

      If you select the Data as base64 string option, option, you can select a mime type.

    5. Click Add. You can add multiple columns to update.

    6. To specify the result of number of rows returned, on the Row count, select the Long or Short type variable.

    Object

    1. On the Return to list, select the List process variable.

    2. On the Row count, select the Long or Short type variable.

      It specifies the result of number of rows returned.

  4. You can either get multiple rows or get only the first row.

    • To get multiple rows, make sure Return first found is clear.

    • To get only the first row, select Return first found. The following things happen:

      • The Return to list option is not available under Return data when you map fields.

      • The Return variable option becomes unavailable and Return to list option is automatically changed to the object name when you map an object.

  5. Click OK.

    When you execute this activity, any row that matches the search criteria is returned with the mapped data object variable. If the row does not exist, no action is performed.