Troubleshooting Sidebar Edition Integrations

We have many Sidebar edition integrations. They all use the same Sidebar but they’re very different in other ways. This table attempts to provide an overview of the technical differences between the integrations.

Microsoft Office for Windows · Word · PowerPoint · Excel · Outlook


Platform.NET (requires Microsoft .NET Framework version 4.5 or later)
Web browserInternet Explorer 11
Browser dependencyAcrolinx requires minimum Internet Explorer 11
Configurations
LocalStorage Latest versions

LocalStorage for Office is stored in registry at:
HKEY_CURRENT_USER\Software\Acrolinx\Plugins\Storage\AcrolinxStorage

Office version 1.1 and earlier
Office Sidebar saves Acrolinx URL (from option dialog) in following registry path:

HKEY_CURRENT_USER\Software\Acrolinx\PlugIns\Office\ServerAddress

If no key is there, it will fall back to:

HKEY_LOCAL_MACHINE\Software\Acrolinx\PlugIns\Office\ServerAddress

Internet Explorer browser LocalStorage where cookies are stored:
%userprofile%\Local Settings\Application Data\Microsoft\Internet Explorer\DOMStore

C:\Users\<USER>\Local Settings\Application Data\Microsoft\Internet Explorer\DOMStore

Log file
%temp%\Acrolinx\logs\<appname>\<date>_<appname>.log
C:\Users\<user_name>\AppData\Local\Temp\Acrolinx\logs

To set the log level, edit the following file:

<ADDIN_INSTALL_DIR>\Acrolinx.Sidebar.log4net.xml

Change level value to any one of the following:

ALL
DEBUG
INFO
WARN
ERROR
FATAL
OFF -> Log details will not appear
for example,
 <level value="DEBUG"/>
Start page location
Interface languageApplication language will be picked
Installer languageLanguage is picked up according to System locale
Prerequisite installation check

64-bit(x64):

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\<Version>\<Application Name>\InstallRoot

32-bit(x86):

HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Office\<Version>\<Application Name>
\InstallRoot

Check for the following key:

Key="Path" Value="C:\Program Files\Microsoft Office\root\Office16"

Version: 15.0,16.0
Application Name: Word, PowerPoint, Excel, Outlook.


Oxygen · Standalone · Eclipse


Oxygen Standalone

PlatformJava, Java FX and Swing
Web browser JavaFX WebView is a mini browser that is called as an embedded browser in JavaFX application. This browser is based on WebKit.
Browser dependency--
Configurations
  • Windows XP - [user-home-folder] \Application Data\com.oxygenxml
  • Windows Vista/7 - [user-home-folder] \AppData\Roaming\com.oxygenxml
  • Mac OS X - [user-home-folder] /Library/Preferences/com.oxygenxml
  • Linux - [user-home-folder] /.com.oxygenxml

for Oxygen XML Author: oxyAuthorOptionsSaVERSION.xml
for OxygenXML: oxyOptionsSaVERSION.xml

<entry>
           <String>PLUGIN_CUSTOM_OPTIONS.acrolinxServerURL</String>
            <String>https://test-latest-ssl.acrolinx.com</String>
           </entry>
LocalStorage
  • Windows XP - [user-home-folder] \Application Data\com.oxygenxml
  • Windows Vista/7 - [user-home-folder] \AppData\Roaming\com.oxygenxml
  • Mac OS X - [user-home-folder] /Library/Preferences/com.oxygenxml
  • Linux - [user-home-folder] /.com.oxygenxml

for Oxygen XML Author: oxyAuthorOptionsSaVERSION.xml
for OxygenXML: oxyOptionsSaVERSION.xml

Log File

Windows: C:\Users\<user_name>\AppData\Local\Temp\Acrolinx\Logs\

Linux: /tmp/acrolinx/logs/

Mac: /Users/<USERNAME>/Library/Logs/Acrolinx

Start page location

Windows: C:\Users\<user_name>\AppData\Local\Temp\Acrolinx\acrolinx_start_page_<version>/

Linux: /tmp/acrolinx/acrolinx_start_page_<version>/

Mac: /Users/<USERNAME>/Library/acrolinx/acrolinx_start_page_<version>/

Interface language

