Integrate > SAP Solution Manager > Configure > Configuration Options

Configuration Options

This section describes configurable options for integrating SAP Solution Manager events and topology with OpsCx for SAP Solution Manager. All options are preconfigured with default values you can modify. While basic options have their default values specified in the configuration files, the default values of advanced options are implicitly defined. To modify the value of an advanced option, manually add the option and its chosen value to a configuration file.

You can find integration configuration files in the <OvDataDir>/conf/HPBsmIntSapSolma/genint directory on the Operations Connector host. They are plain text files. In a configuration file, in the nodes section, each option has a value that is assigned by using the following syntax:

"<OptionName>"' : "<Value>"

If an appropriate option and its value are present but commented out, remove the comment delimiter // and modify the value as needed.

When adding an advanced option to the configuration file, make sure to add it to the appropriate subsection of the nodes section. Use the following syntax:

"<AdvancedOptionName>" : "<Value>",

After reconfiguring a OpsCx for SAP Solution Manager integration, restart the integration service as described in Restarting the Services topic.

Some option descriptions inside the configuration files might be incomplete. Refer to this document for a complete and correct information about configuration options.

Event Integration Options

The following tables list options in event_integration.conf—the event integration configuration file.

Basic Options

Option Name Description, (Default) Value
Subsection: source (eventreceiver)
filename

Path of the file with a valid Lua script that processes SAP Solution Manager event data.

Windows default value:
${OvInstallDir}\bin\win64\HPBsmIntSapSolma\lua\sap_event_receiver.lua

Linux default value:
/opt/OV/lib64/HPBsmIntSapSolma/lua/sap_event_receiver.lua

single-run

The option that, when set to true, causes the Lua script to be executed only once or until the first successful completion.

Default value: true

port

Network port on which the OpsCx for SAP Solution Manager listens for incoming SAP Solution Manager events. To modify this option, it is recommended using SAP Solution Manager configuration tool which also makes necessary changes on the SAP Solution Manager side.

dump-event-data

This option enables or disables transferring of the raw event data received by SAP Solution Manager to a file.

Default value: false

dump-output-file

Path to the file for transferring the raw event data received by SAP Solution Manager.

Windows default value:
${OvDataDir}\datafiles\HPBsmIntSapSolma\sap_event_dumps.xml

Linux default value:
/var/opt/OV/datafiles/HPBsmIntSapSolma/sap_event_dumps.xml

Subsection: processor (eventsplitter)
copy-count

You may alter this option only to locally generate an event output file in the XML format for troubleshooting purposes. Follow the instructions in Troubleshooting the Collection of Events and Topology topic.

Default value: 1

Subsection: sink (wslistener)
use-ssl

This option enables or disables secure communication using the SSL protocol.

Default value: true

uri

String that specifies the web address to use in the REST Web Service communication between OpsCx for SAP Solution Manager and Operations Connector. Specify a valid URL string without the scheme name (protocol), hostname, and port.

Default value: /bsmc/rest/events/HPBsmIntSapSolma

server-name

Fully qualified domain name (FQDN) or IP address of your Operations Connector host.

Default value: localhost

port

Default port of Operations Connector policies of the REST Web Service Listener type. As long as you do not reconfigure Operations Connector, you may not alter this option.

Default value: 30005

use-persistency

This option enables or disables a local file-based message buffering mechanism. When the mechanism is enabled, messages are delivered in any circumstance.

Default value: true

pesistency-dir

Path of the directory for persistency data files: an internal buffer for the not-yet-dispatched messages. You must create the directory in advance with the read and write access enabled.

Windows default value:
${OvDataDir}\tmp\HPBsmIntSapSolma

Linux default value:
/var/opt/OV/tmp/HPBsmIntSapSolma

persistency-max-size

Size (in bytes) that a persistency data file must exceed to initiate the creation of a new data file.

Default value: 10240

persistency-max-files

Maximum number of persistency data files the message buffering mechanism maintains.

Default value: 10

persistency-prefix

You may not alter this option.

Default value: HPBsmIntSapSolma-events

retry-wait

Time period (in seconds) that OpsCx for SAP Solution Manager waits before retrying to send the REST Web Service request. This option is ignored if the use-persistency basic option is set to false.

Default value: 30

auth-username

User name used for authenticating against the REST Web Service endpoint on the Operations Connector host.

Default value: exampleauthusr

auth-password

Password used for authenticating against the REST Web Service endpoint on the Operations Connector host.

Default value: exampleauthpass

root-element

Name of the root element in the event output XML file. You may not alter this option.

Default value: sap_event_message

Subsection: sink (eventsink)
filename

Path of the event output file to which OpsCx for SAP Solution Manager writes data. You do not have to create this file in advance.

Windows default value:
${OvDataDir}\datafiles\HPBsmIntSapSolma\sap_events.xml

Linux default value:
/var/opt/OV/datafiles/HPBsmIntSapSolma/sap_events.xml

root-element

Name of the root element in the event output XML file. You may not alter this option.

Default value: sap_event_message

Advanced Options

Option Name Description, (Default) Value
Subsection: source (eventreceiver)
interval

Seconds that OpsCx for SAP Solution Manager waits after re-running the script. This option is ignored if the single-run option is specified.

Default value: 10

error-timeout

