Log Settings

The Settings icon enables you to set the log levels using the Excel add-in.

You can export or save the log. The log can be sent to the support team for diagnosing errors. The Log helps you troubleshoot errors. This field allows you to set the time limit for logging information that is stored in the log file. This setting automatically clears log information older than the entry made in this field. The default is 72 hrs. If the records are older than 72 hours, they will be deleted automatically.Description of log-settings.png follows
Description of the illustration log-settings.png

Use Log Levels

Each log message is associated with a severity level. The level gives a rough guide to the importance and urgency of a log message. The log levels are specified with the following values ranging from one having lowest impact (left-most) to the one having highest impact (right-most):

STOP, ERROR, WARNING, INFO, VERBOSE

The following table lists the severity levels of log messages:

Each logging level is cumulative, that is, each level contains all the data generated by the higher levels. For example, Warning logs contain all the data generated by the Error logs, plus the events that are specific to the Error category.

Log message format

The Log Settings writes a message to the specified log file consisting of a module, Timestamp, Severity, Server Name, Connection, Thread ID or User ID or Transaction ID, Message ID, and the Message, along with a stack trace if any. Each attribute is contained between angle brackets.

The following is an example of a message in the server log file (split for readability; in practice, the message might be on one line):
{"module":"ServerHelper","logMessage":"connection not is
      avialble","timestamp":1688901058020,"level":3,"payload":{"conAlias":"Excel
      Connection","status":400},"id":161,"timeString":"9 Jul 2023
      16:40:58"},{"module":"ServerHelper","logMessage":"connection not is
      avialble","timestamp":1688901059724,"level":3}

Hours to keep a log

This field has the automatic cleaning operation. The log settings automatically clears old logs. If the logs are older than 72 hours which is the default value, they will be deleted automatically.

Clean Log

This button deletes all the logs.

Export Log

The Export Log button exports or saves logs to a file. Selecting the Export Log icon in Windows enables the add-in in downloading the exported log to “Downloads” folder.

Selecting the Export Log icon in Mac enables the add-in in copying the log information to clipboard. You can paste it to a file and save the log. The log you export will be in JSON format. The JSON file might contain sensitive information like your password, date of birth or any other data you want to secure.