Connect:Direct for VM/ESA Process Parameters
- BATCHID = VM-ID-name
specifies the target virtual machine ID name. This parameter is required.
- CLASS = n
determines the node-to-node session on which a Process can execute. If CLASS is not specified, the Process uses the class value specified in the ADJACENT.NODE NETMAP record for the destination node (SNODE). Values range from 1-255.
- CKPT = [nK | nM]
specifies the byte interval for checkpoint support. This enables restart of interrupted transmissions at the last valid transmission point and reduces restart time.
K denotes thousands, and M denotes millions. A CKPT value of zero (0) stops automatic processing.
IBM® Connect:Direct® converts the value to a block boundary, and a data transmission checkpoint is taken at that position. Sequential files can be checkpointed.
- COMPRESS [PRIMEchar=X’40’ | X’xx’|C’c’] | [EXTended]
specifies to compress the file data, reducing the amount of data transmitted during a file copy. The file is automatically decompressed at the destination.
Note: If the SNODE is B2B Integrator, only COMRESS EXT is supported.PRIMEchar specifies the primary compression character. The default value for PRIMEchar is a blank (X’40’).
If compression is specified, IBM Connect:Direct reduces the amount of data transmitted based on the following rules:
- Repetitive occurrences (ranging from 2-64) of the primary compression character are compressed to one byte.
- Repetitive occurrences (ranging from 3-64) of any other character are compressed to two bytes.
EXTended searches for repetitive strings of characters in data and compresses them to codes that are transmitted and converted back to the original string during decompression. It is useful to specify this parameter when line transmission speeds are limited, CPU is available, and data is repetitive.
The following are valid options for EXTended:
- CMPrlevel determines the compression level. The valid value range is 1-9. Level 1 is the fastest compression, but it offers the lowest degree of compression. A higher compression level produces a higher quality of compression, but the higher level has the slowest rate of compression. The default is 1.
- WINdowsize determines the size of the compression window or history buffer. This memory is above the line. The valid values are 8-15. Higher windowsize specifications increase the degree of compression and use more virtual memory. Size 8 uses 1 KB of memory where Size 15 requires 128 KB of memory. The default is 13.
- MEMlevel identifies how much virtual memory is allocated to maintain the internal compression state. This memory is above the line memory. The valid value range is 1-9. Level 1 requires the least memory (1K), but it reduces the degree of compression. Level 9 provides the fastest speed, but it uses the most memory (256K). The default is 4.
The following example shows one way to specify the various EXTended options in a COPY statement:
COMPRESS EXT = ( CMP=4 WIN=12 MEM=8 )
- condition
specifies the type of comparison to be performed. Valid symbols, alternate symbols, and conditions are:
- = or EQ specifies that the completion code must be equal to the value nn for the condition to be satisfied.
- <> or ¬= or NE specifies that the completion code must not equal the value nn for the condition to be satisfied.
- >= or ¬< or GE specifies that the completion code must be greater than or equal to the value nn for the condition to be satisfied.
- > or GT specifies that the completion code must be greater than the value nn for the condition to be satisfied.
- <= or ¬> or LE specifies that the completion code must be less than or equal to the value nn for the condition to be satisfied.
- < or LT specifies that the completion code must be less than the value nn for the condition to be satisfied.
The completion code from the RUN JOB statement is from the job submission only and is not the completion code of the submitted job.
- COPY
identifies the COPY statement. This statement identifier is specified with either the FROM or TO parameter.
- DCB =([BLKSIZE=no. bytes, DEN=[0|1|2|3|4], DSORG=[PS|VSAM], LRECL=no. bytes, RECFM=record format, TRTCH=[C|E|T|ET] [COMP | XF | NOCOMP | NF]])
specifies source and destination file allocation attributes.
For destination files, these parameters override the DCB information provided in the source file at open time.
For SAM-to-SAM copies where the destination file is new and the DCB parameter is not specifiers with the TO parameter, the DCB BLKSIZE, DEN, DSORG, LRECL, RECFM, and TRTCH are taken from the source file or from the TYPE defaults file if the TYPE keyword is specified.
BLKSIZE specifies the length in bytes of the block. The range is 18 bytes to 32,760 bytes. For BLKSIZE greater than 32760 bytes, you must use the DMGIOX64 exit described in the Using IBM Connect:Direct Exits chapter of the IBM Sterling Connect:Direct for VM/ESA Administration Guide.
DEN specifies the magnetic tape mode setting. The following table shows values for the DEN parameter for 7- and 9-track tape. Specifying the DEN and TRTCH values together selects a tape device for allocation by Connect:Direct for VM/ESA.
DEN 7-Track Tape 9-Track Tape 0 200 bpi - 1 556 bpi - 2 800 bpi 800 bpi (NRZI) NRZI is Non-Return-to-Zero Inverted recording mode
3 - 1600 bpi (PE) PE is Phase Encoded recording mode
4 - 6250 bpi (GCR) GCR is Group Coded recording mode
DSORG specifies file organization. Supported file organizations are Physical Sequential (PS) and VSAM.
LRECL specifies the length in bytes of the record.
When RECFM=V or RECFM=VB type files are used, the LRECL value must be at least the size of the largest record in the file plus 4 bytes.
If RECFM=V, the BLKSIZE value must be at least the LRECL value plus another 4 bytes. The BLKSIZE value does not need to be an even multiple of LRECL.
RECFM specifies the format of the records in the file. Valid values are F (Fixed), FB, V (Variable), or VB.
TRTCH specifies the magnetic tape mode setting. Specifying the TRTCH and DEN values together selects a tape device for allocation by Connect:Direct for VM/ESA. Valid options are:
- C specifies data conversion, odd parity, and no translation.
- E specifies no data conversion, even parity, and no translation.
- T specifies no data conversion, odd parity, and BCD or EBCDIC translation.
- ET specifies no data conversion, even parity, and BCD or EBCDIC translation.
- COMP | XF specifies the tape to create in compressed format.
- NOCOMP | NF specifies the tape to create without compression.
- DSN = ‘filename filetype’
specifies the destination filename and file type. Enclose the filename in single quotation marks. This parameter is required.
- DSN = ‘fn ft [fm]’
specifies the filename (fn), file type (ft), and optional file mode (fm). This parameter is required.
The optional file mode is the mode of a minidisk accessed by the IBM Connect:Direct Data Transmission Facility (DTF), not by the CMS user.
If a new Process is created that will be submitted from an existing Process, and if the existing Process is submitted immediately, you must specify the file mode of the new Process.
If the Process has been edited, the DTF machine must re-access the disk where the Process resides.
- EIF
is required for specifying the end of the IF THEN or IF THEN ELSE block of statements. There are no parameters.
- ELSE
designates a block of IBM Connect:Direct statements that execute when the IF THEN condition is not satisfied. There are no parameters.
- EXCLUDE = [(] generic | member | (startrange/stoprange)| list[)]
excludes specific CMS files from a copy.
generic specifies a generic filename. For example, if CDV* is specified, all filenames beginning with CDV and having the specified file type are excluded from a copy.
You can override an excluded generic filename by specifying an individual filename in the SELECT parameter.
member excludes an individual filename. Its exclusion cannot be overridden.
startrange specifies the first name in an alphanumeric range of files to exclude.
stoprange specifies the last name in an alphanumeric range of files to exclude.
Separate the startrange and stoprange parameters with a slash (/). Do not specify generic filenames (*) as startrange or stoprange values. The first and last files specified in the range as well as all files between are excluded.
You can override an excluded range by specifying an individual filename in the SELECT parameter.
- EXIT
bypasses all remaining steps within a Process. There are no parameters.
- FROM
specifies the source file characteristics. This parameter is required.
- (FROM) DISP = ([OLD | SHR])
specifies the source file status and what to do with the file during transmission. Values are:
- OLD specifies that the source file existed before the Process began executing and the Process is given exclusive control of the file.
- SHR specifies that the source file existed before the Process began executing and the file can be used simultaneously by another job or Process. The default is SHR.
- (FROM) DSN = ’filename filetype’ | GROUP = ’* * ... *’
specifies the source filename and file type, or VSAM filename. The filename and file type are verified based on the VM standard filename conventions.
Enclose the filename in single quotation marks if the copy is from a Connect:Direct for VM/ESA node or if the Connect:Direct for z/OS® PDS member name contains special characters.
This parameter is required.
- GOTO
moves to a specific step within a Process.
- HOLD = Yes | No | Call
specifies whether the Process is placed in the Hold queue at submission.
Yes specifies that the Process is submitted to the Hold queue and remains there until the operator releases the Process. When both HOLD=YES and a STARTT value are specified, the HOLD specification takes precedence.
No specifies that the Process executes as soon as possible. This is the default.
Call specifies that the Process is placed in the Hold queue until a VTAM session is established with the specified SNODE. This session can be established by either another Process running on the PNODE or by the SNODE contacting the PNODE. For example, a Process submitted HOLD=NO establishes a session and causes execution of any Processes for this node that are designated HOLD=CALL.
- IF THEN
specifies that the IBM Connect:Direct system executes a block of IBM Connect:Direct statements based on the completion code of a Process step. An EIF statement must be used in conjunction with an IF THEN statement. A return code with the high order bit on is evaluated as a negative return code.
- label
For the IF THEN statement, the label specifies the name of a previous step whose completion code is used for comparison.
For the GOTO statement, the label specifies the name of a subsequent step in a Process (required for GOTO only). The name can neither be the label of a preceding step nor the label of the GOTO statement of which it is a part.
Labels must begin in column 1. The label is a 1-8 character alphanumeric string, with the first letter alphabetic only.
- LABEL =([file sequence number], [SL|NL], [RETPD=nnnn|EXPDT=yyddd])
specifies tape label information.
file sequence number specifies the relative file position on the tape.
SL specifies IBM standard labels.
NL specifies no labels.
RETPD specifies the retention period.
EXPDT specifies the expiration date.
- LINK = (userid,password,mode,ccuu)
specifies the disk where the CMS file is located. This parameter allows you to access the CMS file. This parameter is required.
You cannot specify the SFSDIR and the LINK parameter for the same file.
userid specifies the 1-8 character owner ID for the CMS minidisk where the file is located.
password specifies the 1-256 character appropriate password for the CMS minidisk where the file is located. The default password is ALL.
mode specifies the link access mode.
When used with the FROM parameter, the access modes are:
- W (primary read/write access)
- M (primary multiple access)
- R (primary read only)
- RR (primary and secondary read only access)
- WR (primary read/write access; alternate read only access)
- MR (primary multiple access; alternate read only access)
- MW (primary multiple access; alternate read/write only access).
When used with the TO parameter, the access modes are:
- W (primary read/write access)
- M (primary multiple access)
- WR (primary read/write access; alternate read only access)
- MR (primary multiple access; alternate read only access)
- MW (primary multiple access; alternate read/write only access).
CAUTION:MW access to CMS format disks can be destructive. You must guarantee that no other VM user, or IBM Connect:Direct Process, has MW, M, or W access to the minidisk. If multiple users or Processes get write access to the disk at the same time, there is a high probability that the CMS directory on the disk will be destroyed. The most likely result is a message from Group Control System (GCS) or an equivalent message from CMS. The GCS message will indicate that a CSIFNS420T file system error was detected. When GCS issues the CSIFNS420T message, GCS terminates all processing.ccuu specifies the virtual address of the disk where the CMS file is located. Any four-digit number is valid.
- MAXDELAY = [UNLIMITED | QUEUED | 0 | hh:mm:ss]
indicates that the submit command waits until the submitted Process completes execution or the specified time interval expires.
unlimited specifies the submit command to wait for the Process to complete execution. UNLIMITED is the default if MAXDELAY is specified without any parameters.
queued specifies the submit command waits until the process completes or 30 minutes, whichever occurs first.
0 specifies the submit command will attempt to start a session for the submitted Process to execute on immediately. The submit command waits until the Process completes or until all timer retries have been exhausted.
hh:mm:ss specifies that the submit command waits for an interval no longer than the specified hours, minutes, and seconds or until the Process completes, whichever occurs first.
- NEWNAME = new-name
specifies a new name to be given to a Process. The default value is the PROCESS statement label.
- NOTIFY = %USER | userid
specifies the user to receive Process completion messages.
%USER specifies that the user who submitted the Process receives the completion messages if the IBM Connect:Direct user ID is the same as the VM id. If the IBM Connect:Direct user ID is different from the VM user ID, the user is not notified.
userid specifies the VM user ID to receive Process completion messages.
- NOREPLACE
specifies to not replace a set of existing files with the same name at the destination node.
NOREPLACE takes effect only when the FROM and TO files are sets of files. The default is REPLACE.
NOREPLACE applies to an entire set of files as opposed to the NR option of the SELECT parameter, which applies to files within a set of files.
- nn
specifies the numeric value used for completion code checking. If specified as X‘nn’, it is a hexadecimal value. Any other specification indicates a decimal.
Typically, if a completion code less than 4 is returned, the Process completed successfully. In most cases, a return code greater than 4 indicates the Process ended in error. A return code equaling 4 indicates a warning.
- OLDDATE
specifies that the creation/last modified date and time of the file being transmitted is used to set the creation date and time of the file received.
If OLDDATE, the current date and time are used for the creation date and time of the received file.
Use the OLDDATE parameter for sequential file transfers between two Connect:Direct for VM/ESA systems, and transfers between a set of CMS files on Connect:Direct for VM/ESA to partitioned data sets (PDS) on Connect:Direct for z/OS systems.
- PACCT = ‘pnode-accounting-data’
specifies the accounting data for the primary node (PNODE). The maximum length of the accounting data is 256 characters. Enclose the string in single quotation marks if it contains special characters. This data overrides any accounting data specified on the SIGNON command and can be used by a user-written program or statistics exit.
- PARM = (parameter [, parameter,...])
specifies the parameters passed to the subtask when that subtask is attached. These parameters are the actual parameters rather than a list of addresses. Specify null parameters by adjacent commas (,,).
The parameter list format consists of a two-byte field, indicating the length of the parameter, followed by the parameter itself. The valid data types for the PARM parameter follow:
CLn’value’ specifies a data type of character with a length of n, where n is the number of bytes. The length is optional. If it is not specified the actual length of the value is used. If the length specified is less than the real value, the data is truncated. If the length specified is longer than the value, the value is padded with blanks on the right. For example, CL44’FILE.NAME’.
XLn’value’ specifies a data type of hexadecimal with a length of n, where n is the number of bytes. The length is optional. If it is not specified, the length of the value is used. If the length specified is less than the real value the data is truncated. If the length specified is longer than the value, the value is padded on the left with binary zeros. For example, XL8’FF00’.
H’value’ specifies a half-word value. No length is specified. The value can be specified with a plus (+) or minus (-) sign. For example, H’-32’. If no sign is provided, plus is assumed.
F’value’ specifies a full-word value. No length is specified. The value can be specified with a plus (+) or minus (-) sign. If no sign is provided, plus is assumed. For example, F’4096’.
PLn’value’ specifies a packed value. The length is optional. The length specifies the size of the field in bytes and cannot be longer than 16.
If the length is not specified, the length of the value is used. If the length specified is longer than the value, the value is padded to the left with zeros. The value can be specified with a plus (+) or minus (-) sign. For example, PL10’+512’. If no sign is provided, plus is assumed.
If no data type or length is specified, the parameter is assumed to be character type and the length of the parameter is used. For example, if PARM=(’FILE.NAME’) is specified, the length used is 9.
The parameter can also be specified as a symbolic value that is resolved when the Process is submitted. If a symbol is used, the parameter must be specified without a data type designation or length. For example, &PARM1.
Enclose strings comprised of symbolic substitution in double quotes. Use the data-type format if an ampersand (&) is passed as part of the parameter. For example, CL8’&PARM1’ uses no substitution; CL8"&PARM1" indicates that the value is substituted.
- PGM = program-name
specifies the name of the program that is attached as a subtask. This parameter is required.
The program runs on the specified node and has access to the DD statements allocated on that node only.
- PNODE
On a COPY statement, specifies the primary node in a file copy. When specified with the FROM parameter, the file to be copied resides on the primary node. When specified with the TO parameter, the file is sent to the primary node. PNODE is the default with the COPY FROM parameter.
On a Run Job statement, specifies that the job is submitted on the primary node, which is the default value.
On a Run Task statement, specifies that the program will be executed on the primary node, which is the default.
- PNODE = primary-node-name
specifies a 1-16 character alphanumeric name that declares the primary node (PNODE) to be used in this Process. The name can be expressed in alphanumerics or nationals (@ # $), with embedded periods.
The Process is always submitted is the PNODE. This parameter defaults to the name of the node submitting the Process and does not have to be specified. It is used for documentation purposes only.
- PNODEID = (id [,pswd ] [,newpswd])
specifies security user IDs and passwords at the primary node (PNODE). This parameter should only be used to validate security with an ID different from the one used to sign on to IBM Connect:Direct.
id specifies the security ID passed to the security system at the PNODE (1-8 alphanumeric characters).
pswd specifies the 1-8 alphanumeric character password for the specified ID. This parameter can be validated by the security system at the PNODE. This parameter is optional, unless the user’s security requires a password.
newpswd specifies a new 1-8 alphanumeric character password. It can be used by the security system to change the current security password to the new security password.
- PROCess
identifies the PROCESS statement. This statement identifier can be abbreviated to PROC.
- process name
specifies the 1-8 character name of the Process. The first character must be alphabetic and must start in column one. The PROCESS keyword must be on the same line as the Process name.
This label identifies the Process in any messages or statistics.
- PROTECT = Yes | No
specifies whether an IBM RACF profile will be created for a new file.
Yes specifies that a RACF profile will be created for a newly transferred file.
No specifies that a RACF profile will not be created. No is the default.
The PROTECT parameter is valid only with the TO parameter of the COPY statement.
- PRTY = n
specifies the Process priority in the Transmission Control Queue (TCQ). The TCQ holds all Processes submitted to IBM Connect:Direct. The higher the number, the higher the priority.
This priority is used only for Process selection within class and does not affect VTAM transmission priority. The range is from 0-15. If PRTY is not specified, the default is the priority defined by the PRTYDEF keyword in the IBM Connect:Direct initialization parameters.
- REQUEUE = Yes | No
specifies whether a COPY step should be queued again if an x37 termination occurs during processing. This parameter is valid only if used when checkpointing.
Yes places the Process in the Hold queue with a status of HELD IN ERROR (HE). You can then take corrective action and restart the Process at the failing step. Checkpointing resumes at the last successful checkpoint. The Process must be explicitly released from the Hold queue when the status is HELD IN ERROR (HE).
No enables the Process to run to completion, executing subsequent steps when a COPY step fails with an abnormal termination. The default is NO.
- REPLACE
specifies that the set of files replaces files of the same name on the destination node.
- RETAIN = Yes | No | Initial
keeps a copy of the Process in the Hold queue after the Process executes.
Yes keeps the Process in the Hold queue after initial execution. You must then do one of the following:
- Manually release the Process through the CHANGE PROCESS command to execute it
- Delete the Process through the DELETE PROCESS command
- Specify the STARTT parameter to release the Process again at
a specified interval. Using RETAIN=YES with STARTT will run a Process
repeatedly at a given interval. However, a date is invalid as a STARTT
subparameter when used in conjunction with RETAIN.
When a Process is submitted with RETAIN=YES and HOLD=NO or CALL, the HOLD parameter is ignored.
No specifies that the system deletes the Process after execution. This is the default value.
Initial specifies that the Process executes every time IBM Connect:Direct is initialized. The Process will not execute when initially submitted. Do not specify STARTT with RETAIN=INITIAL.
- RUN JOB
identifies the RUN JOB statement.
- RUN TASK
identifies the RUN TASK statement.
- SACCT = ‘snode-accounting-data’
specifies the accounting data for the SNODE. The maximum length of the accounting data is 256 characters. Enclose the string in single quotation marks if it contains special characters. This data overrides any accounting data specified on the SIGNON command and can be used by a user-written program or statistics exit.
This parameter is ignored when the SNODE is a Connect:Direct for i5/OSnode.
- SELECT = [(]member | generic | (*) | (member, [newname], [NR|R]) | (generic,,[NR|R]) (startrange/stoprange,, [NR|R]) | list [)]
selects files in a set of CMS files for copying.
generic specifies a generic filename. For example, if CDV* is specified, all filenames beginning with CDV and with the specified file type are selected to be copied.
(*) represents a global generic. A global generic indicates that all files in the set of files are included in the copy.
You can override a generic selection with the EXCLUDE parameter.
If you use a generic and specify NR or R as the third positional parameter, the second positional parameter must be null. For example, SELECT = (CDV*,,R).
member specifies an individual filename. This is the same as specifying a filename in the DSN.
You can override a filename selection with the EXCLUDE parameter.
newname specifies a new name for a file. If you use a a generic name or range is used as the first positional parameter, the newname parameter must be null.
NR specifies that a file will not replace an existing file with the same name at the destination. NR overrides the REPLACE parameter.
When used with the newname parameter, NR only applies to the newname and not to the original filename. When used with a generic name or with a range, NR applies to all selected files. NR applies to files within a set of files, as opposed to NOREPLACE, which applies to the set of files as a whole.
R specifies that a file will replace an existing file of the same name at the destination. R overrides the NOREPLACE option. R is the default.
When used with the newname parameter, R only applies to the newname and not to the original filename. When used with a generic name or with a range, R applies to all files selected for that criterion.
startrange specifies the first name in an alphanumeric range of files to select.
stoprange specifies the last name in an alphanumeric range of files to select.
Separate the startrange and stoprange parameters with a slash (/). Do not specify generic filenames (*) ar startrange or stoprange values. The first and last files specified in the range as well as all files between are selected.
You can override a selected range by specifying an individual filename in the EXCLUDE parameter.
If you specify a file range, with the NR or R option, you must leave the second positional parameter as null. For example, SELECT = (file1/file99,,R).
- SFSDIR=(’dirid’, [CRE , NOCRE])
specifies the location of the Shared File System (SFS) managed file.
dirid specifies the directory name where the SFS file resides. The maximum length is 153 characters. The minimum specification for dirid is ’poolid:userid.’
CRE creates a new or extend an existing subdirectory, if the user has creation authority. This is the default.
NOCRE neither creates a new subdirectory nor extends an existing subdirectory.
You cannot specify the SFSDIR and the LINK parameters for the same file.
- SNODE
On a Copy statement, specifies the secondary node. When SNODE is specified with the FROM parameter, the file to be copied resides on the secondary node. When SNODE is specified with the TO parameter, the file is sent to the secondary node.
On a Run Job statement, specifies that the job is submitted on the secondary node.
On a Run Task statement, specifies that the subtask will be attached on the secondary node.
- SNODE = secondary-node-name
is a 1-16 character alphanumeric name that specifies the secondary node (SNODE) used in the Process. The name can be alphanumerics or nationals (@ # $) with embedded periods. This parameter is required for the PROCESS statement, unless it is specified in the SUBMIT statement.
This is the logical node name that has been defined in the ADJACENT.NODE entry for that node in the network map. The PNODE and SNODE can specify the same symbolic node name.
When used in the SUBMIT statement, this parameter overrides the value specified in the PROCESS statement. The default value for SNODE is the value specified in the PROCESS statement.
- SNODEID = (id [,pswd ] [,newpswd])
specifies security user IDs and passwords at the SNODE.
For Connect:Direct for i5/OS, if the Process submitter’s SNODEID and password is not specified in the PROCESS statement, the Process submitter’s user ID and password is used for theConnect:Direct for i5/OS security ID and password check.
id specifies the 1-8 character security ID passed to the security system on the SNODE.
For Connect:Direct for HP NonStop, this subparameter specifies the HP NonStop group number and user number. These numbers can range from 0-255. Use a period as a separator between the group number and the user number.
For Connect:Direct for i5/OS, this subparameter specifies the i5/OS user profile used for authorization checks during Process execution. It is limited to 8 characters even though i5/OS user profiles may be 10 characters long.
pswd specifies the current 1-8 character security password and can be used by the SNODE security system to validate the security password. This is optional unless the user’s security requires a password.
For Connect:Direct for HP NonStop, the VM node only recognizes passwords specified in uppercase alphanumeric characters. A Process cannot be successfully initiated from Connect:Direct for VM/ESA with Connect:Direct for HP NonStop unless the Connect:Direct for HP NonStop SNODEID password only contains uppercase alphanumeric characters (no control characters).
newpswd specifies the new 1-8 alphanumeric security password and can be used by the security system to change the current password to a new password.
For Connect:Direct for HP NonStop, SAFEGUARD must be running on HP NonStop.
For Connect:Direct for i5/OS,this subparameter is ignored.
- STARTT = ([date | day][,hh:mm:ssXM])
specifies that the Process will be executed at a selected date or time. The date, day, and time are positional parameters. If the date or day is not specified, a comma must precede the time.
Do not specify STARTT with RETAIN=INITIAL.
If you specify both HOLD=YES and a STARTT value in a Process, the HOLD specification takes precedence, and the Process is placed in the Hold queue.
date specifies that the Process starts on a specific date. Depending on the value of the DATEFORM initialization parameter, you can specify the date in one of the following formats:
DATEFORM Value Formats DATEFORM=MDY (default) mm/dd/yy mm/dd/yyyy mm.dd.yy mm.dd.yyyy DATEFORM=DMY dd/mm/yy dd/mm/yyyy dd.mm.yy dd.mm.yyyy DATEFORM=YMD yy/mm/dd yyyy/mm/dd yy.mm.dd yyyy.mm.dd DATEFORM=YDM yy/dd/mm yyyy/dd/mm yy.dd.mm yyyy.dd.mm You can use periods or slashes (/) to separate the components of a date value. You can omit the period or slash separators for transfers between mainframe nodes.
If you only specify a date, the time defaults to 00:00.
If you specify RETAIN=YES, you cannot specify a date in the STARTT parameter.
Valid Julian date formats are yyddd, yyyyddd, yy/ddd, yyyy/ddd, yy.ddd, or yyyy.ddd.
day specifies the day of the week to release the Process for execution. Valid names include MOnday, TUesday, WEdnesday, THursday, FRiday, SAturday, and SUnday. You can abbreviate the day value to the first two characters.
If the day of the week is specified with RETAIN=YES, the Process executes the same day every week. If only day is specified, the time defaults to 00:00. Therefore, if a Process is submitted on Monday, with Monday as the only STARTT parameter, the Process does not run until the following Monday.
You can also specify TODAY, which releases the Process for execution the day and time of Process submission (unless the time of day is specified), or TOMORROW, which releases the Process for execution the next day.
hh:mm:ssXM indicates the time of day the Process will be released in hours (hh), minutes (mm), and seconds (ss). XM can be set to AM or PM.
You can specify the time of day using the 24-hour clock or the 12-hour clock. If you use the 24-hour clock, valid times are from 00:00:00 to 24:00:00. If you do not use AM and PM, the 24-hour clock is assumed.
If you use the 12-hour clock, 01:00:00 hours can be expressed as 1:00AM, and 13:00 hours can be expressed as 1:00PM.
If you specify hh:mm:ssXM with RETAIN=YES, the Process executes at the same time every day. You do not need to specify minutes and seconds.
You can also specify NOON, which releases the Process for execution at noon, or MIDNIGHT to release the Process for execution at midnight.
- stepname
specifies the user=defined name of the Copy, Run Job, Run Task, or Submit step.
Stepnames must begin in column one. Stepnames are 1-8 character alphanumeric strings. The first character must be alphabetic.
- SUBMIT
identifies the SUBMIT statement.
- SUBNODE = PNODE | SNODE
specifies the node where the Process defined in a SUBMIT statement will execute. PNODE indicates that the Process is submitted on the node that has Process control. SNODE indicates that the Process is submitted on the node participating in, but not controlling, Process execution. In both cases, the Process must reside on the node on which it is being submitted. The default is PNODE.
- SYMBOL
identifies the SYMBOL statement.
- &symbolic_name=variable-string
specifies a string that is substituted into the Process.
When IBM Connect:Direct encounters an ampersand (&) followed by 1-17 alphanumeric characters, IBM Connect:Direct substitutes a string represented by that ampersand and the alphanumeric characters.
Symbols in the string are resolved from previously specified values in a PROCESS, SUBMIT, or SYMBOL statement. With the SYMBOL statement, different pieces of a IBM Connect:Direct statement string can be concatenated, enabling you to move data in a variety of ways.
Specify a null value by an equal sign (=) immediately followed by a comma. Enclose a symbolic parameter containing special characters in single quotation marks.
- &symbolic_name_1 = variable-string-1
&symbolic_name_2 = variable-string-2
.
.
.
&symbolic_name_n = variable-string-n specifies the default value for a symbolic parameter in the Process. You can override this value in the SUBMIT command.
Enclose a symbolic parameter containing special characters in single quotation marks. Specify a null value by the equal sign (=) immediately followed by a comma.
The symbolic parameter for the SUBMIT statement must begin with a single ampersand. This allows correct symbolic parameters resolution.
An ampersand symbolic parameter can be set to a single ampersand symbolic parameter that was resolved during the first Process submission.
Do not use identical symbolic names.
- SYSOPTS='!SPOOL[CLASS x] [DIST distcode | * | OFF] [FORM form | OFF]'
specifies CLASS, FORM and DISTCODE values for !SPOOL output. You can specify one, two, or all three subparameters. Enclose the !SPOOL string in single or double quotes.
The following is an example:
COPY FROM (DSN='SUPPORT.VM1500.TEXT' SNODE ) - TO (DSN='!SPOOL MAINT * TEXT' - SYSOPTS='!SPOOL CLASS B DIST VM1500' - ) COMPRESS PRIMECHAR=X'00'
- THEN
specifies the subsequent processing to perform if the specified condition is met.
- TO
specifies the destination file characteristics. This parameter is required.
- (TO) DISP = [NEW|OLD|RPL|SHR|MOD]
specifies the destination file disposition. Values are:
NEW specifies that the Process step will create the destination file. NEW applies to SAM files only. NEW is the default.
OLD specifies that the destination file existed before the Process began executing. If DISP=OLD, the destination file can be a VSAM file or a SAM file.
RPL specifies that the destination file will replace any existing file or allocate a new file. DISP=RPL can be specified for SAM files only.
SHR specifies that the destination file existed before the Process began executing and that the file can be used simultaneously by another job or Process.
MOD specifies that the Process step will modify the SAM file by appending data at the end of an existing file. If a file does not exist, a new file is allocated
Only OLD and RPL apply to VSAM files.
- (TO) DSN = ’filename filetype’ | DSN = ’!SPOOL vmid fn ft’ | GROUP = ’%1% ... %N%’
specifies the destination filename and file type, or VSAM filename.
If copying the file to a Connect:Direct for VM/ESA node, enclose the filename in single quotation marks.
This parameter is required.
Connect:Direct for VM/ESA can be used to spool files to a specific virtual reader. This is useful for downloading files, because IBM Connect:Direct cannot gain write access to a primary user minidisk. The spooled data is in Netdata format (the same as files sent with the CMS SENDFILE command).
To send a file to the virtual reader, use the following format, where vmid is the machine ID of the virtual reader at the destination, and fn and ft are the filename and file type of the spooled file:
DSN=’!SPOOL vmid fn ft’
To spool a set of files on a minidisk with the same file type, enter the following, where vmid is the machine ID of the virtual reader at the destination, and ft is the file type of the file(s) to be spooled:
DSN=’!SPOOL vmid * ft’
If you are using !SPOOL and your keyboard does not interpret ! as X’5A’, use the key that translates to 5A.
- TYPE = typekey
specifies the member name of the type defaults file. This file contains the file attribute defaults used to open the destination file.
- UNIT = (3480 | 3480X |TAPE)
specifies the device type. Acceptable values are 3480, 3480X and TAPE.
3480X specifies that the unit type is an IDRC-compatible drive.
- VOL = (,, [volume sequence number], [volume count], SER=volume serial number | (list))
specifies the volume serial numbers containing the file. If VOL is not specified with the FROM parameter, the file must be cataloged.
volume sequence number (for tape files) is a number ranging from 1-255 and is used to begin processing. The default is 1.
volume count (for tape files) specifies the maximum number of volumes needed for an output type file. The default is 5.
ser specifies by serial number the volumes where the file resides or will reside. A volume serial number is 1-6 alphanumeric characters.
- VSAMCAT = (dsn, vmid, pwd, accmode, ccuu)
specifies the catalog for the VSAM file to be copied. This parameter is required only if you use a catalog other than the master catalog.
dsn specifies the filename of the VSAM catalog containing the file to be copied. The maximum length is 44 characters.
vmid specifies the owner ID for the VSAM minidisk where the file is located. The maximum length is 8 characters.
pwd specifies the appropriate password for the VSAM minidisk where the file is located. The maximum length is 8 characters.
accmode specifies the link access mode. Valid access modes are:
- NULL
- W (primary read/write access)
- M (primary multiple access)
- MW (primary multiple access; alternate read/write only access).
CAUTION:MW access to CMS format disks can be destructive. You must guarantee that no other VM user, or IBM Connect:Direct Process, has MW, M, or W access to the minidisk. If multiple users or Processes get write access to the disk at the same time, there is a high probability that the CMS directory on the disk will be destroyed. The most likely result is a message from Group Control System (GCS) or an equivalent message from CMS. The GCS message will indicate that a CSIFNS420T file system error was detected. When GCS issues the CSIFNS420T message, GCS terminates all processing.ccuu specifies the virtual address of the disk where the VSAM file is located. Any four-digit number is valid.