SAP B1 Integration Framework Messages Test

The integration framework for SAP Business One is a Web browser-based solution to design integration flows for exchanging data between different systems. The integration framework provides an infrastructure that allows for the communication and interaction between software applications such as SAP Business One, other SAP solutions as well as non-SAP systems; whether they are cloud applications or on-premise applications. The purpose of the integration framework is to provide data mapping and transformed information to the software applications involved. The integration framework for SAP Business One supports various log types to analyze and troubleshoot the daily transactions generated by your integration scenarios.

The Message Log shows all messages being processed through the integration framework and allows you to view and debug the message through various processing steps. The information recorded in the log includes scenario package and step, sender and receiver system, trigger, date and time. The integration framework always processes data internally as XML messages irrespective of the inbound data format. The Message Log will capture the full XML message only when the Log Level parameter is set to “Full message”. The logs in the message log will be stored for a maximum of one day only. The logs will be lost if the SAP Business One is rebooted.

If the message log is not scanned periodically for messages with failure status, then, critical errors encountered in the integration framework may sometimes be overlooked by the administrators. If the issues / errors are not resolved on time, then, the integration framework may fail abruptly. To avoid such failures, it is essential to monitor the message log from time to time and periodically analyze the count of log messages based on their severity. The SAP B1 Integration Framework Messages test helps administrators perform such diligent tasks.

This test scans the message log for messages and reports the count of messages that were recorded with Success, Failure, Processing and Filtered status. Using this test, administrators can figure out the severity with which maximum number of messages were recorded. This way, administrators can isolate messages with Failure status and can analyze the reason behind such frequent failures.

Target of the test : A SAP Business One

Agent deploying the test : An internal agent

Outputs of the test : One set of results for the target SAP Business One being monitored.

Configurable parameters for the test
Parameter Description

Test Period

How often should the test be executed

Host

The host for which the test is to be configured.

Port

Enter the port to which the specified host listens.

Database Type

By default, SAP Business One runs either on SAP HANA or Microsoft SQL Database server i.e., the backend database of SAP Business One is either SAP HANA or Microsoft SQL Database server. If the target SAP Business One runs on SAP HANA, choose HANA from the Database Type list. By default, MsSQL option will be chosen from this list indicating that the target SAP Business One runs on Microsoft SQL Database server.

Database Host

Specify the IP address of the host on which the database (i.e., the SAP HANA or Microsoft SQL Database server) of the target SAP Business One is installed.

Database Port

Specify the port at which the specified Database Host listens to. The default Database Port is 1433, if the target Business One runs on Microsoft SQL Database server and 30015, if the target Business One runs on SAP HANA.

Database User

If the target SAP Business One runs on Microsoft SQL Server 2005 or above, provide the name of a SQL user with all of the privileges outlined in User Privileges Required for Monitoring Microsoft SQL server in this text box. If the target SAP Business One runs on SAP HANA database server, then, a special database user account with Monitoring privileges has to be created on the SAP HANA database server of the target SAP Business One that requires monitoring. The syntax of the script that is used for user creation is discussed in Pre-requisites for Monitoring the SAP HANA Database Server. Specify the name of this user against the Database User parameter.

Password

Here, specify the password of the specified Database User.

Confirm Password

Confirm the password by retyping it here.

Database Name

To collect metrics from the logs of the target SAP Business One, the eG agent should connect to the SAP Business One database and other common databases such as RSP, B1if, SBO-COMMON etc. For this, you need to specify the name of the SAP Business One database corresponding to the target SAP Business One being monitored against the Database Name parameter. To know how to figure out the database name, refer to How to Find the Name of the SAP Business One Database?

Instance

This is set to default by default. This implies that the eG agent automatically discovers the instance name at run time. 

Domain

This parameter is applicable only if MsSQL option is chosen from the Database Type list.

By default, none is displayed in the DOMAIN text box. If the ‘SQL server and Windows’ authentication has been enabled for the server being monitored, then the DOMAIN can continue to be none. On the other hand, if ‘Windows only’ authentication has been enabled, then, in the DOMAIN text box, specify the Windows domain in which the managed Microsoft SQL server exists. Also, in such a case, the USER name and PASSWORD that you provide should be that of a user authorized to access the Microsoft SQL database server of the target SAP Business One.

DD Frequency

Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD frequency.

Detailed Diagnosis

To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option.

The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

  • The eG manager license should allow the detailed diagnosis capability
  • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
Measurements made by the test
Measurement Description Measurement Unit Interpretation

Success messages

Indicates the number of messages that were recorded with a Success status in the message log during the last measurement period.

Number

A high value is desired for this measure.

Failure messages

Indicates the number of messages that were recorded with a Failure status in the message log during the last measurement period.

Number

Ideally, the value of this measure should be 0.

For each message that was recorded with Failure status, the detailed diagnosis of this measure lists the ID, Start time, Finish time, System ID of the Sender, System ID of the Receiver, Trigger, Result, Scenario Step and Scenario Package.

Processing messages

Indicates the number of messages that were recorded with a Processing status in the message log during the last measurement period.

Number

 

Filtered messages

Indicates the number of messages that were recorded with a Filtered status in the message log during the last measurement period.

Number

 

Message processing rate

Indicates the number of messages that were recorded with the Processing status per minute in the message log during the last measurement period.

Messages/min

 

Failure message rate

Indicates the number of messages that were recorded with the Failure status per minute in the message log during the last measurement period.

Messages/min