Create CICS ILE C object (CRTCICSC)

The Create CICS C (CRTCICSC) command calls the CICS translator, which translates C source containing CICS statements and produces a temporary source member. If the source program also contains Structured Query Language (SQL) commands, it optionally calls the SQL precompiler following a successful CICS translate. Following the CICS translation and the optional SQL precompilation, the ILE C compiler may optionally be called to compile the source.

Note: It is possible to precompile your SQL statements first by running the CRTSQLCI command and specifying the *NOGEN option on the OPTION parameter. This puts the SQL precompiler output in QSQLTEMP in library QTEMP. You must then run the CRTCICSC command specifying SRCFILE as QTEMP/QSQLTEMP; the SRCMBR name can be obtained by looking in this file for your SQL precompiled program source. The rest of the parameters on CRTCICSC can be entered as normal.

Parameters

Keyword	Description	Choices	Notes
OBJ	Object	Qualified object name	Required, Positional 1
	Qualifier 1: Object	Name
	Qualifier 2: Library	Name, *CURLIB
SRCFILE	Source file	Qualified object name	Optional, Positional 2
	Qualifier 1: Source file	Name, QCSRC
	Qualifier 2: Library	Name, LIBL, CURLIB
SRCMBR	Source member	Name, *OBJ	Optional, Positional 3
OBJTYPE	Compile type	MODULE, PGM	Optional
TEXT	Text description	Character value, *SRCMBRTXT	Optional
OUTPUT	C Compiler output	NONE, PRINT	Optional
DBGVIEW	C Debugging view	NONE, ALL, STMT, SOURCE, *LIST	Optional
MSGLMT	C Compiler messages	Element list	Optional
	Element 1: Message limit	1-32767, *NOMAX
	Element 2: Message limit severity	10, 20, 30
CICSOPT	CICS Options	Values (up to 19 repetitions): NOSOURCE, NOSRC, SOURCE, SRC, NOVBREF, VBREF, NOXREFCICS, XREFCICS, NODEBUG, DEBUG, NOGEN, GEN, NOSECLVL, SECLVL, NOGRAPHIC, GRAPHIC, NOPP, PP	Optional
OUTFILE	CICS Output file	Qualified object name	Optional
	Qualifier 1: CICS Output file	Name, QACYCICS
	Qualifier 2: Library	Name, QTEMP, LIBL, CURLIB
OUTMBR	CICS Output member	Name, *OBJ	Optional
CICSGENLVL	CICS Message level	0-40, 10	Optional
MARGINS	Source margins	Element list	Optional
	Element 1: Left margin	1-80, 1
	Element 2: Right margin	10-100, 80
TGTRLS	Target release	Character value	Optional
SQLOPT	SQL Options	Values (up to 16 repetitions): NOSOURCE, NOSRC, SOURCE, SRC, XREF, NOXREF, GEN, NOGEN, SYSVAL, PERIOD, COMMA, SECLVL, NOSECLVL, SQL, *SYS	Optional
INCFILE	SQL INCLUDE file	Qualified object name	Optional
	Qualifier 1: SQL INCLUDE file	Name, *SRCFILE
	Qualifier 2: Library	Name, LIBL, CURLIB
COMMIT	SQL Commitment control	CHG, CS, ALL, NONE	Optional
ALWCPYDTA	SQL Allow copy of data	YES, OPTIMIZE, *NO	Optional
ALWBLK	SQL Allow blocking	READ, NONE, *ALLREAD	Optional
DLYPRP	SQL Delay PREPARE	NO, YES	Optional
CLOSQLCSR	SQL Close cursor	ENDACTGRP, ENDMOD	Optional
SQLGENLVL	SQL Message level	0-40, 10	Optional
SAAFLAG	SQL SAA flagging	NOFLAG, FLAG	Optional
FLAGSTD	SQL ANS flagging	NONE, ANS	Optional
DATFMT	SQL Date format	JOB, USA, ISO, EUR, JIS, MDY, DMY, YMD, *JUL	Optional
TIMFMT	SQL Time format	HMS, USA, ISO, EUR, *JIS	Optional
TIMSEP	SQL Time separator	' ', ':', '.', ',', JOB, BLANK	Optional
DATSEP	SQL Date separator	' ', '.', ',', '/', '-', JOB, BLANK	Optional
DFTRDBCOL	SQL Default collection	Name, *NONE	Optional
REPLACE	Replace object	YES, NO	Optional