Uses language set in Oxygen Language Options. If not available, English as default language.

How to enable debug logging

Follow instructions on: https://www.oxygenxml.com/doc/versions/19.1/ug-editor/topics/custom-startup-parameters-file.html

and set -Dacrolog.level=debug

Oxygen Eclipse

PlatformJava, SWT
Web browserWith SWT, Acrolinx uses operating systems default browser engine.
Browser dependencyInternet Explorer 11. other browser version not yet verified
Configurations

eclipseInstallationDirectory/configuration/.settings/com.acrolinx.client.sidebar.oxygen.eclipse.plugin.prefs

acrolinxServerURL=https://test-latest-ssl.acrolinx.com
        
LocalStorage

Oxygen XML Author
ECLIPSE-WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/com.oxygenxml.author.prefs

Oxygen XML
ECLIPSE-WORKSPACE/.metadata/.plugins/org.eclipse.core.runtime/.settings/com.oxygenxml.editor.prefs

Log File

Windows: C:\Users\<user_name>\AppData\Local\Temp\Acrolinx\Logs\

Linux: /tmp/acrolinx/logs/

Mac: /Users/<USERNAME>/Library/Logs/Acrolinx

Start page location

Windows: C:\Users\<user_name>\AppData\Local\Temp\Acrolinx\acrolinx_start_page_<version>/

Linux: /tmp/acrolinx/acrolinx_start_page_<version>/

Mac: /Users/<USERNAME>/Library/acrolinx/acrolinx_start_page_<version>/

Interface language

Uses system default language, or if not available, English as default.

How to enable debug logging

Set -Dacrolog.level=debug within the eclipse.ini file in the Eclipse installation folder.


Adobe FrameMaker


PlatformMFC C++
Web browserInternet Explorer 11
Browser dependencyAcrolinx requires minimum Internet Explorer 11
Configurations
LocalStorage

1.2 FM and later

LocalStorage for FM is stored in registry at:
HKEY_CURRENT_USER\Software\Acrolinx\Plugins\Storage\AcrolinxStorage

If no key is defined, it will fall back to:
HKEY_LOCAL_MACHINE\SOFTWARE\Acrolinx\PlugIns\Storage\AcrolinxStorage\acrolinx.serverSelector.serverAddress

FM 1.1 and 1.0

FrameMaker Sidebar saves Acrolinx URL in following registry path: HKEY_CURRENT_USER\Software\Acrolinx\PlugIns\FrameMakerSidebar\ServerAddress

Log File

%temp%\Acrolinx\logs\Adobe FrameMaker <fm-version>\<date>-Adobe FrameMaker <fm-version>.log (for example: 2018-6-29-Adobe FrameMaker 2017.log)

Set the log level to debug:

Add entry in registry

HKEY_CURRENT_USER\Software\Acrolinx\Plugins\SdkCpp\enable.debug.log and set value to DWORD 1

64-bit(x64): C:\Program Files\Acrolinx\C++SDK\Acrolinx.Startpage.dll
32-bit (x86) C:\Program Files (x86)\Acrolinx\C++SDK\Acrolinx.Startpage.dll

Interface language

Uses the language of your FrameMaker installation for English, German, French, or Japanese.


MadCap · Flare · Contributor


Platform.NET
Web browserInternet Explorer 11
Browser dependencyAcrolinx requires minimum Internet Explorer 11
ConfigurationsIf you configure LocalStorage or proxy settings in Internet Explorer, Acrolinx falls back to use those settings
LocalStorage

Flare and Contributor Sidebar saves Acrolinx URL (from option dialog) in following registry path:

HKEY_CURRENT_USER\Software\Acrolinx\Plugins\MadCapSidebar\

Log File

Version 1.1:

%temp%\Acrolinx\logs\<date>_<appname>.log

C:\Users\<user_name>\AppData\Local\Temp\Acrolinx\logs

Version 1.2:

C:\Users\$USER$\AppData\Local\Temp\Acrolinx\logs\AcrolinxForMadCap

To set the log level, edit the following file:

Acrolinx.Sidebar.log4net.xml

Use one of the

Acrolinx.Sidebar.log4net.xml

user can mention any one of the following:
<level value="Info" />
to

