Monitor > Processes > Process filters
  

Process filters

The Processes page displays a list of process instances that are running or have been run in the organization. You can apply filters to view the processes that you would like to monitor and analyze.
You can create the following types of process filters:
Simple process filter
You can create a simple process filter to filter processes based on a field, operator, and value.
Advanced process filter
You can use a query to define an advanced process filter condition. Construct the query by using an extensive set of properties from pre-defined lists and by grouping expressions with logical operators.

Simple process filters

You can create a simple process filter to filter processes based on a field, operator, and value.
You can create one or more simple process filters. When you create multiple simple process filters, the Process Server joins all the filters with an AND operator and displays the processes that meet all the filter conditions.
For example, to view the processes that were completed today, you can create two simple process filter conditions with the Status field set to Completed and the End Date field set to Today as shown in the following image:
The image shows two simple process filter conditions that return the processes that were completed today.

Configuring a simple process filter

    1In Application Integration Console, click Processes on the left navigation bar.
    2On the right pane, click the Filter icon.
    The Add Field and Use a Query options appear.
    3Click the down arrow adjacent to Add Field and select one of the following fields based on which you want to filter the processes:
    The following image shows the fields based on which you can filter processes:
    The image shows the fields based on which you can filter processes, namely, ID, Name, Version, Start Date, End Date, Group, and Status.
    4Configure the filter condition based on the field that you selected.
    The following table describes the steps that you must complete based on the field that you selected:
    Field
    Description
    ID
    The instance ID of the process. Every process run has a unique instance ID.
    If you selected ID, complete the following steps:
    1. aSelect one of the following operators:
      • - Equals
      • - Does not equal
      • - Less than
      • - Less than or equal to
      • - Greater than
      • - Greater than or equal to
      • - Between
    2. bEnter a value for the filter condition.
      3. If you selected the Between operator, enter two values to define a range based on which you want to filter the processes.
    Version
    The version number of the process.
    If you selected Version, complete the following steps:
    1. aSelect one of the following operators:
      • - Equals
      • - Does not equal
      • - Less than
      • - Less than or equal to
      • - Greater than
      • - Greater than or equal to
      • - Between
    2. bEnter a value for the filter condition.
      3. If you selected the Between operator, enter two values to define a range based on which you want to filter the processes.
    Name
    The name of the process.
    If you selected Name, enter a value for the filter condition.
    Group
    The group that a process belongs to. The group name is specified in the Process Deployment Descriptor (PDD) and displayed on the Deployed Process Version Detail page.
    If you selected Group, enter a value for the filter condition.
    Start Date
    The date when the process execution started.
    If you selected Start Date, select one of the following values based on which you want to filter the processes:
    • - Any time
    • - Today
    • - Last Week
    • - Last Month
    • - Last Year
    • - Custom Range
    If you selected Custom Range, click the calendar to specify a date and time range for the filter condition.
    End Date
    The date when the process completed, faulted, or was stopped or suspended.
    If you selected End Date, select one of the following values based on which you want to filter the processes:
    • - Any time
    • - Today
    • - Last Week
    • - Last Month
    • - Last Year
    • - Custom Range
    If you selected Custom Range, click the calendar to specify a date and time range for the filter condition.
    Status
    The state of the process execution.
    If you selected Status, select one of the following values based on which you want to filter the processes:
    • - Completed
    • - Faulted
    • - Running
    • - Suspended
    5Create additional filters if needed.
    The Process Server joins all the filters with an AND operator and displays the processes that meet all the filter conditions.
To remove a filter, click Close next to the filter condition. To remove all the filters and view all the processes, click Close next to the Filter icon.

Advanced process filters

You can construct a query to define an advanced process filter condition. You can construct the query by using an extensive set of properties from pre-defined lists and by grouping expressions with logical operators.
The following image shows the Query Builder page:
The image shows the Query Builder page.
You can use the Process Properties and Property Codes lists to select the properties based on which you want to filter processes. Use the Operators list to define the operators that you want to include in the query.
The following table describes the properties that are available in the Process Properties list:
Process Property
Description
Sample Query
End Date
The date when the process completed, faulted, or was stopped or suspended.
The End Date field uses Coordinated Universal Time (UTC).
Double-click to add the getProcessProperty("EndDate") property to the query. Select an operator and click the calendar below the Insert Date field to select an end date.
To use the = or != operator with an end date in the query, you must specify the end date in milliseconds. Otherwise, the query returns incorrect results.
You can also use a range of dates in the query to filter processes based on the end date.
Use one of the following queries to filter the processes whose end date is August 21, 2020:
  • - getProcessProperty("EndDate") = "1597994701818"
  • - getProcessProperty("EndDate") > "2020/08/20" and getProcessProperty("EndDate") < "2020/08/22"
