Customization Engine Overview

The RecoveryLink customization engine is a powerful tool that allows customers to completely customize the type, format, conditionals (limited to positive conditions only), behaviors, and placement of data throughout their instance of the application. This is done through a four-part framework consisting of library fields, blocks, templates, and workflows ( coming soon).

Library fields are the individual data variables that are used to collect information, such as race, date of birth, session notes, etc. Library fields are the basic building elements of all custom elements in the application. Each field can be named for the data dictionary (not displayed in forms but used for reporting), a type selected (string, date, single select radio/drop-down, multi-select checkbox, grouped drop downs, and other types coming in the future), a label and description provided, and properties set related to requirement and conditional behavior. Customers may add as many new library fields as needed in their customization engine. When creating new fields, please note that the system will automatically assign a label name "custom_12512351212" that will be used when placing the new field within blocks later. This label is unable to be edited at this time.

Library blocks are unique sets of library fields placed in a specific order, that display together as a block of questions in any template used in the application, such as participant demographics. Blocks can be created or customized to display fields in a certain order as well as set properties such as behavior (create new OR update revise) show, required, and conditionals. Create new behavior means the block accepts new data each time it is used, while update revise means the block will be pre-filled with previously collected data the last time the bock was collected in a template. Blocks may also have unique names, labels, and descriptions. Customers are limited to the default blocks which may be customized, as well as three default blocks that are empty by default and can be used for any purposes the customer may have. In the future, the customization engine will support the creation of new blocks that are empty by default. Please note that the default blocks of demographics, contact information, and recovery characteristics also drive the information that display on the participant profile. You are not required to use these blocks, but should you elect to not use them, no related information will display on the participant profile. The display on the profile is dynamic, so any changes made to these three blocks will display on each participant profile in the staff application.

Library templates make up the data collection forms that are used throughout the application. Templates can be created for engagement sessions (e.g, brief check-ins), data collection forms (e.g., REAL-D custom form), or activity logs (e.g., harm reduction activity log). Templates can be created by placing blocks in a specific order, which controls their display within the template when used in the application. Each template must have a type selected, a name and label provided, and any descriptive help text included as necessary. The customization engine does not currently support creating new templates, but will include this feature when the workflow section is released.

The workflow section of the customization engine is coming soon and will allow customers to specify additional properties for created and customized templates such as advanced if/then properties (e.g., use this template after this event happens), template eligibility (e.g., make this template available only to these organizations, locations, or specific program IDs), and much more.

Please note that within the application, there are certain elements (fields, blocks, and templates) that are unable to be modified (i.e., system locked or system hidden) to prevent unintended breaking of the application. When attempting to modify these elements of the engine, a warning label will show and prevent the action from being taken. 

You may also see additional sections in your customization engine if you have certain microservices or add-on modules, including the GPRA and Kiosk. These features are discussed within the microservices and add-on modules section of the knowledge base.

Library Fields

Library Blocks

Library Templates