Installing CMS 10.3–10.5 Oxygen Web Service


Prerequisites:
  • System administrators must install Ingeniux CMS 10.3.169–10.5 and have access to the CMS site instance file system. See CMS 10.0-10.3 Installation & Upgrades for details.
  • System administrators must have access to the OxygenWebService.zip compatible with CMS 10.3–5.

  • System administrators must create a root folder to contain the DITA resources in the Ingeniux CMS Assets Manager. To upload DITA resources to this folder, see Uploading Assets for steps to upload assets to Ingeniux CMS.
  • CMS administrators must create a folder named dtd in the CMS Assets Manager. Create the folder directly under the Assets root node in the Assets Tree, or create the folder under the DITA root folder to display DTD resources directly in the Oxygen Desktop Plugin's Ingeniux CMS Browser tab. If you have DTD file resources, upload them to this folder.
  • CMS administrators must create a folder called Templates in the CMS Assets Manager. Create the folder directly under the Assets root node in the Assets Tree, or create the folder under the DITA root folder to display template resources directly in the Oxygen Desktop Plugin's Ingeniux CMS Browser tab. If you have custom template resources, upload them to this folder.

The Oxygen Desktop Plugin requires Ingeniux CMS system administrators to install the Oxygen Web Service in the Ingeniux CMS site instance file directory.
To install the OxygenWebService.zip package:
  1. Log in to the CMS instance, and take note of the asset folder identifiers (af/IDs) for your DITA root folder, templates folder, and DTD folder in the Assets Manager.

    You will use these af/IDs as part of the Oxygen Web Service setup process.

  2. Stop the CMS instance application pool by completing the following steps.
    1. Open Internet Information Services Manager (IIS), and navigate to the CMS instance application pool.
    2. Right-click the application pool, and click Stop.
      The CMS instance stops running.
  3. Access the OxygenWebService.zip package on your file system.
  4. Extract OxygenWebSevice.zip to the Custom folder within your Ingeniux CMS installation (e.g., [Drive:]\[path-to-cms-site-instance]\App_Data\xml\Custom\OxygenWebService\).
  5. In the OxygenWebService folder, open Web.config in a text editor.
  6. Provide the appropriate values for the following keys:
    <?xml version="1.0" encoding="utf-8"?>
    <configuration>
      <appSettings>
        <add key="webpages:Version" value="3.0.0.0" />
        <add key="webpages:Enabled" value="false" />
        <add key="ClientValidationEnabled" value="true" />
        <add key="UnobtrusiveJavaScriptEnabled" value="true" />
        <add key="key" value="[your-api-key-here]" />
        <add key="user" value="admin" />
        <add key="lockdown" value="false"/>
        <add key="rootFolderId" value="af/3" />
        <add key="ditaSchema" value="XML" />
        <add key="templatesFolderId" value="af/4" />
        <add key="dtdRootId" value="af/5" />
        <add key="defaultTemplateDescription" value="Custom Template" />
        <add key="javaBinPath" value="C:\Program Files\Java\jdk-12.0.1\bin" />
        <add key="allowDelete" value="false"/>
        <add key="customTemplatesOnly" value="true|false"/>
        <add key="contentTitleXpath" value=""/>
        <add key="treeChildrenPageSize" value="40"/>
        <add key="prodModeErrorReport" value="false"/>
      </appSettings>
      ... 
                      
    </configuration>
    Key NameDescription
    key

    Enter an API key value.

    Important
    After you configure the plugin and start Oxygen XML Editor, you will use this API key to gain access to DITA content in Ingeniux CMS. The API key can be any string over twelve characters long.
    user

    Enter a username value. Provide a valid user that exists in the CMS instance that you will access.

    This user will be a fallback account for operations related to the web service.

    rootFolderId

    Enter the af/ID value. Provide the ID of the CMS root folder where your DITA assets reside.

    templatesFolderId

    Enter the af/ID value. Provide the ID of the CMS root folder where your custom template assets reside.

    dtdRootId

    Enter the af/ID value. Provide the ID of the CMS root folder where your DTD assets reside.

    defaultTemplateDescription

    Enter a brief text description for your custom templates.

    javaBinPath

    If this filepath doesn't exist on your machine, then change the value to the appropriate filepath (e.g., C:\Program Files\Oxygen XML Editor 24\jre\bin).

    allowDelete

    Enter true or false.

    If set to true, users can directly delete DITA assets via the Oxygen Desktop Plugin.

    If set to false (default value), users can only delete DITA assets via the CMS Assets Manager UI.

    customTemplatesOnly

    Enter true or false.

    If set to true, users can only select custom templates when creating new document assets.

    If set to false, users can select preconfigured Oxygen XML Editor templates or custom templates when creating new documents.

    contentTitleXpath

    Keep this setting as is or enter the following XPath expression: /*/title. If set to /*/title, each DITA asset's title element value displays as the DITA asset's name in the Ingeniux CMS Browser tab tree structure.

    Tip
    To view the DITA asset's file name, content contributors can hover over the DITA asset in the Ingeniux CMS Browser tab. The asset's tooltip displays the file name.

    If set to no value (default), the DITA asset's file name displays in the Ingeniux CMS Browser tab tree structure.

    treeChildrenPageSize

    Keep the 40 value as is or enter a new number value.

    This key sets the maximum number of assets to display for any expanded node in the Ingeniux CMS Browser tab and Search Result tab of the Oxygen Desktop Plugin. If a node contains more assets than the maximum defined value, the system doesn't load the extra assets until the user clicks More... in the tree structure.

    prodModeErrorReport

    Enter true or false.

    If set to true, the system removes the stack trace from the CMS instance error report.

    If set to false (default), the system keeps the stack trace in the CMS instance error report.

    Important
    Keep the user and key values in mind. You will use these values again as part of the plugin setup process in the Oxygen XML Editor UI.
  7. Save and close Web.config.
  8. Start the CMS instance application pool by completing the following steps.
    1. Open Internet Information Services Manager (IIS), and navigate to the CMS instance's application pool.
    2. Right-click the application pool, and click Start.
      The CMS instance starts running.

Next Steps:

Note
When subsequent CMS 10.3–10.5 Oxygen Web Service updates become available, see Updating Oxygen Web Service for details to apply them.

Install the CMS 10.3–10.5 Connector in your Oxygen XML Editor authoring client(s).