Considerations for Working with Discovery Framework and Assessments
Understand considerations related to working with assessment questions and Discovery Framework Omniscripts.
Required Editions
| View supported product editions. |
Considerations for Working with Questions
- You can’t change an active version of a question. To make changes, create another version of that question.
- When you clone a question, the new question is in Draft state by default. Mark the question as Active to make it the active version.
- You can’t archive questions that are in Draft state.
- You can't use certain reserved keywords as the Developer Name or API Name for assessment questions. These keywords are generated by default during the execution of the Omniscripts of type Discovery Framework. Some examples of the reserved keywords include omniscriptId, language, AssessmentSignature, DigitalSignature, SignedElements, and DocumentMatrix.
- When an assessment question is of the data type Radio, Radio Group, Select, or Multiselect, the Response Values field is required. Enter response values with each value on a new line.
- Only one version of the question is active at a time.
- When you mark an active assessment question version as inactive, the status of the assessment question version changes from Active to Archived.
- Always update your Omniscript when a question used in the Omniscript is updated to a new active version. Updating the Omniscript makes sure that all responses are saved to the correct version of the question.
- The label and option values for Select, Multiselect, Radio, and Radio Group question types are derived from the Response Values field of the assessment question record.
- Discovery Framework doesn't support translations in runtime.
- Discovery Framework Prefill doesn't work with Files and Formula type questions.
- Dynamic Assessments in Public Sector Solutions support only a subset of Discovery Framework question data types. See Create Dynamic Assessment Questions.
- Discovery Framework doesn't support nested repeat blocks.
- The enhanced experience doesn't support selecting a record type when creating questions.
Considerations for Working with Omniscript Designer
- For Omniscripts of type Discovery Framework, you can’t format the Text block in Rich Text Editor. To format or make style changes, use HTML tags in the question text of the assessment question.
- The Signature, QR code, and Document Matrix components are compatible only with Omniscripts of type Discovery Framework.
- While designing a form, if some questions in the Omniscript are no longer in the active version, click Edit Form and then click OK. This operation refreshes the Omniscript with the latest active question versions.
- storeResponses remote action is only supported for Discovery Framework type Omniscripts.
- Review these requirements and behavioral changes before you enable the enhanced save
response experience.
- After enabling the enhanced save responses, assessment question responses are mapped to the questions used when creating the Omniscripts. However, this may not apply to existing Omniscripts that contain radio group children.
- The one-to-one mapping between junction records and OmniProcess elements is updated. Multiple junction records now point to a single OmniProcess element, specifically for radio group children. Validate your logic and adapt it to handle these multiple junctions.
- To ensure that responses map correctly, export only updated Omniscripts.
- Existing Omniscripts with radio groups save child question responses to the latest active question version, even when Enhanced Save Responses is turned on. This behavior occurs because the Omniscripts lack junction records for radio child elements. To use Enhanced Save Responses with existing Discovery Framework Omniscripts, edit the Omniscript assessment form and save your changes. Discovery Framework automatically retrieves the latest question information and updates the Omniscript.
- To pass values to an assessment record, configure the Remote Options for the default Save
Response step in your Omniscript.
- In Remote Options, the Remote Class and Remote Method fields are populated by default. You can override the default class names.
- To pass Key values in the Remote Options field, use this syntax: Assessment.<fieldname>.
- Only the DateTime, Date, Phone, Email, Checkbox, Integer, Double, Currency, Percent, Text, DynamicEnum, Text Area, Long Text Area, and EntityId (lookup) data types are supported as Remote Option values.
- Geolocation, Multi-Select, Text Area (Rich), Text (Encrypted), Time, and URL values in Remote Options data types aren’t supported.
- The field names must match the developer names of the Assessment object fields. For example, Assessment.Name.
- Provide valid entity ID values to avoid database errors.
- The storeResponses remote action used to store Assessment responses only
- Provide date values in the ISO format. For example, 2022-05-25T06:30:00.000Z. For more robust functionality, you can also define Set Value actions with date functions and pass the element value as Key values. See Omniscripts Date Element.
- Save Assessment as Draft isn't supported for Experience Cloud users.
Did this article solve your issue?
Let us know so we can improve!
