Administering the RPC Server for IMS Connect using the Command Central Command Line

This document describes how to administer the EntireX RPC Server for IMS Connect, using the Command Central command-line interface. It covers the following topics:

Administering the RPC Server for IMS Connect using the Command Central GUI is described under Administering the RPC Server for IMS Connect using the Command Central GUI. The core Command Central documentation is provided separately and is also available under Guides for Tools Shared by Software AG Products on the Software AG documentation website.

Creating an RPC Server Instance

The following table lists the parameters to include when creating an EntireX RPC instance, using the Command Central create instances commands.

Command Parameter Value Description
sagcc create instances node_alias name Required. Specifies the alias name of the installation in which the runtime component is installed.
type RpcServerImsConnect Required. EntireXCore instance type of RPC server. Must be "RpcServerImsConnect".
product EntireXCore Required. Must be set to "EntireXCore".
instance.name name Required. Name of the runtime component, for example "MyRpcServer".
install.service true | false Optional. Register Windows Service for automatic startup. Default is false. If this parameter is true, the RPC server can be controlled by the Windows Service Control Manager.
server.address class/server/service Required. The case-sensitive RPC server address has the format: CLASS/SERVER/SERVICE.
server.adminport 1025-65535 Required. The administration port in range from 1025 to 65535.
broker.transport ssl | tcp Transport over TCP or SSL. Default is TCP.
broker.host name Required. EntireX Broker host name or IP address. See Using the Broker ID in Applications in the RPC Programming documentation.
broker.port 1025-65535 Required. Port number in range from 1025 to 65535.
broker.user user Optional. The user ID for secured access to the broker.
broker.password password Optional. The password for secured access to the broker.
ims.transport ssl | tcp Required. Use TCP or SSL to communicate with IMS Connect.
ims.host name Required. Host name or IP address where IMS Connect is running.
ims.port n Required. TCP or SSL port number where IMS Connect is listening.
ims.datastoreid name Required. Data store ID. Name of the IMS system that will receive transactions.
ims.encoding codepage Optional. Specify the appropriate EBCDIC encoding used by your IMS Connect. This codepage is also used when communicating with the EntireX Broker.
ims.user userid Optional. User ID as defined in your underlying mainframe security system (e.g. RACF).
ims.password password Optional. Password as defined in your underlying mainframe security system (e.g. RACF).

Example

  • To create a new instance for an installed EntireX of the type "RpcServerImsConnect", with name "MyRpcServer", with server address "RPC/SRV1/CALLNAT", using administration port 5757, with broker host name "localhost", listening on broker port 1971, using IMS transport TCP on host "IMSHOST", connected with port 3838, using IMS system "IMSSYS" and encoding "cp037" in the installation with alias name "local":

    sagcc create instances local EntireXCore type=RpcServerImsConnect instance.name=MyRpcServer server.address=RPC/SRV1/CALLNAT server.adminport=5757 broker.host=localhost broker.port=1971 ims.transport=TCP ims.host=IMSHOST ims.port=3838 ims.datastoreid=IMSSYS ims.encoding=cp037

    Information about the creation job - including the job ID - is displayed.

Configuring an RPC Server Instance

Here you can administer the parameters of the RPC Server for IMS Connect. Any changes to parameters will be used the next time you start the RPC server.

Broker

Here you can administer the parameters used for communication between the RPC Server for IMS Connect and EntireX Broker.

Parameters

Parameter Value Description
BrokerTransport TCP | SSL Transport over TCP or SSL. Default is TCP.
BrokerHost name Required. EntireX Broker host name or IP address. See Using the Broker ID in Applications in the RPC Programming documentation.
BrokerPort 1025-65535 Required. Port number in range from 1025 to 65535.
BrokerUser user Optional. The user ID for secured access to the broker.
BrokerPassword password Optional. The password for secured access to the broker.
BrokerEncoding codepage Required. Encoding used for the communication between the RPC server and EntireX Broker.
BrokerSslTrustStore filename Optional. Specifies the location of SSL trust store.
BrokerSslVerifyServer true | false Optional. The RPC server as SSL client checks the identity of the broker as SSL server.
BrokerFipsMode yes | no Optional. Enable FIPS-140 compliant SSL communication. Default is no.

