Generic Service (workflow activity)
Compose Enterprise is going through a design update. The illustrations on this page might be of the old design, but the information is up to date. Thank you for your patience during this update!
You will find the Generic Service activity under Data Delivery in the workflow builder Activities Panel. Select the Generic Service activity by drag and drop. Click on the new activity in the canvas. The generic service activity Properties will now appear in a panel on the right. If you need more information on how to build a generic service, please see the user guide Integrations (Generic Service).
Properties – Generic Service | |
|---|---|
Name | For the convenience of the workflow designer. The name is only used while building the workflow and is not shown in respondent view. If you give all the workflow activities easily identifiable names it will be easier to find the correct activity when documents and question answers are used across the workflow. |
Generic Service | Under Generic Service click Browse and pick the generic service you want to connect. The name of the selected generic service will be visible here. If you wish to remove the generic service you have added, press Clear. |
Version | Choose the version of the generic service that is to be used. All available generic service versions can be selected, but note that changes done between the different generic service versions may effect other parts of your workflow. |
Use highest minor version | When checked, the generic services' highest minor version will be used in the workflow. I.e. if you create a new minor version of the selected generic service and the check box is checked, this generic service version is automatically used when a respondent opens a new workflow session. (Minor = 2.1->2.2, major = 2.1->3.0) (Only available if a generic service has been selected.) |
Block progress if call fails | When checked, the process will be stopped if the call fails. |
Map Request Variables | When a generic service version is selected the Map Request Variables button is enabled. Clicking it opens the Variables menu in the table below. |
Variables
Variables – Map Request Variables | |
|---|---|
Variable | Displays all service Request Variables. To map the request variable to preferred value, select the variable in the list. |
Value | The chosen source value will be displayed here. |
Optional | If checked, it indicates that the variable is optional and in that case it does not have to be set. Whether the variable is optional or not is not defined here and needs to be changed in the generic service builder. This is simply a view of the settings, and you are only able to select the variable value here. |
Variable | Name of the variable given in the Generic Service Builder. |
Type | The variable type set in the Generic Service Builder. |
Static Value | A request variable can be pre-populated with a static value. Enter the static value in the input field. |
Value From Workflow | A request variable can be populated with a value from the workflow. To select from where in the workflow the value should be retrieved press Browse and expand (>) the workflow activity to select the value. When the value is selected the name of the value will be displayed in the list of selected questions. Press Clear to remove the connection between the selected value and the selected question. |