Administering the RPC Server for XML/SOAP using the Command Central Command Line

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

Administering the RPC Server for XML/SOAP using the Command Central GUI is described under Administering the RPC Server for XML/SOAP 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 Opt/
Req 		Description
sagcc create instances node_alias name R Required. Specifies the alias name of the installation in which the runtime component is installed.
type RpcServerXml R Required. EntireXCore instance type of RPC server. Must be "RpcServerXml".
product EntireXCore R Required. Must be set to "EntireXCore".
instance.name name R Required. Name of the runtime component, for example "MyRpcServer".
install.service true | false O 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 R Required. The case-sensitive RPC server address has the format: CLASS/SERVER/SERVICE.
server.adminport 1025-65535 R Required. The administration port in range from 1025 to 65535.
broker.transport ssl | tcp R Transport over TCP or SSL. Default is TCP.
broker.host name R Required. EntireX Broker host name or IP address. See Using the Broker ID in Applications in the RPC Programming documentation.
broker.port 1025-65535 R Required. Port number in range from 1025 to 65535.
broker.user user O Optional. The user ID for secured access to the broker.
broker.password password O Optional. The password for secured access to the broker.

Example

  • To create a new instance for an installed EntireX of the type "RpcServerXml", with name "MyRpcServer", with server address "RPC/SRV1/CALLNAT", using administration port 5757, with broker host name "localhost", listening on broker port 1971, in the installation with alias name "local":

    sagcc create instances local EntireXCore type=RpcServerXml instance.name=MyRpcServer server.address=RPC/SRV1/CALLNAT server.adminport=5757 broker.host=localhost broker.port=1971

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

Migrating a Configuration File

After you have created an RPC Server for XML/SOAP using Command Central, you can copy an existing configuration file entirex.xmlrpcserver.configuration.xml to your newly created server.

Start of instruction setTo migrate an existing configuration file to an RPC Server for XML/SOAP that was created using Command Central

  1. Copy file entirex.xmlrpcserver.configuration.xml to <EntireX home>/config/rpc/EntireXCore-RpcServerXml-<instance name>.

  2. Remove file connections.cfg.

  3. Rename file entirex.xmlrpcserver.configuration.xml to connections.cfg.

Configuring an RPC Server Instance

Here you can administer the parameters of the RPC Server for XML/SOAP. 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 XML/SOAP and EntireX Broker.

Parameters

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

Displaying the Broker Settings of the RPC Server

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

Example 1

  • To display the Broker parameters of the RPC Server for XML/SOAP "MyRpcServer" in the installation with alias name "local":

    sagcc get configuration data local EntireXCore-RpcServerXml-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-RpcServerXml-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 Opt/
Req 		Description
sagcc update configuration data node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".
instanceid R Required. Must be "BROKER".
-i file O Optional. Specifies the file from where you want the input read.

Example

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

    sagcc update configuration data local EntireXCore-RpcServerXml-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 XML/SOAP. Any changes will take effect after the next restart.

Displaying the Content of the RPC Server Configuration File

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

Example 1

  • To display the configuration file of the RPC Server for XML/SOAP "MyRpcServer" in the installation with alias name "local":

    sagcc get configuration data local EntireXCore-RpcServerXml-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-RpcServerXml-MyRpcServer CONFIGURATION -o configuration.txt

Updating the Content of the RPC Server Configuration File

Command Parameter Opt/
Req 		Description
sagcc update configuration data node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".
instanceid R Required. Must be "CONFIGURATION".
-i file O 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-RpcServerXml-MyRpcServer CONFIGURATION -i configuration.json

Deployment

Here you modify the parameter to allow dynamic deployment of XML mapping files.

Parameter

Parameter Value Description
Enabled true | false A running RPC Server for XML/SOAP accepts/rejects XML mapping file (XMM) deployment. Default is rejects (false).

Displaying the Deployment Parameter

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-RpcServerXml-".
instanceid Required. Must be "DEPLOYMENT".
-o file Optional. Specifies the file where you want the output written.

Example 1

  • To display the Deployment parameter of RPC Server for XML/SOAP "MyRpcServer" in the installation with alias name "local" on stdout:

    sagcc get configuration data local EntireXCore-RpcServerXml-MyRpcServer DEPLOYMENT

