Login
Home CMS Documentation Home CMS 10 DITA Processing Pipeline Authoring and Editing DITA Content Oxygen XML Web Author Installing Oxygen XML Web Author as a Custom App

Installing Oxygen XML Web Author as a Custom App

Prerequisites:
  • CMS 10.6 must be installed. See CMS Statistics to for details to check your site version.
  • You must have access to the most recent REST plugin and the Oxygen XML Web Author custom application packages. Contact Ingeniux Support to obtain these packages.
  • At least one DITA collection must be uploaded to the DITA root folder. You will use this collection to test that Oxygen XML Web Author is functioning properly as a CMS custom tab application.

Oxygen XML Web Author is a lightweight alternative to Oxygen XML editor, which is a desktop application. Both editors can access CMS assets; however, Oxygen XML Web Author is integrated seamlessly into the Ingeniux CMS UI. Oxygen XML Web Author may be particularly useful to organizations that produce DITA documentation and other structured content. With Oxygen XML Web Author, CMS users can create and edit DITA resources stored in the CMS Assets Manager.

Before Oxygen XML Web Author can be used, administrators must first take steps to configure the application. Once integrated into the CMS, Oxygen XML Web Author displays within a custom tab in Assets Manager.

To install Oxygen XML Web Author as a custom app within Ingeniux CMS, follow these steps:
  1. Install Oxygen XML Web Author
  2. Install REST Plugin
  3. Configure REST Plugin
  4. Install Custom App
  5. Create Custom Tab
  6. Configure Custom App Web.config
  7. Test Oxygen XML Web Author

Install Oxygen XML Web Author

To install Oxygen XML Web Author:
  1. Download Oxygen XML Web Author from the Oxygen XML website.
    Note
    Oxygen XML Web Author is a proprietary authoring tool that requires the purchase of licenses. Contact Ingeniux Support for details.
  2. Install the executable (oxygenxml-web-author-64bit.exe).
    Note
    In most cases, you will install the Oxygen XML Web Author on the server where the CMS resides. However, once security credentials are in place, the CMS can connect to Oxygen XML Web Author from any accessible web server.
  3. When the installation completes, open Oxygen XML Web Author in a web browser, and enter the license key.

Install REST Plugin

To install the REST Plugin:
  1. Navigate the REST plugin you obtained from Ingeniux Support (see prerequisite).

    This plugin allows Oxygen XML Web Author to access the CMS assets through OAuth identities.

  2. Return the Oxygen XML Web Author web application that you have installed.

    For example, go to http://localhost:8089/oxygen-xml-web-author/app/oxygen.html.

  3. Click the Administration Page in the Oxygen XML Web Author UI.
  4. Navigate to Settings > Plugins.
  5. Upload the REST plugin.
  6. Restart the Oxygen XML Web Author servlet in order for the application to recognize the new plugin:
    1. Go to the installation directory of Oxygen XML Web Author.
    2. Launch Manage Web Author.
    3. Go to the General tab.
    4. Click the Stop button, then click Start.
    5. Click OK.
      The new REST plugin now displays in the list of plugins in the Plugins page.

Configure REST Plugin

To configure the REST plugin:
  1. Navigate to the new REST plugin within the Plugins page.
  2. Click Configure...
  3. Provide values for the following fields in the Plugin configuration dialog that displays:
    FieldDescription
    REST Server URLUse the following format:

    http://[your-site-here]/automated/OxygenApi/

    REST Client IDIn the host CMS, navigate to Administration > System Options > CMS > OAuth Identities. Add an identity, then use the Client Id generated by the CMS to populate this REST Client ID field.
    Important
    In the CMS UI, click the Save icon in order for the Client ID and the Client Secret to display in the resulting dialog.
    REST Client_Sec

    Use the Client Secret generated by the CMS to populate this REST Client_Sec field.

    use_invisible_login Select the use_invisible_login option.
  4. Click Apply.

Install Custom App

To install the Oxygen XML Web Author custom application in the CMS:
  1. Navigate the custom app (OxygenWebAuthorApp.zip) you obtained from Ingeniux Support (see prerequisite).
  2. Copy and expand the custom app to the ..\site\ App_Data\xml\Custom folder path of the CMS installation.

Create Custom Tab

To create the Oxygen XML Web Author custom tab in the CMS:
  1. Navigate to Administration > System Options > CMS > Custom Tabs > Management.
    This tab will display in Assets and contain an embedded instance of Oxygen XML Web Author.
  2. Click Add to create a custom tab.
  3. Enter a Name for the new custom tab in the dialog (e.g., Oxygen XML Web Author)
  4. Enter Apps/OxygenWebAuthorApp/OxygenRedir in the URL field.
  5. Select the Attach to Assets checkbox in the Scope area.
  6. Select the Plugin App option from the Location drop-down list.
  7. Click SaveSave Button in the top-left corner of Custom Tabs Management Configuration.

Configure Custom App Web.config

To configure Web.config in the Oxygen XML Web Author custom application:
  1. Open the Oxygen XML Web Author custom app Web.config file in a text editor.

    Web.config is located within the root folder of the OxygenAuthorBaseUrl custom application.

  2. Configure the <add> element with the @key="OxygenAuthorBaseURL" attribute. In the @value attribute, reference the URL of the Oxygen XML Web Author application.For example, your code will look similar to the following:

    OxygenAuthorBaseUrl setting
    <add key="OxygenAuthorBaseUrl" value="http://localhost:8089/oxygen-xml-web-author/app/oxygen.html?author={0}&url=rest%3A%2F%2F{1}" />

  3. Configure the <add> element with the @key="OxygenRootFolder" attribute. In the @value attribute, reference the a/ID of the DITA root folder containing all your DITA assets in the CMS Assets Manager.For example, your code will look similar to the following:

    OxygenRootFolder setting
    <add key="OxygenRootFolder" value="af/4"/>

  4. Save and close Web.config.

Test Oxygen XML Web Author

To test Oxygen XML Web Author in the CMS Assets Manager:
  1. Log in to the CMS where you have configured Oxygen XML Web Author.
  2. Navigate to Assets.
  3. Check out a DITA asset within the Assets Tree.
  4. Verify the checked-out asset can be viewed and edited in the new custom tab hosting Oxygen XML Web Author.