While creating a template, you may need to define template and transaction parameters based on your need. This document guides you on how to use the different types of parameters. It also describes how do these parameters function with different settings.

This page also discusses the characteristics of the various fields on the Add Template/Transaction Parameters screen and their effects on the parameters' representation.

On the following screen, when you click Add Parameter, it guides you to the page that lets you add the template or transaction parameters.

Defining parameters is an optional step during template creation.

Below is the screen that asks you for the details described in the table that follows to add a parameter.

Fields	Description
Group	Unique name to identify a group.
Name	Name of the parameter.
Display Name	Display name for the Parameter. This display name will be visible instead of the Parameter's actual name on the Parameter Values page.
Tooltip	Message that you want to show as a tooltip for the Parameter.
Parameter Type	Type of the input parameter to be received from the Partner.
Mandatory	Parameter may be mandatory or optional. By default, the parameters are mandatory.
Default Value	Default value of the parameter.

Fields' details explained

As you set the values for some of these fields, for example, Display Name, Tooltip, the corresponding changes reflect in several pages related to the templates and transactions. You may also need to do some additional settings in case of some specific type of parameters, for example, Combo and Text. The following sections talk of these fields, their possible values and settings, and the changes they bring into effect.

Display Name: The name you enter in this field appears on the following pages:

Add Template Parameters
Add Transaction Parameters
View Template
View Transaction
Parameter Values
Template Parameter Preview

Tooltip: The message you enter in this field can be seen as a tooltip for the parameter in the following pages:

Parameter Values
Template Parameter Preview

Parameter Type: Depending on the Parameter Type you have selected, you may have to define some additional fields/options or settings while defining a parameter. The following points underline the characteristics of a set of some parameter types in terms of options and settings.

Below is the set of validation fields you encounter if you select the parameter types given in the table that follows. You can perform a validation check on the parameters using these fields.
- Maximum Length - Enter the maximum length (in number) allowed for the parameter.
- Pattern - Set the pattern for the Parameter. It should be defined in a regular expression.
- Test Pattern - Check the validity of the expression in the Pattern field by giving a value in this field.

Parameter Types	Validation fields
Parameter Types	Max Length	Pattern	Test Pattern
Combo	No	No	No
Password	Yes	Yes	Yes
Text Field	Yes	Yes	Yes
Text Area	Yes	Yes	Yes
Radio Button	No	No	No
Date Field	No	No	No
Checkbox	No	No	No
Email	Yes	No	No
URL	Yes	No	No
Number	No	No	No
Decimal Number(Float)	No	No	No

Pattern and Test Pattern fields' values should be a regex written in JavaScript only.

If you select the Combo as the Parameter Type, you can provide the value either manually by entering a list of options in the Value filed or dynamically by calling a REST Consumer.
To call a REST Consumer to populate the values:
1. Select the Dynamic check box.
2. In the Select REST Consumer field, select a REST Consumer from the list. You can also create a new REST Consumer by clicking the sign.
  The parameter values are populated in the Default Value field. You can apply sorting on the retrieved values by selecting Apply Sorting check box.
  
  A REST Consumer here should support the Get method and Basic Authentication only.
If you select the CheckBox as the Parameter Type, you can select any of the following three values in the Select CheckBox Value field.
- true/false
- on/off
- 1/0
The default value for each of the selected options is Unchecked. You can change the default value to Checked based on your requirement.

REST Consumer response

The response received from the REST call in case of a Combo parameter is always in the JSON format. Below is an example of the JSON response that you receive.

Sample JSON Response

[
    {
        "value": "AllDays"
    },
    {
        "value": "BusinessDays"
    },
    {
        "value": "WeekDays"
    }
]

Parameters preview

After you have defined the parameters, you can preview them by clicking the icon on the parameter definition page.

You may be interested in...

Fields' details explained

REST Consumer response

Parameters preview

What's new

Best practices

Training guides

Frequently asked questions

Adeptia Connect APIs

Adeptia security report

Browser not supported