Specifying custom adapter modules in AppData

Update AppData through Contenta Explorer to specify the custom adapter modules that you want to use.

Procedure

  1. In the Contenta Explorer application select: Tools > Options
  2. Click the Tools Preferences tab in the resulting dialog box display.
  3. Select Global.
  4. If the key Document Types is listed, skip to the next step. If it is not listed, add it by clicking Insert Key then enter Document Types.
  5. Select Document Types then click Insert Key.
  6. Enter the document type data that is in the property sheet field, Document Type.
    This is case-sensitive; use the same case and spelling that is in the property sheet field for the object on which the users will execute the tool.
  7. Select the new key (Document Type) and enter the key for the executable file.
    For example, XmEdit.exe or for Contenta Web , enter the tool name that appears in the tools list.
  8. Select the key from the previous step then click Insert Value.
  9. In the Value Name field, enter appropriately, either GetDoc or PutDoc.
  10. In the Value Data field enter the name of your custom module.
    Entering the filename extension .pm is optional.

Example

For example:
UserKeyValue NameValue Data
{Global}\Document Types\Book\XmEdit.exeGetDocCustomGetDocXmBook
{Global}\Document Types\Book\XmEdit.exePutDocCustomPutDocXmBook
{Global}\Document Types\Military\XmEdit.exeGetDocCustomGetDocXmMil
{Global}\Document Types\Military\XmEdit.exePutDocCustomPutDocXmMil
{Global}\Document Types\Book\XmEdit2.exeGetDocCustomGetDocXmBk2
{Global}\Document Types\Book\XmEdit2.exePutDocCustomPutDocXmBk2
{Global}\Document Types\Book\Epic Check OutGetDocCustomGetDocXmBook
{Global}\Document Types\Book\Epic Check InPutDocCustomPutDocXmBook

The last two entries in the example specify that the Web client tools Arbortext Editor Check Out and Check In, when invoked on an object whose Document Type property sheet field contains the value Book, should use the custom adapters CustomGetDocXmBook and CustomPutDocXmBook respectively.

For example:
The names of the tools that are used in the entries are the tool names that are listed in the Tools list in Contenta Web . These tool names are derived from the Menu Label field in pcmadmin for each tool. The Key column (as shown above) is comprised of the following three fields:
  • 1st is always Document Types
  • 2nd is a doctype such as Book, memo, report, docbook, and so on.
  • 3rd, for Contenta Explorer , it is the exact filename of the tool launched from the command line or from Contenta Explorer . For Contenta Web , it is the tool name that the user selects to invoke the tool. This tool makes API calls GetDocPerl() or PutDocPerl() for example:
    • Contenta Explorer : EpicEdit.pl, EpicCheckout.pl, EpicCheckin.pl, xmedit.exe, xmcheckout.exe, xmcheckin.pl, frameedit.pl, framecheckout.exe, framecheckin.pl
    • Contenta Web : Arbortext Editor Check Out, Arbortext Editor Check In