Checking In DITA Assets

Prerequisites: Users must have permissions to check in and out assets in the CMS Assets Manager. See Creating Groups for details to set permissions.

After completing edits, users can check in the document asset to the CMS Assets Manager. The Check In action creates a new version of the document asset that includes the changes made during the check-out session.

To check in a CMS DITA document asset via the Oxygen XML Editor plugin:

  1. Open the Oxygen XML Editor application.
  2. Navigate to a checked-out document asset within the Ingeniux CMS Browser tab tree structure.

    Note: An unlock icon displays next to checked-out document assets assigned to you in the Ingeniux CMS Browser tab. If you hover over a checked-out document asset, the tooltip text displays Checked Out and assigned to [name-of-operating-cms-user].

  3. To check in the document asset, choose one of the following steps:
    • Right-click the document asset in the Ingeniux CMS Browser tab, and click Check In (or press CTRL+Shift+I).

      Check In via Ingeniux CMS Browser Tab

    • Double-click the document asset in the Ingeniux CMS Browser tab to display the asset in the main pane Editor. Click Check In in the toolbar (or press CTRL+Alt+I).

      Check In via Toolbar

    The Check In dialog displays.

  4. Optional: Enter comments about the document asset in the text field. The CMS Assets Manager UI displays these comments in the Notes field of the document asset's Overview tab.

    Check In Document in CMS Dialog

  5. Click Check In. The system checks in the new document asset version to the CMS, and, depending on the Close Editor After Check In / Undo Check Out checkbox setting, the asset remains open or closes in Oxygen XML Editor's main pane. The document asset's checked-out (unlock) icon switches to the checked-in (page) icon in the Ingeniux CMS Browser tab.

Additional Information:

When operating users open a checked-in document asset in the Oxygen Desktop Plugin, the asset displays in read-only mode.