Workbench 0.18 User Guide

Guest Tools

General Guidance

Add a Tool

Adding a tool starts by clicking on the Add/Edit Tool Icon in the top left corner of the Toolbox pane.  This will open the Tools dialogue box.

Add a tool

Click on the row marked Click here to add a new item.

Tool details dialogue.

A Tool Details dialogue will appear; complete this as follows:

Name:

The name you wish to call this tool.  This name will appear when you hover over the tool icon.

Description:

A description of the tool.  This description will appear when you hover over the icon.

Path:

The path to the executable for the tool.  You can browse to the executable by clicking on the button that follows the entry field.

Extension(s):

The file extensions that define the file types supported by this tool.  This can be a list with the entries separated by a semicolon.  The types specified here should be those directly supported by the tool.  Don’t define transformed types here as Workbench will interpret this as meaning the tool directly supports the file format and so will not run the desired Transformer.

Icon:

The default icon will appear here once the path is set.  You can browse and select any GIF, PNG or JPEG to replace the default.

Each tool must have at least one Tool Usage Profile.  These are added using the Profiles area of the Tools dialogue.  The Profile area includes two buttons; one with a small yellow star that is used for new profiles, and one with a blue pencil which is used to edit existing profiles.

Tool profile list

Click on the button with a yellow star to initiate the profile dialogue.  If we define multiple profiles for a tool, when we click on a tool to use it a prompt will appear so that we can select the desired profile.  All options will have the same icon but the name under each will be the name we define here in the Name field.

Tool usage profile dialogue.

Set a name for this profile in the Name field.

Add a Description of the profile for future reference.

Enter the command line parameters needed by the tool into the Arguments field.  Don’t include the executable as you have already defined this in the Tool Path field.  Where you require Workbench to provide variable data, enter a variable reference such as %1 or %2.  

The variables you define are replaced by Workbench at run time with the values defined by the Variables dialogue.  The variable types are detailed in the next section.

Click on the red X next to an argument to delete its definition.  If you want to remove the argument completely, remember to remove its definition in the Arguments field.

Click Save to save the Tool Usage profile.

Click Save again to save the tool definition and then close the tool dialogue box.  The new tool is now ready for use.

Edit a Tool Definition

Editing a tool starts by clicking on the Add/Edit Tool icon in the top left corner of the Toolbox pane.  This will open the Tools dialogue box.  Click on the edit hotlink next to the tool to be edited to bring up the Tool Details dialogue box in edit mode.

Editing a tool.

Tool Details are as described above.

Click the Save button to save the changes at any time.

Editing a tool profile.

Tool Profiles can be edited in the following way: 

  • Click on the Profile to highlight it with a dark blue background
  • Click on the blue pencil icon
  • Make the changes required
  • Click Save to return to the Tools dialogue
  • Click Save again to save all changes

For details of the meanings of the fields in the Tool Usage Profile see Add a Tool above.