ALL
DEBUG
INFO
WARN
ERROR
FATAL
OFF -> Log details will not appear
Start page location


Interface language

English


Adobe Creative Cloud · InDesign · InCopy


PlatformCommon Extensibility Platform (CEP)
  • io JS (node JS)
  • Chromium embedded framework (CEF)
  • Adobe Extended Script
Web browser

2015 and 2017 Chromium - Chrome 41

2018 Chromium - Chrome 57

Browser dependency

Adobe only supports Chrome 41 in 2015 and 2017

Configurations
LocalStorage

A file is created to hold the AcrolinxStorage, which will be shared by Adobe CC extensions.
File name: acrolinxStorage.json

Mac: ~/Library/Application Support/Acrolinx/Storage

Windows: %AppData%\Acrolinx\Storage

Log File

Mac:
~/Library/Logs/Acrolinx/Adobe_InDesign
~/Library/Logs/Acrolinx/Adobe_InCopy

Windows:

%TEMP%\Acrolinx\Logs\Adobe_InDesign
%TEMP%\Acrolinx\Logs\Adobe_InCopy

Start page location

The start page ships with the integration. Usually, it's installed where the extension is installed:

Windows: C:\Program Files (x86)\Common Files\Adobe\CEP\extensions\

Mac: /Library/Application Support/Adobe/CEP/extensions

Interface language

Acrolinx uses the interface language of InDesign or InCopy.


JustSystems XMetaL


PlatformJavaScript
Web browserInternet Explorer 11
Browser dependencyAcrolinx requires minimum Internet Explorer 11

(XMetaL requires minimum Internet Explorer 9)

ConfigurationsXMetaL Sidebar saves Acrolinx URL (from option dialog) in following registry path:

HKEY_CURRENT_USER\Software\acrolinx\Plugins\XMetaLSidebar

LocalStorage

1.0 SR1 XMetaL

LocalStorage for XMetaL is stored in registry at:
HKEY_CURRENT_USER\Software\Acrolinx\Plugins\Storage\AcrolinxStorage

1.0 XMetaL
Internet Explorer browser LocalStorage where cookies are stored:
%userprofile%\Local Settings\Application Data\Microsoft\Internet Explorer\DOMStore

C:\Users\<USER>\Local Settings\Application Data\Microsoft\Internet Explorer\DOMStore

Log File

%temp%\Acrolinx\xmetalSidebar\xMetalSidebar<datetime>.log

Start page location


Interface language

Sidebar only shows in English.


PTC Arbortext


PlatformJava, Java FX and Swing
Web browserJavaFX WebView is a mini browser that is called as an embedded browser in JavaFX application. This browser is based on WebKit.
Browser dependency--
Configurations

The configuration information for "Acrolinx for Arbortext" stores in the registry path:

HKEY_LOCAL_MACHINE\Software\Acrolinx\Plugins\ArbortextSidebarPlugin

Run the installer with SKIPJAVACHECK="1" parameter to skip Java check during install.

LocalStorage

%AppData%\java\webview\localstorage (Non-Editable and managed by Sidebar)

Log File

%temp%\Acrolinx\Logs\AcrolinxForArbortext\AcrolinxForArbortext.log

Start page location

C:\Users\<USER>\AppData\Local\Temp\Acrolinx\acrolinx_start_page_<VERSION>

%TEMP%\Acrolinx\acrolinx_start_page_<version>

Interface language

Uses system default language, or if not available, English as default.


Mac · MS Office Word · MS Office PowerPoint · MS Outlook · Sketch

PlatformObjective C
Web browserSafari 11
Browser dependencyAcrolinx requires minimum Safari 11
Configurations
LocalStorage

LocalStorage data is saved in user defaults.(can be found at ~/Library/Preferences/com.acrolinx.Acrolinx.baseclimb.plist and com.acrolinx.Acrolinx.plist).

Log File

/Users/<USERNAME>/Library/Logs/Acrolinx/yyyy-MM-dd HHmmss Acrolog.log

Start page location

Start page is embedded inside Acrolinx application dmg.

Interface language

Uses system default language


Microsoft Visual Studio Code


Platform

Version 1.1 and 1.0: Type Script, Node.js

