Set Up Demo Data Module

Before you begin

After installing the Demo Data module, complete the post-deployment configuration and incorporation steps to use it with the Case Management Studio Base application. The setup includes:

• Enabling external deployments.
• Configuring the connected system.
• Updating Case Management Studio group security.
• Adding Reporting pages to the Workspace site.

Before performing these steps, verify that your system meets the required prerequisites.

System prerequisites

Your system must meet the following requirements to run the Demo Data module:

• Appian platform running version 26.9 or greater.
• A supported version of MariaDB or SQL server as a business data source.
• A supported web browser.
• Imported Case Management Studio Base application version 2.4 or higher, which includes the following application containers:
  • CMGT Case Management Studio Base (CMGT)
  • CMGT Control Panel Generated Objects (CMGT)
• CMGT Add-On - Demo Data Module (CMGT_EXT) application container imported and installed in the target environment.

Step 1: Enable external deployments

Enable deployments in the target environment to deploy the demo data to the Case Management Studio Base application.

To enable external deployments:

1. In the target environment, log in as an admin user.
2. Go to the Admin Console.
3. Click Infrastructure.
4. In the External Deployments section, check both Enable Incoming and Enable Outgoing.
5. In the Deployment Settings section, add a service account in the Authenticate As and Deploy As fields.
   • Note: If a service account does not exist, create one via the Deploy As field. The user must be a system administrator in order for it to appear in the picker.
6. Click SAVE CHANGES.

Step 2: Configure the connected system

Set up the connected system that backs the Demo Data module.

To configure the connected system:

1. Go to the Admin Console.
2. Click Web API Authentication.
3. Click CREATE.

4. In the Description field, enter Demo Module Deploy or another unique description for the API key.

   

5. In the Service Account field, search for and select the deployment service account you created in Step 1.
6. Click CREATE.
7. Click Copy API key to clipboard and save the API key in a secure location.
8. Click OK.
9. Go to Appian Designer.
10. Search for and open the CMGT Add-On - Demo Data Module application.
11. In the Build view, search for and open the CMGT EXT Connected System object.
12. In the Base URL field, update the URL to match the target environment. Use the following format: https://<ENVIRONMENT_URL>/suite/webapi/.
13. Clear the Value field and paste the API key you copied in step 7.
14. Click SAVE.

Step 3: Update the Case Management Studio group security

Add the Demo Data users to the CMGT Internal Users group.

To update the group security:

1. Go to Appian Designer.
2. Search for and open the CMGT Case Management Studio Base application.
3. In the Build view, search for and open the CMGT Internal Users group.
4. Click ADD MEMBERS.
5. In the Groups to Add field, search for and select the following groups:
   • CMGT EXT Demo Data Users
   • CMGT EXT Demo Data Administrators
6. Click ADD.

Step 4: Add Reporting pages to the Workspace site

Add the Process HQ Reporting pages to the Workspace site so that demo users can view the sample reports included with the Demo Data module.

To add Reporting pages to the Workspace site:

1. In the target environment, log in as an admin user.
2. Go to Appian Designer.
3. Open the CMGT Case Management Studio Base application.
4. Search for and open the CMGT_WorkspaceSite site object.
5. To add the Case Manager Reporting page:
   1. Under Pages, click Add Page.
   2. Configure the page with the following settings:
      • Name: Reporting
      • Icon: bar-chart
      • Type: Process HQ - Dashboard
      • Content: Reporting Overview - Case Manager Dashboard

      • Visibility:

        1
        2
        3
        4
        a!isUserMemberOfGroup(
          username: loggedInUser(),
          groups: {cons!CMGT_GRP_CASE_MANAGERS, cons!CMGT_EXT_GRP_ADMIN}
        )
        

   3. (Optional) If you need to distinguish this page from other reporting pages, rename the dashboard.
6. To add the Case Worker Reporting page:
   1. Under Pages, click Add Page.
   2. Configure the page with the following settings:
      • Name: Reporting
      • Icon: bar-chart
      • Type: Process HQ - Dashboard
      • Content: Reporting Overview - Case Worker Dashboard

      • Visibility:

        1
        2
        3
        4
        a!isUserMemberOfGroup(
          username: loggedInUser(),
          groups: cons!CMGT_GRP_CASE_WORKERS
        )
        

   3. (Optional) If you need to distinguish this page from other reporting pages, rename the dashboard.

Next steps

Now that you have set up the Demo Data module, load sample data packs into the Case Management Studio Base application to support feature and functionality demonstrations. After loading a demo data pack, sample Process HQ reports are available on the Reporting pages in Workspace.

Feedback