This section describes each command in detail including their syntax, keyword and parameter descriptions. Examples are provided to illustrate the use of these commands in the heterogeneous environments typical of most implementation. While the examples are relatively simple, they also illustrate the use of the naming conventions described previously.
The following table summarizes the Apply Engine commands.
| Command | Type | Description |
|---|---|---|
| APPLY | Processing | Write to the target datastore. |
| AUTOMAP | Processing | Automatically map a source to an identical or nearly identical target description. |
| BEGIN | END GROUP | Data Definition | Create a "named" group of DESCRIPTIONS to simplify specification of DATASTORE. |
| COMMIT | Environment | Specifies the commit frequency for datastores that support commit operations. |
| CREATE RDBMS CURSOR | Data Definition | Defines a database "Cursor" providing granular control of the retrieval and update of single rows or sets of data in any supported Relational datastore. |
| CREATE PROC | Processing | Defines a called procedure (PROC) to perform mapping, business logic. |
| CREATE Function PROC | Processing | The difference is that these User Functions can be called from anywhere in the Apply Engine script to perform some sort of specialized processing that may be called from one or more of the usual Called Procs that process specific source CDC records. |
| DATASTORE | Data Definition | Describes the type, method of access, physical name and other characteristics for both source and target datastores. |
| DATEFORMAT | Field Specification | Specifies the date format for Oracle and DB2. |
| DECLARE | Field Specification | Declares a user-defined variable. |
| DESCRIPTION | Data Definition | Describes the logical/physical structure/layout of the data in a source or target datastore. |
| EXTTYPE | Field Specification | Specifies the semantic of the data in a source field. |
| GROUP BY | Field Specification | Groups source data records based on a source data field(s). |
| INITIALIZE | Field Specification | Initializes a target field to a constant value. |
| INVALID | Field Specification | Specifies the value to use in place of an invalid value of a numeric or character source field. |
| JOBNAME / Engine Name | Environment | Specifies a name for an Apply Engine instance. |
| LABEL | Field Specification | For XML structures, specifies the text string for a tag on an XML data record. |
| OPTIONS | Environment | Specify global script behavior options. |
| PROCESS INTO | Processing | Processes one or more target datastores based on the action specified for each datastore (Change or Insert) Options include inserting records that if they are unavailable for update. |
| RDBMS | Environment | Describes the connection information for a relational database (RDBMS). |
| REPLICATE | Processing | Automatically map the source description to an actual or implied target description and APPLY (write) to the Target datastore. |
| REPORT | Environment | Controls the file name and frequency of the Engine runtime report. |
| RETYPE | Field Specification | Changes the data type of a source field, overriding the defining data structure. |
| SELECT | Processing | Reads records for a source datastore. |
| UNION | Processing | Concatenates multiple SELECT commands allowing for multi-step scripts. |