- Welcome to the EasyVista Wiki
- Self Help and Service Bots Documentation
- Self Help - Overview
- Self Help Projects
- The predefined variables of a Self Help project
The predefined variables of a Self Help project
Each new Self Help project automatically contains a list of generic variables.
- These variables are used to retrieve information on the current step or procedure and the logged-in user.
- They can be used:
- To display data during the procedure.
- In input and output parameters.
Example
Retrieve and display the email address of the user running the current step ==> Use the executionContext.user.email predefined variable.
Notes
- Predefined variables are provided by EasyVista. You cannot delete or modify an existing one.
- They are available in the Library folder of each Self Help project.
- You should not confuse predefined variables that are native to all Self Help projects with project variables. Project variables may be manually created by each customer, based on customer requirements for their Self Help project, or they may be shipped with the Standard project template.
List of variables
| Variable | Type of data | Content | |
|---|---|---|---|
|
currentNode: Information on the current step |
|||
| currentNode.automatic | Boolean | Type of step
|
|
| currentNode.id | Text | Step ID | |
| currentNode.name | Text | Step name | |
| currentNode.resourcesTab | Table | List of resources linked to the step, i.e. table with the ID, name and URL of each resource | |
| currentNode.textId | Text | ID of the Text resource that stores the content of the step | |
| currentNode.type | Text | Type of step, e.g. Action, Page with Choices, etc. | |
|
executionContext: Information on the current procedure |
|||
| executionContext.channel | Text | Execution channel of the procedure
|
|
| executionContext.contextId | Text | ID of the procedure | |
| executionContext.country | Fixed length string | Code of the country associated with the procedure instance language, e.g. FR, GB, etc. | |
| executionContext.currentNodeTimeOnEnter | Integer | Execution time of the current step | |
| executionContext.expertSessionId | Text | ID of the expert session when writers generate a direct link in the Desktop Studio and click Launch the procedure | |
| executionContext.instanceId | Text | ID of the procedure | |
| executionContext.isDebug | Text | Mode for running the procedure
|
|
| executionContext.isMobile | Boolean | Procedure run in a skin for mobile display
|
|
| executionContext.lang | Fixed length string | Language in which the procedure is run, e.g. EN, FR | |
| executionContext.lastNodeDuration | Integer | Consultation time of the last step (= end time of the procedure instance) | |
| executionContext.log | Text | Contents of the execution report
Note: The report is created progressively at the same time as the user journey in the procedure. You can configure it step by step. |
|
| executionContext.referrer | Text | URL for running the procedure, e.g. from a website or portal, etc. | |
| executionContext.sessionLess | Boolean | Access to the procedure by logging in or by generating a direct link | |
| executionContext.startScenarioTime | Integer | Start time of the procedure instance | |
| executionContext.userAgent | Text | Information on the Web browser used by the procedure | |
| executionContext.userSessionId | Text | ID of the user session for connections via the portal | |
| executionContext.versionId | Text | ID of the current procedure version | |
|
executionContext.user: Information on the user running the current procedure |
|||
| executionContext.user.email | Text | Email address of the user | |
| executionContext.user.firstName | Text | First name of the user | |
| executionContext.user.groups | Plain text table | List of groups where the user belongs | |
| executionContext.user.id | Text | ID of the user | |
| executionContext.user.lastName | Text | Last name of the user | |
| executionContext.user.login | Text | User login entered during authentication | |
| executionContext.user.title | Text | Title of the ID, e.g. Mr. or Ms | |
|
Other variables |
|||
| custom | Text | Generic global variable
Note:
|
|
| stopMessage | Text | Variable which contents is displayed in the statistics Message column available in the Desktop Studio in publish mode
Note: Variable empty by default. |
|
See the Report tab in the Procedure: How to display a variable in a step
Step 1: Display the step of the procedure.
1. Select the Self Help project in the tree structure of the Explorer pane.
2. Double-click the procedure.
The procedure will appear in the Conception pane.
3. Click the step displayed in the flow chart.
The content of the step will appear in the Description pane.
Step 2: Insert the generic variable in the content of the step.
2. Click 
to expand the tree structure for Library > Predefined Variables.
3. Click and drag the variable from the Explorer pane to the content of the step in the Description pane.
The inserted variable will appear with a gray outline.
Step 3: Check that the variable is correctly displayed when the procedure is run.
1. Click 
in the toolbar and select 
Launch the procedure.
The step will appear in your Web browser.
2. Check that the variable has been replaced with the correct content.
