Logging in Coresuite and Related Products

Table of Contents

I Introduction `(Back to Table of Contents)`

Coresuite and related products let you log and trace events during application execution to troubleshoot the system, under the guidance of Coresystems Support or your partner.
The event information is saved as log messages in log files. The files provide a source of information for understanding the root causes of any issues when you are working with Coresuite and/or related products. This information is useful when dealing with incident reports and searching for solutions.

A log file contains text information about important events that happened within the Coresuite. The events are written into the text file, together with a message and information about the timestamp (when it happened) and functionality or place (exact source code line).

The logging framework provides the following features:
- It records application flow – which function was entered and when it happened.
- In some cases, it records performance – the duration of execution of each specific part of the code.
- Messages are logged with a specified severity.

You can configure the logging settings and decide what severity level of messages are to be recorded in the log files. You can also customize the log file path to determine where the messages are to be recorded in the log files.

II Coresuite Log Configuration `(Back to Table of Contents)`

The severity of Coresuite log level and path can be configured (from Coresuite 7.90 onwards) in SAP Business One via:

Administration → Add-Ons → coresuite administration → Administration → tab Settings.

Log Level:

For the Log Level, there are 7 levels of logging you can select from:

0 - Trace	This is the most detailed log level. The following events will be recorded: - Trace, Debug, Info, Warn, Error, and Fatal information messages - Contains identification of business objects, form IDs, referenced/used DLLs
1 - Debug	This is a less detailed level compared to *0 - Trace* level. The following events will be recorded: - Debug, Info, Warn, Error, and Fatal information messages
2 - Info	This is a less detailed level compared to *1 - Debug* level. The following events will be recorded: - Info, Warn, Error, and Fatal information messages - This is the default setting
3 - Warn	This is a less detailed level compared to *2 - Info* level. The following events will be recorded: - Warn, Error, and Fatal information messages
4 - Error	This is a high-severity level of logging. Only *Error* and *Fatal* messages will be recorded. - This is the recommended setting.
5 - Fatal	Very high severity level. Only *Fatal* messages will be recorded.
6 - Off	No log files will be created and no messages will be recorded. Logging is turned off.

III Log Files Location `(Back to Table of Contents)`

For the Log Level, there are 7 levels of logging you can select from:

Component / Filename	Description and Log Path
Coresuite
coresuite.launcher.log	- This log is created when the add-on starts. It can be used to troubleshoot Coresuite installation and startup issues. - It records events related to the start-up of the Coresuite. Path: C:\Users\<Username>\AppData\Local\Temp\ Filename: coresuite.launcher.log
coresuite-SBODEMOCH-manager.log	- This log records all the actions that are being performed within Coresuite when the Coresuite add-on and its modules are installed, started, and when users are working with the add-on. It can be used to troubleshoot failures or issues when working with the add-on. - For centralized logging, you can configure any other desired folder. - In highly secure environments, we suggest using the path %temp% as it will store logs under each user's temp folder. Default Path (can be changed): C:\Users\<Username>\AppData\Local\Temp\coresuite Filename and the format of the file: coresuite-XX-YY.log XX - Company Database YY - SAP Business One UserID
Coresuite Service
DebugLog_20230629053211.log	- This log is created when Coresuite Service starts. It can be used to troubleshoot Coresuite Service startup issues. - It records events related to the start-up of the service and DLLs loaded by the service. Path: C:\ProgramData\Coresystems\Coresuite Service\DebugLogs Filename and the format of the file: DebugLog_XX.log XX - TimeStamp when the service started
coresuite-SBODEMOCH-manager.log	- This log records the actions that are being performed by Coresuite Designer libraries. It can be used to troubleshoot failures or issues related to document printing, emailing, etc. Path: C:\Windows\Temp\coresuite Filename and the format of the file: coresuite-XX-YY.log XX - Company Database YY - SAP Business One UserID
@COR_CUSTOM_SVCLOG	- This log records by default execution of Coresuite Service rules. - In your own rules, you can customize the code to record any log message related to the rule, which is required (by you or the customer) to be stored in this table. - The log can be cleaned via a sample rule with the name "SAMPLE: Delete Old Service Logs" we provide in Coresuite Service Rules. Path: This log is stored in the database table with the name @COR_CUSTOM_SVCLOG
Coresuite Administration Assistant
coresuite.Admin.Assistant.log	This is a debug log and it is created only in cases like when the module can't be deployed or a similar issue happens when using CAA: Path: %temp% Filename: coresuite.Admin.Assistant.log

(Back to Table of Contents)

Change of standard logging mechanism to NLog
Coresuite 7.90 - Changelog - Section: Log Level, Dynamic Path of Log Report, and License Check

I Introduction `(Back to Table of Contents)`

II Coresuite Log Configuration `(Back to Table of Contents)`

III Log Files Location `(Back to Table of Contents)`

Related Articles

Comments

I Introduction (Back to Table of Contents)

II Coresuite Log Configuration (Back to Table of Contents)

III Log Files Location (Back to Table of Contents)

Related Articles

Related articles

I Introduction `(Back to Table of Contents)`

II Coresuite Log Configuration `(Back to Table of Contents)`

III Log Files Location `(Back to Table of Contents)`