Top

Object (OBJ)

Specifies the name and qualifier of the object being created.

The name of the object can be qualified by one of the following library values:

*CURLIB: Specifies that the object is to be created in the current library for the job. If no library is specified as the current library for the job, the object is created in QGPL.
library-name: Specify the name of the library in which the object is to be created.

object-name: Specify the name of the object that is to be created.

Note: If the object name you specify is the same as that of an existing object, and if the REPLACE parameter is specified as *YES (the default) your new object replaces the existing one.

Source file (SRCFILE)

Specifies the qualified name of the source file that contains the C source code with the EXEC CICS or EXEC SQL statements.

The source file can be qualified by one of the following library values:

*LIBL: Specifies that the library list is used to locate the source file.
*CURLIB: Specifies that the current library for the job is used to locate the source file. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the library where the source file is located.

QCSRC: Specifies that if a C source file name is not specified, the supplied source file QCSRC contains the C source.

source-file-name: Specify the name of the source file that contains the C source code.

Compile type (OBJTYPE)

Specifies the type of object to be created.

The possible values are:

*MODULE: Specifies that the CICS precompiler is to issue the CRTCMOD command to create a module.
*PGM: Specifies that the CICS precompiler is to issue the CRTBNDC command to create a bound program.
Notes:
- If *NOGEN is specified for the CICSOPT option, only the CICS temporary source member is generated and a module or program is not created.

Text description (TEXT)

Allows you to enter text that describes the compiled module or program and its function.

*SRCMBRTXT: Specifies that the text is taken from the source-file member being used to create the module or program. Text for a database source member can be added or changed by using the Source Entry Utility (STRSEU) command, or by using either the Add Physical File Member (ADDPFM) or Change Physical File Member (CHGPFM) command. If the source file is an inline file or a device file, the text is blank.
*BLANK: No text is specified.
'description': Specify no more than 50 characters of text, enclosed in apostrophes.

C Debugging view (DBGVIEW)

Specifies which level of debugging is available for the compiled module or program, and which source views are available for source-level debugging.

The possible values of the DBGVIEW parameter are:

*NONE: Disables all of the debug options for debugging the compiled module or program. This is the default.
*ALL Enables all of the debug options for debugging the compiled module or program and produces a source view, as well as a listing view.
*STMT Allows the compiled module or program to be debugged using program statement numbers and symbolic identifiers.
*SOURCE: Generates the source view for debugging the compiled module or program.
*LIST Generates the listing view for debugging the compiled module or program.

Create CICS ILE C object (MSGLMT)

Specifies the maximum number of messages that can occur before the C compilation stops.

message-limit: Specifies the number of messages that can occur.

*NOMAX: Compilation continues regardless of the number of messages that have occurred at the specified message severity level. This is the default.
maximum-message-limit: Specify the maximum number of messages that can occur at, or above, the specified message severity level, before compilation stops. The valid range is 1 to 32767.

message-severity: Specifies the message severity that can occur before compilation stops.

0: Specifies that a message-limit of messages at severity 0 or above can occur before compilation stops.
10: Specifies that a message-limit of messages at severity 10 or above can occur before compilation stops.
30: Specifies that a message-limit of messages at severity 30 or above can occur before compilation stops.

CICS Options (CICSOPT)

