If you specify -t file (file stands for the file's full path), "
Return Code" configuration on each line of this file will take effect. The format is:
<EJR API>;<STEP>;<Return Code>;Dummy. For example,
m_ProgramExec;START;C0088;Dummy, where step
START returns
C0088 for
m_ProgramExec utility. If you specify
-t NULL, "
Return Code" configuration in this file will not take effect; every step (for every utility) will return code
C0000.
|
|
|
The Return code for an Oracle Tuxedo Application Runtime for Batch function execution.
•
|
if MT_RC = Cnnnn, return code OK
|
•
|
if MT_RC = Unnnn, User abort
|
•
|
if MT_RC= Syyy, System abort
|
|
|
General return code (for the job) MT_RC_JOB is updated with MT_RC at the end of each phase. It contains the maximum MT_RC value for the job.
|
|
The MT_RC return code is compared to this value to determine if the result of the execution was normal or not.
|
|
|
|
|
A COBOL runtime, runb, is provided to initialize the execution context of a user COBOL program before the call for its execution. This runtime is used instead of the standard COBOL runtime.
•
|
Initialization: If a COBOL program is executed (m_ProgramExec) using the - b option, the runtime command, runb, connects it to the database according to the MT_DB_LOGIN environment variable . It must have the correct value (user name, password and Oracle instance, at least "/"). It can be used in the TuxJES Security Configuration file and specified when submitting jobs or set as an environment variable. If the configuration file is not specified, the environment variable MT_DB_LOGIN value is used.
|
Using the -t argument, it is possible to run the KSH script without executing the internal functions. The
-t argument allows a script to be checked (for example a newly-developed script) and verify the chaining of the different phases.
where name is the name of an executable file and
option is a string of one of the following two types:
noargletter . . . or
argletter optarg [, . . .]
Where PROCNAME is the name of procedure, and
NUM is the sequence number of procedure calls.
RC indicates a return code.
STEP.RC indicates that the expression tests a return code for a specific STEP.
Operator indicates the operator used for the conditional expression (GT, LT, EQ etc.).
STEP.RUN indicates that a specific job step started execution or not.
ABEND indicates an abend condition occurred.
ABENDCC indicates a system or user completion code.
When MT_DSNUTILB_LOADUNLOAD is set to "
yes", this function calls the COBOL program "
schema-table-L" for loading data from a file into table in DB, and
MT_CTL is not used. The COBOL program is generated by Workbench Rdbms Convertor.
When MT_DSNUTILB_LOADUNLOAD is set to other value than "
yes",This function executes a command stored in the file which ddname is
MT_CTL.
Only when MT_DSNUTILB_LOADUNLOAD is set to "
yes", this option takes effect.
Only when MT_DSNUTILB_LOADUNLOAD is set to "
yes", this option takes effect.
Specifies the DB SYSTEM. This "
DB SYSTEM" value is used to get the "DB connection credential string" from file specified by global variable
MT_DB2_SYSTEM_MAPPING. And then apply it to
MT_DB_LOGIN. After this API is executed successfully,
MT_DB_LOGIN is restored.
Specifies the DB SYSTEM. This "
DB SYSTEM" value is used to get the "DB connection credential string" from file specified by global variable
MT_DB2_SYSTEM_MAPPING. And then apply it to
MT_DB_LOGIN. After this API is executed successfully,
MT_DB_LOGIN is restored.
When MT_DSNUTILB_LOADUNLOAD is set to "
yes", this function calls the COBOL program "
schema-table-U" for loading data from a file into table in
DB, and
MT_CTL is not used. The COBOL program is generated by Workbench Rdbms Convertor.
When MT_DSNUTILB_LOADUNLOAD is set to other value than "
yes", this function executes a command stored in the file which ddname is
MT_CTL.
When MT_DSNUTILB_LOADUNLOAD is set to "
yes", the value for this option can be one of the following two formats:
TableName,
SchemaName.TableName
Specifies the DB SYSTEM. This "
DB SYSTEM" value is used to get the "DB connection credential string" from file specified by global variable
MT_DB2_SYSTEM_MAPPING. And then apply it to
MT_DB_LOGIN. After this API is executed successfully,
MT_DB_LOGIN is restored.
•
|
When MT_DSNUTILB_LOADUNLOAD is set to yes.
|
If this option is set to -u DSNTIAUL, the data file that this utility generates on Batch Runtime has the same format as the data file that utility
DSNTIAUL generates on mainframe. If this option is set to other values or if this option is not set, the data file that this utility generates on Batch Runtime has the same format as the data file that utility
DSNUTILB generates on mainframe.
•
|
When MT_DSNUTILB_LOADUNLOAD is not set to yes.
|
The data file that -u <utility name> generates is simply in text format (rather than binary format) whatever
-u <utility name> is set.
m_DirCreate [-v volume] DirName
m_DSNUTILB – Mainframe simulatation utility that loads/unloads table from database.
m_DSNUTILB uses
DD SYSIN as input.
DD SYSIN includes standard
DSNUTILB utility commands. Currently, only load and unload commands are supported.
Specifies the DB SYSTEM. This "
DB SYSTEM" value is used to get the "DB connection credential string" from file specified by global variable
MT_DB2_SYSTEM_MAPPING. And then apply it to
MT_DB_LOGIN. After this API is executed successfully,
MT_DB_LOGIN is restored.
With -b RC0, whether encountering errors or not, all SQL will be executed and then all successful SQL will be committed in the end; however, without
-b RC0, if any error is encountered, SQL will rollback when terminating.
Specifies the DB SYSTEM. This "
DB SYSTEM" value is used to get the "DB connection credential string" from file specified by global variable
MT_DB2_SYSTEM_MAPPING. And then apply it to
MT_DB_LOGIN. After this API is executed successfully,
MT_DB_LOGIN is restored.
m_FileAssign assigns a file. If assigning a file triggers the creation of a file, the creation process precedes the assign itself.
•
|
For the DISP=OLD and DISP=PASS options, the file is kept.
|
•
|
For the DISP=MOD option, the write to the file is made in a temporary intermediary file, then by a copy in Extend on the original file.
|
•
|
In one step, if a DDNAME is defined more than one time by m_FileAssign, only the first one takes effect. The disposition specified for the former DSNAME is also discarded.
|
m_FileClrData is used to clear a file. GDG file is not supported.
m_FileExist is used to check whether a file is present.
Indicates the Outfile volume. This option only works when file catalog is enabled in Batch Runtime.
This function emulates the z/OS feature: EXEC PGM=FTP.it launches an ftp process and executes ftp command(s) stored in an input file. An environment variable,
S must be declared and initialized with the following value (upper or lower case):
Y or
YES: Test mode. Ftp commands (except for “
open”, “
user”, “
quit” or “
bye”), are not executed.
N or
NO: real mode. All ftp commands are executed.
\$MT_FTP_PASS can be added to the input file to replace the real ftp password (which means the security profile password is used). For example:
user user1 \$MT_FTP_PASS.
If -r is specified and the GDG to be defined already exists, only the maximum number of generation files of the GDG is updated with the value specified by
-s.
The name of the GDG base for which the maximum number of generations is being defined. The maximum length of GDG base name is 1024.
m_IDCAMS — Executes the stored IDCAMS commands.
sysin file: By default
SYSIN. ddname of a
sysin file which contains function to launch.
m_JobBegin -j jobname [-C cond] [-c
class] [-p
priority] [-r
restart] [-t
typrun] -v
version -s
start_label
•
|
class is stored in the JOBID.class file
|
•
|
restart is stored in the JOBID.restart file
|
•
|
priority is stored in the JOBID.priority file
|
•
|
typrun is stored in the JOBID.typrun file
|
COPY – Copy the job directly in an output stream to sysout.
HOLD – The system should hold the job.
JCLHOLD – JES2 should hold the job.
SCAN – Scan JCL for syntax errors only.
m_OCOPY — Copy MVS file to UNIX file, and vice versa.
When "-U" is specified for a DD, the file is a UNIX file and it does not have dcb file.
m_OCOPY is used to copy a MVS file, which has a dcb file, to a UNIX file, which does not have the dcb file. Also,
m_OCOPY can be used to copy a UNIX file to a MVS file.
m_OSHELL is used to execute a shell command. All the parameters are to be executed as a complete shell command.
Note:
|
m_OSHELL always returns C0000, even when the execution of shell command fails.
|
m_OutputAssign — manages DD SYSOUT statements with the following parameters: CLASS, COPIES, DEST, FORMS and HOLD.
Example with an output class A:
m_OutputSet — manages the "OUTPUT JCL" statement with the following parameters: CLASS, COPIES, DEFAULT, DEST, FORMS, PRIORITY and WRITER.
m_Pkzip [-f][-F] -a [-k][-n][-g][-d]
m_Pkunzip [-f][-F] -a [-k][-n][-g][-d][-o][-w]
m_ProcBegin ProcedureName
MT_EXCI is set to an non-empty string if EXCI interface exists and needs to use it, otherwise
MT_EXCI is empty by default (needs Oracle Tuxedo).
In the last case, MT_EXCI must be set to
ART KIX objects folder and
MT_JESDECRYPT must be set to
jesdecrypt object file (for example,
/path/to/jesdecrypt.dynamic.linux64.o)
To use XA,
MT_EXCI_XA must be set with the name of the resource manager for
XA and
MT_EXCIGRPNAME must be set with the
TUXEDO SRVGRP value of
ARTDPL server.
(For example, MT_EXCI_XA=Oracle_XA and
MT_EXCIGRPNAME=ResourceXA)
If MT_EXCI is set to an non-empty string and
MT_EXCI_XA and
MT_EXCIGRPNAME are set to empty, you will connect to database without using
XA.
Specifies the DB SYSTEM. This "
DB SYSTEM" value is used to get the "DB connection credential string" from file specified by global variable
MT_DB2_SYSTEM_MAPPING. And then apply it to
MT_DB_LOGIN. After this API is executed successfully,
MT_DB_LOGIN is restored.
Note:
|
When m_ProgramExec invokes nonexistent programs, JOB will continue if those programs are specified in MT_UTILITY_LIST_UNSUPPORT.
|
Another way to use runbexci instead of
runb is to configure the program in
MT_EXCI_PGM_LIST. By doing this, whether or not
-n is set, the program is invoked only by
runbexci.
PARM=MT5 on z/OS becomes
"MT5" on target
Two successive <&&> (2 ampersands) are replaced by one
<&> (1 ampersnd) character.
m_Smtp — Sends an email using SMTP protocol.
Specifies the DB SYSTEM. This "
DB SYSTEM" value is used to get the "DB connection credential string" from file specified by global variable
MT_DB2_SYSTEM_MAPPING. And then apply it to
MT_DB_LOGIN. After this API is executed successfully,
MT_DB_LOGIN is restored.
If SvrGrpName is not specified or
"" is specified, although no errors are reported, the job will be randomly executed on any server group.