History | Edit

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 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.

Configure 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 be different than ours, but as an example, our developer used the following procedure for the registration process:
    1. Go to: https://manage.windowsazure.com/.
    2. Sign in with your credentials.
    3. Go to your Active Directory.
    4. Switch to the Applications tab.
    5. Click Add on the footer.
    6. Choose Add an application my organization is developing.
    7. Enter a name (for example: "Oxygen XML Web Author").
    8. Fill the form:

      Sign-On URL: The URL of the Web Author Dashboard (for example, http://mycompany.com/oxygenxml-web-author/app/oxygen.html).

      API ID URL: Some Unique URL: (for example, http://mycompany.com/web-author/).

    9. Click Submit.
    10. The app is created. Click Configure.
    11. Click Add Application and choose one 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".
    12. Change the Reply URL 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.

    13. In the Keys section, select a duration to generate a new key.
    14. Click Save.
    15. 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 Autosave interval that specifies the time in seconds between autosaves. To disable the autosave feature, change this value to 0.
  3. Restart the 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.