Open topic with navigation

Adding or Editing a Tool

To add or configure (edit) a tool:

  1. Choose the menu command Tools > Local Commands > Configure.

  2. In the Configure Tools window:

    • Click New if you are adding a tool, or

    • Select an existing tool and click Edit.

  3. ClosedIn the Tool window, set options for command line parameters to be used for the program, described below:

    Tool Configuration Options

    Option

    Description

    Name

    User-friendly name for this tool.

    Program

    Path to the executable file.

    Working Directory

    Default location assumed for arguments to the command.

    For example, to create a command (for example, delete <file>.ast) that acts on a file type that always resides in the same directory, specify the location here to save users from having to provide the full path to the file each time they use the command.

    Icon

    Path to the icon image file used to represent the tool.

    Program Parameters

    Provide any parameters needed for the command.

    You can enter parameters in the field, or click the button to get a pull-out menu where you can select Event Attributes to use as parameters, or add the selected cell or selected row as parameters to the command.

    Show in toolbar

    When Show in toolbar is on, the tool icon is shown in the Console toolbar. By default, this option is selected.

    Use with data export

    The purpose of this option is to separate tools that are run against events in channels and tools used as a destinations for event export.

    By default, this option is not selected (off).

    If this tool is to be used as a destination for event export, select Use with data export.

    If this tool contains a command that will run against events in a channel, leave Use with data export off.

  4. Name, Program, Working Directory, Icon, and Program Parameters (command line parameters to be used for the program) are text fields. Also select whether you an the tool to show in the toolbar

  5. Click OK, then Done.

To delete a tool:

  1. Choose menu command Tools >Local Commands > Configure.

  2. In the Configure Tools window, select an existing tool and click Delete.

  3. In the dialog box, click Yes.

  4. Click Done.