List Navigator Activity
- Last UpdatedJun 21, 2024
- 5 minute read
Activity Description
The List Navigator activity is used to change the scope of the XML List XML variable during the workflow execution.
Usage Scenario
Telematics Project Managers can submit ad hoc requests for list of overdue tasks assigned to all team members. The request triggers a workflow that goes through every item in the Task List to build a report of tasks with overdue status.
Activity Properties
The List Navigator activity has to be configured by specifying appropriate values for the different properties in the Activity Properties area. The Activity Properties can be accessed by clicking the Activity Properties tool in the tool bar or by selecting the appropriate option from the right-click menu for the List Navigator activity. The Activity Properties are organized under the following groups of related properties. The properties under each group are described in this topic.
Name & Description
The properties in the Name & Description group have been described below. You can use these properties to specify the name and description for the activity.
Name - This property can be used to specify a name for the activity.
Property Type: Optional (This property needs to be set only if necessary.)
Description - This property specifies a brief description to be displayed for the activity.
Property Type: Optional (This property needs to be set only if necessary.)
Display Name - This property specifies the name to be displayed for the activity in the Web Work Item List.
Property Type: Optional (This property need not be set if the display name is already configured in the Actions.xml. The name entered here overrides any display name that is configured for this activity in the Actions.xml file.)
Configuration
The properties in the Configuration group have been described below. You can use these properties to configure the functionality of the activity.
XMLVariable of List Type - This property is used to select the XML variable of List type (XML List).
Property Type: Mandatory
Steps to set the XMLVariable of List Type
Select an XML variable from the XMLVariable of List Type drop-down list.
See XML List Navigator Activity - XMLVariable of List Type for a detailed description of the XMLVariable of List Type property window
.
List Name or ID - This property is used to specify the list name.
Property Type: Optional
Steps to set the List Name
-
To specify the list name, click edit button for the 'ListName' property to open the property window.
-
In this window, enter the list name directly in the text editor.
-
If you want to customize the list name, you can do so using the Field controls to add workflow property values. For example, to select the XMLVariable. you can do as follows: Select "XML Variables". Select the XML variable from where you want to fetch the list name and then select respective node which is expected to have the values from the drop downs for Field and click Append. This will add the placeholder for the XMLvariable after the text entered in the text editor. At run-time this placeholder will be replaced by the corresponding value, i.e. the list name.

-
You can manipulate the text using the appropriate tools from the tool bar. You can cut, copy and paste text, undo and redo changes, zoom in and zoom out the view as well as print the text.
-
You can format the text, if necessary, using the formatting tools. You can make text bold or italic or change the font or size, set text color or background color.
-
After adding the list name, click Update to save it.
-
Click Close to close the window without saving the list name.
-
Click Save to save the XML variable in the Activity Properties window.
See List Navigator: List Name or ID for a detailed description of the List Name property window.
Folder Name - Enter the folder name.
Property Type: Optional (This property needs to be set only if necessary.)
Scope - This property allows you to change the scope of the XML variable during the workflow execution.
Property Type: Optional
Steps to set the Scope
-
Select the option from the Scope drop-down list.
-
If Current option is selected, you can fetch the current item which was alerted in the workflow.
-
If New option is selected, you can add new item to the list.
-
If List Query option is selected, you can build the list query to fetch the items.
List Query - This property is used to build the query for the list.
Property Type: Optional
Steps to set the List Query
-
To build the list, click the edit button for the 'List Query' property to open the property window.
-
You can also enter the query directly in the text editor.
Note: While building query to fetch the items, you need to specify the table name with column name in a Where clause. For example, SKEUsers.Title="AVEVAWorkTasks";
-
You can also build the query using dynamic Query builder.
-
Click the query builder icon to build the query. See List Navigator Activity - Query Builder for a detailed description of the List Query builder window.
-
You can manipulate the text using the appropriate tools from the tool bar. You can cut, copy and paste text, undo and redo changes, zoom in and zoom out the view as well as print the text.
-
You can format the text, if necessary, using the formatting tools. You can make text bold or italic or change the font or size, set text color or background color.
-
After adding the list name, click Update to save it.
-
Click Close to close the window without saving the query.
-
Click Save to save the XML variable in the Activity Properties window.
See List Navigator: List Query for a detailed description of the List Query property window.
Note:
- For executing the List Query following user information is considered for security:
-- If the Workitem Context is available for the List Item, it will consider the workitemactorid
as the user id.
-- If the Workitem Context user id is unavailable, then the System user configured
for the Repository is considered.
-- If the System user is not configured for the Repository, then it will consider
the currently logged-in user id.
- Make sure the user has administrator rights in the AVEVA
Looping Behavior
The property in the Looping Behavior group has been described below. You can use this property to specify the looping behavior of the activity.
Loop through this action if output is - This property is used to specify the condition for looping the activity by selecting an activity output from the drop down.
Property Type: Optional (This property needs to be set only if necessary.)
Activity outputs:
The List Navigator Activity returns the following values -
Action completed: Triggers this output when action is completed.
List Item Not Found: This output will be given for the activity, when the list query specified does not return any items.
Note: Enable Errors Encountered Output property of List Navigator should be set as No to capture this output.
Exception Behavior
These options of Wonderware Skelta BPM 2009 have now been integrated with Raise Error on Unhandled Linked Output and Exception Email Template Configuration in the latest version of the product.
Each activity has the Raise Error on Unhandled Linked Output property on click of which, it shows all the default configured mapped error outputs in red with their check boxes selected.
See Mapped Error Outputs for more details.
Property Type: Optional (This property needs to be set only if necessary.)