Procedure window

One Procedure window is displayed for each procedure you open for editing. In a Procedure window, you can:

create and edit a procedure
insert a script outline into a procedure (click Insert Outline on the toolbar)
test a procedure against a project source (enter the connection and input information in the Test Information tab, then click Execute on the toolbar)

The Procedure window has three panes.

The editing (upper) pane contains three tabs:

The Code Editor tab contains the procedure itself, with the lines automatically numbered down the left side. You can enter Command Manager script statements, modify existing statements, or insert statements from outlines.
The Sample Editor tab contains an example of how to use the procedure.
The Outline Editor tab displays an outline of the procedure. This outline is automatically generated from the information in the Properties tab in the details pane.

The status (lower) pane displays the results, status messages, and error messages of submitted scripts. It includes:

Results: Displays results associated with the current command script.
Messages: Displays the status of the current command script, and the time it took the script to execute.

The details (right) pane contains two tabs:

The Properties tab contains information about the procedure, in the following fields:

Name: The name of the procedure. This name is used as the filename when you save the procedure.
Version: The version number of the procedure.
Description: A description of what the procedure does.
Classpath: Any additional class files used in the procedure.
Inputs: Any parameters passed to the procedure as inputs. For example, if you have a procedure to create a user, the name of the user to be created might be passed in as an input.
Click to create a new input in the Inputs list. Click in the Name column of an input to change the name of an input. Click the Type drop-down list to change the type of input, such as String or Integer.
Click to delete an input.

The Test Information tab contains information used when you test the procedure. For more information, see Testing a procedure against a project source.

In the Connection Information area, you can configure a connection to a project source to test your procedure. Select a project source from the Project Source drop-down list, and enter a login and password in the Login ID and Password fields. Click the Connect button to connect this Procedure window to the specified project source.
In the Test Inputs area, you can enter test values for each of the inputs specified in the Properties tab. When you execute the procedure directly (by selecting Execute from the Connection menu), these values are used.

At the bottom of the Procedure window is a status bar with four sections:

The first (left-most) section displays information about the execution status of the most recently executed procedure.
The second section displays the amount of time the most recently executed procedure required to complete execution. If a procedure is currently executing, this section keeps a count of how long the procedure has been running.
The third section displays the username and metadata source to which this Procedure window is connected.
The fourth (right-most) section displays the location of the cursor (row and column) in the procedure.

Related Topics