Option Source Builder
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!
For single- or multiselect questions elements, the respondent user will be presented with a list of options. These options can be created directly in the Form Builder, or you can connect an option source to this question. Using an option source has many advantages. The option source can be reused within and across forms. It's possible to populate option sources with existing spreadsheets and you only need to update the options in one place if changes are necessary. Click here to watch a solid introduction video about option sources in Compose.
The Option Source Builder has three main sections; Edit, Published, and Languages. Before entering the Option Source Builder you need to create a new option source or open an existing option source (see the https://composetogo.atlassian.net/wiki/spaces/CNGD/pages/1835220 documentation).
Edit
The Edit section consists of a Properties panel. This panel consists of a table, a Populate menu accessible from the Populate button, and a expandable menu for auto-population via a generic service.
Properties table
Properties table | |
---|---|
State | Indicates whether you’re working with a draft or a published option source. |
Validation | Choose a validation for the text representation of your options. In addition to your homemade validation, the defaults String, Integer, Decimal and Date may be used here. |
Answer Value | An option consists of an answer value and a text representation. The text is what the end user will see in the respondent UI, but the answer value is the reference point of the option in Compose. It is the answer value that will be mapped to PDF templates, generated XMLs and in generic service calls. |
Text | See Answer Value |
Pen icon | Provides a larger input field for the option text. |
Language icon | Allows you to see all translations of the option if multiple languages is enabled. |
Delete | All added options may be removed. Pressing the X-icon will delete the option. |
Auto-populate via service | The option source can be connected to a generic service. If this is checked the properties for a service populated option source will be made available. See Auto-populate via service section below. |
Add | Clicking Add will add one more option to the table. |
Clear all | Clicking Clear all will remove all options added. |
Populate | When creating an option source you have the choice to populate the list of options, instead of entering all options manually. More information about option source population in the upcoming section. |
Publish | When one or more options have been added in your draft you have the option to publish the option source. If you are editing an already published option source, the forms using the option source will be updated instantly as you publish the changes. |
Populate menu
In the Populate menu, there are two tabs; Populate From Published and Populate From External File. You enter the two tabs based on whether you’d like to populate the draft in some way with the options from the published option source or from an external file.
Populate From Published
Populate From Published | |
---|---|
Override Draft Options | Select if you wish to override the options in the draft with the options from the published option source. |
Append From Top | Select if you wish to add the options from the published options source to the top of the options table in the draft. |
Append From End | Select if you wish to add the options from the published options source at the bottom of the options table in the draft. |
Close | Closes the menu. |
Populate | Populates the option table with the population settings you’ve chosen. |
Populate From External File
Populate From External File | |
---|---|
Override Draft Options | Select if you wish to override the options in the draft with the options from the external file. |
Append From Top | Select if you wish to add the options from the external file to the top of the options table in the draft. |
Append From End | Select if you wish to add the options from the external file at the bottom of the options table in the draft. |
Format | Format setting of external file. Choose between CVS and SDV. |
Encoding | Encoding setting of external file. Choose between UTF-8 and ISO-8859-1. |
Separator | Enter the separator corresponding with the format you have chosen (; for CSV). |
File | Browse to find the external file you wish to use for option source population. |
Close | Closes the menu. |
Populate | Populates the option table with the population settings you’ve chosen. |
Auto-populate via service
Auto-populate via Service | |
---|---|
Generic Service | The name of the selected generic service will be displayed here. |
Browse | Use the Browse button to find the generic service. |
Clear | Clears the generic service connected to the option source. |
Version | Select the version of the generic service you want to use (if multiple versions). |
Update to highest minor version automatically | If checked, the option source will automatically use the highest minor version of the selected generic service. |
Map Request Variables | Map Request Variables from the generic service. |
Map Response Variables | Map Response Variables from the generic service. |
Schedule | The generic service is usually connected to an external register. In this section, you may set a schedule for the frequency of the service call, and therefore the frequency of the updating of the option source. You do not need to re-publish after automatic updates. |
|
|
Custom (cron expression) | The schedule can be set at a custom interval. If selected, enter the preferred interval as a cron expression in the input field. |
None | The option source will not be updated automatically, only manually. |
Populate | Click to run the generic service for the first time and populate the option source. Clicking Populate will cause the current list of options in your draft to be overwritten. The button is enabled when you have saved the draft you are working on. |
Publish | An option source must be published to be available for use in forms/workflows. Use the publish button to publish the changes done to the option source. When the draft is saved and published it will immediately take effect in workflows/forms where it’s connected. The button is enabled when you have saved the draft you are working on. |
Published
In the Published section, the latest published version of the option source is displayed. The section is visually nearly identical to the Edit section, with the exception of the the lack of all the settings under the table. If the option source is auto-populated via a generic service, then the population settings will show underneath the table.
Languages
The Languages section is similar to the Languages section in the Form Builder.
Make your choices. When you are happy about your changes, click Publish. Your option source should now be possible to connect across Compose builders.