Manage Settings

Use Settings for storing and managing log information for your Spreadsheet Add-ins.

From the Oracle Database menu, click Settings to configure the following options.

Description of the illustration log-settings.png

While most options are available for spreadsheets in general, some options are specific to Microsoft Excel or Google Sheets only.

Show consumer group selection

This option lets you set the priority for queries run from a spreadsheet.

By default, queries run with LOW priority. When enabled, the add-in provides an option to select MEDIUM or HIGH priority for the query. Queries that use HIGH priority consume more resources and may retrieve results faster.

Log level

Each log message is associated with a severity level that indicates the significance and urgency of the log.

A log level can have values ranging from lowest impact to the highest. The following table describes log levels in descending order of their impact.

Log Level	Description
STOP	Records no information. This has the lowest impact.
ERROR	Records events that may require corrective actions, for example, a component is unavailable.
WARNING	Records issues that may lead to an error or require corrective actions in the future. This is the default log level.
INFORMATION	Records completed actions or the current state of a component, for example, the component is initializing.
VERBOSE	Displays detailed processing information including errors, warnings, and information. This has the highest impact.

Each level is cumulative, that is, contains all data generated by the lower levels. For example, a Warning log contains all data generated by the Error logs including the events that are specific to the Error category.

Log Message Format

The Log Settings writes a message to the specified log file. A log file contains information, such as module, Timestamp, Severity, Server Name, Connection, and Message, along with a stack trace if any. Each attribute is specified between curly brackets.

The following is an example of a server log file.

{
  "module": "ServerHelper",
  "logMessage": "New settings saved",
  "timestamp": 1688901058020,
  "level": 3,
  "payload": {
    "conAlias": "Excel Connection",
    "status": 400
  },
  "id": 161,
  "timeString": "19 Jun 20XX 16:40:58"
},
{
  "module": "ServerHelper",
  "logMessage": "serverRequest - success",
  "timestamp": 1688901059724,
  "level": 3
}

Hours to keep log

You can set the time limit for storing the log information in log files. Logs older than the value specified in this field are automatically cleared. The default value is 12 hours. It means the records older than 12 hours get deleted.

Clean log

This option deletes all logs.

Export log

You can export the log to save the information to a file in JSON format. In Windows, the export option saves the log file directly to a folder, for example Downloads. In Mac, the log information is copied to the clipboard. You can paste it to a file and save the log.

Logs are stored locally on the system where the add-in is running. They do not reside on a server or any remote location.

You can then share the log file with the support team for diagnosing and troubleshooting errors.

Note:

The JSON log file can contain personal information or sensitive data. Ensure that you secure any sensitive information before sharing the log file.

Redirect URL

You can use the Copy PL/SQL option and create a connection manually. This option is available in Excel.