MacOS: Installing CMS 10.6 Oxygen Desktop Plugin with Web Launcher

Prerequisites

• System administrators must install Ingeniux CMS 10.6 and have access to the CMS site instance file system.
• Administrators must navigate to Administration > DITA and provide the a/IDs of the DITA Root Folder and DTD Folder within the DITA Content Location area.
• System administrators must have access to the OxygenWebService.zip compatible with CMS 10.6.
• System administrators must install the latest version of the Oxygen Web Service .dll file for CMS 10.6. See Updating Oxygen Web Service for details.

• For users to access templates, CMS administrators must create a folder called Templates in the CMS Assets Manager, and then define the folder ID in the plugin's Web.config.

  Create the Templates 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.

Steps

To install the OxygenWebService.zip package for CMS 10.6:

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

2. Access the CMS 10.6 OxygenWebService.zip package on your file system.
3. Extract the contents from OxygenWebSevice.zip to the Custom folder within your Ingeniux CMS installation (e.g., [Drive:]\[path-to-cms-site-instance]\App_Data\xml\Custom\OxygenWebService\).

4. Configure Web.config via the following steps.

   Important

   You can skip configuring Web.config. However, if you plan to use customized Oxygen Desktop Plugin settings, then modify the applicable keys.

   1. In the OxygenWebService folder, open Web.config in a text editor.
   2. Provide the appropriate values for the following keys:
      OxygenWebService Web.config

      <?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="ingeniux" />
          <add key="user" value="admin" />
          <add key="lockdown" value="false"/>
          <add key="rootFolderId" value="af/3" />
          <add key="ditaSchema" value="DITA Content" />
          <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="treeChildrenPageSize" value="40"/>
          <add key="allowDelete" value="false"/>
          <add key="contentTitleXpath" value=""/>
          <add key="pluginsFolderId" value="" />
          <add key="customTemplatesOnly" value="true|false"/>
          <add key="prodModeErrorReport" value="false"/>
        </appSettings>
        ... 
                        
      </configuration>

      Key Name	Description
      user	The user defined for this key will be a fallback account for operations related to the web service.
      rootFolderId	The a/ID of the CMS root folder where your DITA assets reside. Instead of configuring this value here, configure the DITA Root Folder within Administration > DITA (see prerequisite). Web Launcher automatically retrieves the folder information from the CMS UI.
      templatesFolderId	Enter the af/ID value. Provide the ID of the CMS root folder where your custom template assets reside (see prerequisite).
      dtdRootId (optional)	The a/ID of the DTD folder where your document type definitions (DTDs) will reside. Instead of configuring this value here, configure the DTD Folder within Administration > DITA (see prerequisite). Web Launcher automatically retrieves the folder information from the CMS UI.
      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 25\jre\bin).
      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.
      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.
      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.
      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.
      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.

   3. Save and close Web.config.
5. 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.

To install the Ingeniux CMS Connector add-on for the Oxygen Desktop Plugin:

1. Open the Oxygen XML Web Editor application.

2. Navigate to Help > Install new add-ons... in the Oxygen XML Editor toolbar.

   

   The Install new add-ons dialog displays.

   

3. Copy and paste the following URL in the Show add-ons from field:

   https://oxygenplugindev.ingeniux.com/plugins/pluginfeed.xml

   The Ingeniux CMS Connector add-on displays in the list.

   

4. Select the Ingeniux CMS Connector add-on, and select Next.

5. If a Security confirmation message displays, select Allow or Allow and remember to grant the system permission to connect with the host URL.

   Tip

   We recommend selecting Allow and remember. This way, you only have to grant permissions once and not for each subsequent version update.

6. Accept the license agreements in the License and Signature tabs by selecting the I accept all terms of the end user license agreements checkbox.

   

7. Select Install.

   The add-on installs to your system, and the Add-ons dialog displays.

8. Select OK, and restart the Oxygen XML Editor application to apply the add-on install changes.

   The UI now displays the following:

   • new options (i.e., the Check Out, Check In, and Insert Topic Reference buttons) in the application's toolbar.

     

   • the Ingeniux CMS pane.
   • the Ingeniux DITA References pane.