Update control action
Use the Update control action to reload and refresh the results list of Work Queue, Job list and System queries.
This action is not available for touch-enabled Phone and Tablet forms, as these forms do not support the Work queue, Job list and Workload controls.
The following drill-down properties are available by default for Job list, Work queue and Workload controls.
DynamicQueryId: The unique identifier for the query.
DynamicFilterField: The field type that the filter applies to.
DynamicFilterValue: The value of the field that should be used to update the filter.
DynamicQueryName: The name of query.
DynamicQueryType: The type of query.
CurrentQueryID: The ID of current query.
CurrentQueryName: The name of current query.
CurrentQueryType: The type of current query.
For more information about these fields, see Enumerations.
You can dynamically set the query ID, query name, query type, filter field and filter value on an action, such as Same page, and then use the Update control action to display the results based on the specified changes.
You can specify the query name and query type instead of the query ID. If you do not specify the query type, the query type associated with the control is used at runtime. The Query ID takes precedence over QueryName and QueryType fields.
The current query ID, current query name and current query type properties reflect the currently set or selected query and are read-only. You cannot set these properties at design time.
When you set the dynamic query ID, dynamic query name, and dynamic query type properties using an action and then get the current query ID, current query name and current query type properties using the same action, the values returned are same.
When you clear the Allow query edit setting on the (Job list, Work Queue, or Work load) control and view the control at runtime, on selecting a different query, these properties are populated.
You can set multiple dynamic filters in a query. However, they are not applied automatically; instead these are only applied as a block when you call the UpdateControl action.
For example, to filter your query on Activity name and Priority 3, set:
DynamicFilterField = 5
DynamicFilterValue = 'ActivityName'
DynamicFilterField = 7
DynamicFilterValue = 3
And then call an Update control action.
On the form modeling bar, click
Actions and click
The New action dialog box is displayed.
- On the Type list, select Update control.
- Change the default Name (UpdateControl1) to something meaningful.
- Optional. Enter a Description for the action.
- Optional. Select Multilingual to configure a unique action for each language separately. See Configure multilingual actions.
Control list, select a control.
You can only select Job list, Work queue and Workload controls.
The newly created action is added to the form.
Associate the action with a control, such as button, to trigger this action. See
Configure actions for form control
When you trigger this action, the query result is updated based on the following criteria:
If you set the query ID on the control, the query result identified by the query ID is displayed.
If you set the query ID, filter field and filter value on the control, the query result identified by the ID, and satisfying the combination of filter field and filter value is displayed. Each time you set the filter field and filter value, on triggering the action, the same query is updated, and displayed even if the query ID is removed. The filter field value must correspond to the value set for that field in Query editor. If the filter field and filter value combination is invalid, an error occurs.
To display a different query, you must change the query ID.
If the query is not shared with the current resource, the query name does not appear in the Queries panel at runtime.