Info: This feature requires the Elvis InDesign client version 3.1.0 or higher (shipped with Elvis 5.19 or higher).
This article is part of a series that describes how to use Elvis 5 with Adobe InDesign.
In this article, the process of enabling logging is described.
Enabling logging
To troubleshoot technical issues that may occur when using the Elvis InDesign client, logging can be enabled.
The features and functionality depends on the installed plug-ins:
- Only the Elvis InDesign client is installed, not Smart Connection
- The Elvis InDesign client as well as Smart Connection is installed
Each scenario is described below.
Only Elvis InDesign client is installed
When only the Elvis InDesign client is installed, the following features are available:
- Enabling or disabling logging is done through the preferences of InDesign or InCopy.
- Default logging areas and logging levels are used which cannot be modified.
- The names of the log files are Log_InDesign.txt, Log_InCopy.txt and Log_InDesignServer.txt.
- The Logging folder can be quickly accessed through the preferences of InDesign or InCopy.
Enabling or disabling logging
Enabling or disabling logging is done through the following Preferences in InDesign or InCopy:
Preferences > WoodWing > Enable Logging
Quickly accessing the log folder
The log folder can be quickly accessed through the following option in the Preferences of InDesign or InCopy:
Preferences > WoodWing > Open Log Folder
Location of the log files
The log files are stored in the following location:
- Mac OS X: /Users/<user_name>/Library/Application Support/WoodWing.noindex
- Windows: c:\Users\<user_name>\AppData\Local\WoodWing
Elvis InDesign client and Smart Connection are installed
When the Elvis InDesign client is installed together with Smart Connection, the following features are available:
- Enabling or disabling logging is done by modifying the WWSettings.xml file or through the preferences of InDesign or InCopy.
- When logging is enabled through the WWSettings.xml file, the logging areas and logging levels to use can be specified.
- When logging is enabled by setting the Preference, default logging areas and logging levels are used.
- Depending on the installed plug-ins, separate log files are created for Elvis and Smart Connection or the logging is combined into one file.
- The names of the log files are:
- For Smart Connection: WWLog_InDesign.txt, WWLog_InCopy.txt and WWLog_InDesignServer.txt
- For Elvis or Elvis and Smart Connection combined: Log_InDesign.txt, Log_InCopy.txt and Log_InDesignServer.txt.
- The Logging folder can be quickly accessed through the preferences of InDesign or InCopy.
Enabling or disabling logging
Enabling or disabling logging is done by modifying the WWSettings.xml file (by system administrators), through the Preferences in InDesign or InCopy (by end users), or through scripting (for InDesign Server).
This method is for system administrators who want to make sure that users use a specific method. When setting the method through the WWSettings.xml file, the corresponding Preference in InDesign or InCopy (see below) is disabled, thereby preventing these users from changing the setting.
Enabling logging is done by enabling the logging for Smart Connection. For more information, see Logging Smart Connection activity.
Enable or disable logging through the following Preference in InDesign or InCopy:
Preferences > WoodWing > Enable Logging
Note: When the system administrator has configured the setting through the WWSettings.xml file, the Preference cannot be changed.
To enable or disable logging through scripting, set the following option to 'true' or 'false':
Application.woodwingLogging
After setting the option, logging is immediately affected.
Quickly accessing the log folder
The log folder can be quickly accessed through the following option in the Preferences of InDesign or InCopy:
Preferences > WoodWing > Open Log Folder
Location of the log files
The log files are stored in the following location:
- Mac OS X: /Users/<user_name>/Library/Application Support/WoodWing.noindex
- Windows: c:\Users\<user_name>\AppData\Local\WoodWing
Log file creation
The logging functionality is made available through a specific plug-in that is shipped with the Elvis InDesign client and another plug-in that is shipped with Smart Connection.
For Smart Connection, two versions of this plug-in exist. Depending on the installed version of the Smart Connection plug-ins, the log files are either created separately or combined into one:
| Smart Connection version | Elvis InDesign client | Log file name |
|---|---|---|
|
Older than 10.2.0 (CC 2014) Older than 11.1.0 Older than 12.1.0 |
3.1.0 or higher |
For Smart Connection: WWLog_ 1 For Elvis InDesign client: Log_ 2 |
|
10.2.0 or higher 11.1.0 or higher 12.1.0 or higher |
3.1.0 or higher |
The logging for Elvis InDesign client and |
1 Logging should be enabled through the WWSettings.xml file.
2 Logging should be enabled through the Preferences.
3 When logging is enabled through either the Preferences or the WWSettings.xml file.
Document history
- 22 November 2018: Renamed from 'Enabling logging for the Elvis InDesign client for Elvis 6'.
Comment
Do you have corrections or additional information about this article? Leave a comment! Do you have a question about what is described in this article? Please contact Support.
0 comments
Please sign in to leave a comment.