Example 2

  • To store the Deployment parameter in the file deployment.json in the current working directory:

    sagcc get configuration data local EntireXCore-RpcServerXml-MyRpcServer DEPLOYMENT -o deployment.json

    Resulting output file in JSON format:

    {
    "Enabled": "true"
}

Updating the Deployment Parameter

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-RpcServerXml-".
instanceid Required. Must be "DEPLOYMENT".
-i file Optional. Specifies the file from where you want the input read.

Example

  • To load the Deployment parameter in the installation with alias name "local" from file deployment.json in the current working directory:

    sagcc update configuration data local EntireXCore-RpcServerXml-MyRpcServer DEPLOYMENT -i deployment.json

    See Example 2 above for sample output file.

HTTP(S)

Here you can modify the HTTP(S) parameters of the RPC Server for XML/SOAP.

Parameters

Parameter Description
HttpProxyHost The host name or IP address of the proxy server for HTTP connection.
HttpProxyPort The port number of the proxy server for HTTP connection.
HttpProxyUser The user name for proxy authentication for HTTP connection if required.
HttpProxyPassword The password for proxy authentication for HTTP connection if required.
HttpsProxyHost The host name or IP address of the proxy server for HTTPS connection.
HttpsProxyPort The port number of the proxy server for HTTPS connection.
HttpsProxyUser The user name for proxy authentication for HTTPS connection if required.
HttpsProxyPassword The password for proxy authentication for HTTPS connection if required.
TrustStoreLocation Specifies the location of the SSL trust store used for HTTPS connection.
TrustStorePassword The password of the SSL trust store used for HTTPS connection.
HttpNonProxyHosts List of the hosts that should be accessed without going through the proxy. Asterisk notation allowed.

Displaying the HTTP(S) 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-RpcServerXml-".
instanceid Required. Must be "HTTPS".
-o file Optional. Specifies the file where you want the output written.

Example 1

  • To display the HTTP(S) parameters of RPC Server for XML/SOAP "MyRpcServer" in the installation with alias name "local" on stdout:

    sagcc get configuration data local EntireXCore-RpcServerXml-MyRpcServer HTTPS

Example 2

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

    sagcc get configuration data local EntireXCore-RpcServerXml-MyRpcServer HTTPS -o http.json

    Resulting output file in JSON format:

    {
    "HttpProxyHost": "httpHost",
    "HttpProxyPort": "11111",
    "HttpProxyUser": "httpUser",
    "HttpProxyPassword": "httpPassword",
    "HttpsProxyHost": "sslHost",
    "HttpsProxyPort": "22222",
    "HttpsProxyUser": "sslUser",
    "HttpsProxyPassword": "sslPassword",
    "TrustStoreLocation": "c:/Truststore.p12",
    "HttpNonProxyHosts": [
        {
            "HostPattern": "anyhost"
        },
        {
            "HostPattern": "anyhost2"
        }
    ]
}

Updating the HTTP(S) 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-RpcServerXml-".
instanceid Required. Must be "HTTPS".
-i file Optional. Specifies the file from where you want the input read.

Example

  • To load the HTTP(S) parameters in the installation with alias name "local" from file http.json in the current working directory:

    sagcc update configuration data local EntireXCore-RpcServerXml-MyRpcServer HTTPS -i http.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 XML/SOAP: Active Workers and Busy Workers.

Parameters

Key performance indicators (KPIs) enable you to monitor the health of your RPC Server for XML/SOAP. 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 Opt/
Req 		Description
sagcc get configuration data node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".
instanceid R Required. Must be "EXX-MONITORING-KPIS".
-o file O Optional. Specifies the file where you want the output written.

Example 1

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

    sagcc get configuration data local EntireXCore-RpcServerXml-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-RpcServerXml-MyRpcServer MONITORING-KPI -o my.properties

    Resulting output file in text format:

    entirex.entirex.spm.version=10.9.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 Opt/
Req 		Description
sagcc update configuration data node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".
instanceid R Required. Must be "EXX-MONITORING-KPIS".
-i file O 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-RpcServerXml-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 XML/SOAP.

Parameters

