How to use parameters to customise your message
User specific information that has been entered into the user’s profile (in Create An Employee or Manage Employees) and information that has been entered by the user (in a Forms element) can be included throughout the platform by including the related parameter in the symbols { }. These parameters can be used to customise your message in various modules, including notifications, document templates and general content screens.
For more information on the user profile, please refer to the Create An Employee guide and the Manage Employees guide. For more information on configuring the parameter for a Field in Forms, please refer to the Forms guide.
There are four types of parameters:
1. System Parameters – these are parameters that are automatically generated by the system, including First Name (fname), Email Address (email) and mobile number (mobile). You can also reference platform specific system fields such as your platform’s URL.
2. Custom Parameters – these are parameters that have been configured in your specific instance to be included on the user’s profile, for example Manager’s Name or Address. For more information about custom fields, please refer to the Custom Fields guide.
3. Verification Parameters – these parameters are referring to the Verification Questions that are configured for your specific platform. For more information about Verification Questions, please refer to the Verification Questions guide.
4. Forms Field Parameters - these are the parameters that were configured for a Field in a form that will display the user's answer after they complete the Forms element (for example, a user's address). For more information about Fields, please refer to the Forms guide.
All modules where parameters can be utilised will have a “?” icon at the right-hand side of the screen. Clicking this icon will open a popup window that will give you a list of all parameters that are available to you in your specific Simon instance.
Example
In the below example, custom fields of Start Date, Position and Salary have been configured for the platform. The parameters configured for each of these are start-date, position, and salary.
The user that is being referenced is Kath Day-Knight. Kath is starting with the organisation on the 28th of June 2020 as a Senior Hat Maker and will be paid a salary of $150,000.
The administrator has typed the text for a Notification as below:
Our new employee {name} is starting with us on {start-date}. {fname}’s position is {position}, with a salary of {salary} per year.
The text that will pull through to the notification is:
Our new employee Kath Day-Knight is starting with us on 28/06/2020. Kath’s position is Senior Hat Maker, with a salary of $150,000 per year.