Displaying the Broker Settings of the RPC Server

Command Parameter Description
sagcc get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "BROKER".
-o file Optional. Specifies the file where you want the output written.

Example 1

  • To display the Broker parameters of the RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local":

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer BROKER

Example 2

  • To store the Broker parameters in the file broker.json in the current working directory:

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer BROKER -o broker.json

    Resulting output file in JSON format:

    {
"BrokerHost":"localhost",
"BrokerPort":"1971",
"BrokerTransport":"TCP",
"BrokerUser":"testuser",
"BrokerPassword":"",
"BrokerEncoding":"Cp1252",
"BrokerSslTrustStore":"",
"BrokerSslVerifyServer":"true"
"BrokerFipsMode":"no"
}

Updating the Broker Settings of the RPC Server

Command Parameter Description
sagcc update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "BROKER".
-i file Optional. Specifies the file from where you want the input read.

Example

  • To load the Broker parameters of the RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local" from the file broker.json in the current working directory:

    sagcc update configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer BROKER -i broker.json

    See Example 2 above for sample input file.

Configuration File

Here you can administer the configuration file of the RPC Server for IMS Connect. Any changes will take effect after the next restart.

Displaying the Content of the RPC Server Configuration File

Command Parameter Description
sagcc get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "CONFIGURATION".
-o file Optional. Specifies the file where you want the output written.

Example 1

  • To display the configuration file of the RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local":

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer CONFIGURATION

Example 2

  • To store the contents of the configuration file in the text file configuration.txt in the current working directory:

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer CONFIGURATION -o configuration.txt

Updating the Content of the RPC Server Configuration File

Command Parameter Description
sagcc update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "CONFIGURATION".
-i file Optional. Specifies the file from where you want the input read.

Example

  • To load the contents of configuration file configuration.json in the current working directory:

    sagcc update configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer CONFIGURATION -i configuration.json

IMS Connect

Here you can modify the IMS Connect settings for the RPC Server for IMS Connect.

Parameters

Parameter Description
ImsTransport Use TCP or SSL to communicate with IMS Connect.
ImsHost Host name or IP address where IMS Connect is running.
ImsPort TCP or SSL port number where IMS Connect is listening.
ImsDataStoreId Data store ID. Name of the IMS system that will receive transactions.
ImsEncoding Specify the appropriate EBCDIC encoding used by your IMS Connect. This codepage is also used when communicating with the EntireX Broker.
ImsUser User ID as defined in your underlying mainframe security system (e.g. RACF).
ImsPassword Password as defined in your underlying mainframe security system (e.g. RACF).
ImsPassTicket Optional. Use PassTicket instead of password. Default is false.
ImsApplicationName Optional. Optional. Required if PassTicket is to be used instead of a password. Application name (1-8 characters) as defined in your RACF system.
ImsSecuredSignonKey Optional. Required if PassTicket is to be used instead of a password. Secured signon key as defined in your RACF system. Must be exactly 16 characters long.
ImsSslTrustStore Specifies the location of SSL trust store.
ImsSslVerifyServer The RPC Server as SSL client checks the identity of IMS Connect as SSL server.
ImsTimeout Socket timeout for connection to IMS Connect (in milliseconds).
ImsUseOldExit Control the default exit name. True: *SAMPLE*, False: *SAMPLE1*.
ImsExitName If left blank, the following defaults will be used: *SAMPLE* for old exit, *SAMPLE1* for new exit.

Displaying the IMS Connect Parameters

Command Parameter Description
sagcc get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "IMS-CONNECT".
-o file Optional. Specifies the file where you want the output written.

