Keyword

Description

ACS=ACS400.XXX

Specifies the name of the table that contains the actual sort sequence of your data on the IBM i server. This keyword must be specified because no default value is provided.
Magic xpa for IBM i comes with several default collating sequence tables named ACS400.XXX, where XXX is an abbreviation for your language name such as ENG, GER, and so forth.
You can specify an Alternate Collating Sequence File in the DBMS Properties dialog box. This is the name of an ACS that will be copied to the ACS file setting of the Database Properties dialog box when a new database is created.

?

?

CACHE=N

Specifies how many records you want to transfer for a single READ request. N represents the number of records in a block.
This parameter may significantly improve I/O performance for sequential READ operations.

?

CHECK_KEY=Y

Checks the data table for the existence of a unique index value as the end user attempts to input a data into a record. If a duplicate value is input by the end user into the variables constructing an index defined as Unique in Magic xpa’s Data repository, Magic xpa will issue a Duplicate Index error message and prevent further end-user processing until the input is changed. For some DBMSs, this check takes a toll in performance and it is not recommended. In such a case, the developer may decide not to use this keyword, and then the results of duplicate index value entry will depend on the DBMS behavior.

?

CNVTSTR=Y

Forces the ASCII/EBCDIC conversion for an Alpha field greater than 256 characters.

?

COMPLEXLOGIC

Automatically inserted by the Load Data Source Definition utility to identify files that cannot be recreated by Magic xpa due to specific DB2/400 file definition statements.

?

CREATE=SIZE(*N)

Lets you create new IBM i files, where N specifies the maximum number of records from Magic xpa.

?

CREATE=SIZE(*NOMAX)

Lets you create new IBM i files with no maximum size limit from Magic xpa.

?

CRTSPLF=N

Lets you avoid creating a spool file during the file creation process.

?

?

?

EAC_LOG=[Library/File:Detail]

Magic xpa’s log (trace) file on IBM i. When instructed by Magic’s Technical Support to do so, you can specify any valid file name to keep the trace. The Detail option specifies the level of the information you want to log: 0=No log, 1-4 = increasing log level. Note: This keyword slows the performance of the gateway.

?

EXITPGM=LIBNAME/PRGMAME

This keyword lets you call a user-defined program before Magic xpa opens the file and after Magic xpa closes the file. LIBNAME represents the name of the library and PRGMAME represents the name of the program.
You can use this powerful interface to run an OPNQRYF record selection, for example, before opening the table in Magic xpa.
The parameters for the User Program Parameter Interface are:

• Library name of the file – 10 characters

• File name – 10 characters

• Member name (if any) – 10 characters. If no member name is specified, this field is empty.

• Operation Code – 1 character, where O represents Open and C represents Close.

?

FILELEVEL=NNNNNNNNNN

Automatically inserted by the Load Data Source Definition utility. NNNNNNNNNN represents the value of the data source level stamp.

?

FLDNAMES

Replaces the field description with the field name while retrieving the file description from the IBM i server during a Get Definition operation.

?

HOSTSYNC=N

Can be used to suppress a warning message that the host version is out of date. See Runtime Initialization Features.

?

LANGUAGE=[ASCII-to-EBCDIC translation table name]

The name of the translation table matching your EBCDIC and ASCII code pages. If omitted, the default translation table specified in the router configuration will be used. Magic xpa for IBM i comes with several default translation tables named AS2EB.XXX where XXX is an abbreviation of the language name, such as ENG, GER, and so forth.

?

MAGICDBA=[IBM i_LIBRARY_NAME]

By default, a database connection to the IBM i server (MGCLIENT job) starts from the same library as the EASYCOM TCP/IP listener (EASYCOMD job). To override the default settings, the MAGICDBA keyword has to be set in the DBMS properties of the MAGIC.INI file. The MAGICDBA keyword is only required if there is a requirement to start the MGCLIENT job from a different host library. (Since version: 1.9)

With this option, different versions of Magic clients can connect to multiple IBM i servers.

?

NOCCSIDMSG

