Configure Protocol Adapters Utility (ConfigureAdapter.exe)

The Configure Protocol Adapters utility allows you to configure protocol adapters that can be used to connect external clients to applications. Refer to Using Protocol Adapters for more information about external clients and AB Suite applications.

This utility is installed with Agile Business Suite Runtime and is located in the AB Suite 7.0 installation directory. You can invoke the utility from the command line to configure protocol adapters.

Note: By default, a local administrator can use ConfigureAdapter.exe. For non-administrative users to access this utility, the users must be member of the "Runtime Administrators" COM+ role of Runtime Manager application or member of the "AB Suite Runtime Administrators" user group.

To run ConfigureAdapter.exe from a command line:

Right-click the Start menu, click Run.
Type cmd in the Run dialog box and press Enter to open a Command Prompt.
In the command prompt, change the working directory to the /bin64 folder of the AB Suite 7.0 installation directory.
```
cd C:\Program Files\Unisys\AB Suite 7.0\Bin64
```

The syntax of configure protocol adapters command-line utility for RATL over TCP/IP and Hub is

ConfigureAdapter /TCPIP <[RATL|HUB]> [/P <PortNumber>]
[/TO <Timeout in seconds>] [/STO <Session Timeout>] [/E <Enable>]
[/L <FilePath>] [/S <FileSize>] [/N <NumberOfBackups>] [/?]

Parameters

Argument	Description
/TCPIP <[RATL\|HUB]>	Specifies the configuration of the TCP/IP protocol adapters from the following protocols: RATL – You can specify this option to configure or read the protocol adapter information of RATLSocket. HUB – You can specify this option to configure or read the protocol adapter information of HubSocket. *Notes:* This argument is mandatory. If you do not pass any, the error message "Invalid argument" appears. Apart from "/TCPIP" with options, if you do not pass any other arguments, it lists the TCP/IP configuration details for the default RATLSocket or HubSocket. This information is read-only. For example: To display the TCPIP configuration details of the default RATLSocket, type the following in command prompt ConfigureAdapter.exe /TCPIP RATL
/P <PortNumber>	You can specify the port number on which the RATLSocket or the HUB socket listens. *Note:* You must enter a numeric value in the range of 1 through 65,535. For example: To modify the port number for TCP/IP over Hub, type ConfigureAdapter.exe /TCPIP HUB /P 4000
/TO <Timeout>	You can specify the time in seconds that the adapter waits before timing out.
/STO <Session Timeout>	Specifies the time-out period assigned to the Session object of the application, in seconds. For example: To modify the time out and session protection timeout for HUB over TCP/IP, type ConfigureAdapter.exe /TCPIP HUB /TO 10 /STO 100
/E <Enable>	You can set this argument to "true" to enable the packet logging for RATL over TCP/IP, and HUB, and vice versa. For example: To enable packet logging for HUB over TCP/IP, type ConfigureAdapter.exe /TCPIP HUB /E true
/L <FilePath>	Specifies the location path of the log file. You should specify the absolute file path. *Notes:* If you provide an invalid file path, an error message appears. If you provide empty quotes, "", the location that is already set is considered. If you provide empty quotes with a space within the quotes, the error message "Unable to create directory. Enter a valid directory name." appears. For example: To modify only the location parameter for RATL over TCPIP, type ConfigureAdapter.exe /TCPIP RATL /L c:\temp\stg
/S <FileSize>	Specifies the maximum size of the log file in kB. *Note:* Ensure that you enter a numeric value that is greater than zero and within the range of 1-65,535. For example: To modify only the File Size parameter for RATL over TCPIP, type ConfigureAdapter.exe /TCPIP RATL /S 100
/N <NumberOfBackups>	Specifies the number of backup files that can be created once the log file has reached its maximum. *Note:* Ensure that you enter a numeric value that is greater than zero and within the range of 1-65,535. For example: To modify only the number of backups parameter for RATL over TCPIP, type ConfigureAdapter.exe /TCPIP RATL /N 6
/TCPIP /?	Displays the command line syntax and options of the utility for RATL over TCPIP and Hub. If specified, a usage message appears, and the utility exits without starting the configuring process.

