Using the Procedure Editor

The Procedure Editor is used to define and modify procedures. Use the Procedure Editor to define the navigation path to the host data, define and map procedure parameters, add table columns, refine and synchronize recordset searches, and insert branching options and error handling entities.

The Procedure Editor is divided into three areas: the Icon Button Bar, the Procedure Diagram Pane, and the Settings Pane.

 

Icon Button Bar

The Icon Button Bar is used to add or delete entities, recordsets, error handling, and branching options to the procedure. You can validate the procedure and adjust the procedure's parameters. You can right-click an entity to insert or delete entities or recordsets, or view a snapshot of the entity.

Insert an entity into the procedure
Insert a branch into the procedure
Insert an error entity to handle error conditions
Insert an entity recordset that contains the data to be manipulated
Delete an entity, branch, recordset from the procedure. This does not effect the model.
Create a report listing any problems that would prevent the model from being deployed
Select columns as filter and output parameters, or add or delete columns to the procedure's table

 

Procedure Diagram Pane

The Procedure Diagram Pane is a visual representation of the entities, recordsets, branching, and navigation in a procedure. You can locate insertion points for entities and recordsets by clicking the diagram, as well as identifying elements to delete from a procedure. When you delete a recordset or entity from the procedure diagram, it is not deleted from the model.

Settings Pane

Use the Settings Pane to map entity attributes and recordset fields, set record and synchronization actions, and review errors that occur as you define a procedure.

The Settings Pane displays different settings tabs depending on whether you have selected an entity, recordset, or navigation link in the Procedure Diagram Pane. Use the following information to work with the different Settings Pane tabs. The Settings Pane contains these tabs:

 

Data Exchange Tab

Use the Data Exchange tab to map the entity attributes or recordset fields to procedure parameters and to add columns to the table. The left portion of the tab is used to map parameters using drop down lists, while the right portion of the tab maps parameters using action buttons.

Mapping Parameters Using Drop Down Lists

Attribute/Field list
This list shows either all the attributes of the selected entity or all the fields of the selected recordset as defined in the Design Tool. These may or may not be columns in the table. An attribute or field used in your procedure must be mapped to a column in the table. Click the Use as Filter, Use as Output, or Use as Data buttons to automatically add any attributes or fields as a table column.

Update attribute/field from parameter
Use this column to set filters and add or update data. A parameter value from the procedure is written to the attribute or field and is used to select, update, or delete data. Click the drop down box and select the parameter to map to the attribute or field.

Write attribute/field to parameter
Use this column to return information from the host application. Attribute or field values are written to the selected procedure parameter in order that these can be used by the application that calls the procedure. Click the drop down box and select the parameter to map to the attribute or field.

To map the entity attribute or recordset field to multiple output parameters, select Advanced from the list to display the Advanced Attribute Mapping dialog box.

Note: The list of available filter and output parameters is derived from the parameters that you selected in the Tables dialog box. If the filter or output parameter you want is not available in the list, use the Icon Button Bar to open the Edit Table Columns dialog box and designate those you wish to use.

 

Mapping Parameters Using Action Buttons

Use the action buttons to map the attribute or field to a procedure parameter of the same name. If the attribute or field is not a column in the table, it is displayed in the New table columns pane and will be added to the table automatically. The new table column will have the same name as the attribute or field. If an attribute or field has been previously mapped to a parameter, the action you take here will override the previous mapping.

Use the [Ctrl] or [Shift] key to select a group of attributes or fields, and then click the action button to map the entire group as either filters, outputs, or data.

Table Column Options

The Data Exchange tab is also used to add new columns to your table.

 

Errors Tab

The Errors tab displays any errors in the procedure's entity, recordset, or navigation operation that is currently selected. These messages are also displayed in the validation report created using the Validation button on the Button Bar.

 

Recordset Tab - Record

Use the Recordset tab to define how Host Integrator retrieves data from recordsets. Host Integrator can return only the records that satisfy all the comparison mappings.

 

Record Filtering

The Record filter section defines how the procedure compares filter parameters to recordset fields. Use the Procedure Editor to compare filter parameters to recordset fields. It contains the following columns:

The list of available filter parameters is derived from the parameters you selected in the Filter parameters box in the Table Editor. If the filter parameter you want to write data to is not available in the list, use the Icon Button Bar to open the Edit Table Columns dialog box and designate those columns you wish to use.

When the procedure runs, the parameter is compared to the data retrieved from the recordset; only the data matching all the comparison filters is returned to the querying application.

 

Recordset Tab - Synchronization

Use the Recordset Synchronization tab to define how the procedure remains synchronized with the recordset. How you synchronize with a recordset depends on the behavior of your host application. If the application navigates away from a recordset to perform an operation, you need to define how to return to the correct location in the recordset. You have the following synchronization options:


Error Entity Tab

Use the Error Entity tab to configure Host Integrator to return an error string or the contents of an attribute if the procedure encounters an error in the form of the defined error entity.

 

Operation/Navigation Tab

If you have selected a static navigation path in the Procedure Diagram Pane, the Operation tab provides:


 

Related Topics
Bullet Procedures overview
Bullet Creating procedures
Bullet Operation Tab
Bullet Tables overview