Skip to Content

Wiki source code of 07. Work Queues

Last modified by Chris Weston on 06/11/2025, 14:24
Hide last authors
Chris Weston 1.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 Use the Work Queue editor to create custom workflows that facilitate the automation of outcomes driven by submissions.
6
7 To view all available Work Queues, click **Open** under the **Work Queues** header.
8
9 To modify an existing Work Queue, click the **Open** button for the desired item to open the editor. Use the **Edit** button to modify the **Name** and add a **Description**.
10
11 Click **Import work Queue** at the top of the page to view the import options, where the relevant file can be selected and imported into the system.
12
13 = Creating a Work Queue =
14
15 Click the **Create Work Queue** button on the first tile to begin the creation process.
16
17 Enter a name in the **Name** textbox and use the **Description** textbox to enter additional information, if required.
18
19 Use the **Type** radio buttons to select between **Automated** and **User**. Automated Work Queues are triggered by submissions and will automatically run when conditions are met, while User Work Queues initiate on-demand through manual activation.
20
21 == Work Queue Editor ==
22
23 The Work Queue Editor screen features a drag-and-drop interface to allow users free placement of components on a grid. To add a component, drag the desired option from the floating component toolbox to the desired position on-screen.
24
25 Single click a component to expose a brief overview in the **Summary Pane**, where each configured option is displayed alongside a **Valid** or **Invalid** flag. To edit an added component, either click the **Edit** icon from the summary pane or double click the component on the grid. To remove an added component, click the **Delete** icon from the summary pane.
26
27 To link components in the required order, click and drag the **Connection** dot from one component to another. When adding a **Condition**, an arrow can be generated for each specified outcome.
28
29 At the bottom of the screen, the **Current Status** will indicate either a **Valid** or **Invalid** status. An **Invalid** Work Queue will indicate incorrectly configured components by highlighting them in red.
30
31 === Actions ===
32
33 Actions dictate an outcome via configurable options for each component.
34
35 ==== Condition ====
36
37 Use the **Condition** component to create bespoke conditions based on calculation functions, custom values, conditional statements and fields within a form.
38
39 For more information regarding the available calculation functions, please refer to the [[Calculation Functions Index>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.2ci\. Calculation Builder.WebHome||anchor="Functions"]] section of the [[Calculation Builder>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.2ci\. Calculation Builder.WebHome]] chapter.
40
41 To create conditions, specify the output in single quotes (**' '**). For example:
42
43 CASE
44 WHEN '9_Would_you_recommend_this_course_to_colleagues?' = 'No' THEN 'No'
45 WHEN '9_Would_you_recommend_this_course_to_colleagues?' = 'Yes' THEN 'Yes'
46 END
47
48 The above example creates two conditions, **No** and **Yes**, represented as two separately labelled arrows in the edit screen. Each condition can then be assigned an outcome by connecting the components.
49
50 Use the **Fields** options to select between fields present in an added form. The available fields are organised into their relevant steps.
51
52 ==== Modify Submission ====
53
54 Use the **Modify Submission** component to append and replace submission values for fields through calculation functions, custom values, conditional statements and fields within a form.
55
56 For more information regarding the available calculation functions, please refer to the [[Calculation Functions Index>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.2ci\. Calculation Builder.WebHome||anchor="Functions"]] section of the [[Calculation Builder>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.2ci\. Calculation Builder.WebHome]] chapter.
57
58 Use the **Replace** radio buttons to select either **Append**, where a submission is supplemented with the calculation output, or **Replace**, where a submission is replaced with the calculation output.
59
60 ==== Database ====
61
62 This component facilitates the export of the form data to a database.
63
64 Select a previously configured Database Connection from the **Database Connection** drop-down list, then specify the target **Table**.
65
66 For more information regarding the setup of [[Database Connections>>doc:Technical Documentation.CXAIR.Administration Guide.6\. Advanced Configuration.Database Connections.WebHome]], please refer to the [[Database Connections>>doc:Technical Documentation.CXAIR.Administration Guide.6\. Advanced Configuration.Database Connections.WebHome]] chapter.
67
68 ==== Message ====
69
70 Configure an email that will be sent to users or groups.
71
72 Enter the required message in the **Message **textbox and specify the recipients using the **Users **& **Groups **fields. These fields will automatically suggest results once two or more characters are typed in.
73
74 ==== Validate Against Index Field ====
75
76 This component allows you to compare a value submitted within a field on the form against an entire column of values within an index.
77
78 Select the field from the appropriate step in the form and then the Index Field from a previously configured Index using the drop-down lists.
79
80 This comparison results in two conditions, **Valid** and **Invalid**, represented as two separately labelled arrows in the edit screen. Each condition can then be assigned an outcome by connecting the components.
81
82 ==== Create PDF ====
83
84 Configure an PDF document that can be saved to a folder directory and emailed to users or groups.
85
86 Enter the required message in the **Email Body** textbox and specify the recipients using the **Users **& **Groups **fields. These fields will automatically suggest results once two or more characters are typed in.
87
88 ==== Label ====
89
90 This component allows you to set a label against the submission record, this can be viewed in the index and can also be used to restore the data to this point. Bespoke conditions can be configured to specify the label set using calculation functions, custom values, conditional statements and fields within a form.
91
92 === End Points ===
93
94 Specify the desired result of the Work Queue to signify when the chain of components will reach its conclusion.
95
96 ==== Index ====
97
98 Stores the form in its Index. This is the default action and no further processing is done.
99
100 ==== Work Queue ====
101
102 Add this component to send the form to another Work Queue, facilitating multiple stages of processing.
103
104 Select the desired value from the **Work Queue** drop-down list to specify the target Work Queue.
105
106 ==== Form ====
107
108 After this branch of the Work Queue is complete, specify the form that will be loaded.
109
110 Use the **Project** and **Form** drop-down lists to specify the required form.
111
112 ==== Report ====
113
114 After this branch of the Work Queue is complete, specify the report that will be loaded.
115
116 Click **Select Report** to present the Load screen, where a previously saved report can be selected.
117
118 ==== Pop Up ====
119
120 Displays a pop up message and/or image based on the condition set in the workflow.
121 Select **Do not submit form** if the condition met requires data to not be submitted to the forms index.
122 //Example; we have a valid condition which produces Pop Up A and an invalid condition which produces Pop Up B. We do not want data to be added to the form index in the case of Pop Up B criteria being met, therefore, we select the **Do not submit form **option on Pop Up B only.//