Using the Tables Dialog Box
Tables and procedures enable you to create a database abstraction of host data.
Use the Tables dialog box to create tables and procedures for a Host Integrator
The Tables dialog box is divided into these areas, depending on whether you
are creating a table, procedure, or compound procedure:
Tables and Procedures Pane
The Tables and procedure pane is a tree-view of the model's tables and their
associated procedures. Click a table or procedure to display context-sensitive
information in the properties pane on the right-side of the dialog box.
- New—To create a new table or procedure using the Create
a new table or procedure dialog box.
- Copy—To create a new table or procedure based on one that you
have already created.
- Delete—To delete a table or procedure, select it
in the listing and then click Delete.
Table Properties Pane
When a table is selected in the Tables and procedures pane, you can view and
configure the following properties:
Specifies the name of the currently selected table.
Displays a description of the currently selected table.
Click the "plus sign" button on the right to add a new table column
or the "minus sign" button to delete the selected column. Then supply
a Name, Data Type, Key value, and Description for each column. Table columns
defined in the Tables dialog box are initially not associated with specific
procedures. For step-by-step instructions on creating table columns, see Defining
Set minimum and maximum values for a column; this is an optional setting.
Allow SQL SELECT statements to return a subset of columns when all columns
Select this option to have Host Integrator return a partial set of data to a
querying application. If you leave this check box clear, Host Integrator will
return an error to a querying application if it cannot return a full set of
When a procedure is selected in the Tables and procedures pane, you can view
and set these properties:
The name of the procedure.
- Home entity
The entity where the procedure begins. If the Navigate
back to starting point upon completion option is selected, the procedure
will also navigate back to this entity upon completion. Note: Models
also define a home
entity, but this does not affect a procedure's home entity.
Specifies the procedure's type. Choose to create one of these types of
- SELECT—To retrieve data from host applications.
- UPDATE—To modify data in host applications. To use
an UPDATE procedure, there must already be data associated with the host record.
If there is no data in any of the specified attributes or recordset fields
you are writing to, use an INSERT procedure.
- INSERT—To add a new record to a host application.
- DELETE—To delete an entire record from a host application.
Set these parameters for the type of procedure you are creating.
- Filter parameters
The Filter parameters list shows all table columns currently defined.
Columns that are checked are defined as input parameters for the current procedure;
they identify values that are to be passed in by the client application. If
the Req box is checked, all queries against this procedure MUST contain
this parameter or Host Integrator will return an error. The Status for a selected
column can be Mapped (if the parameter is mapped to an entity attribute, recordset
field, or another parameter) or Unmapped. Use the Procedure Editor or the
Procedure Wizard to map parameters.
- Output parameters
The Output parameters list shows all table columns currently defined.
Columns that are checked are defined as output parameters for the current
procedure. The Status for a selected column can be Mapped (if the parameter
is mapped to an entity attribute, recordset field, or another parameter) or
Unmapped. Use the Procedure Editor or the Procedure Wizard to map parameters.
- Data parameters
The Data parameters list specifies what data is to be inserted
or updated on the host during the procedure. Only those attributes that are
selected (checked) can be updated. If the Req box is checked, all queries
MUST contain this parameter or the Host Integrator will return an error.
Available for SQL queries
If this option is selected, the procedure is available for Host Integrator
to fulfill SQL queries. If this option is not selected, the procedure is only
available using the PerformTableProcedure method.
- Navigate back to starting point upon completion
If this option is selected, the procedure returns to its home entity upon
completion. This gives you greater flexibility in creating
sequences of procedures, but also increases the difficulty of assuring that
Host Integrator is able to navigate from where one procedure ends off to where
- Procedure Editor—To open the procedure in the Procedure
- Advanced Properties—To add an event handler or a
description to the procedure.
- Advanced—To do parameter
to parameter mapping; only available for SELECT procedures.
Compound Procedure Properties
A compound procedure is a procedure that consists of one or more SELECT subprocedures
and an UPDATE or a DELETE subprocedure. A compound procedure cannot contain
an INSERT procedure. By combining one or more subprocedure into a compound procedure,
you can perform more than one query level task at the same time, like selecting
several records and updating or deleting them. The order in which subprocedures
appear in a compound procedure is the order in which they are invoked. The first
subprocedure in a compound procedure must be a SELECT subprocedure.
When you select a compound procedure in the Tables and procedures pane, you
can view and set these properties:
The name of the compound procedure.
The compound procedure's description.
Specifies the compound procedure's type. The options are SELECT, UPDATE, and
This lists the compound procedure's subprocedures. The SELECT subprocedures
are listed in the Select subprocedures box, and the UPDATE or DELETE
subprocedure, if any, is listed in the Update/Delete procedure box. The
order the subprocedures are listed is the order they are invoked when the compound
procedure is run.
The first subprocedure in a compound procedure must be a SELECT subprocedure.
Any output parameters from a subprocedure are used as the filter or data parameters
for the next listed subprocedure .
- Filter parameters
The Filter parameters list specifies which attributes are valid in incoming
query requests. Only those attributes that are selected (checked) are valid.
If the Req box is checked, all queries MUST contain this attribute or
the Host Integrator will return an error.
The column on the right differs according to the procedure type:
- Update—The Data parameters list specifies which attributes
are updated on the host during the compound procedure. Only those attributes
that are selected (checked) can be updated. If the Req box is checked,
all queries MUST contain this parameter or the Host Integrator will return
- Select—The Output parameters list specifies where
the attribute is written from during the compound procedure. The Data
Source column indicates the subprocedure that includes the attribute.
- Delete—No additional information is required for this option.
Available for SQL queries
When you select this check box, you make this procedure available for the
Host Integrator to use to fulfill SQL queries. If you clear this check box,
this procedure will only be available using the PerformTableProcedure method.