To assign parameters to a communication definition

Parent Previous Next

The procedure to assign parameters to a communication definition is as follows:

  1. Navigate to Quick Menu > Communication Engine > Configuration > Communication Definitions. The Communication Definitions window is displayed.
  2. Expand a module and linked entity from the alphabetical list and select an associated communication definition, or type its name into the Search Communications field. By default the list is filtered to show Current communication definitions. An alternative filter can be applied using the Filter by drop-down field: Expired, Future or All combinations 1.
  3. Click on Parameters. The Parameters tab is activated and all existing parameters are displayed in the Parameter Name summary table.
  4. Click on New Parameter.
  5. Enter the Parameter name into the field provided; this will appear as the display caption when the communication is compiled, prompting the end user for an input value. The syntax must exclude spaces and special characters (? / \ # & ! ^ % £ $) 1.
  6. Enter the Parameter description into the field provided.
  7. Using the Data type drop-down field, select a parameter value to control the desired response type e.g. Text, Integer, Date Time or Lookup.
  8. Using the Lookup type drop-down field, select a system parameter value to control the range of possible responses 2.
  9. Where the parameter response input is Mandatory, activate the tick box provided.
  10. Where the parameter response is to be embedded within the communication, activate the Include as additional tag tick box provided.
  11. Click on Save. The new parameter appears in the Parameter Name summary table.


Tip

1 To aid in identification purposes, it is good practice to devise and uphold a consistent naming convention for all parameters.

Note

1 The Search Communications field will match against any element of the communication description.

2 The values linked to the Lookup type can be confirmed using the Lookup data drop-down field; no value needs to be selected as it is made available for reference purposes only.


See related topics...

To create a new communication definition

Communication definition management overview