Each new Self Help project automatically contains a list of predefined variables and macros.

Writers can also create their own project variables and macros based on the requirements for their Self Help project.

Variables and macros are stored in the Self Help project library. They are available to the entire Self Help project, for any step in any procedure.
 

Specific characteristics of variables and macros

• A variable can store several types of data, i.e. Boolean, text, etc.
  • Predefined variables are used to retrieve information on the current step, the current procedure or the logged-in user.
  • A project variable can be defined as a constant and assigned a fixed value. If this is the case, the variable cannot vary depending on the context.
• A macro is a JavaScript expression.
  • Predefined macros are used to modify dates, numbers and tables.
  • A project macro can be defined as a script or as a condition.
     

Using variables and macros
You can use variables and macros to:

• Display data during a procedure.
• Run calculations and display the results in a procedure step.
• Define the conditions for a branch in a procedure step.
• Define the visibility condition for content in a procedure step.
• Configure a connector.
• Define input and output parameters.

Examples

• Retrieve and display the email address of the user running the current step ==> Use the executionContext.user.email predefined variable

• Run calculations or format content ==> Use a predefined macro

• Display the label of an action button based on the language of the logged-in user ==> Use a project macro

Notes

• All variables and macros, both predefined and project, are stored in the Library folder of each Self Help project. As such, they are available to the entire project, for any step in any procedure.
     

• Predefined variables and macros are provided by EasyVista. You cannot delete or modify an existing one.

• Project variables and macros can be created as follows:
  • Automatically, after importing or copying any content (e.g. procedure, resource, etc.) associated with one or more variables and/or macros into the Self Help project.
  • Manually, by writers with write access to the Self Help project.

• Project variables can also be created automatically when designing a form. One project variable will automatically be created for each field in the form.
• Project macros can also be created in the Macro tab of the Description pane in a procedure step. In this case, the macro will run before the step is displayed and will only be applicable to the current procedure.

• The Standard project template contains all predefined variables and macros.

Best Practice

• Create a variable in the project library for items of information that may appear in several procedures of the Self Help project. This way, if you need to update any item of information, you can simply modify the variable in a single place. Your modification will automatically be propagated to all procedures where it is used.

Variables

Different types of variables

List of predefined variables

Screen description: Project Variable

Name: Name of the project variable.

• The name must be unique for the Self Help project.

Data type: Type of data in the project variable, e.g. text, number, date, etc.

Constant: Used to specify if the project variable is a fixed value (box is checked) or not (box is not checked).

• If you create a constant, you must specify its default value.

Default value: Default value defined for a project variable.

• There must be a default value if the Constant box is checked.
• Value Format: Used to specify if the default value is a simple value or an expression.

Description: Description of the project variable.

Procedures

How to create a project variable

Step 1: Display the Self Help project library

1. Select the Self Help project in the tree structure of the Explorer pane.

2. Double-click the Library folder.

The library will display predefined variables and macros as well as project variables and macros.
 

Step 2: Create the project variable in the library

1. Right-click Project Variables and select New > Variable from the contextual menu.

2. Define the new variable.  See the description

• Check the Constant box if the project variable is a fixed value.

• Select the Simple option or the Expression option depending on the format of the default value. Specify the default value.

• If you create a constant, you must specify its default value.

3. Click Finish.

The new project variable will appear in the Self Help project library and will be available to all procedure steps.

      See:

• How to display a variable in a step
• Use case

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 variable in the content of the step

1. Expand Library > Predefined Variables by clicking .

2. 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.
   

Use cases

Use a variable to vary the content of a procedure

This use case allows you to indicate to a user which branches s/he has already been through by displaying an icon on the right of these branches.

Use a variable in a branch condition

This use case explains how to check whether users belong to the company when they submit a request to change their password. It uses a condition with the predefined variable called executionContext.user.email that will check if the user email address contains the value @company.com. Next, based on the results of the condition, it will direct users to the appropriate branch of the procedure.

Step 1: Create the procedure

1. Create a new procedure in your Self Help project.

      See How to create a Self Help procedure

2. Name the procedure I want to change my password.
 

Step 2: Add an Action with Switch step

1. Insert an Action with Switch step in your procedure.

2. Name the step Email test.

Step 3: Define the condition for checking the user email address

1. Double-click the <Condition> field in the top branch.

The window for defining the condition will appear.
        

2. Define the condition for checking that the user email address contains @company.com@.

• Click  next to the first field in the condition.
  The list of project variables available in the Self Help project will appear.
          

• Select the predefined value called executionContext.user.email to retrieve the user email address.

• Specify the other fields in the condition.
  • Operator = contains 
  • Search value = @company.com

3. Click Finish.

The condition will be refreshed.
        
 

Step 4: Define the procedure steps

1. Go to the Condition branch (top branch) and create the steps that will guide users in changing their password.

2. Go to the Default branch (bottom branch) that will become active when the condition is not satisfied, i.e. the user email address does not contain @company.com. Create a step asking users to contact their IT Department.

Macros

Different types of macros

List of predefined macros

Screen description: Project Macro

Name: Name of the project macro.

• The name must be unique for the Self Help project.

Result type: Type of result expected from the project macro, e.g. text, number, date, etc.

Parameters: List of input parameters for the project macro.

• Click + Add a parameter to specify each parameter of the project macro.

Description: Description of the project macro.

Type of macro: Used to specify if the macro is a classic or conditional macro. If it is classic, you must define a script in the Macro body field. If it is conditional, you must define the condition in the three following fields, IF, THEN, and ELSE.

Procedures

How to create a project macro

Step 1: Display the Self Help project library

1. Select the Self Help project in the tree structure of the Explorer pane.

2. Double-click the Library folder.

The library will display predefined variables and macros as well as project variables and macros.
 

Step 2: Create the project macro in the library

1. Right-click Project Macros and select New > Macro from the contextual menu.

2. Define the new macro.  See the description

• Select the Classic or Conditional option depending on the type of macro. Next, define the script or the condition in the fields displayed.

3. Click Finish.

The new project macro will appear in the Self Help project library and will be available to all procedure steps.   See How to display a variable in a step

See detailed step by step on Self Help portal