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 and import content from an Office document into Confluence. 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:

(warning) The information on this page does not apply to Confluence OnDemand.

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, under 'Configuration' in the left-hand panel of the Confluence Administration Console.
  2. Click Show system plugins under 'System Plugins'.
  3. Search the page for Office Connector plugin and select the link.
  4. The 'Office Connector plugin' panel will appear near the top centre of the page, as shown in the screenshot below.
  5. 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.
    • Manage plugin modules – 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

説明

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.

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.

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.

Office コネクタ オプションを設定する

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

Office Connector の構成オプションを設定するには、次の手順を実行します。

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

スクリーンショット: "Office Connecter の構成" オプション


The configuration options are described in the table below:

オプション

既定値

説明

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

無効

このオプションが有効の場合、ユーザーが Word ドキュメントをインポートする際に警告が表示されます。この警告は、ユーザーが既存のコンテンツを上書きする際に通知されます。

Advanced Formatting Options: Use the footnote macro for Word footnotes

無効

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.

認証: URL パスの認証トークンを許可する

無効

このオプションが有効の場合、Office Connector は、URL の認証トークンを使用します。

Temporary storage for viewfile macro

Confluence ホーム ディレクトリ

{viewfile} マクロは一時的にデータをキャッシュします。このオプションによって、キャッシュの場所を設定することができます。利用可能な設定は以下のとおりです。

  • 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.propertiesfile:
    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. 最後の行を編集して、「=」の後に必要な一時場所のパスを直接追加します。例:
      • Windows の場合

        com.benryan.confluence.word.edit.cacheDir=c:\my\path\
        
      • 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

これは、{viewfile} マクロが使用するキャッシュの最大サイズです (上記参照)。

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 Manage Queues to view attachments that are still pending conversion.

関連トピック

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