Specifies whether one or more of the following options are to be used when the C source is CICS translated. If an option is specified more than once, or if two options conflict, the last option specified is used. If an option is not specified, then the default is used.

Source Listing Options

*NOSRC: or *NOSOURCE: Specifies that the CICS translator is not to produce a source listing.
*SRC: or *SOURCE: Specifies that the CICS translator is to produce a source listing, consisting of the all the source input and error messages.

Cross-Reference Options

*NOVBREF: or *NOXREFCICS: Specifies that the CICS translator is not to produce a cross-reference of EXEC CICS names.
*VBREF: or XREFCICS: Specifies that the CICS translator produces a cross-reference between EXEC CICS names in the program and the statement numbers in the program that refer to them.

Debug options

*NODEBUG: Specifies that the CICS translator is not to produce code that will be passed through to CICS to be displayed by the CICS execution diagnostic facility (EDF).
*DEBUG: Specifies that the CICS translator is to produce code that will be passed through to CICS to be displayed by EDF.

Program creation options

*GEN: Specifies that the SQL precompiler or ILE C compiler is to be called after a successful CICS translation.
Note: The SQL precompiler is to be called only if during the CICS translation stage an EXEC SQL statement was found in the C source code being CICS translated.
*NOGEN: Specifies that compilation is to terminate at the end of the CICS translate.

Second-level help text

*NOSECLVL: Specifies that no second-level help text is to be printed.
*SECLVL: Specifies that the second-level text is to be printed along with the first-level help text.
Note: The first-level help text is printed each time an error occurs.

DBCS enablement

*GRAPHIC: Specifies that the translator is to accept double-byte data. This data can only appear in columns 7 through 72. See the CICS Programming guide for restrictions and examples of the use of double-byte data.
*NOGRAPHIC: Specifies that the translator is not to accept double-byte data.

Library (OUTFILE)

Specifies the qualified name of the intermediate precompiler output.

The possible library values are:

*LIBL: Specifies that all libraries in the user and system portions of the job's library list are to be searched.
*CURLIB: Specifies that the current library is to be searched. If no library is specified as the current library for the job, the QGPL library is used.
library-name: Specify the name of the library in which the intermediate precompiler output is to be placed.

source-file-name: Specify the name of the source file that is to contain the intermediate precompiler output.

QTEMP/QACYCICS: If an output source file name is not specified, the supplied source file QTEMP/QACYCICS is to contain the intermediate precompiler output.

CICS Message level (CICSGENLVL)

Specifies a level of CICS precompiler errors. If errors occur with a severity level greater than the value specified in this parameter, either the SQL precompiler is not called (if the CICS precompiler located any SQL in the source) or the C compiler is not called.

Possible values are:

10: If a severity level value is not specified, the default severity level is 10.
severity-level: Specify a number from 0 through 40. Some suggested values are listed below:
- 10 The level value for warnings.
- 20 The level value for general error messages.
- 30 The level value for serious error messages.
- 40 The level value for system-detected error messages.
Note: The value of CICSGENLVL applies only to messages generated as a result of CICS translation errors. The specified CICSGENLVL value is not passed to the SQL precompiler or C compiler.

Target release (TGTRLS)

Specifies the release level of the operating system on which you intend to use the object being created. In the examples given for the *CURRENT and *PRV values, and when specifying the target-release value, the format VxRxMx is used specify release, where Vx is the version, Rx is the release, and Mx is the modification level. For example, V5R3M0 is Version 5, Release 3, Modification 0.

Valid values for this parameter change every release.

The possible values are:

*CURRENT: The object is to be used on the release of the operating system currently running on your system. The object can also be used on a system with any subsequent release of the operating system installed.
*PRV: The object is to be used on the previous release with modification level 0 of the operating system. The object can also be used on a system with any subsequent release of the operating system installed.
release-level: Specify the release level in the format VxRxMx. The object can be used on a system with the specified release or with any subsequent release of the operating system installed.
Valid values depend on the current version, release, and modification level, and they change with each new release.

SQL Options (SQLOPT)

Specifies whether one or more of the following options are to be used when the C source is SQL precompiled. If an option is specified more than once, or if two options conflict, the last option specified is used. If an option is not specified then the default is used.

Source Listing Options

*NOSRC: or *NOSOURCE: Specifies that a source listing is not to be produced by the SQL precompiler.
*SRC: or *SOURCE: Specifies that a source listing is produced by the SQL precompiler, consisting of the source and error messages.

Cross-Reference Options

*NOXREF: Specifies that the SQL precompiler is not to produce a cross-reference of EXEC SQL names.
*XREF: Specifies that the SQL precompiler is to produce a cross-reference between items in the program and the numbers of the statements in the program that refer to these items.

Program Creation Options

*GEN: Specifies that the C compiler is to be called after a successful SQL precompilation.
*NOGEN: Specifies that compilation is to be terminated at the end of the SQL precompilation.

Decimal point options

*SYSVAL: Specifies that the value to be used as the decimal point is from the QDECFMT system value.
*PERIOD: Specifies that the value to be used as a decimal point is a period.
*COMMA: Specifies that the value to be used as a decimal point is a comma.
Note: Any numeric constants in lists (such as in the SELECT clause, the VALUES clause, and so on ) must be separated by a comma followed by a blank. For example, VALUES(1,1, 2,23, 4,1) is equivalent to VALUES(1.1,2.23,4.1) where the decimal point is the period.

Naming Convention Option

*SYS: Specifies that the OS/400 system naming convention is to be used, ( library-name/file-name ).
*SQL: Specifies that the SQL naming convention is to be used ( collection-name.table-name ).

Second-level help text

*NOSECLVL: Specifies that no second-level help text is to be printed.
*SECLVL: Specifies that the second-level help text is to be printed along with the first-level help text.
Note: The first-level help text is printed each time an error occurs.

SQL INCLUDE file (INCFILE)

Specifies the qualified name of the source file that contains the members included in the program with any SQL INCLUDE statement.

The possible library values are:

*LIBL: Specifies that the library list is used to locate the source file.
*CURLIB: Specifies that the current library for the job is used to locate the source file. If no current library entry exists in the library list, QGPL is used.
library-name: Specify the name of the library where the source file is located.
*SRCFILE: Specifies the qualified source file you specified in the SRCFILE parameter that contains the source file members specified on any SQL INCLUDE statement.
source-file-name: Specify the name of the source file that contains the source file members specified on any SQL INCLUDE statement. The record length of the source file you specify here must be no less than the record length of the source file you specified for the SRCFILE parameter.

SQL Commitment control (COMMIT)

Specifies whether SQL statements in the compiled program are run under commitment control. Files referred to in the host language source are not affected by this parameter. Only SQL tables, views, and SQL packages referred to in SQL statements are affected.

*CHG (change): Specifies the objects referred to in SQL COMMENT ON, CREATE, DROP, GRANT, LABEL ON, and REVOKE statements and the rows updated, deleted, and inserted are locked until the end of the unit of work (transaction). Uncommitted changes in other jobs can be seen.
*CS (cursor stability): Specifies that objects referred to in SQL COMMENT ON, CREATE, DROP, GRANT, LABEL ON, and REVOKE statements and the rows updated, deleted, and inserted are locked until the end of the unit of work (transaction). A row that is selected, but not updated, is locked until the next row is selected. Uncommitted changes in other jobs cannot be seen.
*ALL: Specifies that objects referred to in SQL COMMENT ON, CREATE, DROP, GRANT, LABEL ON, and REVOKE statements and the rows updated, deleted, and inserted are locked until the end of the unit of work (transaction). Uncommitted changes in other jobs cannot be seen.
*NONE: Specifies that commitment control is not used. COMMIT and ROLLBACK statements are not allowed. Uncommitted changes in other jobs can be seen. If the SQL DROP COLLECTION statement is included in the program, *NONE must be used.
Note: If *CHG, *CS, or *ALL is specified, DROP COLLECTION cannot be included in the application. The default for this parameter for the Start SQL (STRSQL) command is *NONE.

