Use FileCheckout to create the slave copy of a master file.
FileCheckout may also be entered as CheckoutFile, Checkout, or ChkO.
FileCheckout is supported for BIM files only. It is not supported for workstation, PDS, or VSE files.
Required Operands
FILE is the BIM file that will be the master in the check-out relationship. This file must have CHECK=ON (see the FileDefine and FileAlter commands) and must not already be checked out.
Optional Operands
DIR is the BIM directory in which to create the slave file. DIR must not be the same as the FILE directory.
Default: Currently attached directory.
USER is the user to check out the file to.
Default: Log-on user ID.
A slave copy of the FILE file will be created and stored in the DIR directory under the FILE file name.
This command is intended for use in a situation where a directory of master (production) files is to be maintained in a controlled manner. The check out/check in mechanism assures that all modifications are made to slave copies of the master and that only one slave of a master exists at a time. If many people have LIST access level to the master directory, they can all checkout slave copies. If only one person has DEF access level, that person controls all checkin(s). If an independent copy of a master is desired, use the FileCopy command. The slave file is created with all of the master file attributes, with the exception that is it flagged as the slave in the check-out relationship. Both the file text and the audit trail (if it exists) are copied. A slave in a checkout relationship can be edited only by the user to whom the file is checked out, but that user can edit the slave even if it is in a directory to which the user does not have access.
A slave cannot be purged by the FileDelete command. It can be eliminated either by the FileCheckin or the FileCheckDelete command. The AUDIT, CHECK, and STAMP attributes of a slave cannot be altered by the FileAlter command. Other attributes can be altered, but the attributes are lost when the member is checked in.
The master file is updated to indicate that it is checked out to the slave directory, and the check out user ID. The attributes of the master file can be displayed with the FileInquire command.
The host BIM-EDIT INCLUDE Commands behave somewhat differently when they are contained in the slave file of a check-out relationship. For purposes of INCLUDE expansion, the file is assumed to be part of the directory where the master resides. Therefore, if the full file name (lib.mem) is not specified with the INCLUDE command, BIM-EDIT will include the file from the master directory, not the slave directory. To INCLUDE a file from the slave directory, specify the full file name.
FileCheckout sets last referenced file to the slave file.
When Valid
If USER is entered and not equal to the log-on user ID, the user must have DEF access level to FILE directory. Otherwise, the user must have LIST access level to the FILE directory. In any event, the user must have DEF access level to the DIR directory. FILE must have CHECK=ON (see the FileDefine and FileAlter commands) and must not already be checked out.
Return Codes
OK Successful.
CK One of the following:
File is already checked out.
File is not under checkout control.
DP File already exists in the DIR directory.
NF One of the following:
User not found.
File not found.
DIR directory not found.
SC Inadequate access level.
FileCheckout sets the TXM variables to the attributes of the slave file.
Examples
Checkout BIM file OM20.OMRPWR3 to directory GJB for user GJB:
=> chko om20.omrpwr3,gjb,gjb
Checkout BIM file OM20.OMREXIO for ourselves. Place it in the currently attached directory:
=> chko om20.omrexio