Seconds that OpsCx for SAP Solution Manager waits if an error occurs during the script execution.

Default value: 10

package-path

Additional search paths where OpsCx for SAP Solution Manager searches for Lua modules. Separate the paths with semicolons and use wildcard characters if needed. This option is used to set the global Lua variable package.path.

Default value: (empty)

package-cpath

Additional search paths where OpsCx for SAP Solution Manager searches for C libraries. Separate the paths with semicolons and use wildcard characters if needed.

Default value: (empty)

Subsection: sink (wslistener)
connection-count

This option defines how many concurrent connections OpsCx for SAP Solution Manager should use for transferring event data to Operations Connector.

Default value: 5

bulk-size

Maximum number of messages that OpsCx for SAP Solution Manager should put into a single REST Web Service request.

Default value: 10

ssl-cert

Path of the file that stores a valid CA certificate in the PEM format and which is used to verify the identity of the remote server. The certificate must contain the private key and the public key. The private key may not use a password. Although you can use different ways to obtain such certificate, it is recommended that you use a certificate issued by a certificate authority (CA).

This option must be set when the use-ssl option in the sink (eventsinknode) subsection is set to true.

Default value: (empty)

use-auth

The option that, when set to true, causes OpsCx for SAP Solution Manager to use the credentials specified for the auth-username and auth-password options to authenticate against the remote REST Web Service endpoint.

Enable secure communication by using the SSL protocol to prevent the authentication credentials from being sent unencrypted to the Operations Connector host.

Default value: false

use-store

The option that, when set to true, causes OpsCx for SAP Solution Manager to obtain the authentication credentials from the GenInt keystore rather than from the integration configuration file. In this case, the values of the auth‑username and auth‑password options are used as the credential string IDs inside the keystore.

Enable secure communication by using the SSL protocol to prevent the authentication credentials from being sent unencrypted to the Operations Connector host.

Default value: false

Subsection: sink (eventsink)
rollover-size

Kilobytes that an output XML file must exceed to initiate an output file rollover (that is, creating a new file and redirecting output into it).

Default value: 1024

rollover-count

Maximum number of output XML files the rollover mechanism may maintain.

Default value: 5

rollover-wait

Seconds that OpsCx for SAP Solution Manager waits before retrying the rollover.

Default value: 30

Topology Integration Options

The following tables list options in topology_integration.conf—the topology integration configuration file.

Basic Options

Option Name Description, (Default) Value
Subsection: source (topologysource)
polling_interval

Interval in seconds for requesting topology information from the specified SAP Solution Manager system.

Default value: 3600

sap_host

Fully qualified hostname of the SAP Solution Manager system. To modify this option, it is recommended using SAP Solution Manager configuration tool which also makes necessary changes on the SAP Solution Manager side.

sap_system_id

System number of the SAP Solution Manager system. To modify this option, it is recommended using SAP Solution Manager configuration tool which also makes necessary changes on the SAP Solution Manager side.

sap_client

Client of the SAP Solution Manager system. To modify this option, it is recommended using SAP Solution Manager configuration tool which also makes necessary changes on the SAP Solution Manager side.

Subsection: sink (topologysink)
filename

Path of the topology output file to which OpsCx for SAP Solution Manager writes data. You do not have to create this file in advance.

Windows default value:
${OvDataDir}\datafiles\HPBsmIntSapSolma\sap_topology.xml

Linux default value:
/var/opt/OV/datafiles/HPBsmIntSapSolma/sap_topology.xml

Subsection: source (selfdiscoverytopo)
sap_host

Hostname of the SAP Solution Manager host system. To modify this option, it is recommended using SAP Solution Manager configuration tool which also makes necessary changes on the SAP Solution Manager side.

filename

Path of the file with a valid Lua script that processes SAP Solution Manager self-discovery topology data.

Windows default value:
${OvInstallDir}\bin\win64\HPBsmIntSapSolma\lua\selfdiscoverytopo.lua

Linux default value:

/opt/OV/lib64/HPBsmIntSapSolma/lua/selfdiscoverytopo.lua

interval

Seconds that OpsCx for SAP Solution Manager waits after re-running the script.

Default value: 3600

Subsection: sink (selfdiscoveryxmlfile)
filename

Path of the self-discovery topology output file to which OpsCx for SAP Solution Manager writes data. You do not have to create this file in advance.

Windows default value:
${OvDataDir}\datafiles\HPBsmIntSapSolma\sap_selfdiscoverytopo.xml

Linux default value:
/var/opt/OV/datafiles/HPBsmIntSapSolma/sap_selfdiscoverytopo.xml

Advanced Options

Option Name Description, Default Value
Subsection: sink (selfdiscoveryxmlfile)
tmp-filename

Name of the temporary file used as a buffer while waiting for the next topology data block. If the time period configured with the message-timeout option expires before the next data block arrives, the buffered data overwrites the topology output file, and the buffer is flushed.

The <filename> variable is automatically replaced with the value of the filename option.

Default value: <filename>.tmp

message-timeout

Time period (in seconds) that OpsCx for SAP Solution Manager, Operations Connector waits for the next topology data block before overwriting the topology output file with the received data that is already in the buffer.

Default value: 10

Related topics

Restarting the Services

Troubleshooting the Collection of Events