Example 1

  • To display the IMS Connect parameters of RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local":

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer IMS-CONNECT

Example 2

  • To store the server parameters in the file ims_connect.json in the current working directory:

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer IMS-CONNECT -o ims_connect.json

    Resulting output file in JSON format:

    {
    "ImsTransport": "TCP",
    "ImsHost": "IMSHOST",
    "ImsPort": "3838",
    "ImsDataStoreId": "IMSSYS",
    "ImsEncoding": "cp037",
    "ImsUser": "",
    "ImsPassword": "",
    "ImsSslTrustStore": "",
    "ImsSslVerifyServer": "true",
    "ImsTimeout": "10000",
    "ImsUseOldExit": "true",
    "ImsExitName": ""
}

Updating the IMS Connect Parameters

Command Parameter Description
sagcc update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "IMS-CONNECT".
-i file Optional. Specifies the file from where you want the input read.

Example

  • To load the IMS Connect parameters of the RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local" from file http.json in the current working directory:

    sagcc update configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer IMS-CONNECT -i ims_connect.json

    See Example 2 above for sample output file.

Monitoring KPIs

Here you can administer margins of monitored key performance indicators (KPIs) available for the RPC Server for IMS Connect: Active Workers and Busy Workers.

Parameters

Key performance indicators (KPIs) enable you to monitor the health of your RPC Server for IMS Connect. The following KPIs help you administer, troubleshoot, and resolve performance issues:

KPI Setting
Absolute number of Active Workers entirex.generic.kpi.1.max=20
Critical alert relative to maximum entirex.generic.kpi.1.critical=0.95
Marginal alert relative to maximum entirex.generic.kpi.1.marginal=0.80
Absolute number of Busy Workers entirex.generic.kpi.2.max=20
Critical alert relative to maximum entirex.generic.kpi.2.critical=0.95
Marginal alert relative to maximum entirex.generic.kpi.2.marginal=0.80

Do not change the other properties!

Displaying the Monitoring KPIs

Command Parameter Description
sagcc get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "EXX-MONITORING-KPIS".
-o file Optional. Specifies the file where you want the output written.

Example 1

  • To display the monitoring KPI properties of RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local" on stdout:

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer MONITORING-KPI

Example 2

  • To store the monitoring KPI properties in the file my.properties in the current working directory:

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer MONITORING-KPI -o my.properties

    Resulting output file in text format:

    entirex.entirex.spm.version=10.8.0.0.473
entirex.generic.kpi.1.critical=0.95
entirex.generic.kpi.1.id=\#1
entirex.generic.kpi.1.marginal=0.80
entirex.generic.kpi.1.max=20
entirex.generic.kpi.1.name=Active Workers
entirex.generic.kpi.1.unit=
entirex.generic.kpi.1.value=0
entirex.generic.kpi.2.critical=0.95
entirex.generic.kpi.2.id=\#2
entirex.generic.kpi.2.marginal=0.80
entirex.generic.kpi.2.max=20
entirex.generic.kpi.2.name=Busy Workers
entirex.generic.kpi.2.unit=
entirex.generic.kpi.2.value=0

Updating the Monitoring KPIs

Command Parameter Description
sagcc update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "EXX-MONITORING-KPIS".
-i file Optional. Specifies the file from where you want the input read.

Example

  • To load the contents of file my.properties in the current working directory:

    sagcc update configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer MONITORING-KPI -i my.properties

Server

Here you can administer the parameters defining the registration name, the administration port and the behavior of the RPC Server for IMS Connect.

Parameters

