Skip to main content

Version: 19.11 (EOL)

Using Txn attributes

In order to display Txn information in the UI, you will need to setup some mappings via the dataIndex attribute. dataIndex is a Txn attribute in the underlying configuration that will be used as the value for the field. For example:

{
"$primaryApplicant": {
"label": "Name",
"dataIndex": "properties['PrimaryName']",
"type": "text"
}
}

Fallback dataIndex

In some cases you may want to define a fallback dataIndex. Say you want to display a value in the table that is not available for certain Txn statuses. You can define dataIndex as a list that is checked in the specified order, stopping when a value is found. For example:

{
"$primaryApplicant": {
"label": "Name",
"dataIndex": ["properties['PrimaryName']", "formDataMap['PrimaryName']"],
"type": "text"
}
}

Supported attributes

Here is the list of attributes and supported operations that can be used within a Workspaces configuration.

AttributeDescription
authStatusString

Supported operations: Selection, Filter, Sort

Filter transactions based on the authStatus of the transaction.

clientCodeString

Supported operations: Selection, Filter, Sort

Filter transactions based on the clientCode.

emailAddressString

Supported operations: Selection, Filter, Sort

Filter transactions based on the emailAddress associated with the submission.

formCategoryString

Supported operations: Selection, Filter, Sort

Filter transactions based on the form template version's association to the category specified.

formCodeString

Supported operations: Selection, Filter, Sort

Filter transactions based on the form code of the submitted form.

formDataMapObject

Supported operations: Selection, Filter

Filter transactions based on an entry in the formDataMap. Supports exact match of value but not extract name.

Examples:

  • "formDataMap[*] = 'Jane'"
  • "formDataMap['firstName'] = 'Jane'"
  • "formDataMap['firstName'] IN ('Jane', 'Doe')"
formNameString

Supported operations: Selection, Filter, Sort

Filter transactions based on the form name of the submitted form.

formStatusString

Supported operations: Selection, Filter, Sort

Filter transactions based on transaction form status.

groupNameString

Supported operations: Selection, Filter, Sort

Filter transactions based on the association with submission groups with names specified.

milestonesString

Supported operations: Selection, Filter, Sort

Filter transactions based on submission milestones.

propertiesObject

Supported operations: Selection, Filter

Filter transactions based on submission properties. Supports exact match of both name and value for a single property per search.

Examples:

  • "properties[*] = 'prop1Value'"
  • "properties['property1'] = 'prop1Value'"
  • "properties['property1'] IN ('prop1Value', 'prop2Value')"
spaceNameString

Supported operations: Selection, Filter, Sort

Filter transactions based on the association with spaces with name(s) specified.

submitKeyString

Supported operations: Selection, Filter, Sort

Filter transactions based on the submission submitKey. Matches to one transaction record.

timeAbandonedString

Supported operations: Selection, Filter, Sort

Filter transactions based on the time abandoned timestamp in the format "yyyy-MM-dd", "yyyy-MM-dd HH:mm:ss" or "yyyy-MM-ddTHH:mm:ssZ" (the returned date format).

Examples:

  • "timeAbandoned > '2018-01-01'"
  • "timeAbandoned < '2019-01-01 09:00:00'"
  • "timeAbandoned >= '2018-01-01T15:17:29+10:00'"
timeCompletedString

Supported operations: Selection, Filter, Sort

Filter transactions based on the time completed timestamp in the format "yyyy-MM-dd", "yyyy-MM-dd HH:mm:ss" or "yyyy-MM-ddTHH:mm:ssZ" (the returned date format).

Examples:

  • "timeCompleted < '2018-01-01'"
  • "timeCompleted = '2018-01-01 23:17:29'"
  • "timeCompleted > '2018-01-01T15:17:29+10:00'"
timeCreated String

Supported operations: Selection, Filter, Sort

Filter transactions based on the time created timestamp in the format "yyyy-MM-dd", "yyyy-MM-dd HH:mm:ss" or "yyyy-MM-ddTHH:mm:ssZ" (the returned date format).

Examples:

  • "timeCreated > '2018-01-01'"
  • "timeCreated >= '2018-01-01 15:17:29'"
  • "timeCreated <= '2018-01-01T15:17:29+10:00'"
timeRequestString

Supported operations: Selection, Filter, Sort

Filter transactions based on the time request timestamp in the format "yyyy-MM-dd", "yyyy-MM-dd HH:mm:ss" or "yyyy-MM-ddTHH:mm:ssZ" (the returned date format).

Examples:

  • "timeRequest >= '2018-01-01'"
  • "timeRequest = '2018-01-01 15:17:29'"
  • "timeRequest >= '2018-01-01T15:17:29+10:00'"
timeSubmittedString

Supported operations: Selection, Filter, Sort

Filter transactions based on the time submitted timestamp in the format "yyyy-MM-dd", "yyyy-MM-dd HH:mm:ss" or "yyyy-MM-ddTHH:mm:ssZ" (the returned date format).

Examples:

  • "timeSubmitted < '2018-01-01'"
  • "timeSubmitted = '2018-01-01 15:17:29'"
  • "timeSubmitted >= '2018-01-01T15:17:29+10:00'"
timeUserLastModifiedString

Supported operations: Selection, Filter, Sort

Filter transactions based on the time user last modified timestamp in the format "yyyy-MM-dd", "yyyy-MM-dd HH:mm:ss" or "yyyy-MM-ddTHH:mm:ssZ" (the returned date format).

Examples:

  • "timeUserLastModified <= '2018-01-01'"
  • "timeUserLastModified = '2019-01-01 23:17:29'"
  • "timeUserLastModified > '2018-01-01T15:17:29+10:00'"
trackingCodeString

Supported operations: Selection, Filter, Sort

Filter transactions based on the tracking code. Matches to one transaction record.

userLoginNameString

Supported operations: Selection, Filter, Sort

Filter transactions based on the user login name.

userSaved Boolean

Supported operations: Selection, Filter, Sort

Filter transactions based on the user saved property.

  • true: "userSaved = 1"
  • false: "userSaved = 0", "userSaved = null"
job.jobRefNumberString

Supported operations: Selection, Filter, Sort

Filter transactions based on job reference number.

job.timeCreated String

Supported operations: Selection, Filter, Sort

Filter transactions based on job creation time.

job.timeLastModifiedString

Supported operations: Selection, Filter

Filter transactions based on job last modified time.

job.jobKeyString

Supported operations: Selection

Select job key value for the transaction.

job.nameString

Supported operations: Selection

Select job name value for the transaction.

job.currentActionString

Supported operations: Selection

Select job's current action for the transaction.

job.currentStep String

Supported operations: Selection

Select job's current step for the transaction.

job.statusString

Supported operations: Selection

Select job's status for the transaction.

job.timeCompletionScheduled String

Supported operations: Selection

Select job's completion schedule time for the transaction.