Checking out a module for editing: short-term checkout/checkin using Arbortext Editor

This task explains how to check out a module (short-term) for editing in Arbortext Editor.

Before you begin

SDL Contenta Web clients only: The Contenta Editor Extensions and the Contenta S1000D Arbortext Editor plug-in must be installed on your client.

SDL Contenta Web clients only: In the top banner of your desktop, click Preferences to specify a path to your checkout directory.

SDL Contenta Web clients only: SDL Contenta Web clients that have Arbortext Editor installed on them support both long-term and short-term editing cycles. A long-term checkout is required when Arbortext Editor is not installed on your SDL Contenta Web client.

If Arbortext 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 Arbortext Editor. When you close the document in Arbortext, 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 SDL Contenta S1000D, navigate to the DM, PM, or SCPM that you want to edit.
  2. Click Tools, then click Arbortext.
  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.
    In most cases, Arbortext Editor launches automatically and you can skip the next step.
  4. If Arbortext did not launch automatically (for example, Arbortext Editor is not installed on your SDL Contenta Web client, or the launchArbortext AppData setting is set to no): From your checkout directory, open the module in Arbortext Editor.
  5. Edit the module in Arbortext then save it.
  6. Close the module in Arbortext.
  7. SDL 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 SDL Contenta Explorer.

    The remaining steps in this procedure apply only to SDL 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 SDL 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 SDL 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 SDL 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 Arbortext Editor to continue editing this module. The next time you save and exit, your web session may have timed out. If timed-out, SDL Contenta prompts for your credentials.

    If you click Discard edits and undo checkout, the module is not checked in to SDL 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 Arbortext 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.