Office365 Integration (Pro)

Integration of Office365 in XWiki

azuredroits1.png
CategoryApplication
Active Installs10
Rating
1 Votes
LicenseGNU Lesser General Public License 2.1
SourcesIssues

This macro connects XWiki to Office365, allowing to display and to search for office documents from OneDrive inside XWiki.

Limitations

  • Only Office formats (Word, Excel, Powerpoint) can be embedded. PDF cannot because Office 365 does not provide an embed URL.
  • Sharepoint documents can be embedded by URL but not searched.

Macro embed via URL

First, you can embed an Office 365 document by URL. This way of embedding does not require OAuth credentials to connect XWiki. To embed you just need to get the URL that is displayed when you view or edit an Office document on Office 365. An iframe is used to embed. You can also set width and height parameters of the iframe.

{{office365 url="https://xwikidev-my.sharepoint.com/personal/office365_xwikidev_onmicrosoft_com/_layouts/15/WopiFrame.aspx?sourcedoc=%7BD5A1847B-742D-42EB-980F-4964A21E4F05%7D&file=XWikiKeyMessages2017.pptx&action=default" width="100%" height="800" /}}

office365macroembed1.png

Macro embed via Search

You can embed via search. Just insert the office365 macro without any parameter and a search box will show up. You need to set OAuth credentials in the configuration for this to work (see configuration). You search and then choose the document to embed(two links, "change" and "view" are displayed for changing the embed document or viewing the document on Office365).

{{office365 /}}

office365macroembed2.png

OneDrive search inside XWiki

If you setup OAuth credentials, activate the search UI extension in the Office 365 configuration in the XWiki administration  and add the UI Extension point to the SolrSearchMacros page (see installation instructions) you will see a box showing up on the SOLR search screen of XWiki when searching. This box shows OneDrive results. 

office365search1.png

To configure the extension to be able to use the other features, you will need to get OAuth2 credentials:

Create Office 365 OAuth Credentials

You will need to create credentials on Office 365/Azure AD. This can be done either in Azure AD or on this microsoft app registration web site. It might be necessary to be an admin in the organization

It is necessary to get an Application ID (clientid), create a password (secret)
and set the redirect URI ( http://[your domain]]/xwiki/bin/view/Office365/OAuth (or https) )

office365config.png

Permissions need to be set on the Graph API like below:

permissions.png

Here are some screenshots of the checkboxes checked on the Application Registration Portal:

In case you register the key using the Azure Portal here is how the rights should look:

azuredroits4.png

Enter the credentials in XWiki Administration

You will need to enter your credentials and your tenant ID (either  yourorg.onmicrosoft.com or the full ID) in the Office365 section of the XWiki Administration.

Add the UI Extension point to the Main.SolrSearchMacro page

A UI Extension point needs to be added until XWIKI-14205 is integrated in XWiki.

To add the extension point locate #\displaySearchForm in the page Main.SolrSearchMacros and add the foreach/end block after it:

    #displaySearchForm()
    #foreach ($extension in $services.uix.getExtensions("org.xwiki.platform.search.widget"))
{{html clean=false}}
$services.rendering.render($extension.execute(), 'xhtml/1.0')
{{/html}}
    #end
    #if ($text != '')

Installation Steps

This paid extensions requires XWiki 8.4 or above. In order to install the extension, follow the next steps inside your XWiki instance (on cloud or on premise).

Navigate to the Extension Manager

In the Applications Panel click on "More Applications..." and then "Install new applications...". Alternatively navigate directly to the Administration and select the "Extensions" section.

step1.png

Install the Extension

Search for the extension you wish to install and use the Install button to install it.

step2.png

Get a License

Navigate to the "Licenses" section of the Administration, fill your details, look for the extension you just installed in the live table and click the buttons to get a trial license or to buy a license.

step3.png

Install the License

If you have selected a trial license then you're good and there's nothing else to do. Your trial license is automatically installed.

However if you've selected to buy a license you'll be redirected to a page to perform the payment. At the end you need to come back to the "Licenses" administration section and click on the "Check for Updates" button. This will download and apply the license you bought.

Use the Extension

Start using the Extension! Refer to the extension's documentation to know how to use it.

Options

The price is per year and varies depending on the support level and the number of users.

Support / Users 25 100 500 1000
Silver
Gold
Office365 Integration (Pro) is part of the XWiki Pro package. Purchasing this package you will benefit from more extensions at a better price. Check the full offer in XWiki Pro!

Benefits

What do you get when you purchase an XWiki extension?

1 year license

By purchasing an XWiki extension license, you'll benefit from it during one year.

Free updates

You benefit from all the extension updates during one year. You are always up to date.

Support included

If you are facing an issue, you can reach the XWiki support. Our team is always available to help.

How to Buy

To buy, install this extension from inside your XWiki instance and follow the instructions.

Release notes

v1.3.3

Update the Licensing dependency to version 1.13.
Update the PDF Viewer Macro dependency to version 1.8.3.

v1.3.2

Update the Licensing dependency to version 1.12.2.

v1.3.1

Update the Licensing dependency to version 1.12.1.
Update the PDF Viewer Macro dependency to version 1.8.1.
Bugs fixed:
#4 The admin configuration section is not accessible to users.

v1.3

Update the Licensing dependency to version 1.8.
Update the PDF Viewer Macro dependency to version 1.8.
Display a message when there is no valid license.

v1.2

Initial paid version.

Extension details

This information is only displayed to Administrators. Your users can't see this tab.

License

  • GNU Lesser General Public License 2.1

Sources

Issues

Type

  • xar

Developed by

Compatibility

  • Requires XWiki 8.4 or above.
Installable with the Extension Manager

Dependencies

Tags:
Created by Administrator on 2018/02/26 13:23