Parameter Value Description
ServerAddress class/server/service Required. The case-sensitive RPC server address has the format: CLASS/SERVER/SERVICE.
ServerAdminport 1025-65535 Required. The administration port in range from 1025 to 65535.
ReconnectionAttempts n Required. Number of reconnection attempts to the broker. When the number of attempts is reached and a connection to the broker is not possible, the RPC Server for IMS Connect stops.
WorkerScalability true | false You can either have a fixed or dynamic number of workers. Default is dynamic (true). For more information see Worker Models.
FixNumber 1-255 Required. Fixed number of workers. Must be a number in range from 1 to 255.
MinWorkers 1-255 Required. Minimum number of workers. Must be a number in range from 1 to 255.
MaxWorkers 1-255 Required. Maximum number of workers. Must be a number in range from 1 to 255.

Displaying the Server Settings

Command Parameter Description
sagcc get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "SERVER".
-o file Optional. Specifies the file where you want the output written.

Example 1

  • To display the server parameters of RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local" on stdout:

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer SERVER

Example 2

  • To store the server parameters in the file server.json in the current working directory:

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer SERVER -o server.json

    Resulting output file in JSON format:

    {
"ServerAddress":"RPC/SRV1/CALLNAT",
"ServerAdminport":"4711",
"ReconnectionAttempts":"15",
"WorkerScalability":"true",
"FixNumber":"5",
"MinWorkers":"1",
"MaxWorkers":"10"
}

Updating the Server Settings

Command Parameter Description
sagcc update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "SERVER".
-i file Optional. Specifies the file from where you want the input read.

Example

  • To load the server parameters from the file server.json in the current working directory:

    sagcc update configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer SERVER -i server.json

    See Example 2 above for sample input file.

Trace

Here you can set the trace level of the RPC Server for IMS Connect.

Parameters

Parameter Value Description
TraceLevel 0 | 1 | 2 | 3 One of the following levels:
0 - None - No trace output (default).
1 - Standard - Minimal trace output.
2 - Advanced - Detailed trace output.
3 - Support - Support diagnostic. Use only when requested by Software AG Support.

Displaying the Trace Level

Command Parameter Description
sagcc get configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "TRACE".
-o file Optional. Specifies the file where you want the output written.

Example 1

  • To display the trace level of RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local" on stdout:

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer TRACE

Example 2

  • To store the trace level in the file trace.json in the current working directory:

    sagcc get configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer TRACE -o trace.json

    Resulting output file in JSON format:

    {
"TraceLevel":"0"
}

Updating the Trace Level

Command Parameter Description
sagcc update configuration data node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
instanceid Required. Must be "TRACE".
-i file Optional. Specifies the file from where you want the input read.

Example

  • To load the trace level parameters from the file trace.json in the current working directory:

    sagcc update configuration data local EntireXCore-RpcServerImsConnect-MyRpcServer TRACE -i trace.json

    See Example 2 above for sample input file.

Displaying the EntireX Inventory

Listing all Inventory Components

The following table lists the parameters to include, when listing all EntireX instances, using the Command Central list inventory commands.

Command Parameter Description
sagcc list inventory components node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".

Example

  • To list inventory components of instance EntireX in the installation with alias name "local":

    sagcc list inventory components local EntireXCore*

    A list of all EntireX RPC Server runtime components will be displayed.

Viewing the Runtime Status

The following table lists the parameters to include when displaying the state of an EntireX component, using the Command Central get monitoring commands.

Command Parameter Description
sagcc get monitoring state node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".

Example

  • To display state information about the RPC Server for IMS Connect:

    sagcc get monitoring state local EntireXCore-RpcServerImsConnect-MyRpcServer

    Runtime status and runtime state will be displayed.

    • Runtime status indicates whether a runtime component is running or not. Examples of a runtime status are ONLINE or STOPPED.

    • Runtime state indicates the health of a runtime component by providing key performance indicators (KPIs) for the component. Each KPI provides information about the current use, marginal use, critical use and maximum use.

Starting an RPC Server Instance

The following table lists the parameters to include when starting an EntireX RPC Server for IMS Connect, using the Command Central exec lifecycle commands.

Command Parameter Description
sagcc exec lifecycle start node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".

