Documentation Center

Checking out a module for editing: short-term checkout/checkin in the editor

This task explains how to check out a module (short-term) for editing in the Arbortext or Oxygen XML editor.

Before you begin

Contenta Web clients only:
  • Contenta editor extension for the Arbortext Editor must be installed.
  • If using Arbortext Editor, the Contenta S1000D Arbortext Editor plug-in must be installed.
  • In the top banner of your desktop, click Preferences to specify a path to your checkout directory.

Contenta Web clients only: Contenta Web clients that have an Arbortext or Oxygen editor installed support both long-term and short-term editing cycles. Only long-term checkout is available when an editor is not installed on the Contenta Web client.

If the editor is not installed on your client, see Checking out a module for editing long term.

About this task

With short-term checkout and checkin, the module is exported to the checkout directory where you edit it in the editor. When you close the document in the editor, you are presented with the available checkin options.

If the module you check out contains references to other modules, the referenced objects are not checked out at the same time.

Procedure

  1. In Contenta S1000D, navigate to the DM, PM, or SCPM that you want to edit.
  2. Select Tools, then select Arbortext or Oxygen.
  3. If your module contains graphics, you may be asked if you want to export them. Respond as you deem appropriate. See Exporting and displaying graphics when you check out a module.
  4. When prompted by the browser, save or open the XML file. If you saved the file to a folder on your disk, navigate to the XML file location and open the module in the editor.
  5. Edit and save the module in the XML editor.
  6. Close the module in the editor.
  7. Contenta Explorer clients only: When prompted Do you want to check in this document? click Yes or No.
    If you clicked Yes, click OK to acknowledge the Document is checked in successfully message.

    If you clicked No, click OK to acknowledge the Object unlocked successfully message.

    Skip the remaining steps in this procedure when using Contenta Explorer.

    The remaining steps in this procedure apply only to Contenta Web clients.

  8. If you did not make any edits, you are prompted: The document was not modified. Do you want to undo checkout?
    If you click Yes, the module is not checked in to Contenta S1000D, and the lock is removed. Click OK to acknowledge the Object unlocked successfully message.

    If you click No, nothing changes: The module remains in your checkout directory on the file system and it is locked in Contenta.

  9. If you made edits, you are prompted if you want to Check in this document, Save this document and check it in later, or Discard edits and undo checkout.
    If you click Check in this document, the module is checked in to Contenta, the lock is removed, and the checkout directory is removed when possible. Click OK to acknowledge the Document is checked in successfully message.

    If you click Save this document and check it in later, your module is saved in the checkout directory. Manually open the editor to continue editing this module. The next time you save and exit, your web session may have timed out. If timed-out, Contenta prompts for your credentials.

    If you click Discard edits and undo checkout, the module is not checked in to Contenta, and the lock is removed. Click OK to acknowledge the Object unlocked successfully message.

  10. If you see a Delete: remove_file path-of-checkout-directory: permission denied error, click OK to acknowledge the message.

    This error may occur when it is not possible to remove the checkout directory on the client. For example, this directory cannot be removed if a user navigates to it, to open the editor then subsequently selects either Check in this document or Discard edits and undo checkout.

    Files to be deleted must be moved out of the document checkout directory before the directory can be removed. These files are moved to a folder named S1000D_MarkedForDelete, located directly under the main checkout directory.
  11. Click Exit in the checkout browser window to close the window after saving or opening the document. The window does not close automatically.