The syntax of Configure Protocol Adapters command line utility for RATL over MSMQ and SOAP over MSMQ is

ConfigureAdapter.exe /MSMQ <[RATL|SOAP]> /SM <MSMQ Server Machine>
[/E <enable>] [/L <FilePath>] [/S <FileSize>][/N <NumberOfBackups>] [?]

Parameters

Argument	Description
/MSMQ <[RATL\|SOAP]>	Specifies configuring the MSMQ protocol adapters for the following protocols: RATL: You can specify this option to configure or read the protocol adapter information for RATL over MSMQ. SOAP: You can specify this option to configure or read the protocol adapter information for SOAP over MSMQ. *Notes:* This argument is mandatory. If you do not pass any option with this argument, the error message "Invalid argument" appears. Apart from "/MSMQ" with options, if you do not pass any other arguments, it displays and lists the MSMQ configuration details for RATLQueue and SoapQueue. This information is read-only. For example: To display the MSMQ configuration details of RATL over MSMQ that was set previously, type ConfigureAdapter.exe /MSMQ RATL
/SM <MSMQ Server Machine>	Specifies the name of the machine on which the required MSMQ server is located. *Note:* If you specify a wrong machine name, an error message appears. For example: To modify only the server machine for RATL over MSMQ, type ConfigureAdapter.exe /MSMQ RATL /SM <ServerName>
/E <enable>	You can set this argument to "true " to enable the packet logging for RATL over MSMQ and SOAP over MSMQ and vice versa. For example: To enable packet logging for RATL over MSMQ, type ConfigureAdapter.exe /MSMQ RATL /E true
/L <FilePath>	Specifies the location of the log file. You should specify the absolute file path. *Notes:* If you provide an invalid file path, an error message appears. If you provide empty quotes, "", the location that was set previously is considered. If you provide empty quotes with a space within the quotes, the error message "Unable to create directory. Enter a valid directory name." appears. For example: To modify only the location parameter for RATL over MSMQ, type ConfigureAdapter.exe /MSMQ RATL /L c:\temp\stg
/S <FileSize>	Specifies the maximum size of the log file in kB. *Note:* Ensure that you enter a numeric value that is greater than zero and from 1-65,535. For example: To modify only the File Size parameter for RATL over MSMQ, type ConfigureAdapter.exe /MSMQ RATL /S 1000
/N <NumberOfBackups>	Specifies the number of backup files that can be created once the log file has reached its maximum. *Note:* Ensure that you enter a numeric value that is greater than zero and from 1-65,535. For example: To modify only the number of backups parameter for SOAP over MSMQ, type ConfigureAdapter.exe /MSMQ SOAP /N 1
/MSMQ /?	Displays the command syntax and options of the utility for RATL over MSMQ and SOAP over MSMQ. If specified, a usage message appears, and the utility exits without starting the configuring process.

Troubleshooting Error Messages

If you provide incorrect option for an argument, an error message specifying that the argument is invalid appears, along with the argument and the usage of the utility, for reference.
If you pass an incorrect command, the error message "Invalid input specified" appears.
If you pass an incorrect argument, an error message specifying that the input is invalid appears along with the argument and the usage of the utility, for reference.
If you pass any incorrect values for an argument, an error message specifying that the argument is invalid appears, along with the argument and the usage of the utility, for reference.
If you pass argument values that are same as the existing values, the error message "No configuration changes have been made" appears.
If you try to pass any argument when logging is disabled, a warning message specifying that logging is disabled and suggestion to enable logging to change the property values appears.
If you pass any argument after logging is disabled, an error message specifying that no configuration changes have been made and suggestion to enable log appears.
If you pass valid arguments to run the utility, the message "Successfully updated the configuration" appears.
If you pass duplicate arguments, the error message "Encountered duplicate arguments. Please address the duplicates before proceeding." appears.

Example

The following command displays the configuration details of RATL over MSMQ that was set in the previous transaction.

ConfigureAdapter.exe /MSMQ RATL