Parameter Value Opt/
Req 		Description
ServerAddress class/server/service R Required. The case-sensitive RPC server address has the format: CLASS/SERVER/SERVICE.
ServerAdminport 1025-65535 R Required. The administration port in range from 1025 to 65535.
ReconnectionAttempts n R 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 XML/SOAP stops.
WorkerScalability true | false R You can either have a fixed or dynamic number of workers. Default is dynamic (true). For more information see Worker Models.
FixNumber 1-255 R Required. Fixed number of workers. Must be a number in range from 1 to 255.
MinWorkers 1-255 R Required. Minimum number of workers. Must be a number in range from 1 to 255.
MaxWorkers 1-255 R Required. Maximum number of workers. Must be a number in range from 1 to 255.

Displaying the Server Settings

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

Example 1

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

    sagcc get configuration data local EntireXCore-RpcServerXml-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-RpcServerXml-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 Opt/
Req 		Description
sagcc update configuration data node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".
instanceid R Required. Must be "SERVER".
-i file O 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-RpcServerXml-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 XML/SOAP.

Parameters

Command Parameter Opt/
Req 		Description
TraceLevel 0 | 1 | 2 | 3 R 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 Opt/
Req 		Description
sagcc get configuration data node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".
instanceid R Required. Must be "TRACE".
-o file O Optional. Specifies the file where you want the output written.

Example 1

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

    sagcc get configuration data local EntireXCore-RpcServerXml-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-RpcServerXml-MyRpcServer TRACE -o trace.json

    Resulting output file in JSON format:

    {
"TraceLevel":"0"
}

Updating the Trace Level

Command Parameter Opt/
Req 		Description
sagcc update configuration data node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".
instanceid R Required. Must be "TRACE".
-i file O 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-RpcServerXml-MyRpcServer TRACE -i trace.json

    See Example 2 above for sample input file.

XML Mapping Files

Here you can add, modify or remove the XML mapping files and the settings that the RPC Server for XML/SOAP uses to connect to a web service.

Parameters

Parameter Value Description
Id instanceid The instance ID of the XML mapping file.
Required when updating an XML/SOAP mapping file; must be omitted for creating a new XML/SOAP mapping file.
ConnectionUrl url Required. URL of the web service to call.
TimeOut n HTTP(S) connection timeout (seconds).
XmmFile filename Required. Absolute location including name of XML mapping file.
SoapVersion soap1 | soap2 RPC Server for XML/SOAP communicates with SOAP version 1.1 or 1.2.

Note:
Mapping using pure XML is not affected by this setting.

WsdlFile filename Optional. Absolute location including name of WSDL file. If you are using a WSDL file, the address of the web service is retrieved from this.
WsdlService servicename Optional. The service name to use must be defined in WSDL file and match the selected SOAP version. If the service name is unique for the SOAP version, it can be omitted.
WsdlPort portname Optional. The port name to use must be defined in WSDL file and match the selected SOAP version. If the port name is unique for the SOAP version, it can be omitted.
BasicAuthentication disabled | baFixed | baRuntime Disable/enable the basic authentication for web service connection.
disabled Disable basic authentication.
baFixed The basic authentication uses the credentials defined for user and password
baRuntime The basic authentication uses the credentials set by RPC client application.
AuthUser user User for basic authentication.
AuthPassword password Password for basic authentication.
UsernameToken disabled | passwordText | passwordDigest Authenticate user with UsernameToken security.
disabled Payload does not contains a UsernameToken.
passwordText The UsernameToken in payload contains the plain text password. We strongly recommend secure transport (HTTPS) when sending the password in plain text.
passwordDigest The UsernameToken in payload contains digest of the password.

Listing the XML/SOAP Mapping Files

Command Parameter Description
sagcc list configuration instances local 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-RpcServerXml-".
-o file Optional. Specifies the file where you want the output written.

Example

  • To display the XML/SOAP mappings of instances list:

    sagcc list configuration instances local EntireXCore-RpcServerXml-MyRpcServer

    The mapping files have the prefix "XMM-".

Creating an XML/SOAP Mapping File

Command Parameter Description
sagcc create 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-RpcServerXml-".
instanceid Required. Must be "MAPPING"
-i file Optional. Specifies the file from where you want the input read.

Example

  • To create an XML/SOAP mapping entry for RPC Server for XML/SOAP "MyRpcServer" in the installation with alias name "local" from file newMapping.json in the current working directory, the newMapping.json file must not contain an ID:

    sagcc create configuration data local EntireXCore-RpcServerXml-MyRpcServer MAPPING -i newMapping.json