Version 1.0: Desktop sidebar

Web browserChromium 53
Server dependencyVersion 1.1: 5.5 and later
Configurations Electron: packaged Chromium
LocalStorage

Depending on your platform, the user settings file is located here:

Version 1.1:

  • Windows %AppData%\Acrolinx\Storage\acrolinxStorage.json
  • Mac $HOME/Library/Application Support/Acrolinx/Storage/acrolinxStorage.json
  • Linux $HOME/.config/Acrolinx/Storage/ acrolinxStorage.json

Version 1.0:

  • Windows %APPDATA%\Code\User\settings.json
  • Mac $HOME/Library/Application Support/Code/User/settings.json
  • Linux $HOME/.config/Code/User/settings.json
Log File

Version 1.1: Default log level is info. To change the log level to debug: Goto File menu > Preferences > Settings > User Settings, set "acrolinx.loglevel": "debug". Restart Visual Studio Code to take effect

User can use one of the following log levels:
trace
info
debug
warn
error
fatal

Version 1.0: No integration logs. Open Sidebar browser console.

Start page location

Version 1.1: Bundled with the Sidebar

Version 1.0: loads the start page from the cloud.

Interface language

Version 1.1: Taken from Visual Studio locale language

Version 1.0: Sidebar only shows in English.


IBM Notes


PlatformJava, SWT
Web browserWith SWT, Acrolinx uses operating systems default browser engine.
Browser dependencyInternet Explorer 11
Configurations
LocalStorage

%userprofile%\Local Settings\Application Data\Microsoft\Internet Explorer\DOMStore

C:\Users\<USER>\Local Settings\Application Data\Microsoft\Internet Explorer\DOMStore

Log File

%Temp%\Acrolinx\logs\AcrolinxForNotes.log

Start page location


Interface language

English only


Desktop Checker


PlatformJavaScript
Web browser Electron: packaged Chromium
Installation Folder
  • Windows Default location is C:\Program Files(x86)\Acrolinx\Desktop Checker\Acrolinx Desktop Checker.exe Location can be changed by passing argument TARGETDIR to MSI installer
  • Mac /Applications/Acrolinx Desktop Checker.app
  • Ubuntu /opt/Acrolinx Desktop Checker (with Debian installer)
Configurations


LocalStorage

Depending on your platform, the user settings file is located here:

  • Windows %AppData%\Acrolinx Desktop Checker\
  • Mac $HOME/Library/Application Support/Acrolinx Desktop Checker/
  • Linux $HOME/.config/Acrolinx Desktop Checker/
Log File

Log files are accessible from the Sidebar: About -> Open Log File.

-OR-

To obtain console logs: Open View -> Developer Tools and on Console tab right-click Save as... to save the .log file to your computer

Start page locationBundled with the build
Interface languageTaken from system language


Browser Extensions - Chrome | Firefox | Microsoft Edge | Safari


PlatformJavaScript
Configurations


Start page locationBundled in the extension.
Interface languageDerived from the browser language.

Chrome

LocalStorageOpen Chrome -> Right click and select "Inspect" -> Go to Application tab -> In left side panel, Click on Storage -> Select Cookies
Log fileGo to Console log -> Right click on Console -> Click on Save As

Firefox

LocalStorageOpen Firefox -> Right click and select "Inspect Element" -> Go to Storage tab -> In left side panel, Click Cookies.
Log fileGo to Console log -> Right click on Console -> Click on Select All and Copy Log into file.

Microsoft Edge

LocalStorageOpen Microsoft Edge -> Right click and select "Inspect Element"-> Go to Debugger tab -> in left side panel -> Cookies.
Log fileGo to Console log -> Right click on Console -> Click on Copy All and Save to File.

Safari

LocalStorageStorage of the extension. To view storage contents: Open Safari -> Right click and select "Inspect Element" -> Select Storage tab -> On left side panel, select LocalStorage.
Log fileRight-click and select "Inspect Element" -> Go to Console log -> Press Command+A -> Right click on the console -> Click on "Copy Selected" or "Save selected".


Drupal


PlatformJavaScript
Web browser
Browser dependency
Configurations
LocalStorage
Log File


Start page location
Interface language


AEM