Example

  • To start the RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local":

    sagcc exec lifecycle start local EntireXCore-RpcServerImsConnect-MyRpcServer

    Information about the job - including the job ID - will be displayed.

Stopping an RPC Server Instance

The following table lists the parameters to include when stopping an EntireX RPC Server for IMS Connect, using the Command Central exec lifecycle commands.

Command Parameter Description
sagcc exec lifecycle stop node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".

Example

  • To stop the RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local":

    sagcc exec lifecycle stop local EntireXCore-RpcServerImsConnect-MyRpcServer

    Information about the job - including the job ID - will be displayed.

Inspecting the Log Files

Here you can administer the log files of the RPC Server for IMS Connect. The following table lists the parameters to include when displaying or modifying parameters of the RPC server, using the Command Central list commands.

List all RPC Server Log Files

Command Parameter Description
sagcc list diagnostics logs node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".

Example

  • To list the log files of RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local" on stdout:

    sagcc list diagnostics logs local EntireXCore-RpcServerImsConnect-MyRpcServer

Getting Content from or Downloading RPC Server Log Files

Command Parameter Description
sagcc get diagnostics logs node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
full | tail | head Optional. Shows full log file content, or only tail or head.
export -o file Optional. Creates a zip file of the logs.

Example 1

  • To list the tail of the log file content in the current working directory:

    sagcc get diagnostics logs local EntireXCore-RpcServerImsConnect-MyRpcServer server.log tail

Example 2

  • To create a zip file myfile.zip of the logs:

    sagcc get diagnostics logs local EntireXCore-RpcServerImsConnect-MyRpcServer export -o myfile.zip

Changing the Trace Level Temporarily

Here you can temporarily change the trace level of a running RPC server. The following table lists the parameters to include when displaying or modifying parameters of an EntireX component, using the Command Central exec administration command. The change is effective immediately; there is no need to restart the RPC server.

Note:
If you want to set the trace level permanently, see Trace under Configuring an RPC Server Instance.

Displaying the Trace Level of a Running RPC Server

Command Parameter Description
sagcc exec administration component Required. Specifies that a component will be administered.
node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
Trace Required. Specifies what is to be administered.
load tracelevel=? Required. Get the trace level.
-f xml|json Required. Specifies XML or JSON as output format.

Example 1

  • To display the current trace level of the RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local" in JSON format on stdout:

    sagcc exec administration component local EntireXCore-RpcServerImsConnect-MyRpcServer Trace load tracelevel=? -f json

Example 2

  • To display the current trace level of the RPC Server for IMS Connect "MyRpcServer" in the installation with alias name "local" in XML format on stdout:

    sagcc exec administration component local EntireXCore-RpcServerImsConnect-MyRpcServer Trace load tracelevel=? -f xml

Updating the Trace Level of a Running RPC Server

Command Parameter Description
sagcc exec administration component Required. Specifies that a component will be administered.
node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".
Trace Required. Specifies what is to be administered.
update tracelevel Required. Update temporarily the trace level of a running RPC server.
-f xml|json Required. Specifies XML or JSON as output format.

Example

  • To change the current trace level of the running RPC Server with the name "MyRpcServer" in the installation with alias name "local":

    sagcc exec administration component local EntireXCore-RpcServerImsConnect-MyRpcServer Trace update tracelevel=2 -f json

Deleting an RPC Server Instance

The following table lists the parameters to include when deleting an EntireX RPC Server instance, using the Command Central delete instances commands.

Command Parameter Description
sagcc delete instances node_alias Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid Required. The component identifier. The prefix is "EntireXCore-RpcServerImsConnect-".

Example

  • To delete an instance of an EntireX RPC Server for IMS Connect with the name "MyRpcServer" in the installation with alias name "local":

    sagcc delete instances local EntireXCore-RpcServerImsConnect-MyRpcServer

    Information about the deletion job - including the job ID - is displayed.