Add advanced customizations to your framework extension

You can integrate other customizations such as using Schematron or forms in Oxygen Web Author. This procedure shows how to create and upload a copy of the IXIASOFT framework and your framework extension, so you can customize your installation of Oxygen XML Editor.

Before you can customize your framework extension, you must set up the following:

  • Oxygen XML Editor
  • A copy of the IXIASOFT framework
  • Your framework extension

Once set up, you can use the Oxygen Web Author Customization Guide to make the changes you want.

Important: Making changes directly to the IXIASOFT framework and integrating plugins for Oxygen XML Web Author is not supported. The IXIASOFT framework may be overwritten during updates and upgrades.
  1. To save and test your framework, create a folder on your local disk.
    For example, create a folder called Frameworks.

    The framework extension is created during the installation of IXIA CCMS Web. It should be saved in a safe location, such as with your backups of the Content Store..

  2. Get the IXIASOFT framework and the framework extension template:
    1. Go to the 7.0 area of the MadCap Software Downloads site:
      https://cms.ixiasoft.com/downloads/CCMS_7.0/
    2. Click the Oxygen_Framework_Templates folder.
    3. Download MadCap Software's Oxygen Framework files.
      These files are referred to by the framework extension template.
    4. Extract the zip file to the local drive.
      For example, to your Frameworks folder.
    5. If you do not already have a custom framework, download the FrameworkExtensionTemplate-version.zip.
  3. Paste the zip file into the folder you created.
    For example, copy OxygenFramework-Ixiasoft-version.zip into the Frameworks folder.
  4. Unzip the files.
  5. Open Oxygen XML Editor.
  6. Add the location of the frameworks to the Preferences dialog box.
    Note: The procedure for adding the location depends on the Oxygen XML Editor you are using.
    1. Navigate to the area where you can select your framework:
      Standalone Oxygen XML Editor
      • In the main menu, open Options > Preferences.
      • In the left pane, open Document Type Association > Locations.
      • Click Add.
      Oxygen XML Editor in IXIA CCMS Desktop
      • In the main menu, open Window > Preferences.
      • In the left pane, open oXygen XML Editor > Document Type Association.
      • Click the Change frameworks (Document Type Associations) directory location link.
      • Click New.
    2. Select the folder containing the IXIASOFT framework and your framework extension (for example, the Frameworks folder).
    3. If required, click Apply.
    4. In the left pane, click Document Type Association.
      You should see the two frameworks listed. If you do not, close and reopen Oxygen XML Editor.
    5. Double-click your framework extension (for example, dita-company).
  7. Create the desired customizations in the dita-company folder.

    Do not edit the files in OxygenFramework-Ixiasoft-1.X-version.

    Details on how to customize a framework extension are provided in the Oxygen Web Author Customization Guide available on the Oxygen XML Web Author website (https://www.oxygenxml.com/doc/versions/21.0.0/ug-waCustom/).

    Note: Isolating customizations is a best practice to facilitate future upgrades and updates.
  8. Zip your customization folder to dita-company.zip
  9. Upload the dita-company.zip into CCMS Web.