Default Parameters for SapB1DIAPILogTest

This test monitors logs from client types that deal with DI API. These client types include :B1 Studio Shell, Java B1 logger and DTW B1 logger. The test scans these logs for specific patterns of messages and reports the count of error and general information messages that match the configured patterns. This way, the test pinpoints critical errors that the SAP Business One may have experienced recently and reveals the clients that were affected more frequently.

This page depicts the default parameters that need to be configured for the SapB1DIAPILogTest.

• The TEST PERIOD list box helps the user to decide how often this test needs to be executed.

• In the HOST text box, specify the IP address of the host for which this test is to be configured.

• LOG DIRECTORY is the directory to which logs from various nodes installed on a host are written. Typically, these logs are written to ‘*.log.csv’ files in the ‘logging’ directory of the SAP Business One installation. If SAP Business One is installed in the C drive of a Windows host and a user named Admin is authorized to that directory, the logging directory will be available in the following location by default: C:\ProgramData\SAP BusinessObjects\SAP Business One\Log\SAP Business One\Admin\BusinessOne

• Log file names are generally of the following format : .._.pid.log.csv For e.g., Client.b1logger.20180903_155642.pid664.log is one of the log files from the B1 logger client process running in the SAP Business One. SERVER ABBREVIATION in this case is Client.b1logger. The default value for this parameter has hence been set as a comma separated list of server descriptions and their abbreviations as follows : :. By default, this parameter has been set as: Client_ AuditLogger:Client.AuditLogger*.csv,Client_ B1Logger:Client.b1logger*.csv,Client_StartupLogger:Client.StartupLogger*.csv,Client_ StockTool:Client.StockTool*.csv,DTW_ B1Logger:DTW.b1logger*.csv,Java_B1Logger:java.b1logger*.csv.

• In the SEARCH PATTERN text box, enter the specific patterns of messages to be monitored. The pattern should be in the following format: :, where is the pattern name that will be displayed in the monitor interface and is an expression of the form - *expr* or expr or *expr or expr*, etc. A leading '*' signifies any number of leading characters, while a trailing '*' signifies any number of trailing characters.

  For example, say you specify ORA:ORA-* in the SearchPattern text box. This indicates that "ORA" is the pattern name to be displayed in the monitor interface. "ORA-*" indicates that the test will monitor only those lines in the log file which start with the term "ORA-". Similarly, if your pattern specification reads: offline:*offline, then it means that the pattern name is offline and that the test will monitor those lines in the log file which end with the term offline.

  A single pattern may also be of the form e1+e2, where + signifies an OR condition. That is, the is matched if either e1 is true or e2 is true.

  Multiple search patterns can be specified as a comma-separated list. For example: ORA:ORA-*,offline:*offline*,online:*online.

  Each of these patterns will be searched for in every log file that is present in the configured Log Directory.

• In the LINES text box, specify two numbers in the format x:y. This means that when a line in the log file matches a particular pattern, then x lines before the matched line and y lines after the matched line will be reported in the detail diagnosis output (in addition to the matched line). The default value here is 0:0. Multiple entries can be provided as a comma-separated list.

  If you give 1:1 as the value for Lines, then this value will be applied to all the patterns specified in the SearchPattern field. If you give 0:0,1:1,2:1 as the value for Lines and if the corresponding value in the SearchPattern field is like ORA:ORA-*,offline:*offline*,online:*online then:

  • 0:0 will be applied to ORA:ORA- * pattern

  • 1:1 will be applied to offline:*offline* pattern

  • 2:1 will be applied to online:*online pattern

• The ROTATING FILE flag governs the display of descriptors for this test in the eG monitoring console.

  If this flag is set to True, the descriptors of this test will be displayed in the following format: :. For instance, if the Log Directory parameter is set to c:\SAPBOBI\logs and RotatingFile is set to True, then, your descriptor will be of the following format: c:\SAPBOBI\logs:. On the other hand, if the RotatingFile flag had been set to False, then the descriptors will be of the following format: : - i.e., logs: in the case of the example above.

• In the EXCLUDE PATTERN text box, provide a comma-separated list of patterns to be excluded from monitoring in the ExcludePattern text box. For example *critical*,*exception*. By default, this parameter is set to ‘none’

• By default, the UNIQUEMATCH parameter is set to False, indicating that, by default, the test checks every line in the log file for the existence of each of the configured SearchPatterns. By setting this parameter to True, you can instruct the test to ignore a line and move to the next as soon as a match for one of the configured patterns is found in that line. For example, assume that Pattern1:*fatal*,Pattern2:*error* is the SearchPattern that has been configured. If UniqueMatch is set to False, then the test will read every line in the log file completely to check for the existence of messages embedding the strings ‘fatal’ and ‘error’. If both the patterns are detected in the same line, then the number of matches will be incremented by 2. On the other hand, if UniqueMatch is set to True, then the test will read a line only until a match for one of the configured patterns is found and not both. This means that even if the strings ‘fatal’ and ‘error’ follow one another in the same line, the test will consider only the first match and not the next. The match count in this case will therefore be incremented by only 1.

• If UTF-8 encoding is to be used for reading the log files in the configured log directory, then, set the USEUTF8 flag to True. By default, this flag is set to False.

• If UTFᆤ encoding is to be used for reading the log files in the configured log directory, then, set the USEUTF16 flag to True. By default, this flag is set to False.