Set Up the Surveys and Questions Add-On Module

Set up the Surveys and Questions module

After installing the Surveys and Questions add-on module, you need to set it up before using it with Connected Claims. This guide walks you through the recommended setup steps, which include:

• Adding the runtimeSurvey relationship to Task record.
• Configuring the Survey site pages in Studio.
• Enabling dynamic display when creating Runtime Survey tasks on a claim.
• Enabling dynamic display when creating Reference Survey tasks.
• Enabling additional relationships when creating Survey tasks.
• Querying survey-related relationships when completing a task.
• Enabling dynamic display when completing Runtime Survey tasks on a claim.
• Enabling dynamic display when viewing Survey Task records.
• Setting additional survey relationships in the Task SetMetadata rule.

System prerequisites

Before setting up the Surveys and Questions module, ensure your environment meets the following requirements:

• Appian platform running version 25.4 or greater.
• A supported web browser.
• Imported Connected Claims Base Application version 1.2 or higher, which includes the following application containers:
  • Connected Claims Management Base (CCM)
  • CCM Studio Generated Objects
• Imported Survey Task Framework v1.2 application.

Step 1: Adding the runtimeSurvey relationship to Task record

This step establishes the data relationship between tasks and survey runtime data, enabling tasks to be associated with dynamic surveys.

To set up the Surveys and Questions module with Connected Claims you need to first update the Task record type by adding a new relationship for the Survey Runtime:

To update the record type:

1. In the target environment, log in as the deployment user.
2. Navigate to Appian Designer.
3. Navigate to Connected Claims Management Base application.
4. Search for and open the CCM_Task record type.
   1. Add a new relationship to the record type called stfRuntimeSurvey.

   2. Set up the relationship as shown:

      

Step 2: Configuring the Survey site pages in Studio

This step adds the Surveys and Questions pages to the Studio interface, allowing users to create and manage surveys and questions within the Connected Claims Studio environment.

Next, you need to add and configure the Survey site pages in Studio.

To add and configure site pages:

1. Open the CCM_WFL_Site_Studio site object.
   1. In the Pages section, add a new page called Surveys to the Tasking page group.

      1. Set up the Surveys page as shown:

         

   2. In the Pages section, add a new page called Questions to the Tasking page group.

      1. Set up the Questions page as shown:

         

Step 3: Enabling dynamic display when creating Runtime Survey tasks on a claim

This configuration enables the survey creation interface to display dynamically when users create Runtime Survey tasks, allowing them to configure survey-specific settings.

Next, you need to enable dynamic display to occur when creating Runtime Survey tasks on a claim.

To enable dynamic display:

1. Open the CCM_Task_Sub_TaskBehaviorTypeCreateDynamicDisplay interface.

   1. Add the following code to the existing a!match() in the interface:

      

      1
      2
      3
      4
      5
      6
      7
      8
      9
      /*Survey*/
            equals: cons!CCM_STF_REFID_TASK_BEHAVIOR_TYPE_SURVEY,
            then: {
              rule!CCM_STF_SurveyTaskBehaviorType_CreateDynamicDisplay(
                brandingMap: ri!brandingMap,
                targetRecord: ri!task,
                contextJsonRecordField: 'recordType!{ee5aa46d-0228-430f-a794-1134a11fbcc0-ccm}CCM_Task.fields.{664672b3-911e-425a-a1b1-99917f4c255e-ccm}contextJson'
              )
            }
      

Step 4: Enabling dynamic display when creating Reference Survey tasks

Similar to Runtime Survey tasks, this step enables the dynamic display interface for Reference Survey tasks, allowing users to configure reusable survey templates in Studio.

In this step, you will enable dynamic display when creating a Reference Survey task in Studio.

To enable dynamic display:

1. Open the CCM_ReferenceTask_Sub_TaskBehaviorTypeCreateDynamicDisplay interface.

   1. Add the following code to the existing a!match() within this interface:

      

      1
      2
      3
      4
      5
      6
      7
      8
      9
      /*Survey*/
          equals: cons!CCM_STF_REFID_TASK_BEHAVIOR_TYPE_SURVEY,
          then: {
            rule!CCM_STF_SurveyTaskBehaviorType_CreateDynamicDisplay(
              brandingMap: ri!brandingMap,
              targetRecord: ri!referenceTask,
              contextJsonRecordField: 'recordType!{3dbe5fed-28bf-4f27-aa59-eb2c940289b4-ccm}CCM_WFL_CFG_ReferenceTask.fields.{c634a732-7506-42e0-b52a-9d1a48df3999}contextJsonDefault'
            )
          }
      

