Global parameters

Creating a global parameter

You can create a new global parameter (query or header) from the Schema tab and these parameters can be reused in the Request tab for a specific action.

To create a new global parameter from the Schema tab, complete the following steps:

1. From the Connector Development Kit home page, click the connector that you want to work with.

2. Go to the Schema tab and click Create global parameter +. The Create global parameter panel is displayed.

3. Enter a Display name, Property, and optionally add a description.

   • Display name: The human-readable name that is displayed to users.
   • Property: The name of the parameter as defined in the connectors API. Ensure that you use the correct property otherwise, tests fail. (Normally this property is lowercase and concatenated if it contains more than one word).

4. In the Type field, select one of the following options based on the property type:

   • String
   • Integer
   • Number
   • Boolean
   • Array of strings
   • Array of integers
   • Array of numbers
   • Date

5. Select the applicable Location of your parameter.

6. Select one of the following Field display type options:

   • Text input

   • Text area

   • Dropdown

     Note: If you select the field display type as Dropdown, then you can add additional stored values (property ID), display name, and define the order. For the Boolean data type, the stored value and display name are noneditable.

7. Choose if the parameter is required or not.

8. If you selected the parameter type as String, Number, Integer, or Date and set the Location as Query, then select a list of Operators that can be used as a filter for your query parameter.

   Restriction: The operators that you specify for the query parameter might not work on some endpoints or target applications. This is because the Operators function uses default query strings to communicate with the endpoint, and some of the endpoints might not support the default query strings as they use custom formats.

   Tip: If you selected the parameter type as Date, you can use values such as ISO, Coordinated Universal Time (UTC), Epoch, or other custom raw formats. For a list of custom raw formats, see List of common date time formats for Moment.js.

9. Click Apply changes. A notification is displayed to indicate that the parameter is created successfully.

Editing a global parameter

You can edit a global parameter from the Schema tab only. It cannot be edited from the Request tab of a specific action.

To edit a global parameter, complete the following steps:

1. From the Connector Development Kit home page, click the connector that you want to work with.
2. Go to the Schema tab.
3. Under the Global parameters section, click the global parameter that you want to edit. The Edit parameter side panel is displayed.
4. Update the fields that you want to edit.
5. Click Apply changes. A notification is displayed to indicate that the parameter was updated successfully.

Deleting a global parameter

You can delete a global parameter from the Schema tab only. It cannot be deleted from the Request tab of a specific action.