Documentation Center

Defining a Tool for an Object and assigning it to a Tool Box

You define a Tool for an Object, and then you assign it to a Tool Box.

Procedure

  1. Start the Contenta Administration Tool, pcmadmin, in singleuser mode (see Executing the Administration Tool).
  2. Access the Tools For Object window for the Object you want to associate with the new Tool (see Accessing the Tools for Object Window ).
  3. Click New to access the New Tool for Object window.
  4. Complete the fields as described in the following table:
    FieldDescription
    Menu Label

    Enter a name for Tool (maximum 30 characters; first character must be alphanumeric, characters following can be alphanumeric, underscore or space).

    Tools are displayed alphabetically on the Tools and Content menus, and on the Toolbar —the name entered in this field affects where the Tool appears on the menu and on the Toolbar.

    Tools with the same menu label appear once on the Tools menu even if they have different command line entries.

    If you are modifying a Tool definition, you cannot edit this field.

    Description

    Brief description of the Tool (maximum 30 characters).

    This description appears in the Define Tool Box for Role window, make the description clear and concise.

    The first character of the description must be an alphabetic character.

    If you are modifying a Tool definition, you cannot edit this field.

    Characters after the first character may be alphanumeric, an underscore (_), or a space.

    Tool Type

    Tool Class.

    Default is Client Tool.

    Click the ellipses button to select from the list of Tool Types.

    The Tool Type you select has an affect on the other fields in this window. For example, if you select Client Tool, the Web fields are not active.

    See Tool Class for additional information, or to add Tool Types.

    Toolbar Icon Name

    This field is optional and is not available for Creation and System Tools.

    This field is applicable if Show on Toolbar is Yes. A default icon is used if no icon name is specified in this field.

    If specifying a custom icon:
    • The icon file must be stored in the Contenta_home > icons directory.
    • The icon must be a bitmap with a.bmp file extension.
    • The icon’s file name must begin with tl_ .
    • The icon’s file name cannot contain a space, carriage return, new line, or the following symbols:
      " $ % * . / : ; < > @ \ | .
    • Specify the icon’s file name without the .bmp file extension. Contenta assumes, and appends.bmp as the file extension.

    When the user rolls the mouse over the icon on the Toolbar, the Tool type and name is displayed in a Tooltip and in the status bar.

    Show on ToolbarThis field is not available for Creation and System Tools.

    Default is No.

    Specify Yes if you want the Tool to be displayed on the context menu (the menu displayed when you right-click on an Object) and on the Toolbar.

    This field does not affect the tool display on the Tools menu. Tools assigned to an Object are listed on the Tools menu when the Object is selected; it is active if the user has permission to use it.

    The icon displayed for the Tool is specified in the Toolbar Icon Name field. If no icon name is specified, a default icon appears.
    OS Platforms

    Default is ANY.

    Click the ellipses button to select from the list of OS Platforms.

    See Tool Platform for additional information, or to add OS Platforms.

    Applications

    Default is ANY.

    Click the ellipses button to select from the list of Contenta Applications. Delivered Platforms are:
    ANY
    CE (Contenta Explorer)
    CW (Contenta Web)

    See Tool Applications for additional information, or to add Contenta Applications.

    Web Browsers

    Only available when Tool Type is a web-enabled Tool Class such as Web Tool or customer-defined Tool Class with Web Tool set to Yes.

    Default is ANY.

    Click the ellipses button to select from the list of Web Browsers. Delivered browsers are:
    ANY
    IE (Internet Explorer)
    Netscape

    See Tool Web Browsers for additional information, or to add Web Browsers.

    Web Platforms

    Only available when Tool Type is a web-enabled Tool Class such as Web Tool or customer-defined Tool Class with Web Tool set to Yes.

    Default is ANY.

    Click the ellipses button to select from the list of Web Platforms.

    See Tool Web Platforms for additional information, or to add Web Platforms

    Web Servers

    Only available when Tool Type is a web-enabled Tool Class such as Web Tool or customer-defined Tool Class with Web Tool set to Yes.

    Default is ANY.

    Click the ellipses button to select from the list of Web Platforms. Delivered browsers are:

    IIS

    IPLANET

    NETSCAPE

    TOMCAT

    See Tool Web Servers for additional information, or to add Web Severs.

    Command Line

    Enter the command line to be executed when the user selects the menu option.

    See Sample Tool by Object Report.

    See Defining the Editor Tools for information about the command line syntax to add the XMetaL, FrameMaker, or Arbortext Editor Tools.

  5. After editing the fields, click Createhe Assign Tool Boxes window appears.
    The title bar shows the name of the Object and the name of the new Tool.
  6. Assign the new Tool to one or more Tool Boxes.

    The Assign Tool Boxes window contains the following two lists:

    • The Available Tool Boxes list shows Tool Boxes in which you can place the new Tool.

    • The Selected Tool Boxes list shows the Tool Boxes already containing the new Tool.

    To place the new Tool in a Tool Box, select an entry in the Available Tool Boxes list, and then click Add or double-click on an entry in the Available Tool Boxes list.

    To remove the Tool from a Tool Box, select an entry in the Selected Tool Boxes list, then click Remove or double-click on an entry in the Selected Tool Boxes list.

  7. To save your changes, click Save.
    The Assign Tool to Object window appears.
  8. Assign the new Tool to additional Objects.
    The Assign Tool to Object window contains the following two lists:
    • Available Objects lists Objects to which you can assign the new Tool.
    • Selected Objects lists Objects to which the Tool is already assigned.

    To assign the Tool to an Object, select an entry in the Available Objects list, and then click Add or double-click an entry in the Available Objects list.

    To remove a Tool from an Object, select an entry in the Selected Objects list, and then click Delete or double-click on an entry in the Selected Objects list

  9. Click Save to save your changes.
    The Tools For Object window updates.
  10. To exit the Tools For Object window, click Close.
  11. To exit the Object Definition window, click Save.