ControlAddIn WelcomeWizard
Methods
Initialize
Function that initializes the WelcomeWizard API
procedure Initialize(Title: Text, Subtitle: Text, Explanation: Text, Intro: Text, IntroDescription: Text, GetStarted: Text, GetStartedDescription: Text, GetHelp: Text, GetHelpDescription: Text, RoleCenters: Text, RoleCentersDescription: Text, RoleCenter: Text, LegalDescription: Text)Parameters
| Name | Type | Description |
|---|---|---|
| Title | Text |
Welcome Wizard Title |
| Subtitle | Text |
Welcome Wizard Sub Title |
| Explanation | Text |
Information description |
| Intro | Text |
Intro text |
| IntroDescription | Text |
Description for the intro video |
| GetStarted | Text |
Get started text |
| GetStartedDescription | Text |
Description for the get started video |
| GetHelp | Text |
Find Help Text |
| GetHelpDescription | Text |
Description for the find help video |
| RoleCenters | Text |
Role Centers Text |
| RoleCentersDescription | Text |
Description about the role centers |
| RoleCenter | Text |
Role center |
| LegalDescription | Text |
Description explaining demo data is for demonstration purposes |
LoadFlows
Function that loads the embedded Welcome Wizard into a container on a webpage
procedure LoadFlows(EnvironmentId: Text)Parameters
| Name | Type | Description |
|---|---|---|
| EnvironmentId | Text |
Environmnet ID |
UpdateProfileId
Function that updates the Role Center Profile ID
procedure UpdateProfileId(ChangedProfileId: Text)Parameters
| Name | Type | Description |
|---|---|---|
| ChangedProfileId | Text |
Profile ID |
LoadTemplates
Function that loads embedded WelcomeWizard templates into a container on a webpage
procedure LoadTemplates(EnvironmentId: Text, SearchTerm: Text, PageSize: Text, Destination: Text)Parameters
| Name | Type | Description |
|---|---|---|
| EnvironmentId | Text |
Environmnet ID |
| SearchTerm | Text |
Filters templates matching the search term |
| PageSize | Text |
Number of templates to be displayed in the container |
| Destination | Text |
Determines page that opens when one selects a template |