PlatformJavaScript
Web browserChrome/Firefox/Microsoft Edge/Safari. Sidebar integration doesn’t support combination of IE11 with AEM 6.4
Browser dependency
Configurations
LocalStorage
Log File

Refer to browser extensions on this page for browser-specific instructions

Start page locationNot applicable - single sign-on
Interface languageUses AEM language


WordPress


PlatformJavaScript
Web browserChrome/Firefox/Edge/Safari
Browser dependency
Configurations
LocalStorage
Log File

Refer to browser extensions on this page for browser-specific instructions

Start page location
Interface languageUses WordPress language


Oxygen XML Web Author


PlatformJavaScript
Web browser
Browser dependency
Configurations
LocalStorage
Log File
Start page location
Interface language


Microsoft Word Online


PlatformJavaScript
Configurations


Start page locationBundled in the integration.
Interface languageDerived from the Word Online interface language.

Chrome

LocalStorageOpen Chrome -> Customize and control Google Chrome -> More tools -> Developer tools -> Go to Application tab -> In left side panel, Click on Storage -> Select LocalStorage
Log fileGo to Console log -> Right click on Console -> Click on Save As

Firefox

LocalStorageOpen Firefox -> Open Menu -> Web Developer -> Storage Inspector -> In left side panel, Click LocalStorage.
Log fileGo to Console log -> Right click on Console -> Click on Select All and Copy Log into file.

Microsoft Edge

LocalStorageOpen Microsoft Edge -> Settings and more -> Developer Tools -> Go to Debugger tab -> in left side panel -> LocalStorage.
Log fileGo to Console log -> Right click on Console -> Click on Copy All and Save to File.

Safari

LocalStorageOpen Safari -> Click Develop from Menu -> Show JavaScript Console -> Select Storage tab -> On left side panel, select LocalStorage.
Log fileGo to Console log -> Press Command+A -> Right click on the console -> Click on "Copy Selected" or "Save selected".


Microsoft PowerPoint Online


PlatformJavaScript
Web browser
Browser dependency
Configurations
LocalStorage
Log File


Start page location
Interface language


Content Analyzer


PlatformPython on Windows and Mac
LocalStorageRegistry is used for LocalStorage
Log File

Windows: go to File Menu > Preferences > Logging tab. This will show the path of the log file. In Mac: go to Application Menu

Interface languageUse UI Option to change this
PAC file Errors

If the content-analyzer-log.txt contains: UnicodeDecodeError: 'Ascii' codec can't decode byte -> PAC file contains umlaut characters. These aren’t supported

If the content-analyzer-log.txt contains
"TypeError: inet_aton() argument 1 must be string, not None". This could be due to multiple reasons:

1. This indicates the Content Analyzer wasn’t able to parse the PAC file. Is Wireless Proxy Auto-Discovery used on the customer side? WPAD has been disabled in Content Analyzer from 1.3.1 onwards. Suggest to the customer to have direct access to internet.

2. Check the PAC file. The PAC file shouldn’t have reassignments to the same variable. For for example, a variable like hostIP should be assigned value only once in the entire pac file.



Content Analyzer 2019


PlatformPython on Windows and Mac
LocalStorageRegistry is used for LocalStorage
Log File

Windows: go to File Menu > Preferences > Logging tab. This will show the path of the log file. In Mac: go to Application Menu

For a more detailed log level in macOS: use the  open  command from the command line: 

open "Acrolinx Content Analyzer 2019.app"/ --args -d

Interface languageUse UI Option to change this
PAC file Errors

If the content-analyzer-log.txt contains: UnicodeDecodeError: 'Ascii' codec can't decode byte -> PAC file contains umlaut characters. These aren’t supported

If the content-analyzer-log.txt contains
"TypeError: inet_aton() argument 1 must be string, not None". This could be due to multiple reasons:

1. This indicates the Content Analyzer wasn’t able to parse the PAC file. Is Wireless Proxy Auto-Discovery used on the customer side? WPAD has been disabled in Content Analyzer from 1.3.1 onwards. Suggest to the customer to have direct access to internet.

2. Check the PAC file. The PAC file shouldn’t have reassignments to the same variable. For for example, a variable like hostIP should be assigned value only once in the entire pac file.