SQL Allow copy of data (ALWCPYDTA)

Specifies whether a copy of the data is allowed in a SELECT statement.

*YES: A copy of the data can only be used, if necessary, to run a SELECT statement.
*OPTIMIZE: The system chooses whether or not to use the data retrieved directly from the database or to use a copy of the data. The decision is based on which choice will provide the best performance.
This value decreases the time required for the total query. Because the copy of the data must be made before returning the first row of the result table, the time to retrieve the first row may be increased.

Note: If *CS or *ALL is specified on the COMMIT parameter, SQL run time ignores this parameter and uses current data.
*NO: A copy of the data is not allowed. This option could return an negative SQLCODE if the clauses in the SELECT statement require a copy of the data. If the SELECT statement runs successfully, then current data was used.

SQL Allow blocking (ALWBLK)

Specifies whether the database manager can use record blocking and the extent to which blocking can be used for read-only cursors.

*READ: Records are blocked for read-only retrieval of data for cursors when:

*NONE is specified on the COMMIT parameter, to indicate that commitment control is not used.
The cursor is declared with a FOR FETCH ONLY clause or there are no dynamic statements that could run a positioned UPDATE or DELETE statement for the cursor.

Specifying *READ can improve the overall performance of queries that meet the above conditions and retrieve a large number or records.

*NONE: Rows are not blocked for retrieval of data for cursors. Specifying *NONE:

Guarantees that the data retrieved is current.
May reduce the amount of time required to retrieve the first row of data for a query.
Stops the database manager from retrieving a block of data rows that is not used by the program when only the first few rows of a query are retrieved before the query is closed.
Can degrade the overall performance of a query that retrieves a large number of rows.

SQL Delay PREPARE (DLYPRP)

Specifies whether the dynamic statement validation for a PREPARE statement is delayed until an OPEN, EXECUTE, or DESCRIBE statement is run. Delaying validation improves performance by eliminating duplicate validation.

*NO: Dynamic statement validation is not delayed. When the dynamic statement is prepared, the access plan is validated. When the dynamic statement is used in an OPEN or EXECUTE statement, the access plan is revalidated. Because the authority or the existence of objects referred to by the dynamic statement may change, you must still check the SQLCODE or SQLSTATE after issuing the OPEN or EXECUTE statement to ensure that the dynamic statement is still valid.
*YES: Dynamic statement validation is delayed until the dynamic statement is used in an OPEN, EXECUTE, or DESCRIBE SQL statement. When the dynamic statement is used, the validation is completed and an access plan is built. If you specify *YES on this parameter for precompiled programs, you should check the SQLCODE and SQLSTATE after running an OPEN, EXECUTE, or DESCRIBE statement to ensure that the dynamic statement is valid. If you specify *YES, performance is not improved if the INTO clause is used on the PREPARE statement or if a DESCRIBE statement uses the dynamic statement before an OPEN is issued for the statement.

SQL Close cursor (CLOSQLCSR)

Specifies when SQL cursors are to be implicitly closed; when SQL prepared statements are implicitly discarded; and when LOCK TABLE locks are SQL cursors are explicitly closed by issuing the CLOSE, COMMIT (without HOLD), or ROLLBACK (without HOLD) SQL statements.

Possible values are:

*ENDACTGRP: Specifies that SQL cursors are to be closed, SQL prepared statements are to be discarded, and LOCK TABLE locks are to be released when the activation group ends.
*ENDMOD: Specifies that SQL cursors are to be closed and SQL prepared statements are to be discarded when the module is exited. LOCK TABLE locks are to be released when the activation group ends.

SQL Message level (SQLGENLVL)

