Create Custom Data

In this article, we'll walk through:

• How to define Custom Data schema
• What are the different data types supported?

After reading this documentation, you will:

• Understand how to define Custom Data types for your program
• Different kinds of Data Types you can use.
• How to customize how Custom Data will appear in the Coach Portal as Sidebar Sections and Timeline events.

To create a new Custom Data in Workshop, follow the steps below.

1. Ensure you’ve checked out your configuration so you can make changes to your Program. The status of your configuration should be “Build”
2. In the Workshop Menu on the left, select Custom Data from the Build section. You will then be taken to the Custom Data screen which lists all the Custom Data created for this Configuration.
3. Click Create Custom Data
4. On the New Custom Data page, enter the information in the fields necessary for defining a new Custom Data type.

Label *:  The New Custom Data Type Label should be unique, and briefly describe the purpose of the nature of the data set. (e.g. “Risk Stratification”)

ID *: This is auto-generated - you may change it when initially creating the new Custom Data. The ID uniquely identifies data types for processing. IDs must be alpha-numeric,  lowercase, and can’t include spaces (e.g. “risk_stratification”).

Data Fields: A Custom Data Type can have multiple Data Fields. The following fields necessary to create a Data Field are:

Data Field Label *: The Data Field label should provide guidance to the coach on how to interpret the Custom Data. Choose a concise, easy-to-read Name so the Coach can quickly determine what the data is. (e.g. “Risk Score”)

Data Field ID *: This is auto-generated - you may change it when initially creating the new Custom Data. The ID uniquely identifies data types for processing. IDs must be alpha-numeric,  lowercase, and can’t include spaces. (e.g. "risk_score")

Type *: The Type defines the allowed values for the custom data. Setting the type helps to ensures that data will be correctly entered in the expected format. The following are supported

- Text

- Integer (e.g., 1, 2, 3)

- Fraction (e.g., 4.72, 2/3)

- Boolean (e.g., “true” or “false”)

- Dropdown List (e.g., Monday, Tuesday, etc.)

- Date (e.g., 01/01/2019 01:00 PM)

Required: You can define whether this value must be set. If the value is set (checked) to be Required, then in the coach portal, when a coach attempts to change the value, it must be set (cannot be empty) and when updating via the API, a valid value must be set. If the value is not set (not required), then the field can be omitted or null - both in the coach portal and also when making an update via the API. Note: In this case, if omitted on an update then the existing value will be removed from that field

Click Add Field, and repeat for multiple Data Fields, if needed.

Setting how your Custom data will be displayed

Displays allow Custom Data Types to appear in the Coach Portal, as Sidebar Sections and Timeline events.

Create a Sidebar section: is the list of options you can include in your Prompt.

Display Format *: is the dropdown of options you can show custom data in the Sidebar section. They are:

• Single entry (updates cannot appear in Timeline)
• Table of entries
• List of entries

Tip: Once you’ve created this Custom Data Type, it will appear as an option on the Sidebar Layout Builder, for the Custom Data Type to appear in the Sidebar you must move this Custom Data Type to the “Enabled” section for it to appear.

Create a Timeline event: is the Name and Body that custom data will appear in the Timeline event. The variables allowed are the Data Field IDs created for this Custom Data Type.

Name *: The Name should be concise, easy-to-read Name so the Coach can quickly determine what the Timeline event is. (e.g. “Risk score: {{risk_score}})

Body: The Body is an optional field that you can use to further explain the Custom Data Type when the Timeline event is expanded. The body includes formatting options. (e.g. “Latest risk score was updated to {{risk_score}})

Click on Create custom data to save your New Custom Data.