Engine ID
The ID of the engine that runs the process.
Double-click to add the getProcessProperty("EngineId") property to the query. Select an operator and type a value for the engine ID.
Use the following query to filter the processes whose engine ID is 1:
getProcessProperty("EngineId") = 1
Group
The group that a process belongs to. The group name is specified in the Process Deployment Descriptor (PDD) and displayed on the Deployed Process Version Detail page.
Double-click to add the getProcessProperty("Group") property to the query. Select an operator and type a value for the group name.
Enclose the group name within single quotation marks (') or double quotation marks (").
Use the following query to filter the processes that belong to the North West Region group:
getProcessProperty("Group") = "North West Region"
ID
The instance ID of the process. Every process run has a unique instance ID.
Double-click to add the getProcessProperty("Id") property to the query. Select an operator and type a value for the ID.
Use the following query to filter the processes whose instance ID is greater than 434251505437396992:
getProcessProperty("Id") > 434251505437396992
Initiator
The name of the user who initiated the process.
Double-click to add the getProcessProperty("Initiator") property to the query. Select an operator and type a name for the initiator.
Enclose the initiator name within single quotation marks (') or double quotation marks (").
Use the following query to filter the processes that were initiated by John:
getProcessProperty("Initiator") = 'John'
Name
The name of the process.
Double-click to add the getProcessProperty("Name") property to the query. Select an operator and type a process name.
Enclose the process name within single quotation marks (') or double quotation marks (").
Use the following query to filter the processes whose name is LoanApproval:
getProcessProperty("Name") = "LoanApproval"
Namespace
The target namespace of the process.
The target namespace uses the following syntax:
urn:screenflow:process:<process_name>
The target namespace value is unique for each process.
Double-click to add the getProcessProperty("Namespace") property to the query. Select an operator and type a target namespace.
Enclose the target namespace within single quotation marks (') or double quotation marks (").
Use the following query to filter the process whose target namespace is urn:screenflow:process:LoanApproval:
getProcessProperty("Namespace") = 'urn:screenflow:process:LoanApproval'
Start Date
The date when the process execution started.
The Start Date field uses Coordinated Universal Time (UTC).
Double-click to add the getProcessProperty("StartDate") property to the query. Select an operator and click the calendar below the Insert Date field to select a start date.
To use the = or != operator with a start date in the query, you must specify the start date in milliseconds. Otherwise, the query returns incorrect results.
You can also use a range of dates in the query to filter processes based on the start date.
Use one of the following queries to filter the processes whose start date is August 21, 2020:
  • - getProcessProperty("StartDate") = "1597994701818"
  • - getProcessProperty("StartDate") > "2020/08/20" and getProcessProperty("StartDate") < "2020/08/22"
State
The state of the process execution.
Double-click to add the getProcessProperty("State") property to the query. Select an operator. In the Property Codes list, expand the State list and double-click a state value to insert the associated state code into the query.
The following list describes the state values and the associated state codes:
  • - Running. 1. The process is running.
  • - Suspended. 2. The process is suspended.
  • - Completed. 3. The process has completed successfully.
  • - Faulted. 4. The process completed with a fault.
  • - Compensatable. 5. A sub-process is complete and is eligible for compensation.
Use the following query to filter the processes that are in the faulted state:
getProcessProperty("State") = "4"
State Reason
The reason why a process is in the suspended state.
Double-click to add the getProcessProperty("StateReason") property to the query. Select an operator. In the Property Codes list, expand the State Reason list and double-click a state reason value to insert the associated state reason code into the query.
The following list describes the state reason values and the associated state reason codes:
  • - Suspended (Manual). 0. Applies to processes that were suspended manually.
  • - Suspended (Faulting). 1. Applies to processes that were suspended due to a fault that was not caught.
  • - Suspended (Activity). 2. Applies to processes that were suspended at a BPEL suspend activity.
  • - Suspended (Migration Error). 7. Applies to processes that were suspended due to a migration error for a process that has been migrated to a new process version.
  • - Suspended (Migration Warning). 8. Applies to processes that were suspended due to a migration warning for a process that has been migrated to a new process version. Warnings indicate differences found in the new version that might need review and updates before you resume the process.
  • - Pre Migration Copy. 20. Applies to an old process instance that has been saved temporarily until the new process instance has been resumed or terminated.
Use the following query to filter the processes that are in the suspended state because they faulted:
getProcessProperty("StateReason") = 1
Tenant ID
The tenant identification number for the process. The tenant identification number is unique for each organization.
Double-click to add the getProcessProperty("TenantId") property to the query. Select an operator and type a value for the tenant ID.
Enclose the tenant ID within single quotation marks (') or double quotation marks (").
Use the following query to filter the processes whose tenant ID is 3i5mW6m6816cHjNTPH8LwE:
getProcessProperty("TenantId") = "3i5mW6m6816cHjNTPH8LwE"
Title
The name of the process.
Double-click to add the getProcessProperty("Title") property to the query. Select an operator and type a process name.
Enclose the process name within single quotation marks (') or double quotation marks (").
Use the following query to filter the processes whose name is LoanApproval:
getProcessProperty("Name") = "LoanApproval"
Version
The version number of the process.
Double-click to add the getProcessProperty("Version") property to the query. Select an operator and type a value for the version number.
Use the following query to filter the processes whose version number is equal to 1:
getProcessProperty("Version") = 1
The following table describes the properties that are available in the Property Codes list:
Property Code
Description
State
The state of the process execution.
Expand the State list and double-click a state value to insert the associated state code into the query.
The following list describes the state values and the associated state codes:
  • - Running. 1. The process is running.
  • - Suspended. 2. The process is suspended.
  • - Completed. 3. The process has completed successfully.
  • - Faulted. 4. The process completed with a fault.
  • - Compensatable. 5. A sub-process is complete and is eligible for compensation.
State Reason
The reason why a process is in the suspended state.
Expand the State Reason list and double-click a state reason value to insert the associated state reason code into the query.
The following list describes the state reason values and the associated state reason codes:
  • - Suspended (Manual). 0. Applies to processes that were suspended manually.
  • - Suspended (Faulting). 1. Applies to processes that were suspended due to a fault that was not caught.
  • - Suspended (Activity). 2. Applies to processes that were suspended at a BPEL suspend activity.
  • - Suspended (Migration Error). 7. Applies to processes that were suspended due to a migration error for a process that has been migrated to a new process version.
  • - Suspended (Migration Warning). 8. Applies to processes that were suspended due to a migration warning for a process that has been migrated to a new process version. Warnings indicate differences found in the new version that might need review and updates before you resume the process.
  • - Pre Migration Copy. 20. Applies to an old process instance that has been saved temporarily until the new process instance has been resumed or terminated.
The following table describes the operators that you can use in the query:
Operator
Description
and
logical AND
When you join two conditions with an and operator, the Process Server displays processes that meet both the conditions.
For example, consider the following query:
getProcessProperty("Name") = "C3" and getProcessProperty("Version") = 1
This query returns processes whose name is C3 and whose version number is 1 as shown in the following image:
The image shows processes whose process name is C3 and whose version number is 1.
Note: The and operator is case sensitive.
or
logical OR
When you join two conditions with an or operator, the Process Server displays processes that meet either of the two conditions.
For example, consider the following query:
getProcessProperty("Name") = "C3" or getProcessProperty("Version") = 1
This query returns processes whose name is C3 as shown in the following image:
The image shows processes whose process name is C3.
The query also returns processes whose version number is 1 as shown in the following image:
The image shows processes whose version number is 1.
Note: The or operator is case sensitive.
=
Equal to
!=
Not equal to
>
Greater than
>=
Greater than or equal to
<
Less than
<=
Lesser than or equal to

Configuring an advanced process filter

    1In Application Integration Console, click Processes on the left navigation bar.
    2On the right pane, click the Filter icon.
    The Add Field and Use a Query options appear.
    3Click Use a Query.
    The Query Builder page appears.
    The following image shows the Query Builder page:
    The image shows the Query Builder page.
    4Double-click the entries in the Process Properties, Property Codes, and Operators lists to insert the entries into the query. Optionally, edit the query or click Clear to clear the query.
    The query that you configure appears in the Query box.
    5Click Apply.
    The Process Server removes all filters that were previously applied and displays the processes that meet the configured query.
To remove the filters and view all the processes, click Close next to the filter condition or click Close next to the Filter icon.