Step 5: Enabling additional relationships when creating Survey tasks

This step configures the task behavior system to properly initialize and manage survey-related data when Survey tasks are created, ensuring all necessary relationships are established.

In this step, you need to update the Task Behavior expression rules to enable additional relationships when Survey tasks are created.

1. Open the CCM_Task_TaskBehaviorTypeCreateDynamicInitialValues expression rule.

   1. Add the following code to the existing a!match() in this rule:

      

2. Open the CCM_Task_TaskBehaviorTypeSetDynamicValuesNewOccurrence expression rule.

   1. Add the following code to the existing a!match() in this rule:

      

Step 6: Querying survey-related relationships when completing a task

This configuration ensures that when users complete survey tasks, the system can access and display all related survey data including questions and answers.

Next, you will update the CCM_TaskBehaviorType_returnCompleteActionDynamicQueryFields expression rule to allow users to query survey-related relationships when completing a task.

To update the expression rule:

1. Open the CCM_TaskBehaviorType_returnCompleteActionDynamicQueryFields expression rule.

   1. Add the following code to the existing a!match() in this rule:

      

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      /*STF Add ON: Survey*/
        equals: cons!CCM_STF_REFID_TASK_BEHAVIOR_TYPE_SURVEY,
        then: a!map(
          fields: {
            'recordType!{ee5aa46d-0228-430f-a794-1134a11fbcc0-ccm}CCM_Task.relationships.{c45e9bb7-71f1-430d-bd28-ee138bba8dab}stfRuntimeSurvey'
          },
          relatedRecordData: {
            a!relatedRecordData(
              relationship: 'recordType!{ee5aa46d-0228-430f-a794-1134a11fbcc0-ccm}CCM_Task.relationships.{c45e9bb7-71f1-430d-bd28-ee138bba8dab}stfRuntimeSurvey.relationships.{43d501cc-ad5a-4a92-9edf-64ddca9fcfe1}runtimeQuestions',
              limit: 100,
              sort: a!sortInfo(
                field: 'recordType!{04daddea-2f84-4d5a-ba7b-cfe048fb6199}CCM_STF_RuntimeQuestion.fields.{e3ceccf7-c375-447a-888f-68b0ef8cb283}positionOrder',
                ascending: true
              )
            ),
            a!relatedRecordData(
              relationship: 'recordType!{ee5aa46d-0228-430f-a794-1134a11fbcc0-ccm}CCM_Task.relationships.{c45e9bb7-71f1-430d-bd28-ee138bba8dab}stfRuntimeSurvey.relationships.{43d501cc-ad5a-4a92-9edf-64ddca9fcfe1}runtimeQuestions.relationships.{c52a4351-2dd6-4926-b01c-d2c95c0c58e3}runtimeAnswers',
              limit: 100
            )
          }
        )
      

Step 7: Enabling dynamic display when completing Runtime Survey tasks on a claim

This step configures the task completion interface to display survey questions and capture responses when users complete Runtime Survey tasks.

Next, you need to enable dynamic display to occur when completing Runtime Survey tasks on a claim.

To enable dynamic display:

1. Open the CCM_Task_Sub_TaskBehaviorTypeCompleteDynamicDisplay interface.

   1. Add the following code to the existing a!match() in this interface:

      

Step 8: Enabling dynamic display when viewing Survey Task records

This configuration enables users to view completed survey responses and survey details when viewing Survey Task records in the system.

In this step, you will update the CCM_Task_Sub_TaskBehaviorTypeSummaryDynamicDisplay interface to enable dynamic display to occur when viewing Survey Task records.

To enable dynamic display:

1. Open the CCM_Task_Sub_TaskBehaviorTypeSummaryDynamicDisplay interface.

   1. Add the following code to the existing a!match() in this interface:

      

Step 9: Setting additional survey relationships in the Task SetMetadata rule

The final step ensures that survey-related metadata and relationships are properly maintained when tasks are updated or modified.

Finally, in this step you will update the CCM_Task_SetMetadata expression rule to enable users to set additional survey relationships.

1. Open the expression rule CCM_Task_SetMetadata.

   1. Add the following code to the list of maps in the childRelationships input of the call to (around Line ~379):

      

Next steps

Now that you have set up the Surveys and Questions module, you can create dynamic surveys and questionnaires within Connected Claims, configure survey tasks in Studio, and collect structured data through customizable survey forms integrated with your claims workflow.

Feedback