Configuring the Office Connector

The Office Connector is a Confluence add-on that allows Confluence users to interact with Microsoft Office and Open Office in various ways. You can display content from Office documents on a wiki page and import content from an Office document into Confluence. Please refer to the User Guide for details of these interactions.

The Office Connector add-on is shipped with Confluence. A System Administrator can enable or disable parts of the Office Connector and can configure options as described below.

Enabling and Disabling the Office Connector and its Modules

The Office Connector is bundled with Confluence, so you should not need to install it. But you may wish to enable or disable some of its modules.

To enable or disable the Office Connector and its modules:

  1. Select Manage Add-ons in the left-hand panel of the Confluence Administration Console.
  2. Click Show system add-ons under 'System Add-ons'.
  3. Enter 'Office Connector' in the Filter Visible add-ons field to quickly find the Office Connector add-on.
  4. Open the details view of the add-on by clicking on the Office Connector add-on in the system add-ons list.
  5. From the details view, you can:
    • Click Configure to specify preferences for the Office Connector. This open the configuration screen described below.
    • Click Disable to disable all modules of the add-on.
    • View the modules that make up the add-on by expanding the modules list. You can enable or disable certain Office Connector modules.

To disable or enable a module:

  1. Open the details view for the Office Connector add-on in the 'Manage Add-ons' page.
  2. Epand the active modules link. The text of this link indicates the number of enabled modules out of the total modules in the add-on.

    Screenshot: Enabling the Office Connector add-on and its modules

  3. Hover over the module in the list to make the Enable or Disable button visible, and click the button to apply the action.

Only certain Office Connector modules can be disabled. Modules that are integral to the operation of the add-on cannot be disabled, and do not have an Enable or Disable button. Modules that can be disabled include the button and provide a brief, on-screen description of the module.

Configuring the Office Connector Options

Confluence administrators can configure settings that control the behaviour of the Office Connector on your Confluence site. 

To set the configuration options for the Office Connector:

  1. Select Office Connector under 'Configuration' in the left-hand panel of the 'Confluence Administration Console'. The 'Configure Office Connector plugin' screen appears.

    Screenshot: Configuring the Office Connector options

     

  2. Set the configuration options as described in the table below.

The configuration options are described in the table below:

Option

Default Value

Description

Edit in word button location Page action icon Where the button for editing the content in Word is located. You can configure the button to appear in the page action icon or from the view page tab.

Warnings: Show a warning before allowing a user to perform an import

Disabled

If this option is enabled, the user will receive a warning when importing a Word document. The warning will tell the user when they are about to overwrite existing content.

Advanced Formatting Options: Use the footnote macro for Word footnotes

Disabled

If this option is enabled, a Confluence page created from an imported Word document will use the {footnote} macro from Adaptavist to render any footnotes contained in the document. Note that you will need to install the Footnotes add-on onto your Confluence site. For more information about this add-on and macro, please refer to the Footnotes add-on.

Authentication: Allow authentication tokens in the URL path

Disabled

If this option is enabled, the Office Connector will use authentication tokens in the URL.

Temporary storage for viewfile macro

The Confluence Home directory.

The {viewfile} macro will cache data temporarily. This option allows you to set the location of the cache. Available settings are:

  • Confluence home directory – The temporary file will be stored in your Confluence Home directory.
  • A directory specified in the directories.properties file – You can specify a location by editing the Office Connector's directories.properties file:
    1. Go to the bundled-plugins directory in your Confluence Home directory.
    2. Copy the Office Connector JAR file to a temporary location: OfficeConnector-x.xx.jar, where 'x.xx' is the version number.
    3. Unzip the JAR file and find the directories.properties file in the resourcesdirectory. The content of the file looks like this:

      #Complete the following line to set a custom cache directory.
      #If resetting to blank, don't delete anything before or including the '='
      com.benryan.confluence.word.edit.cacheDir=
      
    4. Edit the last line, adding the path to your required temporary location directly after the '=' character. For example:
      • On Windows:

        com.benryan.confluence.word.edit.cacheDir=c:\my\path\
        
      • On Linux:

        com.benryan.confluence.word.edit.cacheDir=/home/myusername/my/path
        
    5. Save the file, recreate the JAR and put it in the bundled-plugins directory in your Confluence Home directory, overwriting the original JAR.
  • Cache in-memory – The temporary file will be held in memory. We recommend this option if you are running in a clustered environment.

Maximum file space for cache (MB)

500

This is the maximum size of the cache used by the {viewfile} macro. (See above.)

Number of Conversion Queues

6

This is the maximum number of threads used to convert PowerPoint, Excel files or PDF slide shows. You can use this setting to manage Confluence performance, by limiting the number of threads so that the Office Connector does not consume too many resources. Click Manage Queues to view attachments that are still pending conversion.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport