Please enable JavaScript to view this site.

This directive allows you to "Include" the contents of previously defined parts containing any combination of Commands and Functions into an Apply Engine script. The #INCLUDE directive must be specified on a separate line, starting in column 1 and the file included can itself contain further levels of #INCLUDE directives. The most common use of the #INCLUDE directive is for re-using Procedures (Called PROCs) containing frequently used sequences of Commands and Functions that perform common mapping or business logic.  It is also highly recommended for creating a master Apply Engine script that includes multiple individual scripts.

Syntax

#INCLUDE[<path_name>/]<file_name>| DD:<ddname>[%nn %nn …];

 

Parameter Description

[<path_name>/]<file_name>| DD:<ddname>(<file_name>)

 

The path_name and file_name parameters are used on UNIX and Windows. They provide fully qualified name of the physical file where the object to be included resides.

The DD:<ddname> parameter is used in the z/OS environment. This represents the DDNAME of the file, included in the Parser JCL that references the physical file containing the object to be included

%nn

 

This is one (1) or more optional substitution variables that can be incorporated into the included file.

Example 1

Include a commonly used CURSOR in the script. The file will typically contain all The cursor Key and Result structures as well as the CREATE RDBMS CURSOR command required when Opening a Cursor.

#INCLUDE /ORACSR/<table_name>.csr;

 

When the Parser component is executed, the #INCLUDE directive merges the CREATE CURSOR command from lookup1.txt into the Apply Engine script.

Example 2

Include multiple Descriptions and a common PROC "check_char"  into a master Apply Engine script file.

#INCLUDE ./ORADDL/table1.ddl;

...

#INCLUDE ./ORADDL/table2.ddl;

...

#INCLUDE ./CDCPROC/checkchar.sqd;

 

When the Parser component is executed, the #INCLUDE directive merges the contents of the table1.ddl, table2.ddl and checkchar.sqd files at the positions specified by the #INCLUDE directive into a single Apply Engine script.

Example 3

Using example #2 above, utilize the #INCLUDE directive in the z/OS environment.

#INCLUDE DD:TABLE1;

...

#INCLUDE DD:TABLE2;

...

#INCLUDE DD:CDCPROC(CHECKCHAR);