Integrating Web Author with SharePoint Online
Edit online

The Oxygen XML Web Author includes a plugin that allows you to use the Oxygen XML Web Author to edit files stored in a SharePoint Online repository. You can configure your SharePoint integration to use the OAuth 2.0 authentication flow to access files stored in a public or private repository. You will then have access to some file checking in/out toolbar buttons that are specific to SharePoint.

Note: To integrate Oxygen XML Web Author with a SharePoint On-Premise server, use the generic CMIS plugin.

Configuring a SharePoint Integration

To configure your SharePoint integration, follow this procedure:

  1. Register a new application in the Azure Management Portal at: https://manage.windowsazure.com/.

    For details about registering an application in the Azure Management Portal, see the following articles:
    Tip: Your situation may require a different procedure, but here is an example of a common procedure for the registration process:
    1. Go to: https://manage.windowsazure.com/.
    2. Sign in with your credentials.
    3. Go to your Azure Active Directory.
    4. Choose the App registrations category.
    5. Click New application registration on the header.
    6. Fill the form
      1. Enter a name (e.g. "Oxygen XML Web Author").
      2. Leave the Application type as Web app / API.
      3. Sign-On URL: The URL of the Web Author Dashboard (for example, http://mycompany.com:8080/oxygenxml-web-author/app/oxygen.html).
    7. Click Create.
    8. The app is created. Click Settings.
    9. Click Required permissions and choose all of the following:
      • Office 365 SharePoint online and choose the following Delegated Permissions: "Read and write items and lists in all site collections".
      • Windows Azure Active Directory and choose the following Delegated Permissions: "Sign in and read user profile".
      • Microsoft Graph API and choose the following Delegated Permissions: "Read items in all site collections".

    10. Click Reply URLs to a URL of the following form:

      http://mycompany.com:8080/oxygenxml-web-author/plugins-dispatcher/sp-oauth

      where the URL of the Dashboard is: http://mycompany.com:8080/oxygenxml-web-author/app/oxygen.html.

    11. In the Keys section, select a duration to generate a new key.
    12. Click Save.
    13. Make note of the value of the key and the client ID (Client ID and Client Secret). You will need to input these values in the Web Author Administration page for the SharePoint configuration.
  2. Go to the Administration Page, in the Plugins section click on the Configure icon for the SharePoint plugin, and enter the Client ID, Client Secret, and Redirect URL in the Plugin configuration dialog box. You can also configure the following optional settings:
    • Autosave interval - Specifies the time in seconds between auto-saves. To disable the autosave feature, change this value to 0.
    • Allow anyone to Check-In a document - If this option is selected, all users can check in a document even if they did not check it out themselves.
  3. Restart Oxygen XML Web Author.

Result: After completing the configuration, you will have access to some SharePoint-specific toolbar buttons that allow you to check in/out files. Also, when you check out files from your SharePoint site, the file name will be decorated with a distinctive mark () to indicate that the file is currently checked out.