Specifies a level of SQL precompiler errors. If errors occur with a severity level greater than the value specified in the parameter, then the ILE C compiler is not called.

Possible values are:

10: If no value is specified, the default severity level is 10.
severity-level: Specify a number in the range 0 through 40. Some suggested values are listed below:
- 10 The level value for warnings.
- 20 The level value for general error messages.
- 30 The level value for serious error messages.
- 40 The level value for system-detected error messages.
Note: The value of SQLGENLVL applies only to messages generated as a result of SQL precompilation errors. The specified SQLGENLVL value is not passed to the ILE C compiler.

SQL Date format (DATFMT)

Specifies the format used when accessing date result columns. All output date fields are returned in the specified format. For input date strings, the specified value is used to determine if the date is in a valid format.

Note: An input date string that uses format *USA, *ISO, *EUR, or *JIS is always valid. If you connect to a relational database that is on a system that is not an iSeries system, *USA, *ISO, *EUR, or *JIS must be used.

*JOB: Specifies the format used for the job at precompilation. Use the Display Job (DSPJOB) command to determine the current date format for the job.
*USA: The United States date format mm/dd/yyyy is used.
*ISO: The International Organization for Standardization (ISO) date format yyyy-mm-dd is used.
*EUR: The European date format dd.mm.yyyy is used.
*JIS: The Japanese Industrial Standard date format yyyy-mm-dd is used.
*MDY: The date format mm/dd/yy is used.
*DMY: The date format dd/mm/yy is used.
*YMD: The date format yy/mm/dd is used.
*JUL: The Julian date format yy/ddd is used.

SQL Time format (TIMFMT)

Specifies the format used when accessing time result columns. All output time fields are returned in the specified format. For input time strings, the specified value is used to determine if the time is specified in a valid format.

Note: An input time string that uses the format *USA, *ISO, *EUR, or *JIS is always valid. If you connect to a relational database that is on a system that is not an iSeries system, the time format must be *USA, *ISO, *EUR, *JIS, or *HMS with a time separator of colon or period.

*HMS: The hh:mm:ss format is used.
*USA: The United States time format hh:mm xx is used, where xx is AM or PM.
*ISO: The International Organization for Standardization (ISO) time format hh.mm.ss is used.
*EUR: The European time format hh.mm.ss is used.
*JIS: The Japanese Industrial standard time format hh:mm:ss is used.

SQL Time separator (TIMSEP)

Specifies the separator used when accessing time result columns.

Note: This parameter applies only when *HMS is specified on the TIMFMT parameter.

*JOB The time separator specified for the job at precompile time is used. Use the Display Job (DSPJOB) command to determine the current value for the job.
":": A colon (:) is used as the time separator.
".": A period (.) is used as the time separator.
",": A comma (,) is used as the time separator.
" ": A blank space is used as the time separator.
*BLANK A blank is used as the time separator.

SQL Date separator (DATSEP)

Specifies the separator used when accessing date result columns.

*JOB The date separator for the job at the precompile time is used. Use the Display Job (DSPJOB) command to determine the current value for the job.
"/": A slash (/) is used as the date separator.
".": A period (.) is used as the date separator.
",": A comma (,) is used as the date separator.
"-": A hyphen (-) is used as the date separator.
" ": A blank space is used as the date separator.
*BLANK A blank is used as the time separator.

Replace object (REPLACE)

Specifies whether a CICS module or program is to be created when there is an existing CICS module or program of the same name and type in the same library. The value of this parameter is passed to the CRTSQLCI, CRTCMOD, or CRTBNDC command.

*YES Specifies that a CICS module or program is to be created, an existing object of the same name and type in the specified library is to be moved to QRPLOBJ. The *YES value is passed to the CRTSQLCI, CRTCMOD, or CRTBNDC command.
*NO Specifies that a CICS module or program is not to be created if an object of the same name and type already exists in the specified library.