This documentation relates to an earlier version of Confluence.
View this page in the current documentation or visit the current documentation home.

Skip to end of metadata
Go to start of metadata

The Office Connector is a Confluence plugin 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, import content from an Office document into Confluence, and edit a Confluence page in Microsoft Word. Please refer to the User Guide for details of these interactions.

A System Administrator can enable or disable parts of the Office Connector and can configure options as described below.

On this page:

Enabling and Disabling the Office Connector and its Modules

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

A System Administrator can install, enable or disable plugins and plugin modules. You can read a general overview in Installing Plugins and Macros.

To enable or disable the Office Connector and its modules,

  1. Select 'Plugins' in the left-hand panel of the Confluence Administration Console.
  2. Search the page for 'Office Connector plugin' and select the link.
  3. The 'Office Connector plugin' panel will appear near the top centre of the page, as shown in the screenshot below.
  4. Now you can do one of the following:
    • Configure plugin – This will take you to the separate plugin configuration screen described below.
    • Disable plugin – Click this link if you want to disable all modules of the plugin, but leave the plugin installed on your Confluence site.
    • Uninstall plugin – Click this link if you want to remove the Office Connector permanently from your Confluence site. To restore it at a later date, you will need to re-install it from the Confluence Plugin Repository.
    • You can also enable or disable one or more of the Office Connector modules, as described in the table below.


Screenshot: Enabling the Office Connector plugin and its modules


The following modules are available for the Office Connector plugin:

Module

Description

OC Settings Manager

Component to read and write persistent settings for the Office Connector.

Slide Cache Manager

Component to cache slide-based conversions when displaying PowerPoint and PDF documents.

Html Cache Manager

Component to cache HTML-based conversions when displaying Word and Excel documents.

File Cache Cleanup Job

This module is a recurring task that cleans up the Office Connector file cache.

File Cache Cleanup

This module is the trigger for the File Cache Cleanup Job.

Office Connector administration link

This module supplies the 'Office Connector Configuration' link in the left-hand panel of the Confluence Administration Console. The link gives access to the plugin configuration screen described below.

Link for previewing a search result

This modules supplies the 'View' link which appears next to attachments displayed in search results, where the attachment is an Office document.

Link for previewing an attachment

This modules supplies the 'View' link which appears next to attachments displayed on the 'Attachments' view of a page, where the attachment is an Office document.

Edit in Word UI on page actions

This module supplies an 'Edit in Word' icon which appears in older versions of Confluence, at the top right of the page with other icons such as the 'Browse Space' and 'Add Page' icons. Not relevant to Confluence 2.10 or later, except for custom themes. You can configure the location of this option on the Office Connector configuration screen, as described below.

Edit in Word UI on drop down menu

This modules supplies the 'Edit in Word' link which appears in the Confluence 'Tools' dropdown menu.

editinwordlink

This modules supplies the {editinwordlink} macro. See Edit in Word Link Macro.

viewfile

This module supplies the {viewfile} macro. See View File Macro.

viewdoc

This module supplies the Word document component of the {viewfile} macro.

viewxls

This module supplies the Excel document component of the {viewfile} macro.

viewppt

This module supplies the PowerPoint document component of the {viewfile} macro.

viewpdf

This module supplies the PDF document component of the {viewfile} macro.

editgrid

This module is used to migrate editgrid users to the Office Connector.

Edit in Word UI on page tabs

This module supplies an 'Edit in Word' tab which appears in older versions of Confluence, next to the 'View', 'Edit', 'Attachments' and 'Info' tabs. Not relevant to Confluence 2.10 or later, except for custom themes. You can configure the location of this option on the Office Connector configuration screen, as described below.

Import Word UI on page tabs

This module supplies a 'Doc Import' tab which appears in older versions of Confluence, next to the 'View', 'Edit', 'Attachments' and 'Info' tabs. Not relevant to Confluence 2.10 or later, except for custom themes.

Import Word UI on drop down menu

This modules supplies the 'Doc Import' link which appears in the Confluence 'Tools' dropdown menu.

Edit in Office javascript resource

This module contains the javascript resources for launching the desktop applications for editing Office documents.

Office Connector Servlet

This module allows Confluence users to edit their Confluence pages in Microsoft Word. It performs the conversion to and from Word.

Office Authenticator Filter

This module authenticates HTTP requests from Office applications.

PPT slide web service

This module allows Confluence users to view a PowerPoint presentation on a wiki page. It provides the slide images to the Flash control which displays the slides on the wiki page.

DOC and XLS image cache web service

This module is required if Confluence users want to view a Word document or an Excel spreadsheet on a wiki page. It allows images to be stored in a cache on the server, so that they can be retrieved when the browser renders the HTML page.

Office Connector Actions

This module must be enabled if the Office Connector is used.

Configuring the Office Connector Options

A Confluence administrator can set the options described below, to determine the behaviour of the Office Connector on your Confluence site.

To set the configuration options for the Office Connector,

  1. Select 'Office Connector Configuration' in the left-hand panel of the Confluence Administration Console.
  2. The 'Configure Office Connector plugin' screen will appear. Set the configuration options as described in the table below.

Screenshot: Configuring the Office Connector options


The configuration options are described in the table below:

Option

Default Value

Description

Edit in word button location

'Tools' menu.

This setting determines the location of the 'Edit in Word' option on the Confluence menus or screens. You may want to change the location if you are using a theme which does not support the default location. Note that you must ensure that the relevant plugin modules are enabled, as described above. Available settings are:

  • Page action icon – An icon at the top right of the page with other icons such as the 'Browse Space' and 'Add Page' icons.
  • View page tab – A page tab, next to the 'View', 'Edit', 'Attachments' and 'Info' tabs.

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 plugin onto your Confluence site. For more information about this plugin and macro, please refer to the Footnotes plugin.

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 resources directory. 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 Mac OS X:
        com.benryan.confluence.word.edit.cacheDir=/Users/myusername/my/path/
        
      • On UNIX:
        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 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 the 'Manage Queues' link to view attachments that are still pending conversion.

RELATED TOPICS

Office Connector Prerequisites
Office Connector Limitations and Known Issues
Working with the Office Connector
Installing Plugins and Macros

  • No labels