Welcome > Form Designer module > Add actions to a form or control > Add actions > Add an Update Control action

Add an Update Control action

Use the Update Control action to reload and refresh the results list of Work Queue, JobList and System queries.

This action is not available for touch-enabled Phone and Tablet forms, as these forms do not support the Work Queue, JobList and Workload controls.

The following drill-down properties are available by default for JobList, 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 on these fields, see Enumerations.

Note the following:

  • 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.

    Note The QueryId takes precedence over QueryName and QueryType fields.

  • The current query ID, current query name and current query type properties reflect the currently set/selected query and are read-only. You cannot set these properties at the design time.

  • The following happen at runtime:

    • When you view the JobList, Work Queue and Workload controls and access these properties from an action, the correct values are returned.

    • 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 create a new query, the current query type will be set but the current ID and current query name are not available until the query is saved.

    • When you set the Allow Query Edit setting as No on the control and view the control at runtime, on selecting a different query, these properties are populated.

  1. On the Form Modeling bar, click Actions.
  2. On the Actions page, click Add Generic Add.
  3. On the Type list, select Update Control.
  4. Enter a Name and Description for the action.
  5. Optionally, configure a unique action for each language separately. See Configure multilingual actions for a form or control for more information.
  6. In the Field box, consume a control.
    Note You can only consume JobList, Work queue and Workload controls.
  7. Click OK.

    The newly created action is added to the table.

  8. Associate the action with a control, such as button, to trigger this action. See Associate an action with a form or control for more information.
    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.