Documentation Center

How the Checkout Tool Works

When the user executes the FrameBookCheckout tool:

  • The tool attempts to lock the object(s) prior to exporting it to the checkout directory. If the object(s) were previously locked or otherwise not modifiable, the tool cannot lock the object and exports the data as read-only.
  • The tool exports FmBook object into a FrameMaker book (.book) file and FMDoc objects into FrameMaker chapter (.fm) files.

    They are exported into a new directory under the Contenta checkout directory. The new directory is created using the naming convention:

    Contenta_object_name#object_ID#configuration_object_ID_n

    where _n is a number which increments by one for each existing exported copy of the given object. That is, if the object is checked-out more than once before it is checked-in, a new directory is created with an incremental number.

    Troubleshooting tip: The FrameMaker application allows you to modify any data that is checked-out but know that you cannot check-in read-only data/files.

  • When exporting FmBook objects, the tool scans the FmDoc objects for the names of the graphics and looks for them in the Graphics container. When the graphic is located, the graphic object is locked and the data is also exported into the checkout directory. The graphic is exported with the appropriate filename extension. (Only graphics that are referenced in the document are exported.)

    Example

  • The tool creates an EntIdMap file and stores it in the checkout directory. The EntIdMap file keeps track of all modifications to the exported files. See How the Checkout Tool Works.
  • The files are opened in the FrameMaker application.