Adapter properties and commands

This section provides the detailed description of the adapter properties for defining connections, actions, and cards.

Service

Retrieves SOAP services from service definition. This property is by default set as service definition. This is a mandatory property. The corresponding adapter command is -URL.

Endpoint

Specifies actions available in Link. This is a mandatory property. The corresponding adapter command is -E (or -ENDPOINT).

Headers

Specifies the headers. This is an optional command. Each header is specified as name, value pair in the format name=value, and multiple headers are separated by a space character, for example: header1=value1 header2=value2 header3=value3. The corresponding adapter command is -H (or -HEADERS).

Authentication
Specifies the configuration scripts or packages. It is available when you set Configuration Mode to Configuration Script or Configuration Packages. It provides the options to authenticate the connection. This is an optional property. Authentication options are as follows:
  • None: This option does not require any authentication.
  • Basic: This option requires username and password for authentication.
  • OAuth 2.0: This option requires an access token to access the REST APIs securely by using OAuth 2.0 Authentication.
Access Token

Specifies an access token to access the REST APIs using OAuth 2.0 Authentication. It can be generated outside Link using REST API tools, such as Postman. This is a mandatory property. The corresponding adapter command is -AT or (-ACCESSTOKEN).

Access Token Expiry Action
Specifies the action to be taken by the SOAP adapter, if the provided access token is reported expired or invalid. This is a mandatory property. The default value is Report Error. The corresponding adapter command is -ATEA (or –ACCESSTOKENEXPIRYACTION). The following actions are supported:
  • Report Error: The corresponding adapter command value is -report_error.
  • Refresh Token: The corresponding adapter command value is -refresh_token.
  • Request New Token: The corresponding adapter command value is -password.
Access Token URL

Specifies the URL of the authentication server for providing access tokens. This is a mandatory property. The corresponding adapter command is -TURL.

Consumer Key

Specifies the consumer key value to use when performing Refresh Token or Request New Token expiry action. This is a mandatory property. The corresponding adapter command is -CK (or -CONSUMERKEY).

Consumer Secret

Specifies the consumer secret value to use when performing Request New Token expiry action. This is a mandatory property. The corresponding adapter command is -CS (or -CONSUMERSECRET).

Refresh Token

Specifies the refresh token to perform Refresh Token expiry action. It needs to be captured outside of Link to enable the adapter to refresh the access token without any user interaction. This is a mandatory property. The corresponding adapter command is -RT (or -REFRESHTOKEN).

Security Token

Specifies the security token that is provided to you when you register. This is an optional property. The corresponding adapter command is -ST (or -SECURITYTOKEN).

Logging

Specifies the level of logging to use for the log (trace) file produced by the adapter.

The value Information means log informational messages, the value Errors Only means log error messages only, and the value Verbose means log debug and trace level messages along with the informational and error messages. The default is off.

The corresponding adapter command is:

-T[V|E][+] [file_path]

-T -> Log adapter informational messages.

-TE -> Log only adapter errors.

-TV -> Use verbose (debug) logging. The log file records all activity that occurs while the adapter is producing or consuming messages.

+ -> Appends the trace information to the existing log file. Omit this argument to create a new log file.

file_path -> The full path to the adapter trace log. If you omit this keyword, the adapter creates the m4rest.mtr log file in the map directory.

Append Log

The Append Log consist of a flag that indicates what to do if the specified log file is already exists. When set to true, the log messages are appended to the file. When set to false, the file is truncated, and the messages are written to the empty file. The default value is true.

Log File Path

Specifies the location of the log file to which to write log messages. If not specified, the default log file name m4rest.mtr is used and the file is stored to the directory in which the executed compiled map resides.