Edit online

Integrating Web Author with SharePoint Online

The Oxygen XML Web Author includes a plugin that allows you to use 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://portal.azure.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://portal.azure.com/.
    2. Sign in with your credentials.
    3. Go to your Manage Azure Active Directory.
    4. Choose the App registrations category.
    5. Click New registration on the header.
    6. Complete the form:
      1. Enter a name (e.g. "Oxygen XML Web Author").
      2. For Redirect URI, set the application type to Web.
      3. For Redirect URI, enter the Web Author redirect URL in the following format: [OXYGEN_WEBAUTHOR_URL]/plugins-dispatcher/sp-oauth where [OXYGEN_WEBAUTHOR_URL] is the location where Web Author is deployed (for example, http://www.mydomain.com/oxygen-xml-web-author/plugins-dispatcher/sp-oauth).
    7. Click Register. The app is created.
    8. Choose the API permissions category. Add permissions by clicking the Add a permission button, selecting the relevant permissions, and pressing Add permission:
      • Microsoft Graph > Delegated permissions > Sites.Read.All (reads items in all site collections).
      • SharePoint > Delegated permissions > AllSites.Write (reads and writes items in all site collections).
    9. Choose the Authentication category. In the Platform configurations section, ensure that there is a platform defined with the following configuration:
      1. Platform type: "Web".
      2. Redirect URIs: The Web Author redirect URL in the following format: [OXYGEN_WEBAUTHOR_URL]/plugins-dispatcher/sp-oauth where [OXYGEN_WEBAUTHOR_URL] is the location where Web Author is deployed (for example, http://www.mydomain.com/oxygen-xml-web-author/plugins-dispatcher/sp-oauth).
    10. Choose the Certificates & secrets category.
      1. In the Client secrets section, click New client secret.
      2. Select an expiration time and click Add.
      3. Make note of the newly added Client Secret for later use.
    11. Choose the Overview category and make note of the Application (client) ID for the next step.
  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.