Should be specified by the user to avoid getting the following message, which appears if the CCSID definition is missing:
Magic Client Job CCSID=37 does not match the User CCSID definition.
Magic Client Job CCSID was changed to -2.
An example of this parameter in the Magic.file is as follows:
[MAGIC_DBMS]
DB2/400 = 7, NotAllowNull, 10.3, DB2/400 Parameters, N, , NotLogSync, 0, 0, NotCheckExist,
Oracle = 14, NotAllowNull, 10.3, Oracle Parameters,,,,,,,
AS400 = 17, NotAllowNull, 10.3, LANGUAGE=support\AS2EB.eng NOCCSIDMSG, N, , NotLogSync, 5, 0, NotCheckExist, support\ACS400.eng

?

NOCHKRECLVL

Lets the user enter the logical file definition of a physical file to a Magic xpa index even when their record format names are different.
Note: Use this keyword only when the record size of the physical file and the record size of the logical file are the same.

?

?

NOMSGBOX

Turns off Magic xpa’s default error message box.
The error can be retrieved using the DbERR()function or the RTVERRID user-defined function. Use it in Batch type programs when operator intervention is not possible and automatic error handling is required.

?

OVRLFLIB=< library name>|<*LIBL>|<*CURRLIB>

library name – Magic xpa will look in the named library for logical files.
*LIBL – Magic xpa will look in the IBM i default library list for the job.
*CURRLIB – Magic xpa will look in the current library.

?

?

RECLVL=XXXXXXXXXXXXX

Automatically inserted by the Load Data Source Definition utility.
XXXXXXXXXXXXX represents the value of the Record level ID.

?

RECNAME=Rfilename

RECNAME is added by Magic xpa when a new IBM i file is created.
Filename is a string that is defined as a Data Source Name in the Data repository. The maximum string length is 10. The Information for SQL Database property values are used during file conversion. The value of the RECNAME keyword is taken as the new file’s Record Name.
After a Get Definition operation, the Record Name parameter of the file defined on IBM i will be added in the Information for SQL Database property, in the format RECNAME=Rfilename.

?

*RNGSVR=Y

Utilizes Open Query for Task ranges.

?

?

?

SHARE=Y

Lets you share an ODP file with another program in the same job, such as OPNQRYF. Y represents Yes.

?

STORAGE=DB2

Lets you store the Date and Time string fields in native Date or Time formats in the DB2/400s. By default, Magic xpa’s Date and Time string fields are stored as alphanumeric fields in DB2/400.
Logical fields are stored in ASCII format by default. Use this keyword to translate logical field contents to EBCDIC on the IBM i server, storing T or F in the database.

To set the date format, DATFMT=XXX, when using the STORAGE=DB2 keyword to European or USA format, do the following:
• substitute *EUR for XXX to use the European date format
• substitute *USA for XXX to use the USA format

Additional supported formats are *MDY, *DMY, and *YMD

To set the time format when using the STORAGE=DB2 keyword to the HMS format (HH:MM:SS), use the following syntax: FORMAT=*HMS. Note: The default time format is HH.MM.SS.

?

STORAGE=MEMO

Magic xpa does not allow the creation of an index for a column with the Memo storage type (Alpha attribute). On the other hand, an IBM i field of Memo storage type can be defined as an index. The Gateway compensates for this incompatibility with the STORAGE=MEMO keyword. The steps to follow are:
1. Get Definition of the data source containing the Memo storage type column or columns.
2. Change the storage attribute from String Memo to String, and increment the column picture size by 2.
3. Add the STORAGE=MEMO keyword to the Database information column property.

?

TRANSACTIONS=Y

Starts journaling changes for all of the data files in the current database.
The IsamTransaction keyword has to be set in Magic400.ini in order to activate this keyword.

?

?

TYPE=PF or TYPE=LF

Automatically inserted by the Load Data Source Definition utility to identify the file as physical or logical and prevent the IBM i file structure from being changed within Magic xpa.
An attempt to modify the structure of a file having this keyword will result in an error message.

?