Displaying an XML/SOAP Mapping 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-RpcServerXml-".
instanceid Required. The instanceid of an XML/SOAP mapping is prefixed with "XMM-" followed by a number.
-o file Optional. Specifies the file where you want the output written.

Example 1

  • To display the parameters of XML/SOAP mapping with instance ID "XMM-1" of RPC Server for XML/SOAP "MyRpcServer" in the installation with alias name "local" on stdout:

    sagcc get configuration data local EntireXCore-RpcServerXml-MyRpcServer XMM-1

Example 2

  • To store the parameters of XML/SOAP mapping with instance ID "XMM-1" in the file mapping1.json in the current working directory:

    sagcc get configuration data local EntireXCore-RpcServerXml-MyRpcServer XMM-1 -o mapping1.json

    Resulting output file in JSON format:

    {
    "Id": "XMM-1",
    "ConnectionUrl": "http://www.sample.sample/greeting",
    "TimeOut": "33",
    "XmmFile": "c:/xmlserver/sample.xmm",
    "SoapVersion": "soap11",
    "WsdlFile": "c:/xmlserver/sample.wsdl",
    "WsdlService": "Greeting",
    "WsdlPort": "GreetingPort",
    "BasicAuthentication": "baFixed",
    "AuthUser": "bauser",
    "AuthPassword": "bapassword"
    "UsernameToken": "passworddigest",
}

Updating an XML/SOAP Mapping 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-RpcServerXml-".
instanceid Required. The instanceid of an XML/SOAP mapping is prefixed with "XMM-" followed by a number.
-i file Optional. Specifies the file from where you want the input read.

Example

  • To load the parameters of XML/SOAP mapping file with instance ID "XMM-1" in the installation with alias name "local" from file mapping.json in the current working directory:

    sagcc update configuration data local EntireXCore-RpcServerXml-MyRpcServer XMM-1 -i mapping.json

    See Example 2 above for sample output 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 Opt/
Req 		Description
sagcc list inventory components node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".

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 Opt/
Req 		Description
sagcc get monitoring state node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".

Example

  • To display state information about the RPC Server for XML/SOAP:

    sagcc get monitoring state local EntireXCore-RpcServerXml-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 XML/SOAP, using the Command Central exec lifecycle commands.

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

Example

  • To start the RPC Server for XML/SOAP "MyRpcServer" in the installation with alias name "local":

    sagcc exec lifecycle start local EntireXCore-RpcServerXml-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 XML/SOAP, using the Command Central exec lifecycle commands.

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

Example

  • To stop the RPC Server for XML/SOAP "MyRpcServer" in the installation with alias name "local":

    sagcc exec lifecycle stop local EntireXCore-RpcServerXml-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 XML/SOAP. 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 Opt/
Req 		Description
sagcc list diagnostics logs node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".

Example

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

    sagcc list diagnostics logs local EntireXCore-RpcServerXml-MyRpcServer

Getting Content from or Downloading RPC Server Log Files

Command Parameter Opt/
Req 		Description
sagcc get diagnostics logs node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".
full | tail | head O Optional. Shows full log file content, or only tail or head.
export -o file O 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-RpcServerXml-MyRpcServer server.log tail

Example 2

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

    sagcc get diagnostics logs local EntireXCore-RpcServerXml-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 Opt/
Req 		Description
sagcc exec administration component R Required. Specifies that a component will be administered.
node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
Trace R Required. Specifies what is to be administered.
load tracelevel=? R Required. Get the trace level.
-f xml|json R Required. Specifies XML or JSON as output format.

Example 1

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

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

Example 2

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

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

Updating the Trace Level of a Running RPC Server

Command Parameter Opt/
Req 		Description
sagcc exec administration component R Required. Specifies that a component will be administered.
node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".
Trace R Required. Specifies what is to be administered.
update tracelevel R Required. Update temporarily the trace level of a running RPC server.
-f xml|json R 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-RpcServerXml-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 Opt/
Req 		Description
sagcc delete instances node_alias R Required. Specifies the alias name of the installation in which the runtime component is installed.
componentid R Required. The component identifier. The prefix is "EntireXCore-RpcServerXml-".

Example

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

    sagcc delete instances local EntireXCore-RpcServerXml-MyRpcServer

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