Defining the Adapter Definition

You can define the adapter interface in the adapter definition file (.nad). The available adapter operations are defined via Technical Processes.

To define an adapter definition

Create an adapter project. For more information, see Creating Adapter Projects .
Double-click the <Project_name>.nad definition file.
An editor for editing the adapter definition opens.
In the Adapter section, define the basic settings of the adapter:

Name: Adapter name
Version: Adapter version
Category: Adapter category, such as Tools
Package: Name of the WildFly module to be deployed later

This setting is relevant for the Package as Adapter option.

License Key: License key for the adapter
Description: Adapter description

Make the settings on the Operations, Parameters, Icons, and Tabs tabs as described in the following sections.

Operations Tab

Use the Add button to add as many adapter operations as you want.
Each operation must be linked to a Technical Process.

Note:

The name of the operation must not contain spaces.

Tip:

To delete an operation, highlight the appropriate row and select Remove .
Newly created processes are loaded automatically.

For each operation, select the appropriate Technical Process from the Operations folder.

Parameters Tab

Use the Add button to add as many adapter parameters as you want.

Note:

The name of the parameter must not contain spaces.

Define the adapter parameters with the following settings:

Name: Parameter name
Description: Parameter description
Type: Parameter type
- String: For strings
- Number: For numbers
- Boolean: For Boolean values
- Combo: For pick lists
- Password: For passwords

Note:

Names and values for the possible options of a combo box can be created in the Combo Options. The Combo Options appear automatically when the Combo type is selected for a parameter.

Note:

Password values are not in plain text and cannot be copied.

Default Value: Default value of the parameter
Required: Specify whether it is a mandatory or an optional parameter

Note:

The parameters are available in the processes as placeholders PARAM_INPUT_<Name>.

Icons Tab

Define the stored images from the Icons folder as adapter icons.

Tip:

Newly added icons are loaded automatically.

Tabs Tab

Use the New Tab button to add as many tabs as you want to group parameters.

Tip:

Select the Trash icon to delete a complete tab group.

Select Add Properties to add one or more properties.
The Add Properties dialog displays the parameters you have defined on the Parameters tab.
Finally, save the adapter definition.