Document Title: Orbita Program Registration Solution
Solution Center: V 1.0.0
Creation Date:
Author: ORBITA
Table of Content:
The Solution: Why? What? How?
Why was it created?
Orbita Solution Center offers packaged pre-built experiences. All the solutions have been designed with the goals of improving time-to-value and decreasing implementation time. ( Learn more about Solution Center here: 4.0 Orbita Solution Center
The solution Program Registration provides conversational experiences while getting the users enrolled in the organization’s programs.
Program registration is an Out-of-the-Box installation solution that comes with all the necessary tools to create a more efficient experience enrolling in a support/follow-up program in a personalized and adaptive conversational manner.
What is its purpose?
The purpose is to collect user information to understand users and better engage with them by sending notifications, reminders, etc.
On the business side, you will have access to pre-built dashboards that help track program performance, enhance the experience, monitor population, and make data-driven decisions.
How does it work?
It starts with the user receiving a link (e.g via email) from support@orbitahealth.com to access the virtual assistant which will then help the user to register to the program s/he got asked to enroll in.
Solution Installation
How do you install it?
The solution comes with all prebuilt and customizable conversation flows, dashboards, and interaction models.
Login to Experience Manager
Navigate to your project > Project side navigation menu > Create > Solution Center> Solutions.
Click the Add button against the Program Registration solution to install it to your project.
You will see the below pop-up message after the solution is installed successfully.
You can click on the Remove button to uninstall the Program Registration Solution from your project.
Post Installation
After installing the Program Registration solution, you have to add an Event name (progregwelcome) to the intent named ProgramRegistrationWelcomeIntent.
This ProgramRegistrationWelcomeIntent intent is a part of the Program Registration solution. This intent will be deleted if you uninstall the Program Registration solution.
Updating the solution will reset the Intents that are created as a part of this solution to its default state. You have to add the event name to the intent after update.
Go to Project side navigation bar > Intent Library and locate the intent named “ProgramRegistrationWelcomeIntent“.
Click on the vertical ellipses icon and select Edit.
Add the progregwelcome to the events field and press Enter.
Save the intent.
Navigate to Project side navigation menu > Develop > Deployment > Google tab. Publish the interaction model to Google.
Configure Settings
Program Registration solution has configuration options, such as mail subject, disclaimer, email body content, etc.
After installing the Program Registration solution, click on the Configure Button.
This will open a window as shown below.
You can configure the email subject, disclaimer, body, and so on here.
The sample code is given below:
{ "emailDisclaimer": "<p data-renderer-start-pos=\"75\">The information you provide will only be used by [<em data-renderer-mark=\"true\">Brand</em>], our affiliates, and our service providers, to contact you via phone and email about the [<em data-renderer-mark=\"true\">Brand</em>] Select program and to fulfill your optional requests as indicated below. You may request to be removed from our contact list by using the unsubscribe link in any email we send or by calling 1-888-CELATYNE (1-888-927-XXXX).</p>\n\n<p data-renderer-start-pos=\"455\">Our Privacy Policy [<em data-renderer-mark=\"true\">Link to: privacy policy</em>] further governs the use of the information you provide.</p>\n\n<p data-renderer-start-pos=\"558\">By submitting your information, you agree that you have read, understand, and agree to these terms.</p>\n", "emailBody": "<p>Hi,</p>\n\n<p>We invite you to check out our bot and get registered by clicking the below link:</p>\n\n<p><a href=\"__BOT_URL__\">Program Registration</a>.</p>\n\n<p>Thanks.</p>\n", "emailSubject": "Invite for Program Registration", "ackEmailSubject": "Thank you for registering!", "ackEmailBody": "<p>Hi {{msg.payload.firstname}} {{msg.payload.lastname}},</p>\n\n<p> Thank you for registering to the program.<em data-renderer-mark=\"true\"> </em></p>\n\n<p>Thank you.</p>\n", "botUrl": "/oeapi/bot/program-registration", "oeEventName": "progregwelcome", "debug": false }
Change the config settings as required and click Save.
Property | Description |
---|---|
| You can configure the Disclaimer of the campaign email here. |
| You can configure the body of the campaign email here. |
| You can configure the subject of the campaign email here. |
| The subject of the email that is sent after a user registered to the Program |
| The body of the email that is sent after a user registered to the Program |
| This is the bot endpoint that you have configured for the project. |
| This is the Event name progregwelcome you configured earlier. |
Email sent using Campaign API
Email sent by Orbita after registering to the program successfully.
Bot View Template
Navigate to the Experience Designer > Bot Manager flow > Bot View Template node
Custom JS
Place the below code in the Custom JS tab.
// DOM: Create the script element var jsElm = document.createElement("script"); // set the type attribute jsElm.type = "application/javascript"; // make the script element load file jsElm.src = "/oeapi/pr.js"; // finally insert the element to the body element in order to load the script document.body.appendChild(jsElm);
By default, the custom JS tab doesn't contain any code.
Header
Place the below code in the Header tab.
<link href="/oeapi/pr.css" rel="stylesheet">
By default, the header tab will have the first three lines of code. Place the above code at the end (in this example, 4th line).
Campaign API
Follow this document to send campaign emails for program registration. Campaign API
Dashboards
After the solution installation, you can access the pre-built dashboards from the Project side navigation menu > Report > Dashboards.
What dashboards & visualizations are available and what purpose do they serve?
For Program registration, there are 3 different dashboards available.
Program Registration Dashboard contains PHI (Personal Health Information) and includes the following metrics visual:
Email link clicked #
Email conversation Rate %
Total Users Registered
Registration Conversion Rate
Age Bar graph
Registration overtime
Location Map
Pie Charts - Notification Preferences
Individual DataTable
Detailed User Responses contains PHI (Personal Health Information) and includes the following table:
Individual DataTable
Program Registration Dashboard does not contain PHI (Personal Health Information) and includes the following metrics visual:
Email link clicked #
Email conversation Rate %
Total Users Registered
Registration Conversion Rate
Location Map
Age Bar graph
Registration overtime
Pie Charts:
Notification Preferences
Sample screenshot of the dashboard.
Customizing the dashboard
You can create your own visualizations for the program registration in Insights. Refer, Guide to Orbita Insights
Program Registration solution data is captured in the data-<environment>-backend.userinfo
index pattern.
Solution Customization
How can I update content and phrases?
To change the bot responses, you can navigate to the flow studio flows and make changes to the content present in the flow studio controls.
For example, if you want to change the welcome message,
Navigate to the Project side navigation menu > Create > Agents > Flow studio.
Select the Flow Studio named “Welcome”.
Locate the Say control named “Welcome Message”.
Change the contents of the welcome message here.
To introduce variation in the content, we can use phrases. Refer, How do I create phrases for the voice assistant?
It is not recommended to delete the flow studios or its controls that are installed with the Program Registration Solution.
Even modifying the name of the controls might break the flow as everything within the solution is interconnected. Contact support@orbta.ai for support.
How to update the branding of the chatbot?
You can customize the chatbot appearance using CSS and JS. For more information on customizing the appearances of your chatbot, refer https://orbita.atlassian.net/wiki/spaces/OCS/pages/1633681419/3.9.1+Creating+Your+Chatbot#Customizing-your-chatbot
Integrations
This solution does not come with out-of-the-box 3rd party integrations but all the 3rd party integrations supported by the platform can be used with the Program Registration Solution.
For example, you can integrate the Program Registration Solution with google maps to get the latitude and longitude of the zip-code shared by the user during the registration process.
Video Link
https://cdn.orbita.cloud/assets/orbita/solutions/programregistration.mp4
Related Articles
How do I customize an email template?
How do I log and report content data in Orbita Insights?