You can specify installation parameters for openFT in this element.
The description of the FJGEN command (FJGEN - Set installation parameters) shows the structure of the batch job which is required for openFT to run as a background task (FJBATCH member of the FT procedure library). This job remains unchanged even if you specify installation parameters in the PARM member of the FT parameter library. In particular, the string containing the start parameters in the batch job remains unchanged. If, however, you also specify a corresponding parameter in the PARM member, openFT uses this value; the value from the start parameters is not used in this case.
Each line of the PARM member can contain exactly one parameter in the form "keyword=value". No blanks may be inserted between "keyword", "=" and "value". Below is a list of the keywords which may be used.
Keywords:
DESTVOL=
Definition of the volume for local receive files which do not exist and for files used to store the result lists (LISTING=*LISTFILE). Exactly 6 characters. See also the description of the DESTUNIT parameter.
DESTUNIT=
Definition of the unit/groupname for local receive files which do not exist and for files used to store result lists (LISTING=*LISTFILE). Maximum 6 characters.
If you specify a value for only one of the parameters DESTVOL and DESTUNIT, openFT assigns blanks to the other. If you do not specify a value for either of the parameters DESTVOL and DESTUNIT, receive files which do not exist and files for result lists are created on the default volume (system-specific).
UNLOADVOL=
Definition of the volume for temporary PS data sets with the suffix ".U" to which the entire PO/PDSE data sets are transferred (in "unloaded" format) prior to file transfer. Exactly 6 characters. See also the description of the UNLOADUNIT parameter.
UNLOADUNIT=
Definition of the unit/groupname for temporary PS data sets with the suffix ".U" to which entire PO/PDSE data sets are transferred (in "unloaded" format) prior to file transfer. Maximum 6 characters.
If you specify a value for only one of the parameters UNLOADVOL and UNLOADUNIT, openFT assigns blanks to the other. If you do not specify a value for either of the parameters UNLOADVOL and UNLOADUNIT, the temporary PS data sets are created on the default volume (system-specific).
In order to transfer entire PO/PDSE data sets, openFT must be APF-authorized (see section “openFT privileges”).
PODIR=
Number of directory blocks which are to be reserved by openFT when creating a PO data set. Maximum value: 32767 (default: 20).
DSTYPEDEF=
Default value for file organization if the receive file of a file transfer request is to be created as a sequential file whose file organization is not precisely defined by the structure of the send file (if homogeneous systems are used as of V10 partners) or the file name (see the manual "openFT (z/OS) - Command Interface").
Possible Values:
PS | A "physical sequential data set" (PS data set) is created. |
VSAM | A VSAM file of type "entry sequenced" is created. |
If no value or an invalid value is specified for the DSTYPEDEF parameter, the default value PS applies.
LIBTYPEDEF=
Default value for the file organization if a data set (library) divided into members is to be created for a file transfer request in the receive system and the file organization is not precisely defined by the structure of the send file (if a complete PO or PDSE data set is transferred as of V10 partners) or the file name (see the manual "openFT (z/OS) - Command Interface").
This value is important
when a member is the receive file, the associated data set does not yet exist and the type (PO/PDSE) has not been specified (prefix :L: or no prefix),
when a complete PO or PDSE data set is the receive file, the type (PO/PDSE) has not be specified precisely (prefix :L:).
Possible values:
NONE | openFT does not specify the file organization, the system defaults |
if the IBM software product DFSMS (Data Facility System-Managed | |
if DFSMS is active: definition of the default by the ACS routine or | |
PO | A "partitioned organized data set" (PO data set) is created. |
PDSE | An attempt is made to create a "partitioned organized data set extended" |
If no value or an incorrect value is specified for LIBTYPEDEF, the default value NONE applies.
PDSESTORC=
SMS storage class for PDSE data sets (refer to the literature on the IBM software product DFSMS for further details).
Maximum 8 characters; valid name of an SMS storage class.
The value is only used if there are no settings concerning the SMS storage class on your system (please ask your z/OS system administrator).
Please observe the description of the PDSEDATAC parameter.
PDSEMGMTC=
SMS management class for PDSE data sets (refer to the literature on the IBM software product DFSMS for further details).
Maximum 8 characters; valid name of an SMS management class.
This value is only used if there are no settings concerning the SMS management class on your system (please ask your z/OS system administrator).
Please observe the description of the PDSEDATAC parameter.
PDSEDATAC=
SMS data class for PDSE data sets (refer to the literature on the IBM software product DFSMS for further details).
Maximum 8 characters; valid name of an SMS data class.
This value is only used if there are no settings concerning the SMS data class on your system (please ask your z/OS system administrator).
The parameters PDSESTORC, PDSEMGMTC and PDSEDATAC only become effective if a PDSE data set is to be newly generated as a receive file (either because a complete PDSE file set was specified as the receive file or because a PDSE member is a receive file, but the relevant PDSE data set does not exist yet).
The parameters all only become effective if your system does not contain any specifications for the relevant SMS class.
As a rule, you should not specify any of these parameters; the settings made in your system will then apply. Exception: if no settings are made in your system for any of the SMS classes, you must specify at least one of the parameters PDSESTORC, PDSEMGMTC and PDSEDATAC, otherwise openFT will not be able to generate a PDSE data set.
An invalid specification for one of the parameters, which will become effective (because there are no default settings for the relevant SMS class in your system) will cause those transfer requests to fail for which a new PDSE data set has to be generated on the receive system. Further details are contained in the manual "openFT (z/OS) -
Command Interface").
POSTORC=
SMS storage class for PO data sets (refer to the literature on the IBM software product DFSMS for further details).
Maximum 8 characters; valid name of an SMS storage class.
This value is only used if there are no settings concerning the SMS storage class on your system (please ask your z/OS system administrator).
Please observe the description of the PODATAC parameter.
POMGMTC=
SMS management class for PO data sets (refer to the literature on the IBM software product DFSMS for further details).
Maximum 8 characters; valid name of an SMS management class.
This value is only used if there are no settings concerning the SMS management class on your system (please ask your z/OS system administrator).
Please observe the description of the PODATAC parameter.
PODATAC=
SMS data class for PO data sets (refer to the literature on the IBM software product DFSMS for further details).
Maximum 8 characters; valid name of an SMS data class.
This value is only used if there are no settings concerning the SMS data class on your system (please ask your z/OS system administrator).
If PO data sets are to be created as SMS-managed data sets (prerequisite for this is that the IBM software product DFSMS is installed), the same in essence applies for parameters POSTORC, POMGMTC and PODATAC as for parameters PDSESTORC, PDSEMGMTC and PDSEDATAC (see description of parameter PDSEDATAC in section “Structure of the PARM member”).
JOB_MSGCLASS=
Message class of the follow-up processing job, the preprocessing job and the postprocessing job. This is the default value for the JOB statement parameter MSGCLASS= if the members TSOJOB, JCLJOB, TSOVVJOB, TSOVFJOB or TSONVJOB contain no relevant entry. Exactly 1 character (default value: A).
LST_MSGCLASS=
Message class of the job for printing the result list. This is the default value for the JOB statement parameter MSGCLASS= if the member PRTJOB contains no relevant entry. Exactly 1 character (default value: A).
LISTPARM=
Requests a result list in the local system. This listing is generated for the user for whom file transfer is performed. The value specified here applies to the NCOPY command if LISTING=*STD is specified there.
Possible values: LISTFILE, SYSLST and NONE, meaning see NCOPY command.
JOB_JOBCLASS=
Job class of the follow-up processing job, the preprocessing job, the postprocessing job, and the print job. This is the default value for the JOB statement parameter CLASS= if the members TSOJOB, JCLJOB, TSOVVJOB, TSOVFJOB, TSONVJOB or PRTJOB contain no relevant entry.
Exactly 1 character (default value: A).
NABVOLUME=
The volume on which the request file, the partner list, the operating parameter file, the logging file and the FTAC file are to be located (see section “Internal openFT data sets”).
Exactly 6 characters.
If the corresponding files are SMS managed, the specifications for Volume and Unit may have no effect under certain circumstances. If the files are not SMS managed, an "SMS managed volume" must not be specified here.
See also the description of the NABUNIT parameter.
NABUNIT=
Definition of the unit/groupname of the volume on which request file, the partner list, the operating parameter file, the logging file and the FTAC file is to be set up. Maximum 6 characters.
If you specify a value for only one of the parameters NABVOLUME and NABUNIT, openFT assigns blanks to the other.
If you do not specify a value for either of the parameters NABVOLUME and NABUNIT, the values of DMP_VOLUME and DMP_UNIT (see below) are assumed. Either or both of these values may in turn have been taken from the values specified for VOLUME/UNIT in the FJGEN command.
LOGFILE_2ND_Q=
The second level qualifier for creating the names of the components of the logging file (see section “Internal openFT data sets”).
Up to 18 characters (default: <inst>.SYSLOG, where <inst> is the name of the openFT instance). For the sake of clarity, the name should always start with the instance name followed by a period.
This name must be specified in partially qualified form, i.e. with no "first level qualifier" or single quotes. openFT prefixes this name with the OPENFT QUALIFIER specified in FJGEN.
LOGFILE_SIZE_RC=
Initial size of the logging file (number of logging records).
Maximum value: 16777215 (default: 10000).
openFT uses this value as the primary allocation when creating the VSAM cluster which is part of the logging file. For the secondary allocation, the value is halved.
The specified maximum value is the program-technical limit. When choosing a value for the initial size of the logging file, the actually available storage space needs to be taken into consideration. Note that the logging file is created on the same data volume as the request file, the partner list and (if FTAC is installed) the FTAC file (see section “Internal openFT data sets”).
DMP_VOLUME=
Definition of the volume on which openFT creates the dump and trace files. Exactly 6 characters (default: value specified for VOLUME in the FJGEN command; see the description of the FJGEN command, section “FJGEN - Set installation parameters”). You can also use "DMP_VOLUME= " to specify that the value specified for VOLUME in the FJGEN command is not used when the dump and trace files are created. See also the description of the DMP_UNIT parameter.
DMP_UNIT=
Definition of the unit of the volume on which openFT creates the dump and trace files. Maximum 6 characters (default: value specified for UNIT in the FJGEN command (section “FJGEN - Set installation parameters”).
You can also use "DMP_UNIT= " to specify that the value specified for UNIT in the FJGEN command is not used when the dump and trace files are created.
If, after evaluation of the specifications for FJGEN (VOLUME/UNIT) and the specifications made here, there is no value for DMP_VOLUME or for DMP_UNIT, openFT uses the UNIT name DASD. This UNIT name must then be defined in the system.
Examples
VOLUME/UNIT (FJGEN) | FTMSPPAR | Result |
VSN123/SYSDA | DMP_VOLUME=VSN456 | DMP_VOLUME = VSN456 |
VSN123 | DMP_UNIT=SYSDA | DMP_VOLUME = VSN123 |
/ | DMP_VOLUME=VSN456 | DMP_VOLUME = VSN456 |
VSN123/SYSDA | DMP_VOLUME= | DMP_VOLUME = no value |
VSN123 | DMP_VOLUME= | DMP_VOLUME = no value |
/ | no specifications | DMP_VOLUME = no value |
ROUTCDE=
Routing code of one console to which the openFT asynchronous messages are to be output. (Note openFT uses the WTO macro to output these messages to the console.)Valid values: 1 through 128. Invalid values are ignored and no message is issued.
SMF_RECORD_TYPE=
Type of the accounting record written by openFT to the SMF file. Valid values:
128 through 255 | For each transfer request accepted, an accounting record of the |
0 | No accounting records are written to the SMF file. (Default; values |
SMF_ADM_AREA=
Installation-specific text written by openFT to the FT administrator area of the accounting records (see the description of the accounting record structure in the section “Accounting records”). This text may be up to 40 characters long. Default: blanks.
In order to enter SMF accounting information, openFT must be APF-authorized (see section “openFT privileges”).
SUCC_MSG=
Specifies when an asynchronous message indicating successful file transfer is to be issued. Valid values:
IN | An asynchronous message indicating successful file transfer is output |
OUT | An asynchronous message indicating successful file transfer is output |
BOTH | An asynchronous message is output for all transfer requests following |
Invalid values are ignored and no error message is issued. In this case, no asynchronous message is output following successful file transfer (default value).
The destination for output of the asynchronous message after successful file transfer is controlled by the keyword ENDMSG_ROUTCDE (see below).
The message text for the asynchronous message following successful file transfer can be defined in the SUCCMSG member of the FT parameter library; otherwise, openFT uses a standard text (see section “Structure of the members SUCCMSG and FAILMSG”).
In order to output asynchronous messages following termination of a request, openFT must be APF-authorized (see section “openFT privileges”).
FAIL_MSG=
Specifies when an asynchronous message indicating unsuccessful file transfer is to be output. Valid values:
IN | An asynchronous message indicating unsuccessful file transfer is output |
OUT | An asynchronous message indicating unsuccessful file transfer is output |
BOTH | An asynchronous message is output for all transfer requests following |
Invalid values are ignored and no error message is issued. In this case, no asynchronous message is output following unsuccessful file transfer (default value).
The destination for output of the asynchronous message after successful file transfer is controlled by the keyword ENDMSG_ROUTCDE (see below).
The message text for the asynchronous message following unsuccessful file transfer can be defined in the FAILMSG member of the FT parameter library; otherwise, openFT uses a standard text (see section “Structure of the members SUCCMSG and FAILMSG”).
In order to output asynchronous messages following termination of a request, openFT must be APF-authorized (see section “openFT privileges”).
ENDMSG_TO_TSO=
Switch for controlling the output of asynchronous messages to a TSO terminal at the end of a job. The output is made to the terminal of the TSO user whose user ID was specified in the TRANSFER-ADMISSION. The messages are only output for jobs issued locally; You can find them in the section “FTR messages”.
Possible values:
YES | (Default): The asynchronous messages are output. |
NO | (Or invalid value): The asynchronous messages are not output. |
The asynchronous messages output to a TSO terminal at the end of a job also appear in the openFT job protocol (see section “The openFT job log”).
ENDMSG_ROUTCDE=
Routing code of one console to which the asynchronous messages are to be output at the end of a job. The cases in which an asynchronous message is output at the end of a job is controlled by the keywords SUCC_MSG and FAIL_MSG (see above).
Possible values: 1 to 128. Invalid values are ignored and no message output.
If the keyword is missing or assigned no (or an invalid) value, no output is made to the console.
The asynchronous messages output to a console at the end of a job are assigned a key (FJM2100 for the message following successful file transfer); this makes it possible to process these messages with NetView. The messages also appear in the job protocol openFT in this form (see section “The openFT job log”).
TCP_USERID=
Name of the TCP/IP address space. If the name of the TCP/IP address space is not TCPIP (default), you must specify it here. Message FTR4055 can indicate that the name of the TCP/IP address space has not been specified correctly. Ask your z/OS system administrator.
Up to 8 characters (default: TCPIP).
MSG_CRYPT=
Optionally, it is possible to encrypt the messages from the openFT dialog tasks for the purposes of internal communications with the openFT subsystem. Commands are always encrypted. The mechanism employed is the same as for the encryption of the request description data.
Valid values:
Y | Messages are encrypted. |
N | Messages are not encrypted (default). |
CMD_TRANS=
You use this switch to define the transport protocol to be used to connect the dialog tasks to the openFT subsystem. If openFT implicitly recreates the parameter library then CMD_TRANS=TCP is preset.
Valid values:
VTAM | Communication is performed via VTAM. |
TCP | Communication is performed via TCP (default) |
OPENFT_SVC=
The openFT subsystem administers all the running instances and encrypts or decrypts all the commands, messages (optional, see the MSG-CRYPT parameter) and connection data. The portal to the subsystem is implemented via SVC 109 with "extended code 211". This ESR SVC code is defined using OPENFT-SVC. If "extended Code 211" is already used for a different purpose in your system, you can use the LINK procedure
LINKIGX from the SAMPLES library in order to utilize your extended code. For reasons of security, OPENFT-SVC should be set to a valid value.
USER_INACT_TIME
This specification defines a maximum idle time (in minutes) before a connection between the user TSO interface and the openFT subsystem will be terminated for security reasons.
Valid values:
0 ..30 | Time specification for the maximum idle time in minutes. |
PSSTORC=
SMS storage class for PS datasets. For further details, see the documentation on the IBM software product DFSMS.
Up to 8 characters; valid name of an SMS storage class.
This value only has any effect of there is no default specification for the SMS storage class in your system (ask your z/OS system administrator).
Refer also to the description of the PSDATAC parameter.
PSDATAC=
SMS data class for PS datasets. For further details, see the documentation on the IBM software product DFSMS.
Up to 8 characters; valid name of an SMS data class.
This value only has any effect of there is no default specification for the SMS data class in your system (ask your z/OS system administrator).
DEFFSIZE=
Size of a secondary allocation for the receive file if the size of the send file is unknown. DEFFSIZE is specified in bytes. In this case, the primary allocation is approximately one tenth of this value. If this specification is omitted, DEFFSIZE=2621440 is taken. The DEFFSIZE parameter also influences the size of the temporary file for data output that is used during preprocessing and/or preprocessing with FTEXEC. If, for example, you
want to retrieve large data volumes from z/OS at an external platform using the FTEXEC command or GUI available there then you should set the DEFFSIZE parameter to a sufficiently large value (see also the PALC and SALC parameters during preprocessing with FTEXEC in section “Structure of the members PRTJOB, JCLJOB, TSOJOB, TSOVVJOB, TSOVFJOB and TSONVJOB”). For further details, refer to the section "File types - z/OS files" in the User Guide.
MAXALLOC=
Maximum size of file allocations (both primary and secondary). MAXALLOC is specified in megabytes. The default value is 1024, and the (theoretical) maximum value is 32767.
TZSTRING=
This parameter describes the timezone and the dates when the local time is changed from winter to summer and from summer to winter time.
This entry is required for the complete reading of the openFT logging records when changing from winter to summer time. It is therefore important that the time zone in which openFT is located is entered exactly.
During installation of openFT the value of the parameter TZSTRING is set to the default value CET – Central Europe Time:
CET-1CEST,M3.5.0,M10.5.0/3.
General format of the TZSTRING value:
STD OFFSET1[DST[OFFSET2],[START[/TIME],END[/TIME]]] Parts STD and OFFSET1 are mandatory and the rest is optional. | |
STD | Specifies the name of the time zone. It must be three or more letters only. There is no space character separating the time zone name from the offset. |
OFFSET1 | Specifies the time value which must be added to the local time to get a Coordinated Universal Time value. It has syntax like [+|-]hh[:mm[:ss]]. This is positive if the local time zone is west of the Prime Meridian and negative if it is east. The hour must be between 0 and 24, and the minute and seconds between 0 and 59. |
DST | The DST string specifies the name for the corresponding Daylight Saving Time zone. |
OFFSET2 | Specifies the offset for the corresponding Daylight Saving Time zone; if the offset is omitted, it defaults to one hour ahead of standard time. |
START | Specifies when DST goes into effect. Format is Mm.w.d where: m= month, must be between 1 and 12 w= week, must be between 1 and 5, 1 is the first week of month and 5 is the last d= day of week, 0 is Sunday, 6 is Saturday |
END | Specifies when change is made back to standard time. Format is Mm.w.d where: m= month, must be between 1 and 12 w= week, must be between 1 and 5, 1 is the first week of month and 5 is the last d= day of week, 0 is Sunday, 6 is Saturday |
TIME | For both fields START and END the field TIME has the same meaning - specifies when, in the local time currently in effect, the change to the other time occurs. It has a default value 2:00:00 and can be then omitted. |
Example of the member PARM
DESTVOL=TSO000 DESTUNIT=SYSDA UNLOADVOL=TSO000 UNLOADUNIT=SYSDA DSTYPEDEF=PS LIBTYPEDEF=PO JOB_MSGCLASS=X LST_MSGCLASS=X SUCC_MSG=BOTH FAIL_MSG=BOTH ENDMSG_TO_TSO=YES TCP_MYPORT=1100 LOGFILE_2ND_Q=OPENFTLG
Primary and secondary allocation
When openFT receive files are created in z/OS, the primary allocation approximately corresponds to the (possibly estimated) size of the send file (at least 42 kilobytes, however) plus 128 kilobytes (DEFFSIZE/20). The secondary allocation approximately corresponds to a quarter of the size of the send file plus 512 kilobytes (DEFFSIZE/5). See section “Structure of the PARM member” for details on DEFFSIZE.
If a PO/PDSE file is created by generating a member, the primary allocation is twice the size of the send file (at least 42 kilobytes, however) plus 256 kilobytes (DEFFSIZE/10). The secondary allocation is slightly less than twice the size of the primary allocation.
If the size of the send file is unknown to openFT internally (e.g. in the case of a file transfer with preprocessing and/or preprocessing using the FTEXEC command respectively), or if the size of the send file is not passed to the z/OS receiving system with the protocol used (as is the case, for example, with the FTP protocol), the primary allocation for the receive file in z/OS is 256 kilobytes (DEFFSIZE/10) and the secondary allocation is 2560 kilobytes (DEFFSIZE).
In the case of very large files, it is not always possible to reserve the entire space with a primary allocation, and there are also restrictions for secondary allocations. These limits depend partly on the hardware properties of the disks (a maximum of 65535 tracks per file on a volume) and partly on the current disk occupancy (in the case of multivolumes). For this reason, it is possible to restrict the maximum size of an allocation (both primary and secondary) to a maximum value MAXALLOC, see section “Structure of the PARM member”. If the allocations calculated using the method described above do not exceed this threshold, MAXALLOC is of no significance.