Logging Smart Connection activity

Logging the activity of Smart Connection is useful when troubleshooting any technical issues that may be experienced when working with Smart Connection.

The following types of logging are available:

• Logging network requests
• Generic logging

Logging network requests

Network requests and responses — typically those from SOAP — can be captured for further analysis. Each call is logged in an individual file.

Note: This type of logging is meant to be used temporarily for detailed analysis because the required storage space will grow significantly.

• File: WWSettings.xml file
• Name of option: LogFile
• Location: anywhere between the <Settings> </Settings> tags
• Values:
• RequestBuffer: the path to where the log files should be stored.
• ResponseBuffer: the path to where the log files should be stored.
• SOAPResponse: the path to where the log files should be stored.
• SOAPRequest: the path to where the log files should be stored.
• Advnaced: set to true when a sub folder needs to be created per session, in which all calls are called sequentially. When not set or set to false, per type of call only the last one will be saved (overwriting any previous one). Required storage space will stay about the same, but now only the last call of each type can be traced and there is no way to determine the call sequence.
• Example:

<SCEnt:LogFile
   RequestBuffer="Macintosh HD:log"
   ResponseBuffer="Macintosh HD:log"
   SOAPResponse="Macintosh HD:log"
   SOAPRequest="Macintosh HD:log"
   Advanced="true" 
   />

Important: Make sure to validate the WWSettings.xml file for correct content. See Validating the WWSettings.xml file.

Generic logging

The generic logging mechanism writes information about the internals of Smart Connection to a log file. This file is named as follows:

• For InDesign: WWLog_InDesign.txt
• For InCopy: WWLog_InCopy.txt

The location of these log files is:

• Mac OS: /Users/<username>/Library/Application Support/WoodWing.noindex/
• Windows: Users\<username>\AppData\Roaming\WoodWing\

In order to prevent these files from growing to enormous file sizes, Smart Connection creates a new file at the start of each session and stores the old file in a separate folder, using the date as the folder name.

Areas that can be logged

Specific areas have been identified which can be included or excluded from logging:

• SCPro-MCV: Smart Connection panel related logging
• SCEnt-Workspace: Workflow actions related logging
• SCEnt-Logon: Logon/logoff related logging
• SCEnt-DIME: Logging about handling DIME attachments
• SCEnt-SOAP: Logging about handling SOAP requests
• SCEnt-HTTP: Logging on http requests
• SCEnt-HTTPTimer: Timing of http requests

Enabling Generic logging

Generic logging can be enabled through the WWSettings.xml file or through a preference.

WWSettings.xml file

• File: WWSettings.xml file
• Name of option: Logging
• Location: anywhere between the <Settings> </Settings> tags
• Values:
• level: Defines the type of information that should be logged:
• 0 = All. Everything is logged. The logs contains general information about the process.
• 2 = Info. Logging information of level 'Info', 'Warning' and 'Error' are logged.
• 5 = Warning. Logging information of level 'Warning' and 'Error' are logged. The log contains information about actions that may potentially lead to problems.
• 8 = Error. Logging information of level 'Error' is logged. The log contains information about errors during the processing in InDesign/InCopy.
• allareas: Defines if all areas that can be logged are included or only the areas listed (see Logging specific areas only below.):
• 0 = Only the listed areas are logged.
• 1 = All areas are logged.
• Example:

<Logging level="0" allareas="1"></Logging>

Important: Make sure to validate the WWSettings.xml file for correct content. See Validating the WWSettings.xml file.

Logging specific areas only

Instead of logging all areas, specific areas can be targeted or excluded. This is done by using the following elements:

• <Area>: The defined area is ignored when 'allareas' is set to "1".
• <ExArea>: The defined area is ignored when 'allareas' is set to "0".

<Logging level="0" allareas="0">
   <Area name="SCEnt-Workspace"/>
   <Area name="SCEnt-Logon"/>
</Logging>

Preference

When InDesign is connected to WoodWing's Elvis DAM system through the Elvis InDesign plug-in, logging can be enabled through a preference: 

Preferences > WoodWing > Enable Logging

For more information, see Enabling logging for the Elvis InDesign client for Elvis 6.

Document history

• 30 September 2018: Added section 'Preference' to section 'Enabling Generic logging'