7.  Commands


With a mouseclick you get a describtion of the screen item.

General Remarks regarding CFS Commands

Using commands - entered in the COMMAND field of the file list - functions of CFS that are not directly connected with a particular data element can be executed. For example, moving the window within a data list, or searching the list for an entry.

CFS functions that have no connection with the displayed file list can also be called using commands. For example, calling software components as a subprogram of CFS (EDT, EDOR, LMS, PERCON,...), opening subtasks (LOGON to any userid), connecting to UTM and DCAM applications; for a complete description, see Chapter 9 "Connections").

Commands for displaying and modifying data elements can also be entered in the COMMAND field. For more details, see Chapter 8 "CFS Display/Editor".

Finally, general program modes can be set or reset in the CFS command field. See Chapter 18 "Modifying Parameters".

K-/F-/DUE-Keys

In CFS, the K1 key returns you to the previous hierarchical level.

              LST  NP        *|END

Display Mode ---> File list ---> Selection mask ---> End CFS.

           K1  K1         K1

Pressing the K1 key will stop further display of Help information, as well as further processing of I/IM Actions.

In a file list, the F2 key results in all the displayed file names being made overwriteable for the purpose of renaming.

In Display Mode, the F2 key will cause the contents of the displayed file to be made overwriteable (implicit Modify command).

Using the F3 key, the current screen can be captured to a Hardcopy File.

The Shift ENTER key displays entries from the Command Memory. Further information about this can be found in the section "Command Memory" on page 7-.

Blanks in Commands

Commands can be entered in free format. A command scanner ensures that one to three sequential blanks are removed from CFS commands. CFS works internally with this method of compressed command input. There is no space compression with BS2000 commands.

Chaining Multiple Commands

Multiple commands can be entered in the command field of CFS to be executed one after the other. The individual commands are seperated from one another by the Separator character semicolon ";" . For particular information regarding the seperator character when selecting files using the AL/NP commands, see page 7-.

Examples:

SPL;WAIT;LOCK

ADD CFS.DO.PRINT,CFS.LIB.PLAM,J/PRINT;/ER CFS.DO.PRINT

The seperator character ";" can be redefined to another character, if required. The command is: SEP x (x: new separator character).

A full description of the SEP command can be found on page 18- in Chapter 18 "Modifying Parameters".

* as Dummy Variable for File Names in Commands

* can be used in commands as a dummy variable for the name of a data element within a file list. The name of the desired file, library element, or job variable is determined by entering * in the Action Field. Still in the same dialog step, the * symbol can be used in commands as a dummy variable for the specified names. The mapping of Name <--> * thus established will remain until it is remapped.

As well as *, the Action Codes *1, ..., *9 can be used to mark additional names. The CFS command field can thus process up to 10 different data element names using the respective dummy variable.

The mappings Name <--> *, *1, ..., *9 remain current during the CFS run, even after selecting a new file list.

With regard to library elements, entering an * in the CFS command field will result in the full description of the element being used. Depending on the context, that includes the library name, the name of the element, the element type (PLAM), as well as the version number. In some cases it is desirable only to have the element name, and to ignore the library name, type and version number. If this is the case, enter *E instead of * in the command field.

With regard to many BS2000 commands, the character * in the command field is not used as an abbreviation for a name, e.g. /DO CFS.DO.TRANS-FILE,(*CFS*). In this procedure call, '*CFS*' is a parameter for the DO procedure. A name linked with * is not intended here. To suppress this replacement with a name from the file list, the command CL* (Clear * Action Code) can be used. CL* causes the mapping * <--> Name to be dropped. * can therafter be used as a normal character, without it causing a name replacement.

The * character will never substitute a marked name when issuing the NP* and AL* commands:

NP* Reselect the file list using the previous selection criteria.

AL* Extend the current file list by displaying the selection mask prefilled with the previous selection criteria.

Entering only an * in Column 1 of the command field will terminate CFS.

Substituting Job Variables in Commands

If the syntax &(jv-name) is used in a command, CFS will substitute the present content of the job variable.

Examples:

/CAT *,RDPASS=&(CFS.PASSW),STATE=U

OC1/LOGON TSOS,ADMINSTR,&(PSW)

Command Memory

CFS provides an internal table (8192 bytes), into which all entered commands are stored. The user can access this "Command Memory" in two different ways:

a) sequential:

Press SHIFT + ENTER, if a DUE2 key is not available. If the command field was blank, the last, and then the second last command will be displayed, and so on.

b) associative:

Pressing Shift ENTER with an entry 'string' in the command field, the last, and then the second last command beginning with the character string 'string' will be displayed.

Entering a string with the wildcard character * (*string) will cause the last, and then the second last command which contains the character string 'string' in any position, to be displayed.

Repeatedly pressing Shift ENTER allows the user to scroll back as far as required in the command history.

Examples:

COMMAND : OC    Shift ENTER

displays the last Open Connection command entered.

COMMAND : *FILE  Shift ENTER

displays the last command that contained the character string 'FILE'.

e.g. /FILE ... or ONX/FILE ...

Load the contents of the Command Memory to the P-Keys

An entry from the Command Memory displayed on the screen can be stored in any free P-Key: 'Px:' or 'Px#'. x represents the one or two digit number of the desired P-Key. The entry displayed on screen from the Command Memory is transmitted with the DUE1 key. The entry will then be stored in the specified P-Key. Executing the entry as a command is, in this case, suppressed.

If the entry from the Command Memory is suffixed with *EM, or *EM*DUE, then the P-Key string will be suffixed with < or < DUE1 respectively.

The P-Key string will automatically be suffixed with < DUE1 if the prefix 'Px#' instead of 'Px:' is given.

Example:

The entry /STA 7813 is displayed on the screen from the command memory. Modifying the entry to P12:/STA 7813*DUE and sending it with DUE1 will result in /STA 7813 being stored in the key P12. On account of the *DUE, pressing P12 will automatically result in the entry being transmitted.

Data Protection: Subsequent removal of particular entries from the Command Memory for security purposes is possible: The entry to be removed is found with Shift ENTER. Pressing the K3 key will delete this entry from the Command Memory.

Full Screen Command Memory Output

Entering '--' before the search string will cause a complete screen (Maximum 24 lines) of entries containing the string to be displayed.

The following possibilities exist:

COMMAND : --       Shift ENTER

displays the last 24 entered commands.

COMMAND : --string   Shift ENTER

displays the last 24 commands which begin with 'string'.

COMMAND : --*string  Shift ENTER

displays the last 24 commands that contain the character string 'string'.

Pressing Shift ENTER again will display the previous screen containing the requested commands, and so on.

Notes:

One or more lines from the command memory can be loaded to any desired P-key equally well in Full Screen command memory mode. The procedure is the same as that described above ("Loading the command memory contents to P-keys").

For further information about the command memory, see the commands LM/SM (Load Memory/Save Memory) on page 7-/7-.

The KC command (Keep Command) is also important in connection with the command memory. This command sets an option in CFS such that the command field is not erased after entering a command. The previously entered command will remain in the command field until it is overwritten by spaces or another command.

Convert BCMAP Save File to Procedure Format

BCMAP file1, file2 [, R|P]

The BCMAP FUNCT=SAVE,FILE=file1 command, issued by the system administrator, or at the console, will cause the current BCMAP assignments to be saved to a file. The entries in the file are stored in an internal format which is unreadable to the user. The BCMAP command under CFS will create a Run file or a DO procedure from a BCMAP save file. The BCMAP entries will thus be converted to plain text. The output file created by CFS can be modified by the user and then, for example, be executed in another environment.

file1 Name of the BCMAP save file created with a FUNCT=SAVE,FILE=file1 command.

file2 Name of the output file to be created by CFS.

bR|P The output file will be created as a Run file (standard) or as a BS2000 procedure.

A Run file contains statements without continuation lines up to a length of 200 bytes. The statements in a BS2000 DO procedure, amongst other things, can be split over multiple lines by means of a continuation character '-' in column 72.

Notes:

The CFS BCMAP command can also be invoked as a stand-alone function without CFS being loaded. The program should be executed as follows: /EXEC (BCMAP,$CFS.CFSLIB) .

The names of the input and output files in this case will be taken from SYSDTA.

Calculating and Converting

CFS commands that begin with the character '=' are evaluated by an internal Calculation and Conversion module. The result is displayed in the system line (Line 25). The following functions are available:

Arithmetic and logical Operations:

The four basic arithmetical functions + - * /, as well as % calculations and the logical operations .AND., .OR., .XOR. are provided. Operands can be entered in hexadecimal or decimal format. The mathematical expression should be entered as follows:

=value [ op value ] ...

value Decimal or Hexadecimal value.

Values consisting only of 0 to 9 will be interpreted as decimal values. If the value contains the characters A to F, they will be treated as hexadecimal. Suffixing a decimal value with H or X (e.g. 10H) will cause it to be interpreted as a hexadecimal value.

op Arithmetic or logical operator. The following operators are available:

+ Addition

- Subtraction

* Multiplication

/ Division

% % calculation

.+. Addition without regard to the sign (address calculation)

.-. Subtraction without regard to the sign (address calculation)

.AND. logical AND function

.OR. logical OR function

.XOR. logical Exclusive OR

The individual operations are evaluated linearly. Example: =10+10*2 gives the result 40, and not 30 as would normally be expected. The same is true for all logical operations.

Examples:

=16+80H

The value 144 in decimal and 90H in hexadecimal will be displayed in the system line as the result of the addition.

=7FFFFD45.+.FFF

The value 80000D44 will be displayed as a result of this logical addition. The arithmetic addition =7FFFFD45+FFF will result in the error message 'result too big...' appearing, since the maximum positive hexadecimal value of 7FFFFFFF will have been exceeded (Fixed-point overflow).

=1200%14+1200%85

This expression will be evaluated as follows:

14% of 1200=168, 168+1200=1368, 85% of 1368=1162.

=7C

The decimal and hexadecimal representation of the given value will be displayed: 7C= 124 (7C)

=1.OR.2.OR.4.OR.8

The four hexadecimal operands are logically OR-ed with one another. The hexadecimal value F is displayed as the result.

=AFFE.AND.5001H

The two hexadecimal operands are logically AND-ed with each other. The hexadecimal value 0H is displayed as the result.

=7FFE.XOR.FF0

The two hexadecimal operands are logically XOR-ed with each other. The hexadecimal value 7000EH is displayed as the result.

Character and Hexadecimal Conversion:

Strings entered in hexadecimal notation will be converted to character format. Character strings will be converted to hexadecimal format. Strings to be converted should be entered in the following format:

=X'string' | =[C]'string'

Non-printable characters will be displayed as a '?' when converting to character format.

Examples:

=X'C1C442'

The character equivalent C'AD?' for X'C1C442' will be displayed in the system line. Non-printable characters are displayed as '?'.

='AFFE'

The hexadecimal equivalent X'C1C6C6C5' for C'AFFE' will be displayed in the system line.

Request Help

? | HELP Display menu of all commands / global Help Menu.

?cmd The description of the specified command is displayed.

?NEWS Display the amendment history.

?TAB Display tables. Various tables are offered in a menu. e.g. EBCDIC/ASCII characters, Conversion, 9750 control codes, DCAM return codes, program interrupt codes, SVC values with their respective macros.

?USER Display user-specific help information. For further information regarding user-specific help information, see page 24-.

Terminating CFS

* Terminate CFS. Instead of *, the command END can also be entered. * or END can also be entered from the selection mask in order to terminate the program.

In the command field, * can also be used as a dummy variable for the names of data elements (see page 7-).

In CFS procedures (see page 19-), * represents a comment line, and so cannot be used to terminate CFS. In this case, use the END command to terminate CFS.

Move Viewing Window in File List

+ | - Page up or down towards the beginning or end of the File list. Sending an empty command field (i.e. pressing ENTER) has the same effect as executing the command '+': i.e. page one screen further toward the end of the list.

++ | -- Position the screen at the end/beginning of the Join list.

+n | -n Position the screen n lines further towards the end/beginning of the list.

Pn Position the file list at the n-th entry. n corresponds to the position displayed in the 25th line (P=n/T=m/H=p).

Breakpoint / Execute BS2000 Command

/ Break: Branch to BS2000 command mode.

Return to the CFS program with the BS2000 command /R [esume].

A file being displayed is closed by CFS before switching to the BS2000 command mode. Switching to the command mode can also be achieved by pressing the K2 key. Using this method, however, a Display file is not closed.

/cmd Execute BS2000 command cmd .

% cmd Execute AID command.

Notes:

The parameter ',STATE=U' will be supplied if it is not already given in a /CAT ... command.

When entering the BS2000 command /DO ... , the parameters of a DO procedure are checked for completeness. If a parameter defined in the PROC statement does not contain a value, CFS will provide a parameter mask. In it, all parameters defined in the PROC statement are displayed, together with their respective values, if specified.

The parameter mask can also be sent without it being completely filled in. In this case, the parameters contain no value, and will be asked for if needed by BS2000 in dialog (Prompting). Those parameters entered in the parameter mask will not be prompted for. Testing the DO parameters and displaying the parameter mask can be suppressed by setting the CFS option NDP (No Do Parameters).

Executing a /DO command will terminate CFS.

Process the Actions

A [opt] CFS begins processing the bundled Actions, as well as those that are not executed immediately, such as P (Print), E (Erase) and X (Variable Action ONX...).

An additional option for the Action termination inquiry can be given together with the A command. Adding the suffix opt causes the Action termination inquiry to be suppressed, and the specified program switch to be processed. The following possibilities exist:

opt * | N | NP param | U | UK | T

* process the Actions, and then display the selection mask with its previous contents.

N process the Actions, and then switch to a blank selection mask.

NP param process the Actions, and then execute the specified NP command (File selection). The possible values for param are described under Command NP on page 7-.

U process the Actions, and then display the previous file list in its updated form.

If the AU option is used, the file list window window will not be positioned at the beginning of the list, rather at the last displayed position.

UK as for U, but retaining a previously defined Variable Action for further processing.

T process the Actions, and then terminate CFS.

For a full description of the possible replies to the termination inquiry, see Chapter 23 "Termination Inquiry".

Add File to Library

ADD file [, library] [, element]    Variation 1: No element type specified

Add file to library as an element.

Entering the library name is not obligatory, if one of the following conditions are fulfilled:

a) The file list consists of elements of a library, and the specified file is to be added to this same library.

b) A library name was specified in a previous ADD command, and the current ADD is to the same library.

Giving an element name is optonal. If no element name is specified, then one will be constructed from the file name according to the following rules (dependent on the library type):

FMS : Element name = File name

LMS (ISAM) : Element name = first 8 characters of the last partial qualification

PLAM : Element name = File name.

The element type for PLAM will be requested in this case.

ADD t/file [, library] [, element]   Variation 2: Element type specified

ADD file [, library] [, t/element]

Add file to library as an alement.

This variation of the ADD command is only permissable for PLAM libraries.

The two representations of the Variation 2 above, (specifying the element type before the file name or before the element name), are equivalent.

t/ Element type, under which the file will be added as an element in the PLAM library.

Notes:

If the library specified in the ADD command does not exist, the user will be asked in which format CFS should create the library:

"Create FMS- / LMS- (ISAM) / PLAM-Library / ZIP / None ? (F/M/L/P<2>/Z/N)"

The answer N can be used if the user has mistyped the library name, and CFS is attempting to create a library with this name.

The input P2 will result in a PLAM library with BLKSIZE=(STD,2) being created. Libraries with double block size offer significantly better performance than single-blocked libraries (STD,1), and is available under PLAM from Version 2.0. It must be noted that this library format is not backwards-compatible, and cannot be processed by LMS/PLAM with a version lower than 2.0.

By entering Z, a new ZIP archive will be created.

Particular Information for Delta Storage

Delta Storage means that different versions of the same element can be stored in such a form that only the changed records in relation to the previous version are saved. A significant reduction is storage space is achieved using the Delta technique.

With regard to Delta saving when adding a file to a PLAM library, the following should be noted:

If no element exists in the library with the specified name and type, then the new element will always be saved as a full element, i.e. not saved in delta form.

If an identically named element exists in the PLAM library, then the existing storage form will be retained. This means:

a) If an element with the same name and type exists in the target library as a full element (i.e. not in delta form), then the previous element will be overwritten by the file being added, so long as no differing versions exist.

b) If an element with an identical name and type exist in the target library in a delta form, then the file to be added will be inserted as a new version into the current delta tree by incrementing the version number. The old element will thus not be overwritten, and will still be available. To manipulate library elements stored in delta form correctly, the software product LMS must be available with a version of 1.4 or above.

For further information on delta storage in PLAM libraries, see also pages 3-, 4-, 5- und 5-.

Files in any format can be added to FMS libraries, even PAM files (linked program phases) and files with RECFORM=F, BLKSIZE=(STD,n) and ISAM files. Such elements can, however, not be manipulated with FMS. Selecting these objects is only possible with CFS.

When adding elements to a PLAM library, CFS checks the element type for LMS compatibility. Two variations are possible:

a) Types that are not LMS-compatible are rejected outright by CFS.

b) Non LMS-compatible element types causes CFS to ask the user if he wishes to add the element to the library as a specified type.

The commands to control the type checking are as follows:

CT Check Types: Only LMS compatible element types are allowed.

CTQ Check Types Query: If the element type is not LMS-combatible, ask the user. (Standard).

NCT No Check Types: No check of element type.

LMS compatible element types for PLAM libraries are:

C Core image (linked programs using TSOSLNK)

D Document/Data

H data produced by H Assembler

J JCL (DO/Enter Procedures)

L data produced by BS2000 binder

M Macro

P Print (list files printable with SPACE=E)

R Relocatable (Object module)

S Source

X Extra

For further information on adding files to libraries, see also page 5-: Variable Action ONXADD.

Automatic Documentation

ADOC | NADOC Automatic Documentation File / No Automatic Documentation File

ADOC every time a new file or library element list is created (by returning to the Selection mask, or through the NP command), the old list is saved to a temporary file.

Standard: ADOC.

Notes:

The name of the file will be #CFS.SAVELIST.jobname, or if no Job name is specified in the LOGON command, #CFS.SAVELIST.acct-nr. The default prefix of #CFS. SAVELIST. can be amended by the system administrator.

Entering RL ((Restore List) in the FILENAME-SELECT field will re-display the old file list.

The RL command can be used to alternate the display between the last and the current file list. This is a quick way of processing two separate file lists.

File List: Display the last amendment as a number of days

AGE Age descriptions, and in particular the Age column in the file list, will be displayed as the number of days. This field can also be displayed as a date, by using the DATE command. Switching form one mode to the other will only become operable at the next selection. Instead of AGE, the command NDATE can be used instead.

Standard: AGE.

Increment Version number when adding an existing element to LMS or PLAM libraries

AI | NAI Add version Increment / No Add version Increment.

AI Automatic Version increment when ADDing to an LMS library (ISAM or PLAM): If the element being added already exists in the library, the version description will be incremented by 1 when the new element is added.

NAI When ADDing to an LMS library, if an element of the same name exists, the element with the highest version number will be overwritten. This is not true, however, if the element exists in Delta storage format in a PLAM library. In this case, the version number will be incremented by 1, even if NAI mode is set.

Standard: NAI.

Append File List with New Selection

AL Append List. CFS displays the selection mask. The current file list can be extended by adding additional data objects of the same type i.e. files from the same or another userid, or elements from the same library. It is not possible to mix data objects of different types, or elements from different libraries.

AL param The FILENAME-SELECT and other fields of the selection mask are filled with the param contents, and the file list is extended with the newly selected files. Manually entering the desired selection criteria in the selection mask is not necessary in this variation of the AL command.

param the same options can be given for param as for the NP command (NP param) page 7-.

If the current file list consists of elements from a library, and it is to be extended by the AL command with further elements from the same library, then the folowing abbreviation is possible. The prefix LMS lib / FMS lib / LMR lib necessary to select a library element can be omitted, since it will be supplied by CFS.

Example:  AL XYZ;AG=0

The file list will be appended with all elements from the current library which contain the string 'XYZ' in their name, and which have an age of 0 days.

AL %name | %? [,jrsave] [,?] [;param]

The FILENAME SELECT and other fields of the selection mask will be filled with the contents of the specified parameter set, and the file list extended with the files found that match the selection criteria.

%name Name of the parameter set with the selection criteria.

%? All the relevant parameter sets will be displayed in a list, from which one can be selected by marking it.

jrsave Name of the JRSAVE file containing the specified parameter set.

Standard: CFS.JRSAVE.xxxx. For further information, see page 27-.

? The selection mask will be filled with the contents of the parameter set, and displayed for the user to accept or modify. Normally, the selection will be made immediately.

param With the exception of filename-sel, the same options can be given for param as for the AL param command (see above). The values specified for param will supercede those in the parameter set.

AL* This variation of the AL command causes CFS to switch to the selection mask, which is pre-filled with the selection criteria last used (in contrast to NP*).

Notes:

Regarding "Inserting files into the file list", the command I (Include) should also be noted. The command NP will create a new file list; the old list is lost.

The step of extending the file list can in many cases be saved by using suitable multiple selection criteria (AND/OR options, wildcard syntax) in the first place. For further information, see page 4-.

File List: Display Allocated Space as File Size Indicator

ALLOC The space allocated to a file (in PAM pages) is displayed in the first coulmn of the file list as the measure of the file size.

Normally, the number of occupied PAM pages (LASTP) are displayed as the file size indicator. Changing from one method to the other will only take effect at the next file selection.

Automatic Memory Compression

AMC | NAMC Automatic Memory Compression/No Automatic Memory Compression.

AMC All of the CFS-internal memory areas (FILENAME-SELECT, COMMAND, Connection 0, ..., 9) consist of a 4096 byte table into which the keyboard entries are sequentially stored. When the table is full, the entries are cyclically overwritten from the beginning. To increase the available storage, a memory compression routine can be run internally. This memory compression routine deletes duplicate entries from the tables, thus freeing up space. The sequence of the entries in the table following the compression will not correspond to the actual sequence as entered. Standard: AMC.

For further information on the Command Memory, see also the CM (Compress Memory, page 7-), SM (Save Memory, page 7-) and LM (Load Memory, page 7-) commands.

Query / Modify Address Mode

AMODE The address mode in which CFS is currently operating.

AMODE 31|24 The address mode (Run Mode) of CFS is set to XS-31 or NXS (24-bit mode).

Standard when CFS starts: AMODE24. To change the default from AMODE24 to AMODE31, the AMODE ANY statement in the CFSMAIN initialisation module should be changed to AMODE 31.

Notes:

When executing various CFS commands in AMODE31 such as Action Codes (e.g. EDT), the necessary virtual memory in the upper memory space will be requested. This has the advantage that the 16MB limit does not exist, and thus as much memory as required can be requested.

It must be noted when switching from AMODE31 to AMODE24 that error situations can occur in later programs whereby requested memory in XS area cannot be addressed.

Assign Printer for PDxx Action Code

APD device Define or amend an existing printer device name which will be defined in the PDFILE with a mnemonic code and a virtual device name '????????'. If the virtual device name '????????' has not been assigned to a real device with APD, the printer name will be requested the first time that mnemonic code is called. For further information, see the CFS System Administrators Manual, "PDFILE" section.

Display Monthly Calender

CAL [mm. [yyyy] ]  Calender. The calender for the specified month will be displayed on the screen. If any appointments exist for any day within the specified month, then that day will be flagged with "x" (single appointment), or "xx" (multiple appointments). If the current month is displayed (CAL), the actual day is highlighted.

A full description of this command can be found in Chapter 14 "Event Scheduling System".

Display Format of File Names

CFN | NCFN Complete Filename. The names of the files and Job variables are displayed in the file list in a full, FSTAT compatible form. This means that the catid and userid of the files are always displayed. The system administrator can set the default CFN mode in the CFSMAIN module.

NCFN No Complete Filename. The standard format for displaying file names in CFS is used. The catid and userid of a file is only displayed if it is necessary to distinguish the file from another already in the list.

Reset *-Action Code Relationship

CL*[n] Clear Action-Code *. The mapping: Action-Code *[n] <--> Name is cleared. From now on, the *[n] character can be used in commands, without an accidental substitution by the previously flagged name(Action Code '*[n]') of a data object.

Example:

/FSTAT :*:*SDF*

Here, :*:*SDF* is meant as a parameter for the FSTAT command. The * should not be replaced by some name.

For further information, see page 6-/7-.

Compress Command Memory

CM Compress Memory. The various Command Memory tables (FILENAME-SELECT, COMMAND, Connections) are compressed by removing multiple entries. Compression causes a reorganisation of the tables, and prevents overflow. The chronological order of the entries in the individual tables is lost after compression.

See also the commands AMC (Automatic Memory Compression) on page 18-, LM/SM (Load Memory/Save Memory) on page 7-/7-, as well as 4-, 7-, 9-.

Compare Data Objects

COMP [%name | %? [, JRS=jrfile] [,]] [name1] [, name2] [, S=s] [, P=p] [, K=k] [, L=l] [, FC=fc] [,SA=anz1] [, SR=anz2] [, SL=anz3] [, RP= [p] [Lanz4] [Eanz5] [u] [m] [Tn] ] [,F= [H[n]] [M] [J] [N] [R] [s-fld] [c-fld] [ntr] ] [, ?]

The COMP function will perform a comparison of

a) two files of any file format (Fcbtype, Recform, Recsize, ...),

two library elements, or a file with a library element.

b) two job variables

c) two libraries at the level of the individual elements

d) all elements existing in a library in multiple versions. Here the elements are compared according to ascending version number (History Compare).

e) all files/libraries whose names appear in two file lists created by CFS (File list Compare).

The result of the comparison is stored in a file with the name CFS.COMPLIST.tsn. yymmdd.hhmmss.

For c) to e) above, the user can specify the scope of the comparison:

- Compare on matching names in both file lists

- If appropriate data objects (names) exist in both libraries/file lists: 1 to 1 comparison for similarities/differences.

- If appropriate data objects (names) exist in both libraries/file lists: synchronised comparison with output of the same/differing records.

Issuing the command COMP,, params, the compare parameters can be predefined for successive compare runs.

Issuing the command COMP,, will cause all the compare parameters to revert to the standard values.

All COMP command parameters are optional. If no parameter is given, or if the last parameter entered is a "?", then the following COMP Parameter Mask is displayed.




With a mouseclick you get a describtion of the screen item.

COMP Command Parameters:

%name The parameter specifications for the Compare function will be provided by the specified parameter set.

%? All relevant parameter sets will be displayed in a screen, from which one can be selected by marking it.

JRS=jrfile Name of the JRSAVE file containing the parameter set.

Standard: CFS.JRSAVE.xxxx. For further information, see page 27-.

Notes:

The Compare parameters set by the parameter set can be modified by specifying additional values, such as name1, name2.

Saving a COMP parameter set under CFS is achieved with the SP COMP%name command. For further information, see page 7-.

name1 Name of the first data object to be the subject of the compare. For data object, the name of a file, a job variable, (see parameter F=J), a whole library, or a library element can be given.

A library element should be given in the form lib( [t/] name [/vers]). The element type S/ can be omitted for PLAM libraries.

If particular elements of a library are to be compared with appropriate elements of another library, the desired elements of the first library can be specified in the following way: lib( 'str1' [op 'str2'] ... ). For operator op, |+|* (Or/And/Wildcard) can be given. For a complete description of the search statements, see the section titled "Multiple Searches" on page 8-.

Example: CFS.LIB.TEST1('S/','J/'). On account of the selection criteria, all elements of the type S or J in the PLAM library CFS.LIB.TEST1 are compared with appropriate elements in the library specified in name2.

If all versions of a particular element in a library are to be compared in ascending version number sequence (History Compare, parameter F=H, see page 7-), then the version description /vers in the element name may not be specified.

If the versions of an element from a particular number, or to a particular number are to be compared, then the version descriptor /vers must be terminated with a + / - character.

+: Compare all versions from the specified number to the highest.

-: Compare all versions from the lowest to the specified number.

C1 This results in a file assigned as /FILE file,LINK=C1 being used as the first input file.

(name1) File list compare: name of the first file list to be used as the reference for the compare. The file list should be created by selecting the required data objects, and saving this selection with the DOC file (see 18-) or by entering the file name in the DOCUMENTATION field of the selection mask (see 4-).

Note: In this way, multiple libraries can be selected as files, and the individual elements can be compared on the logical level with those in the selected libraries in the second reference file (name2).

name2 Name of the second comparison file/job variable/library element. When comparing all multi-version elements in a single library (History Compare, parameter F=H, see page 7-), the second file name may not be given (COMP lib1,,F=H), or the respective field in the parameter mask must be blanked out.

C2 A file assigned with /FILE file,LINK=C2 should be used as the second input file.

(name2) File list compare: Name of the second file list to be used as reference for the comparison.

S= Y | N: Synchronisation: Yes | No.

Y Carry out the comparison with synchronisation. When encountering a difference, synchronisation will be sought in the following way: the whole of file name2 will be searched for a consecutive block of num1 records (see parameter SR=xx, page 7-) which match the next records in file name1. This mode is only possible for SAM / ISAM files. For PAM files, the Y operand is ignored. The synchronisation can also be performed on predefined synchronisation fields in the data records. For further information, see the F=s-fld parameter on page 7-.

N The comparison will proceed without synchronisation. The two files will be compared on a 1 to 1 basis. To speed up the comparison still further, the parameter T2 can be set in the Record Printing field. In this case, the comparison run is terminated after encountering the first inequality. If RP=T2 is not given, the two files will be compared to the end, and all differences saved to the comparison log file.

The parameter S= can be entered in the "Synchronisation" field of the mask.

Standard: S=Y for SAM /ISAM files, S=N for PAM files.

P= Y | N: Compare SAM / ISAM files in PAM format. In PAM mode, SAM / ISAM files can be compared with PAM files. With P=Y, the PAM keys of the affected files are also compared. With P=N (Standard), the PAM keys are not compared, and SAM / ISAM files cannot be compared with PAM files ("Illegal File type Combination"). With P=Y, only those data blocks whose Coded File Id (CFID) match the files CFID appearing in the catalog are compared. With P=N, all blocks up to the last page are compared, independently of the CFID in the PAM key.

Library Compare: With P=N, libraries are compared at the element level. With P=Y, the libraries are compared at the PAM block level.

Standard: P=N

PAM Mode (parameter P=Y) can be set in the "Compare in PAM-Format" field of the compare mask.

K= Y | N: ISAM key is included/ excluded from comparison.

Y The ISAM key of the file is included in the comparison.

N The ISAM key is excluded from the comparison, and is thus not relevant to the comparison result. This option should be given when comparing an ISAM file to a SAM file when the ISAM key is not contained in the data of the SAM file.

The parameter K= can be entered in the "Include Isam-Keys" field of the mask.

Standard: N

L= Y | N: for RECFORM=V files: Record length fields included / excluded.

Y The record length fields of both files are included in the comparison. Records of different length are automatically detected as being different, even when they only differ in the number of blanks at the end of the record.

N The record length fields are excluded from the comparison, and are thus not relevant to the comparison result. This option should be given if a Recform=V file is to be compared with a Recform=F file. When comparing records of differing lengths, the shorter record will be padded with blanks to match the longer record (see below).

The parameter L= can be set in the "Include Length-Fields" field of the mask.

Standard: N

FC= X'nn' | C'x': Fill-Character.

For records of differing lengths, the shorter record is padded with the specified character to match the length of the longer record. If the parameter L=Y is given, this option has no effect.

The parameter FC= can be entered in the "Fill-Character" field of the mask.

Standard: FC=X'40', i.e. shorter records are padded with blanks.

SA=num1 Synchronisation Attempts. When processing the COMP function, there is always an attempt made, following any difference, to find the longest synchronisation point, i.e. the largest possible number of matching sequential records in the name1 and name2 files. The search for the optimum synchronisation point is terminated after num1 successful synchronisation points have been found. The longest of the successful points is taken as the optimum synchronisation point. This parameter is only relevant if synchronisation (see parameter S=Y, page 7-) is activated.

The value of this parameter has a decisive influence on the CPU time needed for the comparison. For further information, see the notes below.

The value SA=0 causes there to be no restriction placed on the number of attempted synchronisation points. This means that "better" synchronisation points will be sought until the end of the file name2 is reached, or until the restriction placed by the SL=num3 parameter (see below), is reached.

The parameter SA= can be entered in the "Number of synchronisation-attempts" field in the compare mask.

Standard: SA=5.

SR=num2 Synchronisation Records. Number of records from files name1 and name2 that must match before a synchronisation point is recognised following an inequality. This parameter is only relevant if synchronisation (see parameter S=Y, page 7-) is activated.

The parameter SR= can be entered in the "Number of records for synchron-point" field in the compare mask.

Standard: SR=5. 5 matching records are necessary for a successful synchronisation.

SL=num3 Synchronisation Limit. With this parameter, the record range within which the next synchronisation point must be found, is restricted. After any inequality is detected, an attempt is made to find a synchronisation point within the next num3 records of the name2 file i.e. at least num2 matching records (see parameter SR=). This parameter is only relevant if synchronisation (see parameter S=Y, page 7-) is activated.

The value SL=0 causes there to be no restriction placed on the number of records to be examined for the next synchronisation point. This means that "better" synchronisation points will be sought until the end of file name2 is reached, or until the limit of the SA= num1 parameter (see above) is reached.

The parameter SL= can be entered in the "Number of records to find synchron-point" field in the compare mask.

Standard: SL=0.

RP= [p] [Lnum4] [Enum5] [u] [m] [Tn]

Record Printing. The following can be ascertained with this parameter:

a) if, and if so, in what format the differing records of files name1 and name2 should be listed in the comparison log,

b) the maximum number of records per mismatch that should be printed to the comparison log (Record Print Limit), as well as the number of identical records before and after each mismatch that should be identified in the log,

c) the column position relative to the beginning of the record from which the differing records should be listed in the comparison log,

d) two variations of the representation of the differences when comparing PAM files,

e) when comparing two libraries, a file list compare, or History Compare: area from which the data from library 1 and 2, or file list 1 and 2 are compared: names, names and equalities/inequalities of the data (1 to 1 comparison), names and equalities/inequalities of the data, together with a full synchronised differential log for each pair of data objects.

The subparameters p, Tn, Lnum4, Enum5, u and Tn for RP= can be entered without separators in any combination. Commas are not necessary for separation.

RP=p Y | N | C | X | B

Y Yes. In the comparison log the differing records are listed in character format. The Y option is identical to C (see below).

N No. No record contents are listed in the comparison log. Only a display of the equal and unequal record numbers of files name1 and name2 will appear.

C The differing records will be listed in character format. The record contents will be truncated from column 132 (end of the print line).

X The differing records will be listed in hexadecimal format. The record contents will be truncated from column 132.

B The differing records will be listed in both character and hexadecimal format.

Standard: RP=Y

If the parameter RP=C/X/B is entered when comparing with field synchronisation (see page 7-), and should any differences occur in the two files, then the differences within a record will be flagged. The subparameter A (see below) will cause the differing records to be listed in their full length, and not just up to col. 132.

RP=Lnum4 Output Record Limit. num4 sets the maximum number of records in the files name1 and name2 that will be listed in the comparison log following a mismatch.

Standard: L100

RP=Enum5 Equality Record Limit. This parameter implies RP=T4 (see below). num5 sets the maximum number of matching records that will be listed in the comparison log following a mismatch. Choosing an especially high value for num5 (e.g. 9999) will force the entire output of the file, whereby all equalities and inequalities are marked as such (indicator =/#).

Standard: E25

Note:

If only the respective records from both files are to be listed in the comparison log, this can be achieved, for example, with the parameter combination SR=1,RP=L0E200T4 (output of a maximum of 200 identical sequential records).

RP=u A | D ddd

A The records are listed in their full length. There is no truncation from column 132 in the listing of the comparison log. If necessary, line continuation is performed. Entering this parameter will cause the printed output to differ from the standard output. For example, at least two lines per record are necessary in the comparison log (header record and data content). The record layout is always left-justified in the list.

The mode RP=A can be reset by entering RP=D0.

D ddd    Offset relative to the beginning of the record from which the record content is listed in the comparison log. The counting begins with the offset 0 (beginning of record). In contrast to the parameter A, entering the parameter D will only produce one print line per record. The record contents of the file name1 are left-justified, and the associated records from file name2 are right-justified.

Standard: D0 (alternating left/right representation, one print line per record, output of the record contents from the beginning of the record).

RP=m M1 | M8

M1 When comparing PAM files, the data blocks are compared byte for byte. The representation of the differences in the comparison log will thus appear accurately for each position. The size of the comparison log can be many times greater than that produced in M8 mode.

M8 When comparing PAM files, the data blocks are broken up into 8 byte sections, and then compared between file-1 and file-2. When displaying the differences, it can happen that there are identical positions in a data area that have been flagged as unequal. The M8 mode will produce a smoother representation of the differences compared to the M1 mode, particularly when there is a frequent change between equal and unequal positions.

Standard: M1.

RP=Tn The parameter RP=Tn has three different meanings:

a) Scope of the Comparison.

T1 The comparison is restricted to checking if a name in file list (name1), or library 1 matches a name in file list (name2) or library 2. When comparing two libraries, only the highest version of each element will normally be checked. Setting the parameter F=M (Multiple) will cause all versions to be checked.

The parameter value RP=T1 is not relevant with History Compare (parameter F=H, see page 7-).

T2 The comparison encompasses the level T1. Additionally, the respective files, or elements of the respective libraries are compared using a fast algorithm. The result is saved to the comparison log (Standard).

T3 as T2, except that the synchronised comparison algorithm is used to compare the respective files or elements of the respective libraries. Differing records are output to the comparison log in accordance with the RP operands p, Lnum4 and u (see above). Further information regarding the T3 parameter can be found in the notes below.

RP=T3 is the standard value for History Compare (parameter F=H, see page 7-).

T4 as T3, except that the preceding and succeeding matching records are listed in the log for each difference. This serves, above all, to give a better insight into the context in which the inequality occured. Using the parameter E num5 (see above), the number of matching records can be specified. num5 has a standard value of 25. By choosing an extremely high value for num5, output of the entire file can be achieved. The equal/unequal records are flagged in the comparison log by the =/# character. When using the T4 parameter, it is desirable to give the newest file first, and the oldest file as the second name.

The T4 parameter can only be used in conjunction with synchronised comparison (S=Y).

The T4 parameter offers the user the possibility of comparing two files and displaying only the identical records from each file in the compare log. The parameter in the "Record Printing" (RP) field should be: L0E9999T4. In addition, the "Number of records for synchron-point" field (SR) should have a value of 1.

b) Scope of the Log when comparing with Synchronisation Field.

(F=s-fld).

T1 Only the synchronisation fields are logged for unequal records.

T2 Only the record contents are logged for unequal records.

T3 The record contents, and additionally, the synchronisation fields are logged separately. (Standard)

c) Comparison without synchronisation (S=N): The entry RP=T2 will cause the comparison to be accelerated in so far as the comparison is terminated at the first inequality. No comparison log is produced, as the result (equality/ inequality of the data) is displayed in the compare mask. Entering RP=T3 will cause the files to be compared to the end. The user will get a comparison log which will detail all differences.

The parameter RP= can be entered in the "Record Printing" field of the compare mask.

F= [H] [M] [J] [N] [R] [S s-fld] [c-fld] [ntr]

Compare Fields. This parameter can determine:

a) H-Option (History Compare): All elements that exist in multiple versions in a library are compared. The comparison proceeds according to ascending version number. The comparison can also be restricted to all versions of a single element.

b) M-Option (Multiple): When comparing libraries, all versions of a multi-version element are compared, and not just the highest version.

c) J-Option (Job variables): This option signifies that name1 and name2 represent two job variables that should be compared with one another.

d) N-Option (Names): When comparing libraries or file lists, the names of the matchable compared elements are displayed on screen.

e) R-Option (Reduced Output): When comparing libraries or file lists, the names of the non-matchable elements are not displayed in the comparison log.

f) a data field that appears in all records of files name1 and name2 is used for synchronisation. In this way, two files of any size can be quickly compared with one another.

g) name transformation rules for library and file list compare. A name found in library 1 will be converted according to the transformation rules, and then sought in library 2.

h) that the files should only be compared on specified columns, or that specified columns should be excluded from the comparison.

The subparameters H, M, J, N, s-fld, ntr and c-fld for F= can be entered without separators in any combination. No commas are necessary for separation. The subparameters must, however, be entered in the specified sequence.

F= H[n] History Compare. In this mode, all, or only the last n versions of all elements of library name1 will be compared with each other. The elements to be compared will be done in ascending version description.

n Only the last n versions of each element will be compared with each other in ascending sequence. Default: H0, i.e. all versions of an element will be compared.

The parameter name2 may not be specified in this mode (COMP name1 ,,F=H). The History Compare can also be restricted to all or some verions of a particular element. In this case, the element should be specified as follows:

lib( [t/] name) All versions of the element name will be compared in ascending sequence with each other.

lib( [t/] name/vers+) Beginning with version vers, all higher versions are compared with each other.

lib( [t/] name/vers-) Beginning with the lowest version, all versions up to and including version vers are compared with each other.

The History Mode cannot be used for version controlled FMS library elements.

Standard: H option is not set.

F= M When comparing libraries, respective elements in library name1 and name2 are matched. If an element exists in multiple versions, then normally only the highest numbered element is compared (Standard). The highest version numbers do not have to match. The M option will result in all versions of an element in library name1 being compared with the respective versions of the element in library name2. If more versions of an element exist in name1 than in name2, then the surplus versions will have no matching versions in name2, and hence cannot be compared. For further information, see also the R option below.

Standard: M option is not set.

F= J Compare two Job variables. This indicated that name1 and name2 refer to two job variables. When entering the COMP command at the CFS command line, the positional parameter J must be given last. In the compare mask, the J parameter must be given as the first positional parameter in the "Compare-Fields" field.

Standard: J option is not set.

F= N Compare two libraries or file lists: Show Names. The names of the files/library elements just compared are displayed on screen. In this way the user has an indication of the current position of the comparison run. When entering the COMP command at the CFS command line, the positional parameter N must be given last. In the compare mask, the N parameter must be given as the first positional parameter in the "Compare-Fields" field.

Standard: N option is not set.

F= R[n] R Option (Reduced Output): When comparing libraries or file lists, the names of the non-matchable elements/file are suppressed in the comparison log.

        n Entering R1 will set R mode selectively for file lists (name1), (name2) only. Entering R2 will set R mode for library comparisons only.

Standard: R option is not set.

F= S off/len [A/D] [: off/len [A/D] ] [ ... ]

Synchronisation field. Entering this option causes one or more data fields in the files name1 and name2 to match. The record contents in the synchronisation fields must be sorted in either ascending or descending order. Successively identical field contents are, however, allowed.

When using a synchronisation field, the files to be compared do not have to reside in virtual memory, and thus can be of any size.

off Offset of the synchronisation field relative to the beginning of the record. The counting begins at the offset 0 (beginning of record).

len Length of the synchronisation field.

A The data in the synchronisation field is sorted in ascending sequence.

D The data in the synchronisation field is sorted in descending sequence.

Standard: No Synchronisation fields are used for the comparison.

Multiple synchronisation fields can be defined. A colon ':' should be used as the delimiter between the individual field definitions (e.g. S0/8A:10/2D:72/8A). It is therefore possible to carry out synchronisation using multiple, dissimilarly sorted data fields. For further information regarding synchronisation fields, see also the parameters RP=C/X/B [A] and RP=Tn. (Logging Scope, see page 7-).

When comparing with synchronisation fields, entering the parameter RP= C/X/B [A] will cause differences within the record to be flagged when mismatches between the files occur. Adding the suffix A will cause the differing records to be printed to the log in their entirety, and not just up to column 132.

When comparing with synchronisation fields, the parameter RP= C|X|B [A] will result in differing records from the two files being displayed underneath each other, rather than alongside each other. In addition, the differing characters within the records will be marked with '*' . The suffix A will result in the records being printed to the log in their full length, rather than just up to column 132.

F=ntr 'str1'='str2' [:'str1'='str2'] [...]

Comparing two libraries or file lists: Name Transformation Rules can be given that will determine how a name from the first file list (library) will be matched to a name from the second file list (library). For the standard case (no entry in "Compare-Fields" field), the names to be to be matched must be identical.

The names of the files or libraries in the (name1) file list, or the names of the elements of library (name1) are searched for the presence of character string 'str1', and replaced by 'str2'. The new name thus constructed is then sought in the file list (name2), or library name2, respectively.

Name 1 can be prefixed by ''='str2'.

Name 1 can be suffixed by '_'='str2'.

If 'str1' does not appear in Name 1, no substitution by 'str2' will take place, and Name 1 will be sought unchanged in file list 2 or library 2 respectively. Multiple transformation rules in the form 'str1'='str2' can be entered. A colon ':' should be used as a delimiter. Multiple transformation rules will be applied in turn to each Name.

Standard: no Name Transformation Rules. Names must match exactly.

F=c-fld x off1[=off2]/len [: off1[=off2]/len ] [ ... ]

Compare-Fields. By entering c-fld, it is possible to exclude one or more fields contained in the files name1 and name2 from the comparison. Alternatively, it is possible to restrict the comparison to the specified fields. By excluding column ranges, the amount of virtual memory needed for the comparison is reduced.

x + | -

+ only the fields specified hereafter should be compared.

- the fields specified hereafter should be excluded from the comparison.

off1 Offset of the field to be compared in file name1, relative to the beginning of the record. An offset of 0 indicates the first byte of the record, or the first byte of the record length field (L=Y, see page 7-).

off2 Offset of the field to be compared in file name2. If off2 is not specified, then off1=off2.

len Length of the comparison field.

Multiple field definitions can be specified. The first field definition must begin with '+' or '-', and is then valid for all further fields. The colon ':' should be used as a delimiter between the individual field definitions.

Standard: no Compare-Fields. The entire record is used for the comparison. Exceptions under certain circumstances can be the ISAM key (parameter K=N), as well as the record length field (parameter L=N).

The subparameters N, S s-fld, ntr and c-fld for F= can be entered without spaces in any combination. No commas are necessary for separation. The subparameters must, however, be entered in the correct sequence.

? The parameter mask for the compare function is displayed. The parameter ? is only relevant when entering the COMP command in the command line of CFS, and must always be the last entered.

Notes:

The comparison log will normally be saved to a file with the name CFS.COMPLIST. tsn.yymmdd.hhmmss. The user can choose any name for the comparison log, by issuing a FILE command with the link name COMPLIST before the comparison (/FILE file,LINK= COMPLIST).

If the user selects the name of the comparison log by means of the File command, then all successive comparison logs will be written to this file. This remains valid until a /REL COMPLIST command is issued.

Large tape files can also be compared with the Compare command, although only a 1 to 1 comparison without synchronisation is possible (S=N). The two tape files must first be assigned with file commands, e.g. /FILE name1,LINK=C1,STATE= FOREIGN,FCBT=SAM,RECFORM=.,RECSIZE=.., BLKSIZE=..,VOLUME=..,DEVICE=..

The comparison of the two files, when using synchronisation (parameter S=Y), is carried out in virtual memory. The memory used is released again after the end of the comparison. For a simple 1 to 1 comparison without synchronisation (parameter S=N), no virtual memory is needed for working storage.

When comparing two large files, a check should first always be made for a sorted field (ascending or descending) which could be used for synchronisation. Using a synchronisation field will minimise both the memory and processor requirements. The following notes are only relevant if no synchronisation fields exist for the comparison.

To reduce the virtual memory requirement for particularly large files, the parameter F= (Compare-Fields) can be used to restrict the column range over which the comparison will be performed.

When comparing particularly large files, or when the files contain many differences, setting the parameters SA, SL, and SR accurately is of particular importance to perform the comparison within an acceptable time.

A practical method of reducing the computing load when comparing two very different files is to set the value for the parameter SA (number of synchronisation attempts) to a small positive value. To achieve acceptable comparison results, the parameter SR (number of matching records for a synchronisation point) should be set concurrently to a high value.

If the files to be compared contain many records, and if a conversion of records can be excluded from the beginning of file name1 to the end of file name2, i.e. if a record conversion can always be restricted locally, then the runtime of the comparison can be reduced by setting the SL parameter to the maximum expected search distance to find a synchronisation point.

An increased value for the SR parameter (number of matching records for a synchronisation point) generally leads to a "smoothed" comparison result. If, for example, the records 100 and 104 in a source file are modified, then setting SR=5 (Standard value) will result in the complete record range of 100 to 104 being flagged as different, even though this range also contains matching records.

The best comparison result will be achieved with the parameter values SA=0, SR=1, SL=0. The processing time required can quickly become extreme. A solution is to run the comparison from CFS in batch mode.

When comparing two libraries or file lists (name1),(name2) in RP=T3 mode (fully synchronised comparison log), the log can enlarge very quickly, and require large amounts of disk space. Before starting the comparison run it may be advisable to create a comparison log by means of a file command as follows: /FILE file,LINK= COMP LIST,SPACE=(300,300). After the comparison run is finished, release the link name COMPLIST (/REL COMPLIST).

File list Compare: If the file lists (name1),(name2) contain libraries of the same type (PLAM/LMS/FMS), then these will be compared at an element level. The libraries are not compared by PAM blocks. Multiple libraries can be compared in a single comparison run using this method.

Examples:

COMP LIBR.PLAM(-'R/'),LIBR.PLAM.OLD,RP=T3

All elements from the LIBR.PLAM library that are not type R (relocatable) are compared with the respective elements in the library LIBR.PLAM.OLD. The records that differ between the individual elements are listed in the comparison log with both record number and content (RP=T3). A maximum of 100 records are listed for each unequal record area (standard value: RP=L100).

COMP LIBR.PLAM,,F=H

All elements from the library LIBR.PLAM which exists in at least two versions are compared. The first version is compared with the second, the second with the third, and so on. The result of the comparison will produce a log in which the amendment history of each element will be documented.

Compress Screen before Output

CSO [STAT] | NCSO Compress Screen Output on/off. The screen contents and format information created by CFS in Connections will be compressed before it is displayed, and hence before it is transmitted. The compression is achieved by replacing repeating characters with special control characters (WDH sequences). To achieve optimum compression rates, the CFS file lists are displayed in a slightly modified form. Before CFS is terminated, a message will be displayed containing the compression statistics.

STAT The current compression statistics will be displayed in the system line.

NCSO No Compression of Screen Output. The screen compression will be disabled.

Standard: NCSO.

Create Library

CREALIB library [, P|L|F] [, N]

If a library with the specified name does not exist, one will be created. The command is particularly useful in CFS procedures to ensure a library with the specified name and type does really exist. CFS will then not ask the question in the procedure whether the file should be created or not.

P|L|F Type of Library.

P PLAM

L LMS-ISAM

F FMS

Standard: P

N New. The library will always be created as a new library. An existing library will be deleted.

Standard: An existing library will not be deleted.

Check Element Types when adding Elements to PLAM Libraries

CT | CTQ | NCT Check Types/Check Types and Query/No Check Types. A type check will be made when adding elements to PLAM libraries.

CT Only the LMS-compatible element types C/D/H/J/L/M/P/R/S/X are allowed.

CTQ When adding LMS-incompatible element types, the user is asked whether the element should really be added as that type.

NCT No type check when adding elements to PLAM libraries.

Standard: CTQ.

File List: Display the Last Access in Date Form

DATE The specification of age, in particular the AGE column in the file list, will not be displayed as a number of days, but rather in date form (dd.mm.yy). The command NDATE (or AGE) will reset this mode to the default value. The mode will only be operational after the next selection. Standard: AGE.

Delete Library Element

DEL [t/] element [, library]

Delete the element from the specified library.

The library entry can be omitted if the element to be deleted is in the library last specified in an ADD / DEL /SEL command.

Note:

The name of the library in the ADD/SEL/DEL commands can be omitted if the library specified in the last command is also the current library.

Execute CFS Procedures

DO [N,] [ file | element | lib(element) | %name | %?] [, params, ...]

The specified CFS procedure is executed. For a full description of the DO command, see page 19-.

Note:

CFS processes the DO command in the following way: If lib(element) or %name is specified, then the CFS procedure to be executed has been unequivocally specified. In all other cases, an attempt is made to find the procedure according to the following hierarchy:

a) CFS looks in the assigned userlib (Standard: CFS.USERLIB) for an element with the specified name.

b) The secondary userlib will then be searched. This userlib is set up by /FILE ...,LINK=USERLIB, or by a library with the name $user-id.CFS.USERLIB.STD, where $user-id is the userid in which the CFS phase is stored.

c) A file will be sought matching the given description.

If a), b) or c) do not provide a satisfactory result, an error message will be generated. To change the standard userlib, refer to the commannd UL on page 18-.

Display DO Parameter Mask for Procedures

DP | NDP Do Parameter mask/No Do Parameter mask.

DP When entering a BS2000 DO command in the File list command field, or in Connections, an analysis will be made of the PROC statement in the DO procedure. If it is found to contain DO parameters that have not been assigned, a parameter mask will be displayed. The missing parameters can then be entered.

Standard: DP.

Note:

The parameter mask will also not be displayed in DP mode if the subtask is running under a different userid to that from which CFS was loaded, and the procedure is not shareable. It will also not be displayed if the Connection is operating on a different host system to that of CFS.

Display Used Resources

DU [M | CPU | WSI | IO]

Instead of displaying the current time (hh:mm:ss) in the file list mask, the system resources utilised in the last transaction will be displayed.

M Display Used Memory. The amount of Class 6 memory being used will be displayed.

CPU Display Used CPU Time. The amount of CPU time used since the last screen output will be displayed.

WSI Display Used Working Set Integral. The value of the Working Set Integral since the last screen was output will be displayed. The Working Set Integral is defined the product of the number of main memory pages used and the CPU time used.

IO Display Used IO's. The number of disc IO's used since the last screen output occurred will be displayed.

NDU The current time (hh:mm:ss) will be displayed instead of utilised system resources.

Standard: NDU.

Start a DO Procedure/Enter File using the CFS Job Report System

E proc [, do-params] [, ?] [/enter-params] [, JRF=jr-file] [, ?] [, JN=jobname]

Start and monitor an Enter job. A DO procedure can also be started as an Enter batch job. In this case, the DO parameters are analysed and requested via a mask. After the job has finished, the result is displayed for the user by means of the SYSOUT/SYSLST files, or the JR file. The Enter parameters can also be predefined using the JRP command.

For further information, see Chapter 11, "Job Report System (JRS)".

Call EDT as a Subprogram  (Format Mode)

EDT[n] [, file | lib( [t/] element [/vers] ) | * | D ]

Branch to the F mode of EDT (Return using the K1 key, or H[ALT]).

n The buffer of the specified EDT level is activated.

Standard: n = 0.

file The specified file is loaded into the EDT workfile.

lib( [t/] element [/vers] )

The specified PLAM library element will be loaded into the EDT workfile (§OPEN statement). PLAM elements saved in delta format cannot be processed.

* The file or library element marked with the Action Code '*' will be read into the EDT workfile.

D The file presently displayed by CFS is read into EDT.

Notes:

The user must take care to rewrite the file from EDT (EDT sataement @W (SAM file), or @SA (ISAM file)). An @FILE command with the name of the current file is suppressed by CFS.

Using EDT,* / EDL,* with library elements will automatically cause an Update to be offered by means of an ADD * when exiting EDT. This is because it is not possible to perform a direct rewrite with an EDT command with, for example, FMS/LMS/ISAM library elements.

Once set, EDT parameters such as LOWER ON, SCALE, etc. will remain valid for the entire CFS session. The same is true for the contents of all EDT workfiles, as well as the line and column positions of the individual EDT workfiles.

@RUN calls are possible as from EDT Version 16.1.

Non-standard files such as those with RECFORM=F or ISAM files with KEYPOS/ KEYLEN not equal to 5/8 can easily be edited. Manual assignment using the EDT linkname EDTSAM/EDTISAM is not necessary, as this will be provided by CFS.

Pressing the K1 key will return control to CFS.

Before leaving EDT, all current changes made to the screen contents must be executed with DUE1. K1 terminates EDT without regard to any outstanding amendments on the screen.

If QR mode is set (Query on Return), the user is asked after exiting EDT if the virtual EDT memory should be deleted (@D). QR mode is normally set, and can be reset with the NQR command.

The EDT command will call the ordinary version of EDT in Format mode. If in addition to EDT the TOM-TI editor is also available, the systems administrator can generate CFS such that the TOM-TI Editor can be invoked with the EDT/EDF command. In this case, there are a number of additional TOM-TI commands available (e.g. SORT/ COL/ REF/ DOC/ FETCH).

In Format mode of EDT, the user returns to CFS either by the EDT command HALT, or by pressing the K1 key. If the user gives the EDT HALT command, an additional option can be given (HALT cmd). This suffix is interpreted by CFS as a command by CFS, and is executed.

The commands EDT/EDF/EDL and the Action Codes EDT/ EDF/ EDL call two seperate copies of EDT in the user's data area.

The commands EDT/EDF/EDL use the same EDT data area.

The INTR-STXIT of EDT is not activated in CFS, i.e. the BS2000 command INTR has the same effect as the R[esume] command. This is different to calling EDT as a stand-alone program.: /EXEC $EDT.

If the Job Report function of CFS interrupts the user's EDT session, the original EDT screen can be restored after ending the Job Report (K1 key, END, N) by pressing the K3 key.

Automatic Commands after calling EDT

EDTINIT [cmd;cmd; ...]

After reading in a data object with the EDT[n] Action Code, or with the EDT command, the specified EDT initialisation commands will be executed.

cmd One or more EDT commands. Multiple commands must be separated with a semicolon (;). Example: EDTINIT LOWER ON;PAR EDIT-FULL=ON

Default: No user-defined EDT commands will be executed.

Notes:

If multiple data objects are read into different EDT workfiles (EDT[n] Action Code), the EDTINIT command will be executed individually for each workfile.

An EDTINIT command issued without parameters will reset any previously defined initialisation commands.

Example:

EDTINIT LOWER ON;PAR EDIT-FULL=ON

Calling EDT as a Subprogram (Line Mode)

EDT[n] [, file | lib( [t/] element [/vers] ) | * | D ]

As for EDT, (see above), but EDT is invoked in Line Mode.

Return with @H or @RET.

Calling EDOR as a Subprogram

EDOR [, file] | EDOR , * | EDOR , D

As for EDT (see above), but EDOR is called.

Returning from EDOR to CFS is achieved by the EDOR command sequence H ! H. Processing the file is then terminated. The K2 key can also be used to return from EDOR to CFS. The user can press the K2 key at any time within EDOR, which will cause an immediate branch to CFS. The next EDOR call will return the user to EDOR exactly as it was when it was last aborted with K2.

Erase and Retain Temporary Files

ERT | NERT Erase Retain Tempfiles/Erase No Retain Tempfiles.

ERT The ERT mode results in those files/Job variables/library elements to be erased with Action Code E first being recataloged to temporary files or libraries. These temporary files will automatically be erased by BS2000 at the end of the task. From the users point of view, all those files erased with Action Code E still exist as physical files until the end of the task (they can be accessed by entering FSTAT #, or STAJV # in the FILENAME-SELECT field).

The name of the temporary file is constructed by prefixing the original name with the temporary file indicator (normally the # character), during the CAT command. Naturally this means that the ERT mode is inoperable when explicitly erasing temporary files.

Library elements will be copied as an identically named element to a temporary library before being erased. They will remain available until the end of the task. The name of the temporary library will be created, as for files, by prefixing the library name from which the element was erased with a # character.

The ERT option will not take effect if the files are erased with the Action Codes ED (Erase...,Data), EC (Erase ...,Catalog) or EN (Erase No Retain Tempfiles). The ERT option will also not work for files larger than 500 PAM pages residing on private volumes.

Deleted data objects are automatically removed from the file list (implicit '-' Action Code). The YANK command can be used to restore those files to the file list.

The ERT mode is set by default.

NERT The ERT mode is disabled with the NERT command (No Erase Retain Tempfiles), or using the SET mask.

File Conversion: FC

FC [file1, file2] [, ?] [, reclim] [, const] [, opt] [, LEN=length]

The input file (file1) is converted to a second file, (file2), in any format.

file1 Name of the input file, or a comma if the output record should consist of a specified pad character.

file2 Name of the output file.

The output file's attributes can be set in the FC mask (see below), or predefined with a /FILE command with LINK=OUTFCB.

Entering the command FC without any parameters, or entering the file names followed by a question mark (FC [file1], file2, ?), will display the FC mask.

The FILE command to determine the output file's attributes can, for example, look as follows: /FILE file2,LINK=OUTFCB,FCBTYPE=ISAM,RECFORM=F,RECSIZE=4000 ,KEYPOS=20, KEYLEN=12, BLKSIZE=(STD,2),SPACE=(30,30).

Instead of the name of an output file, OUTFCB can also be given in the FC command. In this case the file name is determined from the OUTFCB link name.

? A question mark can be entered after the name of the output file, which will cause the FC mask to be displayed. The file attributes, as well as all the following parameters, can be entered.

reclim maximum number of records to be converted from file1 to file2.

Standard: reclim=number of input records, or reclim=1, if no input file is specified.

const C'string' | X'string'

Specify a character with which the output record should be padded, in case the input records are longer than the output records. Multiple characters can also be specified.

Standard: C'_'.

opt IK | EK | NA

IK Insert Keys: ISAM keys for the output file records are generated by CFS. These keys can also be generated for SAM files by specifying the IK option. In this case, the output record will contain an 8 digit sequence after the record length field.

Standard: no IK, i.e. the ISAM key is contained within the file to be converted. If this ISAM key is not in ascending sequence, then the option NA(Non Ascending keys; see below) must be specified.

EK Eliminate Keys: The ISAM keys present in the input file will be stripped from the records in the output file. If the input file is not an ISAM file, then the EK option has no effect.

Standard: no EK, i.e. when converting ISAM input files, the keys are not stripped out.

NA Non Ascending Keys: When converting to an ISAM file, the input file contains the data for the ISAM keys. These, however, are not in ascending order, and so CFS has to use the ISAM macro STORE, instead of PUT. The NA option results in, amongst other things, the input records being sorted.

Standard: no NA. A non-ascending key area in the input file will cause a DVS error.

LEN=length Number of bytes in the output record to be created. Any ISAM key and the record length field does not count as part of the data. The LEN option causes Recform-V records to be written to the output file with a length of 4 + length (SAM), or 4 + keylen + length (ISAM).

Standard: Output files with RECFORM=V will contain records with the same length as the input file.

Format of the FC mask for entering file attributes and parameters:


With a mouseclick you get a describtion of the screen item.

Notes:

The utility program PAMCONV will be invoked for executables and PLAM libraries when BLKCTRL=NO is specified.

The parameter RECSIZE=8 must always be given if an output file in RECFORM=U format is required. (Scratch pad register 8 is used by the program for the length of the output record).

If the name of the input file is left blank in the FC mask, then an output file with the specified format consisting of records containing the pad character will be created. The record length is determined by the Recsize value, or by the LEN option for Recform=V formats. The number of records to be written to the output file is specified in the Record-Limit field.

The FC command can also be used to convert SAM/ISAM files to PAM format, and vice versa. The following cases can be distinguished:

SAM/ISAM --> PAM

1) Input file: BLKSIZE = (STD,1)

The input file (SAM/ISAM) is read block-wise, and written as a PAM file. The data content is unchanged.

2) Input file: BLKSIZE > (STD,1)

It is assumed that the first 16 bytes of the input records of the SAM/ISAM file (Recform=V) contains the data for the PAM keys. Following that, 2048 bytes of data are expected for a full PAM block.

PAM --> SAM/ISAM

1) Output file: BLKSIZE = (STD,1)

The input file is transfered block-wise to the output file. The data content is unchanged. Only the FCBTYPE of the file is converted from PAM to SAM/ISAM.

2) Output file: BLKSIZE > (STD,1)

The PAM key is put into the first 16 bytes of each output record. The 2048 data bytes of the PAM block is appended to this.

Convert CFS Information catalog

a) ISAM Catalog --> SAM File

FC2 EXP: catalog, file2

Export the documentary text created in CFS by the IM/IA Action Codes to a standard EDT file.

catalog Name of the information catalog to be exported (CFS.INF, or lib.INF).

file2 Name of the SAM file to which the catalog should be exported.

b) SAM File --> ISAM Catalog

FC2 IMP: file1, catalog [, MERGE]

Convert (import) a SAM file containing the information for the CFS catalog into the ISAM format used by CFS for documentary text.

file1 Name of the SAM file with the information text.

catalog Name of the catalog to be created (CFS.INF or lib.INF).

MERGE The data contained within the SAM file is to be merged into an existing catalog.

Standard: The catalog is created from scratch.

c) ISAM Catalog --> PLAM Library

FC2 CON: file1 [, file2] [, P]

file1 CFS Information catalog (ISAM file).

file2 PLAM library (Output).

If file2 is not specified, a temporary library will be created that will afterwards overwrite catalog file1.

The contents of the information catalog will be transfered to an existing, or newly created PLAM library, file2. An element in the library file2 is created for each file description: S/xxxx. If the file description extends over more than one screen (multiple ISAM records), then the data will be separated in the library element by records containing $NEW PAGE.

d) PLAM Library --> ISAM Catalog

FC2 CON: file1 [, file2] [, P]

file1 PLAM library.

file2 CFS Information catalog (Output).

If file2 is not specified, then a tempory information catalog will be created that will afterwards overwrite the PLAM library file1.

The contents of the elements of the PLAM library file1 will be transfered to an existing, or newly created information catalog file2. For each library element t/xxxxx, one or more ISAM records with the key xxxxx will be created in information catalog file2. Multiple records will be written if the PLAM element contains the seperator record $NEW PAGE.

P This option is only meaningful when converting from PLAM to ISAM. The element type designator in the PLAM library is transfered within the ISAM key of the information catalog records. The INF catalog so created can only be used for documentation of elements of a PLAM library.

More about the "File Information System" can be found in Chapter 13.

Prepare File for Transfer via the Internet

FILEXP file1 [, file2] [, PAM]

File Export. The input file (file1) will be converted to a transparent format. The output file (Fcbtype=SAM, Recform=V) will consist of records less than 256 bytes long, and which consist only of printable characters and numbers. This file can then be transferred in text mode with any file transfer product to a host on any platform, and can then be sent via the Internet to any partner, either via FTP, or as an e-mail attachment.

file1 Name of the input file.

file2 Name of the output file (export file).

If no name is specified, the default name of CFS.EXPORT.FILE will be used.

PAM Only relevant when converting from SAM or ISAM files. The input file will be read by PAM blocks, and not logically, i.e. record by record. This enables defective files to be prepared for transmission.

Notes:

The export file is approximately twice as big as the original file. If the file is transferred to a PC platform (Windows/NT), it is recommended that the file be compressed prior to onward transmission. If a compression package such as PKZip is used to create a self-extracting EXE file, compression rates down to 25% or below can be achieved. This compressed file can then be transferred in binary mode to the required partner.

The export file will contain all information required to reconstruct the original file, including, for example, the original file attributes and, if applicable, the contents of the PAM keys.

Reconstruct a File from a BS2000 Export File

FILIMP file1 [, file2]

File Import. The original attributes and contents of a BS2000 file will be reconstructed from the specified input file, file1.

file1 Name of the input file.

file2 Name of the output file (original format).

Unless otherwise specified, the name in the first record of the input file will be used as the original file name. An existing PVS and userid will be ignored.

Note:

The program can also be executed without CFS being loaded in stand-alone mode as follows:

/EXEC (FILIMP,$user-id.CFSLIB)

The input and output file names in this case will be read from SYSDTA.

CFS File Transfer Command

FT [%name | %? [, JRS=jrfile | ,?] [,]] [datei1] [, datei2] [, passw] [, host2] [, user-id2] [, acct-nr2] [, passw2] [, rem-succ] [, rem-fail] [, rem-par] [, direct] [, lst] [, time]

All FT command parameters are optional. If no parameters are given, they will be requested via the FT parameter mask (see below).


With a mouseclick you get a describtion of the screen item.

FT command parameters:

%name The file transfer parameters will be taken from the specified parameter set.

%? All relevant parameter sets will be displayed in a list, from which one may be selected by marking it.

JRS=jrfile Name of the JRSAVE file containing the parameter set.

Standard: CFS.JRSAVE.xxxx. For further information, see page 27-.

? The FT mask will be prefilled with the values taken from the parameter set for the user to acknowledge. By default, the FT command will be executed immediately.

Notes:

The file transfer parameters activated by the parameter set can be modified by specifying additional parameters e.g. file1, file2 .

Saving the most recently used FT parameters to a parameter set can be done from a CFS file list by issuing an SP FT%name command. For further information, see page 7-.

file1 Name of the file or PLAM library element to be transfered.

A library element should be entered in the form: *LIB( lib,element,type)

file2 Name of the file or PLAM library in the target system.

A library element should be entered in the form: *LIB(lib,element,type)

Standard: same name as file1.

passw Password of the file to be transfered/overwritten in the remote system

[C]'...' | X'...'

host2 Symbolic name of the remote host system.

The host2 name refers to the partner name defined in the FT generation, and not the BCAM generation name.

user-id2 User-Id for the Transfer Admission to the remote host system.

Standard: same user-id as on local system.

FTAC: As an alternative to a remote user-id, an FTAC Transfer Admission for the remote system can be given instead. Here, the constant "FTAC:" should be entered in the "Remote User-Id" field, followed by the actual Transfer Admission. When entering the Transfer Admission, take care to enter uppercase/lowercase letters exactly as in the FTAC profile. CFS does not convert lowercase letter to the respective uppercase.

Note:

When installing CFS, the system administrator must specify whether the FTAC product is available on the local host or not. This is done through the respective entry in the CFSMAIN module (Standard: FTAC not available). For further information, see Appendix A-4 "CFS Installation".

acct-nr2 Account number.

Standard: same account number as on local system.

passw2 Logon password for the remote system user-id ( [C]'...' . | X'...' ).

Standard: no password.

rem-succ Remote Success Procedure. Follow-up processing to be executed in the remote system after a successful file transfer.

proc,* The specified DO procedure proc should use the transfered file as a parameter.

* If an FTAC profile was used for the file transfer, only the file name is passed after a successful transfer.

/cmd .... The specified BS2000 command is executed in the remote system following a successful file transfer. If '*' appears in the BS2000 command, then the name of the transfered file will be substituted at the relevant position. No further parameter for the BS2000 command cmd may follow the '*'. Should this be necessary, the proc,* variation should be used. Multiple BS2000 commands separated by commas can be given (/cmd1 ...;/cmd2 ...).

'/cmd ...' The specified command is executed in the remote system following a successful file transfer. The '*' character is not substituted in this variation.

Standard: no Remote Success Procedure.

rem-fail Remote Failure Procedure. Name of the follow-up processing to be executed in the remote system after an unsuccessful file transfer attempt.

proc,* The specified DO procedure proc should use the transfered file as a parameter.

* If an FTAC profile was used for the file transfer, only the file name is passed after an unsuccessful transfer attempt.

/cmd .... The specified BS2000 command is executed in the remote system following an unsuccessful file transfer attempt. If '*' appears in the BS2000 command, then the name of the transfered file will be substituted at the relevant position. No further parameter for the BS2000 command cmd may follow the '*'. Should this be necessary, the proc,* variation should be used. Multiple BS2000 commands separated by commas can be given (/cmd1 ...;/cmd2 ...).

'/cmd ...' The specified command is executed in the remote system following an unsuccessful file transfer attempt. The '*' character is not substituted in this variation.

Standard: no Remote Failure Procedure.

rem-par Remote Parameter (Type of remote system).

possible types: *BS2000 | *MSP | *ANY | *any

*BS2000 Target system uses the BS2000 operating system.

*MSP Target system uses the MVS operating system.

*ANY Target system uses another operating system (SINIX/VMS/AMBOSS).

*any Target system uses another operating system. The file names are not converted to uppercase (see below).

Standard: *BS2000.

direct Transfer direction of the file transfer.

possible values: TO | FROM

Standard: TO.

lst Listings. Should a log be produced for each tranfered file?

possible values: YES | NO

The value YES has the additional result of activating the CFS Job Report System at the end of the file transfer request in order to display the result log created by CFS on the screen.

Standard: NO.

Note: The message "FILE TRANSFERED" generated by FT-BS2000 is superfluous if the Job Report System is in control. This message can be suppressed with the /BCNTRL MES=NO command.

time hh:mm Start the transfer at a specified time.

If the start time is earlier than the current time, then the request will be processed the next day.

Standard: Start the transfer as soon as possible.

" Modify Extended Parameters for FT " (last field in the FT mask):

Entering Y in this field will display the File Transfer Extended Parameter Mask (FTEP mask). Additional, less frequently used parameters for all future FT calls can be set in this mask. For example, the "Local Transfer Admission User-Id, Acct-Nr, Password" parameters, and the "Local Success Procedure", "Local Failure Procedure" can be set in the FTEP mask. These additional FT parameters can also be preset before the first FT call by the FTEP [param] command (see page 7-).

Standard: N (FTEP mask is not displayed).

Notes:

The termination of FT requests can be monitored with the Job Report System of CFS as from FT-BS2000 Version 3 (FT-Parameter Protocol-Listing: YES). For further information, see page 11-.

When transfering files with FT, read passwords for the files to be transfered in the local system will be requested by CFS dynamically.

To select multiple files for transfer by FT-BS2000, the NSTAT option in the FILENAME-SELECT field should be noted.

If the FT command parameters are explicitly specified up to and including acct-nr2, then the FT parameter mask will not be displayed, and the standard values will be used for any additional parameters necessary. In all other cases, the FT mask will be displayed for the parameters to be entered. To suppress a mask request in procedures, the FT command should be entered with at least the following parameters: FT file1, [file2], [passw], host, user-id2, [acct-nr2]

After sending the FT mask, and after execution of the FT command, the FT mask will be displayed again for further transfers. This remains until the user enters blanks for file1, or cancels the FT mask with K1.

Pressing the K3 key will, as in EDT, refresh the screen with the FT mask.

For further information about file transfer - in particular file transfer between BS2000 and SINIX systems - refer to Chapter 12 "File Transfer using FT-BS2000/RDAC.

Display/Amend Extended File Transfer Parameters

FTEP [user-id] [, acct-nr] [, passw] [, loc-succ] [, loc-fail] [, wr-mode] [, data-typ] [, prio]

The FTEP parameters serve as background information for all successive FT calls. Once set, FTEP parameters can be changed or reset by switching to the FTEP mask and entering blanks or other values.

All parameters for the FTEP command are optional. If no parameters are entered, these are then requested via the FTEP mask (see below).


With a mouseclick you get a describtion of the screen item.

Parameters for the FTEP command:

user-id User-Id for the transfer admission in the local system (own host), and for the processing admission if a loc-succ or loc-fail procedure is specified.

Standard: own User-Id.

The alternative to the local User-Id is to specify the FTAC Transfer Admission for the local system. Here, the string 'FTAC:', followed by the FTAC transfer admission is entered in the "Local User-ID" field.

acct-nr Account number of the specified User-Id.

Standard: Account number of own User-Id.

passw Logon password of the User-Id for the local transfer admission.

Standard: no password.

loc-succ Local Success Procedure. Name of the follow-up processing that is to be executed in the local system (own host) after a successful transfer.

proc,* The specified DO procedure proc should use the file transfered as a parameter.

* If an FTAC profile was used for the file transfer, only the file name is passed after a successful file transfer.

/cmd .... The specified BS2000 command is executed in the local system following a successful file transfer. If '*' appears in the BS2000 command, then the name of the transfered file will be substituted at the relevant position. No further parameter for the BS2000 command cmd may follow the '*'. Should this be necessary, the proc,* variation should be used. Multiple BS2000 commands can be given, separated by commas(/cmd1 ...;/cmd2 ...).

'/cmd ...' The specified command is executed in the remote system following a successful file transfer. The '*' character is not substituted in this variation.

Standard: no Local Success Procedure.

loc-fail Local Failure Procedure. Name of the follow-up processing that is to be executed in the local system (own host) after an unsuccessful transfer attempt.

proc,* The specified DO procedure proc should use the transfered file as a parameter.

* If an FTAC profile was used for the file transfer, only the file name is passed after an unsuccessful transfer attempt.

/cmd .... The specified BS2000 command is executed in the local system following an unsuccessful file transfer attempt. If '*' appears in the BS2000 command, then the name of the transfered file will be substituted at the relevant position. No further parameter for the BS2000 command cmd may follow the '*'. Should this be necessary, the proc,* variation should be used. Multiple BS2000 commands can be given separated by commas (/cmd1 ...;/cmd2 ...).

'/cmd ...' The specified command is executed in the local system following an unsuccessful file transfer attempt. The '*' character is not substituted in this variation.

Standard: no Local Failure Procedure.

wr-mode Write mode. This defines the course of action to be followed if a file already exists for the receive file.

REPLACE If an identically-named file exists in the receiving system, it will be overwritten (Standard).

NEW If an identically-named file exists in the receiving system, it will not be overwritten, and the file will not be transferred.

EXT Extend. An existing file will be opened in Extend mode.

data-type Data Type. This specifies the format of the transmitted file.

CHAR The send file is a text file. The receiving system will store the data as such. If necessary, the file will be converted. (Standard)

BIN The send file is a binary file. The receiving system stores the file exactly as it was sent, with no code conversion taking place.

TRANS Transparent binary transfer (DATA-TYPE= *BIN(TRANS= *YES) ). Any BS2000 files, particularly ISAM and PAM files can be transferred via non-BS2000 platforms (e.g. UNIX or PC) such that they arrive at a remote BS2000 host in the same format as when they were transmitted.

The TRANS option is available from openFT V6.0.

Standard: The format of the local file is unknown and will be determined by the remote system.

prio Specifies the priority with which the transfer should be processed in relation to other transfers to the same remote system.

NORMAL The file transfer has normal priority (Standard).

HIGH The file transfer has a high priority.

comp compression mode.

BYTE The file will be transferred using byte-compression (default).

NONE The file will be transferred without compression.

This mode may be useful when trensferring files to a SINIX/UNIX-computer.

encrypt Encrypted file transfer (as from openFT V6.0).

YES The file will be encrypted before transfer. A prerequisite for this function is that the product openFT-CR is installed.

NO The file will be transmitted unencrypted (Standard).

Set Guard Protection for Files / Library Elements

GUARD [%name | %? [,JRS=jrfile]] [file] [,R=guard|*NONE|*SAME] [,W=guard|*NONE| *SAME] [,E=guard|*NONE|*SAME]

The specified file or library element will be issued with a Guard protection. If no parameters are specified, or if only the file name is specified, the mask shown below will be displayed:


With a mouseclick you get a describtion of the screen item.

%name The parameter values for the Guard command will be taken from the specified parameter set. Saving a parameter set is done with the SPGUARD %name CFS command.

%? All relevant parameter sets will be displayed on screen, from which one may be selected by marking it.

JRS=jrfile Name of the JRSAVE file in which the parameter set has been saved.

Standard: CFS.JRSAVE.xxxx. For further information, see page 27-.

file Name of the file or library element to be protected.

The name of a library element must be entered in the form lib([t/]name[/vers]). Instead of a name, an asterisk '*' can be entered as an abbreviation. The required data object must be marked with an asterisk as an Action Code. If no name is specified, or if no name is entered in the mask, then no action will be performed. The specified Guard profile is, however, stored for use with a later SG (Set Guard) command.

R=guard Read access to the data object is protected by a Guard with the specified name. A Guard, like a file, can be assigned a PVS-id, a userid and a name, although the name is restricted to eight characters.

R=*NONE File: Read access is protected with an empty Guard and is thus prohibited.

PLAM Element: Read access is monitored neither with Guard protection nor with Basic Access Control Level (BACL) attributes.

R=*SAME The Read access rights to the data object remain unaltered.

W=guard Write access to the data object is protected by a Guard with the specified name. A Guard, like a file, can be assigned a PVS-id, a userid and a name, although the name is restricted to eight characters.

W=*NONE File: Write access is protected with an empty Guard and is thus prohibited.

PLAM Element: Write access is monitored neither with Guard protection nor with Basic Access Control Level (BACL) attributes.

W=*SAME Write access rights to the data object remain unaltered.

E=guard Execute access to the data object is protected by a Guard with the specified name. A Guard, like a file, can be assigned a PVS-id, a userid and a name, although the name is restricted to eight characters.

E=*NONE File: Execute access is protected with an empty Guard and is thus prohibited.

PLAM Element: Execute access is monitored neither with Guard protection nor with Basic Access Control Level (BACL) attributes.

E=*SAME Execute access rights to the data object remain unaltered.

Notes:

The following restrictions are valid for files: If the value *NONE is entered for all three access types, Guard access control is totally switched off. The file is then protected only with the SHARE=YES|NO, ACCESS=READ|WRITE attributes. The same effect can be achieved by executing the SGN (Set Guards None) Action Code.

When protecting PLAM elements with a Guard command, the existence of the specified Guard is not checked. If an element is protected with a non-existenet Guard against, for example, read access, then read access will be prohibited by all users until a Guard with the specified name is created.

Activate Hardcopy Mode

HC [n] [file] [, L] [, T] [, B] [, E] [, O] [, A] [, F] [, G] [, I] [, S] [, R] [, RS]

Activate the Hardcopy Mode for the basic CFS task, or for Connection n.

When the Hardcopy Mode is set, all screen input and output (particularly masks) will be captured to the specified file.

All HC command operands are optional, and can be omitted. The default values will then become effective.

The Hardcopy Mode can be turned on and off as often as required (see below for the NHC command).

Apart from activating the Hardcopy Mode explicitly with the HC command, individual screens can be captured by pressing the F3 key (in the base CFS task), or by pressing the pre-defined Hardcopy key (in a Connection, see the CH command on page 18-). It should be noted that each screen captured with F3 will appear in the listing on a separate page. This is in contrast to the normal Hardcopy Mode (HC command), in which multiple screens can be printed on a page.

Entering a CFS mask with the F3 key will be handled identically to DUE1. When working in a Connection, if the specially defined Hardcopy key is pressed, the latest input is lost. It must be re-entered, and transmitted with DUE1.

The HC command works only in the basic CFS task, and will not work in Connections. An HCn command must be given for a Connection. Hardcopy Mode can be activated for a Connection even before it has been opened. Within a Connection, the Hardcopy Mode can be requested via the HC command.

For a full description of all HC command operands, see Chapter 15 "Hardcopy".

NHC | NHC n Reset Hardcopy Mode for the CFS basic task / for Connection n.

Insert File in File List

I file [, act] Include. The specified file/job variable is added to the file list.

Both full and partially qualified names can be given for 'file.'. If file refers to a shareable file under another User-Id, then it should be specified as $user-id.file.

act the Action Code is inserted with the file.

I file,D in this context has a special meaning: CFS inserts the file name into the list and immediately displays this file.

See also the AL (Append List) command.

File Information System: Standard Format for entering INF Text

I FORM=f This command can be used to enter a user-specific format f into the format catalog, $TSOS.CFS.INF.FORMAT, which will serve as the standard format for entering text (IM/IA Action Code, without specifying a format). For further information, see Chapter 13 "File Information System".

Assign Event file (Item File)

IFILE file Item File. The user can set up an Event file with this command. The Event file is needed for the CAL (Calendar), SI (Show Item), SIS (Show Item Short), SIL (Show Item List), MI/II (Modify/Insert Item) commands.

A full description of the commands can be found in Chapter 14, "Event Scheduling System".

Insert Item: Enter new Event

II [date] [/time]   Insert Item. A mask for entering short- and long-term events is displayed.

A full description of the commands can be found in Chapter 14, "Event Scheduling System".

Insert Action Code in all Action Fields

INSRT act The specified code act is inserted into the Action Field for all elements in the list. The viewing window is then repositioned to the top of the list.

Example:

/PROC C
/SYSFILE SYSDTA=(SYSCMD)
/SETSW ON=(1,4)
/EXEC $CFS.CFS
*002 FILE=SYS.CONSLOG.
ONXADD LIB.CONSLOG
INSRT XE
AT
/SETSW OFF=(1,4)
/ENDP

Note:

A further possibility to automatically insert a specified Action Code for all elements of a file list is the Search command, in the form S,'...' =INSRT .. . For a full description, see page 7-.

Commands for Controlling the Job Report System

JR.. JR | JREP | JRF | JRFT | JRIC | JRID | JRP | JRSH

These commands are described fully in Chapter 11 "Job Report System (JRS)" on page 11-.

Retain Last Command

KC | NKC Keep Command /do Not Keep Command.

KC The command last entered will not be erased from the command field.

NKC The command last entered will be erased following successful execution.

Standard: NKC

For information about "Repeat Last Command", see also page 7- (Command Memory).

File List: Number of Used Pages as File Size Indicator

LASTP The file size indicator in the first column of the file list is normally the Last Page, i.e. the number of PAM blocks actually occupied by the file. Switching the mode using the ALLOC command will only take effect at the next file selection.

Standard: LASTP.

Log [Do Not Log] Entries in Command Memory

[N]LIM [SEL|CMD|CON]

Log Input in Memory (LIM) / do Not Log Input in Memory (NLIM).

LIM All user entries (selection mask parameters, commands, Line Mode input in Connections) will be stored in the internal command memory (Default).

SEL Selection mask entries are logged in the memory.

CMD File list entries ("COMMAND :" field) are logged in the memory.

CON Input made in Connections are logged in the memory.

NLIM All input following this command will not be stored in the internal command memory, and hence will not be available for reuse when pressing the DUE2 key. The NLIM command is particularly relevant in CFS procedures, so that the entries produced by the procedure will not be stored in the memory.

SEL Selection mask entries are not logged in the memory.

CMD File list entries ("COMMAND :" field) are not logged in the memory.

CON Input made in Connections are not logged in the memory.

Note:

The CFSMAIN initialisation module can be used to set the scope of the command memory. For further information, see page 7-.

Load Command Memory from a File

LM [ file | lib (t/ element) ]

Load Memory. The CFS-internal memory (storing FILENAME-SELECT and USER-ID fields, Command entries, and Line Mode input in Connections), is loaded with the contents of the specified file, or library element.

Notes:

Ommitting the file or element name from the LM command causes the Command memory to be loaded from a file called CFS.MEM.STD.jobname or acct. The account number acct is used if no Jobname is given with the LOGON command.

The following is valid for the command LM file:

If file does not exist (FSTAT Returncode 0533), then it is assumed that an identically named element in the CFS Userlib is implied. CFS will therefore attempt to load the contents of the element file (with PLAM libraries, S/file) from the CFS Userlib.

See also the commands CM (Command Memory, page 7-) and SM (Save Memory, page 7-).

Call LMS as a Subprogram

LMS Jump to LMS; e.g. to manipulate LMR libraries (OML's).

Return with the LMS statement END.

LMSSDF Jump to LMS (SDF interface, Prompt = '//').

Return by entering the LMS statement END.

After exiting LMS, and calling it anew, the following should be noted:

- The interface chosen (ISP/SDF) at the time of the first LMS call remains valid for all further LMS calls.

- The previously entered LIB statements do not have to be repeated. They are still valid from the previous LMS call.

Lock the Screen against Unauthorised Use

LOCK [passw] The screen under which CFS is running is locked.

In response to the LOCK command, a mask (LOCK mask) is displayed containing a dark, eight digit entry field. To terminate the Lock status (Unlock), the user needs to enter the valid password in the entry field of the Lock mask.

In the LOCK state no functions of CFS are available; it is also not possible to interrupt the CFS basic task to enter BS2000 commands by pressing K2 .

passw Password to unlock the screen.

Any one to eight character alphanumeric string.

Notes:

When defining a LOCK password, see in addition the SPL (Set Password for Lock) command on page 18-.

If no password is specified in the LOCK command, then the last password set in a previous LOCK command, or in an SPL (Set Password for Lock) command, is valid.

If CFS is reloaded from a connection, then it should be noted that the lock function is only operable for the CFS loaded in the connection.

Data security: The LOCK command supports data security for every user: users can leave their screens unattended, with nobody else being able to use CFS, or to look at the opened connections, or the previous commands in the command memory.

The screen area from the third line of the LOCK mask is overwriteable. It can be used to leave a message for colleagues, such as "In a meeting until 16:00 (Room C1/223)".

This message will not be erased if a data transmission key is pressed accidentally.

No Lower Case to Upper Case Conversion

LOW CFS Editor: When in Modify mode, lower case letters are not converted to upper case.

Entering File Documentation text (IM Action Code): The text will be passed as entered in lower or upper case.

Search Command, FIND User Option, ONXFIND Variable Action: No converson from lower case to upper case will take place in the search argument. This can also be achieved by entering the search argument in the form L'....' .

EDT Action Code: When reading in a new file or library element, the LOWER mode of EDT is not changed. A LOWER ON command entered for a previous file will thus remain in effect.

Standard: CAP

Modify CFS Memory Area.

M L'addr', C'string' | X'string'

This command can be used to modify the standard values for the currently loaded CFS program. The Modify command is a substitute for the IDA command, /M C'...' INTO L'...', that could be called from TSOS by a single user. The Modify command should only be used to amend CFS-internal parameters which have no specific CFS modification command.

L'addr' Address of the location to be modified in the loaded program. The parameter addresses can be ascertained using the CFSMAIN source program. For example, the Assembler command MVI 33(R1),C'Y' corresponds to M L'1021',C'Y' (L'1021' = L'1000' + 33) in CFS Modify syntax. All CFS-internal parameter addresses in CFSMAIN will be maintained in future versions of CFS.

C'string' | X'string' The content to be copied to the specified address.

Examples:

M L'1031',X'00'

The contents of the memory location L'1031' will be reset to X'00' as a result of this statement. This will result in no lower case to upper case conversion taking place when capturing a CFS mask using the Hardcopy function.

M L'12E5',C'CFS.JRSAVE.name '

The character string 'CFS.JRSAVE.name___' will be written to memory as from address L'12E5'. This will change the default JRSAVE file name, for example for a second user.

Return from CFS to the Main Program

MAIN Return to the Main program.

This command is only valid if CFS was called as a subprogram from another program.

Notes:

CFS is capable of running as a subprogram in so far as it can be called as a module from any program (dynamically linked, or bound). A full description of the interface can be found on page 17-.

CFS can be called in dialog mode. It presents the same mask as though called via the /EXEC command.

CFS can also be called in procedure mode through the subroutine interface. In this case, the calling program passes CFS statements which are executed by CFS in procedure mode. The statements can be passed via SYSDTA or Format-V type records in memory.

For further information, see Chapter 19 "Procedure Language".

Write Messages or Change Requests to CFS Comments File

MES Write a message to the CFS comments file. A mask is presented in which error messages concerning CFS, change requests, and other miscellaneous messages can be sent to our company, OPG. This information is written to the file $TSOS.CFSCOM. The file name can be changed by the system administrator during CFS installation.

Modify Item: Amend Event Text

MI [date] Modify Item. The old text of the specified event is displayed in a mask, and may be modified.

A full description of these commands may be found in Chapter 14, "Event Scheduling System".

Amend User Option in File List

NL [usopt1] [;[usopt2]] [;[usopt3]] [;[usopt4]]

New List. The current file list is re-displayed, this time with the specified User Options. No new selections are made.

usopt1 Description of a User Option permissable for the current data object. Selection criteria included with the User Option will be ignored.

usopt2;usopt3;usopt4

The value for the first User Option specified (usopt1) will be displayed in the reserved User Option column. The values for any additional User Options, (usopt2;usopt3;usopt4), will replace those in the columns PASS, AGE and LASTP (SPACE). Two consecutive semicolons (";;") will prevent that column from being overwritten by a User Option - see the second and third examples.

If no User Option is specified, the default layout of the file list is displayed without User Options.

Examples:

NL ALLOC

The current value of the ALLOC User Option is displayed for all files displayed in the list.

NL ALCNT;EXTNT;;ALLOC

The User Option column will contain the number of secondary allocations (ALCNT) with the PASS column containing the number of extents (EXTNT). The AGE column will not be overwritten (;;). The LASTP column will be replaced with the allocated space (ALLOC) occupied by the file.

NL ;;;VSN

This command will result in the first column of the file list displaying the VSN of each file instead of the LASTP. The AGE and PASS columns remain unaltered.

Select New Files/Library Elements - drop old List

NP New Parameters. The user is presented with the Selection mask to choose a new file list. The previous file list, and all Actions not yet executed, are invalidated.

Pressing the K1 key has the same effect as the NP command. In this regard, see the section headed "K1 key" at the beginning of this chapter.

The command AL should also be noted at this point. AL will cause the existing list to be extended with the files found using the selection criteria.

NP param The FILENAME-SELECT and other fields of the selection mask are filled with the contents of param. Immediately after the NP command has been executed, the file list comprising the selected files is displayed. The transaction step of "filling in the selection mask" is thus skipped.

The selection statements appear in the Command Memory as a single command, and can be displayed on the screen again by pressing Shift ENTER. For explicit entries in the selection mask, this is only valid for the FILENAME-SELECT and USER-ID fields. For firther information, see page 4-, 7-.

param [filename-sel] [; user-id] [; keyw1=...] [; keyw2=...] [...]

Contents with which the selection mask should be filled. The first positional parameter filename-sel will be placed in the FILENAME-SELECT field, the second, user-id, in the USER-ID field. All further parameters are keyword parameters and are entered in the specified fields.

The shortest allowable keyword abbreviation to map to the respective field is shown below:

LA --> LAST PAGE

AG --> AGE

FCB --> FCBTYPE

VOL --> VOLUME

SH --> SHARE / NONSHARE

ACC --> ACCESS

PAS --> PASS

U --> USER OPTION

SO --> SORT OPTION

DOC --> DOCUMENTATION

VAR --> VARIABLE ACTION

The delimiting character ';' can be remapped to another character using the SEP command. For further information, see Chapter 18 "Amending Parameters".

Examples:

NP SRC

All files containing the character string 'SRC' within their name.

NP CFS.,Q

All files beginning with the partial qualification 'CFS.' (Qualified Selection).

NP SRC;XYZ

All files containing the character string 'SRC' under the User-Id $XYZ.

NP SRC;XYZ;AG=0

All files created or amended today (AGE=0), under the User-Id $XYZ, and containg the character string 'SRC' in their name.

NP;US=RETPD>0;VAR=ONX/CAT RETPD=0

All files under the current User-Id whose release date is sometime in the future (USER OPTION :RETPD>0). This NP command also defines a Variable Action to reset the Retention Period (VAR=ONX/CAT RETPD=0). The Variable Action will be executed after the required files are marked (equivalent to the ON command, Action Code X).

NP %name | %? [,jrsave] [,?] [;param]

The FILENAME-SELECT and other fields of the selection mask will be filled with the contents of the specified parameter set, and then the relevant file list will be assembled and displayed.

%name Name of the parameter set containing the selection criteria.

%? All relevant parameter sets will be displayed on screen in a list, from which one may be selected by marking it.

jrsave Name of the JRSAVE file containing the specified parameter set.

Standard: CFS.JRSAVE.xxxx. For further information, see page 27-.

? The selection mask will be pre-filled with the parameter set contents, and then displayed for the user to accept or modify. Normally the selection process will be started automatically.

param With the exception of filename-sel, any entries which can be used for an NP param command (see above) can be used here for param. The values specified for param will override the corresponding values in the parameter set.

Example:

NP %XYZ,CFS.JRSAVE.1;TSOS;U=LACC

The selection criteria saved in the parameter set %XYZ in the file CFS.JRSAVE.1 will be modified as follows: the contents of the USER-ID field will be replaced with TSOS and the USER OPTION field will be replaced with LACC. The selection result will be displayed immediately as a file list.

Further Variations of the NP Command

NP; Select all files from the current User-Id.

NP; has the same effect as sending an empty selection mask.

NP* This variation of the NP command has the effect of recreating the file list using those selection criteria last used.

NP*;param The file list will be recreated using those selection criteria last used, as well as those fields modified by param. The input format for param is fully described above (NP param).

Notes:

In previous versions of CFS, the command NP* caused the Selection mask to be displayed with its previous contents. The same result is possible in the current version by entering '*' at the termination enquiry, or by entering the command A*.

If a User option was specified in the previous selection, it will be used again in conjunction with the new selection process. Amending the Standard User Options with the UO command (page 18-), will have no effect with a reselection using the NP* command. Using just the NP command to make a new selection of files will cause the amendment of the Standard User Option to become effective.

If libraries (FMS/LMS/PLAM) are displayed in the file list, then entering the Action Code NPF/NPL/NP next to the required library will have the same effect as the commands FMS library, or NP LMS library.

Define Variable Action

ONX | ON& var-act [, ENTER]

Define Variable Action.

ONX... The Variable Action is only carried out for those elements marked in the file list with the Action Code x. Marking the required objects in the file list can be performed in the same transaction as sending the ONX command, or it can be done before the next input.

ON&... The Variable Action is carried out for all selected elements, without them needing to be flagged with an Action Code.

Example: ON&MOVE vsn/device.

var-act The Variable Action to be defined here is the same as that entered in the VARIABLE ACTION field of the Selection mask; for the description, see Chapter 5.

ENTER The Variable Action is defined and the required files are marked in dialog, but the execution of the Variable Action is carried out as an Enter job. The Enter job thus created by CFS is monitored by the Job Report System. For further information, see page 5-.

Note:

If the command line of 71 bytes is too short for the Variable Action to be entered, the following should be done: Enter as much of the Variable Action ON... in the command line as possible. As a next command, enter VAR, and a branch will be made directly to a two line "VARIABLE ACTION" field of the Selection mask. The Variable Action can now be entered in its entirety.

Call PERCON as a Subprogram

PERCON Branch to PERCON.

PERCONSDF Branch to PERCON (SDF interface, Prompt = '//').

Return via the END statement of PERCON.

Load P-Keys

PL [module] [, maplib]  P-Load. Load the programmable keys.

module Name of the module created with the software product PLUS or TLOAD, for loading the P-keys.

maplib Name of the LMR library in which the PLUS/TLOAD module is stored. If no library name is specified, CFS will assume the standard library name, PLUS.MAPLIB (without $User-Id. !), or a library assigned with LINK=MAPLIB.

Notes:

If module and maplib are not specified (PL), then the module PSTD in the CFSLIB will be used to load the P-keys (PL PSTD,CFSLIB).

The PSTD module contains the P-key assignments of EDT (identical to the EDT statement P-K [load P-keys] ).

In the CFS file list, and in CFS Display/Editor, the keys P4 and P5 can be used to page forwards and backwards following the EDT key assignments. P10, as in EDT, causes the window to be positioned at the next hit during a search command.

A further possibility of loading the P-keys by means of the Command Memory is described on page 7-.

Display Volume Information from an Archive Directory

POOL [AV] [, DIR=directory] [, string] [, FILE=file] [, SORT=C|E|R|D|O [, A|D] ]

The following media information relating to entries in an Archive directory will be displayed:

VSN and device type of the media, the save version identifier, owner (Archive pool or operator), expiry date of the volume or save version, and remarks (e.g. that the tape is unusable).

AV Only available Archive volumes (VSN's) will be displayed. Available media are those not associated with an expiry date, or those whose expiry date has passed.

Default: Information on all volumes, i.e. both used and free, will be displayed.

directory Name of the Archive directory.

If the POOL command is issued from within an Archive directory file list (see pages 3- and 4-), the DIR=directory parameter can be omitted. In this case, CFS will supply the name of the directory currently being displayed.

string Only those lines from the Pool list whose contents meet the search criteria will be displayed. As well as the single search argument 'string', multiple search arguments can be constructed by using the operators */,/+ . For a full description of the construction of multiple search criteria, see page 8-.

Examples of search criteria: :1:H04246,:1:H043

'S.9412'

'OPERATOR'+'-07-'

UNUSABLE

file The POOL entries will be written to a file with the specified name. No output will go to the screen.

SORT=x[,A|D] The entries from the POOL command will be sorted on the specified criterion:

C Sort on the column "Current Use"

D Sort on the column "Device"

E Sort on the column "Exp.Date"

O Sort on the column "Owner"

R Sort on the column "Remark"

V Sort on the column "VSN"

A|D The sorting will be in ascending or descending order.

The screen produced by the POOL command looks as follows:


With a mouseclick you get a describtion of the screen item.

The following commands can be issued from the command fields of the POOL mask:

ADD= vsn | (vsn, ...) [, DEVICE=T1600 | device]

Tapes or cassettes from the current directory pool will be added. From the command CFS will build an ARCHIVE statement as follows: POOL DIR=...,ADD=vsn [, DEVICE=...]

REM[OVE]= vsn | (vsn, ...)

Tapes or cassettes from the current directory pool will be removed. From the command CFS will build an ARCHIVE statement as follows: POOL DIR=...,REMOVE=...

PU[RGE] [ SV= OBS[OLETE] ] | svid | (svid, ...) | backup,date[.time] [, FORCE=YES|NO]

All Save Versions whose expiry date has passed will be deleted from the current directory. The parameters for the PURGE command are identical to the corresponding Archive statement. The DIR= and LIST= parameters will be supplied automatically by CFS.

SORT=x[,A|D] The entries from the POOL command will be sorted on the specified criterion:

C Sort on the column "Current Use"

D Sort on the column "Device"

E Sort on the column "Exp.Date"

O Sort on the column "Owner"

R Sort on the column "Remark"

V Sort on the column "VSN"

A|D The sorting will be in ascending or descending order.

/cmd any BS2000 command

+ | +n | ++ Scroll forward in the list

- | -n | -- Scroll backwards in the list

HC file | NHC Enable/disable the hardcopy of the POOL screens

F3 Capture the current screen to the default hardcopy file

K1 Return to the CFS file list from the POOL screen

Note:

Issuing an NPDIR directory command, or entering DIR directory in the FILENAME-SELECT field of the selection mask will display the latest version of all files from the directory, together with the save information (Age/Date), in the form of a file list. For further information, see page 4-.

Display the Public Space Utilisation (PUBSP)

PUBSP [pubset] [, FILE=file] [, SUM]

A screen will be displayed in which the space utilisation of all, or of specific Pubsets is presented. A prerequisite for issuing the PUBSP command from a userid other than TSOS is that the system administrator has started a Holdertask from the utility TASHT (/ENTER CFS.S. LMSLIB(TASHT) ).

pubset The space utilisation of the specified Pubset is displayed. The Pubset identifier must be specified without the colons, e.g. A oder TEST.

file The space utilisation table will be saved to a file with the specified name. The screen display in this case will be suppressed.

SUM Only the summary line (see below) will be displayed for each Public Volume Set.

The PUBSP mask has the following format:


With a mouseclick you get a describtion of the screen item.

The following commands can be specified in the command field of the PUBSP mask:

/cmd any BS2000 command

+ | +n | ++ Position within the list

- | -n | -- Position within the list

HC file | NHC Set/reset hardcopy mode

PUBSP [pubset] another PUBSP command for an additional Pubset

NP* Update the current Pubspace list

LST Leave the PUBSP screen and return to the CFS file list, or to JES. (same effect as pressing K1; see below)

F3 Save the current mask to the standard Hardcopy file

K1 Leave the PUBSP screen and return to the CFS file list

Display Private Disk Space Utilisation (PRIVSP)

PRIVSP [priv] [, FILE=file]

A mask will be displayed indicating the space utilisation of all private disks currently online. If the PRIVSP function is to be made available to users other than TSOS, the system administrator must have started a TASHT Holdertask from under TSOS (/ENTER CFS. S.LMSLIB(TASHT) ).

priv The space utilisation of the private volumes whose VSNs are partially qualified will be displayed. Example: PRIVSP PVT.

file The space utilisation table will be written to a file with the specified name. In this case, the screen output will be suppressed.

The following commands can be specified in the command field of the PUBSP mask:

/cmd any BS2000 command

+ | +n | ++ Position within the list

- | -n | -- Position within the list

HC file | NHC Set/reset hardcopy mode

PRIVSP [priv] another PUBSP command for an additional Pubset

NP* Update the current Pubspace list

LST Leave the PUBSP screen and return to the CFS file list, or to JES. (same effect as pressing K1; see below)

F3 Save the current mask to the standard Hardcopy file

K1 Leave the PUBSP screen and return to the CFS file list

Display Predefined P-Key Assignments

PS [module] [, maplib] P-Show.  Display the contents of P-key assignments which have been created by the software product PLUS, and stored as a module.

The P-keys can be loaded with the PL command.

Display the Public Space Utilisation

PUBSP [pubset] [, FILE=file] [, SUM]

A screen will be displayed in which the space utilisation of all, or of specific Pubsets is presented.

pubset The space utilisation of the specified Pubset is displayed. The Pubset identifier must be specified without the colons, e.g. A or TEST.

file The space utilisation table will be saved to a file with the specified name. The screen output is this case is suppressed.

SUM Only the total line will be displayed.

The PUBSP mask has the following format:


With a mouseclick you get a describtion of the screen item.

The following commands can be specified in the command field of the PUBSP mask:

/cmd any BS2000 command

+ | +n | ++ Position within the list

- | -n | -- Position within the list

HC file | NHC Set/reset hardcopy mode

PUBSP [pubset] another PUBSP command for an additional Pubset

NP* Update the current Pubspace list

LST Leave the PUBSP screen and return to the CFS file list, or to JES. (same effect as pressing K1; see below)

F3 Save the current mask to the standard Hardcopy file

K1 Leave the PUBSP screen and return to the CFS file list

Display Private Volume Utilisation

PRIVSP [priv] [, FILE=file]

The utilisation of all available online private volumes will be displayed. A prerequisite for issuing the PRIVSP command from a userid other than TSOS is that the system administrator needs to have started the CFS-Holdertask from under TSOS (/ENTER CFS.S.LMSLIB(CFSHT) ).

priv The utilisation of the fully or partially specified private volume(s) will be displayed. Example PRIVSP PVT.

file The utilisation table will be saved to a file with the specified name. The output to the screen in this case is suppressed.

The following commands can be issued from the command field of the PRIVSP mask:

/cmd any BS2000 command

+ | +n | ++ Scroll forward in the list

- | -n | -- Scroll backward in the list

HC file | NHC Enable/disable the hardcopy of the PRIVSP screens

PRIVSP [priv] a further PRIVSP command with another partial qualification

NP* Update the latest Privsp list

LST Leave the PRIVSP screen and return to CFS or JES list (identical function to the K1 key, see below)

F3 Capture the current mask to the default hardcopy file

K1 Leave the PRIVSP screen and return to the CFS file list

Query User before Overwriting etc.

QE | NQE Query/No Query on Erase.

To prevent erasing files accidentally when using the E Action Code, the user can be forced to confirm each deletion before the deletion is actually carried out. Standard: NQE (No Query on Erase).

Refer also to the CFS ERT (Erase and Retain Tempfiles) parameter.

QA | NQA Query/No Query on Add.

Before carrying out an ADD operation for an element that already exists in a library, the user is asked if the existing element should really be overwritten: ".... IS ALREADY IN LIBRARY - OVERWRITE ? (Y/N/YA/NA)". During the execution of a Variable Action, answering YA (Yes,All) will overwrite the current element, and all following elements. No further queries will be generated, and Yes will be assumed. Analogous to this is the answer NA (No,All). The YA/NA mode will be reset after termination of the Variable Action.

Standard: NQA (No Query on Add).

QC | NQC Query/No Query on Copy.

Before a copy is performed to a file, JV or library element that already exists, the user will be asked if the existing data object should really be overwritten, as follows: "... IS ALREADY IN CATALOG - OVERWRITE ? (Y/N/YA/NA)". During the execution of a Variable Action, answering YA (Yes,All) will overwrite the data object, and all following objects. No further queries will be generated, and Yes will be assumed. Analogous to this is the answer NA (No,All). The YA/NA mode will be reset after termination of the Variable Action.

Standard: NQC (No Query on Copy).

QR | NQR Query/No Query on EDT-Return.

QR CFS Command EDT/EDL: After terminating EDT, the user is asked if the virtual EDT memory should be deleted (@D).

Action Codes EDT/EDL: The virtual EDT memory will automatically be deleted following the successfull execution of the UPD Action Code.

NQR The virtual EDT memeory is not deleted following a UPD Action Code; the user will not be queried for @D after returning to CFS from EDT.

Standard: QR.

QS | NQS Query/No Query on Select.

Before a Select is performed to a file that already exists, the user will be asked if the existing file should really be overwritten, as follows: "... IS ALREADY IN CATALOG - OVERWRITE ? (Y/N/YA/NA)". During the execution of a Variable Action, answering YA (Yes,All) will overwrite the file, and all following files. No further queries will be generated, and Yes will be assumed. Analogous to this is the answer NA (No,All). The YA/NA mode will be reset after termination of the Variable Action.

Standard: QS (Query on Select).

QT | NQT Query/No Query on Term.

Before terminating CFS, the user is asked: "DO YOU REALLY WANT TO TERMINATE CFS ? (Y/N)". Standard: NQT.

Q | NQ Query/Non Query.

Q equivalent to QE;QA;QC;QT;QR.

NQ equivalent to NQE;NQA;NQC;NQT;NQR.

Transfer/Print Files to/from another Host or PC

RDAC [file1] [, file2] [, passw] [, host2] [, user-id2] [, acct-nr2] [, passw2] [, rem-succ]    [, direct] [, print] [, time]

All RDAC parameters are optional. If no parameters are given, they will be requested via the following mask.


With a mouseclick you get a describtion of the screen item.

RDAC Command Parameters:

file1 Name of the file to be transfered.

file2 Name of the file in the target system.

Standard: same name as file1.

passw Password of the file to be overwritten in or fetched from the remote system.

( [C]'...' | X'...' ).

host2 Symbolic name of the remote host.

The name to be entered for host2 should not be the name generated in BCAM, rather the partner name generated in RDAC on the called host.

user-id2 User-Id on the remote host to which, or from which the file to be transfered will be stored.

Standard: same User-Id as on the local system.

acct-nr2 Account number.

Standard: same account number as on the local system.

passw2 Logon password of the User-Id on the remote system ( [C]'...' | X'...' ).

Standard: no password.

rem-succ Remote Success-Procedure. Name of the follow-up processing to be executed on the remote system in the event of a successful transfer.

proc,* The specified DO procedure, proc, will use the name of the transfered file as a parameter.

/cmd .... The specified BS2000 command is executed on the remote system following a successful transfer. If '*' is specified in the BS2000 command, then the name of the transfered remote file will be substituted at the respective position. No further parameters for the BS2000 command cmd may follow the '*'. If this is necessary, the proc,* variation should be used instead.

'/cmd ...' The specified command is executed on the remote system following a successful transfer. In this variation, the '*' character will not be substituted by a file name.

Standard: no Remote Success-Procedure.

direct Transfer Direction .

possible values: FROM | TO

Standard: Transfer Direction = TO.

print Should the file be transfered to a remote printer?

possible values: NO | YES | form [, pr-params

Entering a value other then YES/NO will be interpreted as a form description, and will produce a print with the specified string as a form parameter.

Following the values YES | form, one or more optional print parameters may be given:

pr-params SPACE= | COPIES= | HEADER= | LINES=nn

Standard: Print = NO.

time hh:mm Start the transfer after the specified time.

Standard: Start the transfer as soon as possible.

Notes:

Elements from a PLAM library can also be printed or transfered to a remote computer. In this case, the library element should be marked with the Action Code *, and then specified in the command in the form RDAC *. In this case, CFS will use a temporary file which will be printed or transfered.

If the parameters are explicitly specified up to and including acct-nr2 in the RDAC command, then the parameter mask will not be displayed, and the standard values will be used for any other required parameters. To suppress a mask display, the RDAC command in procedures should include at least the following parameters: RDAC file1, [file2], host, user-id2, [acct-nr2]

Pressing the K3 key will cause the FT mask screen to be refreshed, as in EDT.

For further information about file transfer using RDAC, and in particular file transfer between BS2000 and MS-DOS systems, see Chapter 12 "File Transfer with FT-BS2000/RDAC".

Restore File Attributes

RECAT file [, CATID=pvs] [, UID=user-id] [, CJ] [,IMP] [,NC] [,NU]

The RECAT command is used in conjunction with a catalog extract created with a Variable Action, ONX LISTCAT file. The following is checked for each entry id the LISTCAT file:

a) if the file still exists.

b) if yes: If the file attributes such as SHARE= YES/NO, ACCESS=READ/WRITE have remained the same. If this is not the case, a /CATALOG command is executed to reset the attributes to their original values.

In particlar, the following attributes are checked, and if necessary, reset:

- SHARE=YES/NO

- ACCESS=READ/WRITE

- RETPD

- AUDIT

- BACKUP-Level

- LARGE=YES/NO

- DESTROY=YES/NO

- SECONDARY ALLOCATION

- BASIC-ACL

With Job variables, the following attributes are checked, and if necessary, reset:

- SHARE=YES/NO

- ACCESS=READ/WRITE

- RETPD

- BASIC-ACL

CATID=pvs A search will be made for the file or Job variables to be processed on the specified Pubset. This is independent of the Catalog Id associated with the data object in the Listcat file.

pvs must be specified without the delimiting colons e.g. CATID=TEST

UID=user-id A search will be made for the file or Job variable to be processed under the specified userid. This is independent of the userid associated with the data object in the Listcat file.

user-id must be specified without the preceding $ sign and period, e.g. UID=TT08

CJ Create Jobvariables. If Job Variables no longer exist at the time of the RECAT command, then they will be recreated with the same contents and attributes. If the Job Variables still exist at the time of the RECAT command, then, if the CJ option is specified, the data content of the Job Variables will be reset to their value in the Listcat file. An exception is if the Job Variable is ACCESS=READ, has a RETPD > 0 or is password protected.

IMP Import Files. If the ONXLISTCAT contains catalog entries of files on private volumes, which at the time of the RECAT command no longer exist in the catalog of the Home PVS (e.g. after /ER file,CATALOG), then an attempt will be made to import these into the Home PVS catalog.

NC No Cat-ID's. The CAT-ID's of the files contained in the LISTCAT file are not taken into account when checking the file attributes.

The NC option should only be used if the CAT-ID's of particular files have changed between the time of the LISTCAT and the RECAT.

NU No User-ID's. The User-Id's of the files contained in the LISTCAT file are not taken into account when checking the file attributes.

Notes:

The CJ parameter of the RECAT command can be used to install Job Variables on a remote system following a successful transfer of a Listcat file. For further information, see page 12-.

The RECAT function can also be called from the CFSLIB as a stand-alone module: /EXEC (RECAT,CFSLIB). The operands required as parameters, file [,P] [,CJ] [,IMP], will be rquested via SYSDTA.

Reorganise Library / ISAM File

REORG lib-1 [, lib-2] [, par]

The specified library lib-1 (FMS/LMS/PLAM), or ISAM file is reorganised, in so far as all elements (records) are transfered to a temporary file, lib-2.

par :x: | vsn/device | PAD=nn | NR | DF[O] | SPACE=(xxxx,yyy)

:x: The reorganised library/temporary file is created on the specified PVS.

vsn/device The reorganised library/temporary file is created on the specified private volume.

Note:

If the temporary file is to be spread over multiple private disks, or if it should be created on any special medium, the following procedure should be used:

Create a file of a sufficient size on the required volume, using any name (with the exception of CFS.REORGFILE). Make this file known to CFS by issuing the following command: /FILE file,LINK=CFSREORG. From now on, any reorganisation will be executed using this file as the work file. This work file will not be deleted following the reorganisation, as is usually the case. The contents can be deleted with an /ERASE file,DATA command. The space reservation will remain.

nn optional PAD factor for the reorganised file. This parameter is only valid when reorganising ISAM files. PAD=nn can also ge given after :x: or vsn/device (separated by a comma).

NR No Release of free space. Space that has been allocated, but not yet used, is not released after the reorganisation. This space is available to the library or file for later use.

Standard: The free space is released.

DF[O] Defragment [Only]. Before copying back the temporary file, the space used by the original file is released by CFS issuing an /ERASE ,SPACE command, then the required space is requested anew. The number of extents of the original file should thus be reduced. The defragmentation is particularly effiecient if the temporary file is created on a different Pubset (REORG lib,:x:,DF).

DFO: Only the defragmentation will be performed. "Holes" in libraries or ISAM files will not be removed.

Standard: Defragmentation disabled for libraries and ISAM files, but enabled for all other files.

SPACE= Following a successful reorganisation, a FILE command with the specified SPACE parameter will be executed. In this way, surplus disk space can be released, and the secondary space allocation for the file can be simultaneously modified. (e.g. SPACE=(-9999,30) ).

Standard: free space is released. The secondary allocation is not amended.

Notes:

"Holes" created by the frequent erasure and creation of elements can be removed from libraries by using the REORG command. Following this command, the library will occupy less disk space.

If lib-2 is not specified, the temporary file created during the reorganisation is copied back to the original library, lib-1, and all unnecessary disk space is released with the command /FILE ...,SPACE=-9999. The temporary file is then erased.

If lib-2 is specified, then the reorganised library/ISAM file will be created with this name, and will not be copied back to the original file afterwards. In this case, the output file, lib-2 will also be optimised with respect to the extents by virtue of a /FILE lib-2, SPACE=(nn, nn) command issued before the reorganisation..

If the file list consists of elements of a library, the name of the library to be reorganised ( lib-1 ) can be omitted. In this case, the library whose elements are being displayed will be reorganised.

Return Control to CFS Procedure

RET Further input for CFS is requested via the input source SYSDTA. If CFS has been started with a STARTUP file, then RET has the effect of reading the next input from the startup file.

The RET command presupposes that control will have been passed from the procedure to the user at some stage in the command/startup file with a *DIA statement. The RET command will then pass control back to the procedure.

RET file | RET lib (element)

By entering a parameter with the RET command, a new input source for SYSDTA may be specified before switching back to procedure mode.

SYSFILE SYSDTA=file | SYSFILE SYSDTA=lib (element).

Notes:

For further information on running CFS in a procedure, see Chapter 19 "Procedure Language".

The procedure language of CFS also offers commands to control the point at which the procedure restarts, based on particular conditions (e.g. user input). For further information, see page 19-.

Rewrite Command for Multiple Update

Using the Variable Action ONXFIND... =W file, or the User Option FIND ... =W file, a printable file is produced. This file will consist of all records from a number of data objects (files, library elements, Job variables) that contain a particular search string (e.g. 'D3475'). The names of the data objects from which the records were extracted are also stored in the Write file. Often, it would be advantageous to be able to make a single, central amendment to the search string (e.g. replace 'D3475' with 'D348E' ), and then rewrite the respective data object with this amendment in a single command.

This function is provided by the Rewrite command of CFS. The Write file may contain any mixture of files, library elements or Job variables (FIND...=W file,E). An example of the application of the Rewrite command can be found on page 19-.

Operation of the Rewrite Command

A Header record containing FILE=, ELEMENT= or JV= is sought in the Write file, and the respective data object is opened in input mode. A second data object is opened in output mode. The records from the input data object and from the Write file are read, and written to the output data object, whereby records from the Write file overwrite the respective records from the input object. After all records have been processed, the newly created output object is copied back to the original, and finally closed (Standard). Setting optional parameters will keep the original unchanged.

If any errors are encountered during processing the data object (e.g. the data object to be modified no longer exists, or the temporary file cannot overwrite the original element because it is cataloged as ACCESS=READ, etc.), then an error protocol is produced. This will have the name of the Write file, with the suffix '.ERR' (file.ERR).

Rewrite Command Syntax

REWR file [, N ] [, BAK=suffix-1] [, SUF=suffix-2] [, AI ] [, NCD] [, ARO] [, XL] [, CL=nn]

file Name of the Write file containing the records to be modified with the respective data object name. This file must have been created with either the Variable Action ONXFIND...=W, or by means of the User Option FIND...=W. An error file created by an earlier Rewrite command may also be used as an input file. This error file will contain all the records that were not successfully processed in an earlier Rewrite run.

N Names Option.

During the Rewrite, the name of the data object currently being processed is displayed on the screen.

The names are not usually displayed. Only the names of the data objects that, for whatever reason, cannot be processed will be displayed, together with the respective error message.

BAK=suffix-1   Save the original to the specified suffix.

Before carrying out the Rewrite, a security copy of the original is created.

Rewrite of File/Job variables: Following a successful Rewrite, a copy of the unchanged original is available under the name xxx.suffix-1. xxx is the name of the file/Job variable to be modified.

Example: BAK=.OLD After carrying out the changes, the original file is still available under the name xxx.OLD.

Rewrite of LMS/PLAM Library elements: The original element is saved with the version description suffix-1. If suffix-1 begins with a full stop, this is ignored for the description.

Example: BAK=.OLD After carrying out the changes, the original element is still available under the [t/]xxx /OLD.

Rewrite of FMS Library elements: Following a successful Rewrite, a copy of the original element is available under the name xxx.suffix-1. xxx is the name of the element to be modified.

SUF=suffix-2 Save the modified data objects with the specified suffix.

Rewrite of Files/Job variables: Following a successful Rewrite, the modified objects exist under the name xxx.suffix-2. xxx is the name of the unchanged original file/Job variable.

Example: SUF=.REWR After carrying out the changes, the amended files exist under the name xxx.REWR.

Rewrite of LMS/PLAM Library elements: The amended elements are given the version description suffix-2. If suffix-2 begins with a full stop, this will be ignored for the version description.

Example: SUF=.REWR After carrying out the changes, the amended elements exist under the name [t/]xxx/REWR. If the library is an LMS/ISAM (OSM format) library, the version description will be abbreviated to REW, since only 3 characters are allowed for the version description.

Rewrite of FMS Library elements: Following a successful Rewrite, the modified elements exist under the name xxx. suffix-2.

AI Add with Increment of version.

The AI mode of CFS is set temporarily during the Rewrite execution. When rewriting LMS-ISAM or PLAM library elements , the version description of the new element is incremented by 1.

NCD No Check for Last Update.

When writing the resulting records from a BS2000 file under OSD V1 or higher, or from a PLAM library, the Last Update date will be written as well as the name of the data object. In this way it can be ascertained if the data object has been amended since the ONXFIND Action was performed. If this is the case, the Rewrite for the data object will not be performed, since it may lead to data inconsistency.

The NCD option allows the user to deactivate the Last Update check.

ARO Access Read Overwrite.

This option allows files cataloged as ACCESS=READ and/or RETPD>0 to be rewritten as well.

XL eXtra Library.

This parameter has only one function when Rewriting library elements, and then only if the BAK=suffix-1 or SUF=suffix-2 parameter is specified. The original (BAK=) or modified (SUF=) library elements will always be written under their original name to a new library named name.suffix-1/2, irrespective of the standard process. name is the name of the library currently being processed.

CL=nn Check Length.

Before writing the result records from the FIND file back to the original data object, it will be checked for length. If the original length is exceeded, that record will not be overwritten. The rejected records from the Write file will be transferred to the Error file (see below: "Rewrite Error Handling").

The specified value nn represents the maximum length which the records from the Write file may have after being written back to the original data object. The record length field of 4 bytes is not included in the calculation.

Example: REWR file,CL=72

After a string manipulation in the Write file using EDT (for example, ON&C'T9G'T'TAPE-C4'), it could occur that the DO procedure continuation character '-' is pushed beyond column 72 after the Rewrite operation. By specifying CL=72, those records will then not be written back to the original file, but will be written instead to the Error file.

Notes:

FIND function with saving of results (ONXFIND...=W file): All records of procedures/macros/source programs containing a continuation character are treated as a logical unit. If the search item is found in one of these records, then all records of this logical unit are transfered. The record in which the hit actually occured is flagged with an 'X' in column 2.

For PLAM library elements with the default version description of 'FF', Rewriting with the option AI will cause the original element to have the version number 001 and the amended element to have the version number 002.

When Rewriting FMS elements the AI option is meaningless.

The SUF and BAK options may not be specified together.

The Write file can be processed by either the CFS Editor (Action Code M), or by EDT.

The Write file records can be up to 2040 bytes in length (PAM blocks, Format B type records of PLAM library elements).

Before modifying the Write file, the original file should be saved.

Rewrite Error Handling

If an error occurs with one of the desgnated files/library elements during the Rewrite, then all records belonging to this data object are taken from the input file (REWR file), and written to an error file with the name file.ERR. Thereafter, the Rewrite continues with the next data object. After the user has resolved the error, a new Rewrite process can be executed for only those unsuccessful elements as follows: REWR file.ERR.

A common error when processing the Rewrite file can occur if the EDT command @ON&C'...'T'...' also changes control information in a record, such as the file or library element name. To avoid these kind of problems, it is recommended that all records with control information necessary for Rewrite should be copied to another workfile (ON&:2-2:FIND'*'COPY TO (1) KEEP). After processing the data content correctly, copy the control information back to its original position (COPY &(1) ).

If the temporary file created by the Rewrite cannot be copied back to the original file for any reason, then a message will be written to the Rewrite error log, and the temporary file (Name = inputfile. REWR) will not be erased.

Editing Options during Rewrite

The CFS Rewrite function can also be used to create new records in data objects, or to erase existing records.

The format of the Write file created by ONXFIND should be noted when using these extended Edit options.

The records have the following format:

DNNNNNNNX.................

|  |   |   |

|  |   |   |

|  |   |   À- Data content (with additional information such as PAM key).

|  |   |      Record type or record ID for PLAM library records)

|  |   |

|  |   À- X: Marker column (Normally blank)

|  |

|  À- NNN: Record number/Block number

|

À- D: Print control character (Write file can be printed with SPACE=E)

Inserting Data Records

If additional records are to be inserted in the Write file after a particular extracted record n , then these should be inserted into the Write file at the end of the record n. The columns DNNNNNNX should be left empty for the inserted records (continuous insertion). The data content of the records should begin at column 10. Any number of records can be inserted.

If new records should be inserted into the Write file after records that do not appear in the Write file, then these should be inserted into the Write file between records with the next largest, and next smallest record number. The first record should contain the record number n in the record number column N. An 'A' should be inserted into the Marker column (A=insert After). The data content of the record to be inserted follows the Marker column. If 2 or more successive records are to be inserted, then the 2nd and succeeding records should contain blanks in the columns N..N and X (continuous insertion). If the insertion is to be before the first record in the data object, then the record number 0 should be specified in the N..N column. If the insertion is to be after the last record, then a large hypothetical record number should be specified, e.g. 9999999.

Replacing Data Records

If a data record is to be completely replaced, then the number of the required record should be specified in the N..N column. Replacing existing records is the primary function of the Rewrite command.

Deleting Data Records

Entering an 'E' (Eliminate) in the Marker column will cause the record/PAM block with the number specified in the N..N columns to be deleted. It is not necessary to enter the data content of the record. For example, entering '______78E' will cause the 78th record to be deleted.

All records of a data object can be written to a Write file as follows: FIND ''=W file.

Restore Saved File List

RL [mn] Restore List. A previously selected file or library list is redisplayed as the current file list. The display window is positioned as it was when the list was last displayed.

mn any one to eight digit alphanumeric mnemonic code, under which the file list to be activated had been saved with the SL (Save List) command (SL mn).

Even without an explicit SL command, the user can restore the following default lists

RLF last list of BS2000 files

RLJ last list of Job variables

RLL last list of library elements

RLD last Archive directory list

RLZ last list of ZIP archive elements

since these are saved automatically under the default names by CFS.

If mn is not specified, then the file list that was last active is redisplayed.

Entering the RL command without the mnemonic code of a list saved with SL is only possible if the ADOC mode of CFS is switched on (Standard).

For further information on restoring earlier file lists, see also the commands SL (Save List) on page 7-, ADOC (Automatic Documentation) on page 18- and DOC on page 18-q, as well as the DOCUMENTATION field of the Selection mask, described on page 4-.

Example:

Parallel processing of multiple library/file lists.

The user has selected a number of libraries as a file list. The table of contents of one of these libraries can be displayed using the NP/NPF Action Code. These contents can then, for example, be saved with SL1. The command RL will return the user to the original list of libraries. The contents of the next library can be displayed with NP/NPF, and then saved with SL2. This process can be repeated for all required libraries. Branching to and from each library directly is then possible with the commands RL1, RL2, etc.

Search for an Entry in a File List.

S [-],'string' The next occurence of the specified string is sought. The display window is so positioned that the search hit is displayed in the first line.

For a full description of the syntax of the Search command, see the section entitled "Searching for Character Strings (Single Search argument/Multiple Search arguments)" on page 8-.

- Backwards Search: the search is carried out from the first displayed line towards the beginning of the file list.

Standard (without entering '-'): the search is carried out from the first displayed line to the end of the file list.

S [-] The next occurence of the search string specified in the last Search command is sought. Optionally, appending '-' will cause the search to proceed backwards.

S? Display the Search argument that was last defined.

Note:

Using the CFS command SC, see below, a Ruler can be displayed together with the file list. The user can then search over an exact column range within the file list.

Example:

S,:13:'SRC.'

Search the displayed list for a file or PLAM element whose name begins with 'SRC.'.

Search the File List and Display Search Results directly on the Screen

S,'string'=P The specified string is sought in the file list from the current position to the end of the list. Entries containing the string are displayed in Line Mode on the screen, and the search process is continued. This format of the Search command is similar to the ON&P'....' statement of EDT.

After a maximum of 21 records have been displayed, an overflow control ("Please acknowledge / End: K1") statement is displayed. Pressing K1 will terminate the search. Pressing any other key will continue the search.

When the search process has finished, the file list will be redisplayed at the position from which the Search command was entered.

Note:

After displaying the search results, the search criteria are still stored. Entering the command S will result in the display window being positioned at the first occurence of the search item.

Search the File List and Insert Action Code

S,'string'=IN[SRT] act

The specified string is sought in the file list from the current position to the end of the list. Entries containing the string will have the Action Code act inserted in their Action Code column. The search process then continues to the end of the file list.

Multiple search arguments, combined with the */,/+ operators may also be specified for 'string', as well as single arguments.

Display Ruler

SC SCO SCale/SCale Off

SC A Ruler marked with columns is displayed in the top half of the screen. The Ruler will be present in Display Mode and when displaying a file list.

OL | NOL As an alternative to SC/SCO, the commands OL/NOL (Orientation Line/No Orientation Line) commands can be given instead.

Standard: SCO (no Ruler display).

PLAM Libraries: Determine Age from "System Date" Directory Field

SDAT PLAM Libraries: The Age indicator in an element list will be determined from the System Date (=date of last update), over which the user has no control.

Standard: UDAT

Note:

When reorganising PLAM libraries, the System Date will be set to the current date (AGE=0) for all elements. The element User Date will not be amended during reorganisation. To maintain relevant age indicators even during library reorganisation, use the UDAT parameter (see page 18-).

Copy a Library Element to a File (Select)

SEL [t/] element, library [, file] [, act]

A file should be created from the specified library element. The name of the file to be created is determined by the user with the file operand. If the operand is omitted, then the file name will be identical to the element name.

t/ When selecting an element from a PLAM library, the element type t/ should be specified. If it is not specified, it will be requested by CFS.

If the file list consists of files, then the file created with the SEL command will be appended to the list.

act Insert the specified Code in the Action Code field of the file just created, and append it to the end of the file list.

For further information on "Selecting Library Elements", see also the Variable Action ONXSEL (page 5-, as well as the Action Code S (page 6-).

SET Command: Amend CFS Parameters from a Screen Mask

SET A mask is displayed in which the most frequently used parameters can be amended for the current CFS session.

SET [%name | %? [,jrsave]]

The parameter values contained in the SET mask will be set to the values previouslt stored in the parameter set %name. The display of the SET mask will be suppressed.

%?: All relevant parameter sets will be displayed on screen in a list, from which one may be selected by marking it.

The mask displayed as a result of the SET command has the following format.


With a mouseclick you get a describtion of the screen item.

Notes:

All parameters can be set or reset using the individual commands as they appear in the SET mask (xxx/ yyy). If the individual commands are not to be set using the mask, they can be entered as parameters as they appear in upper case letters, e.g. "Display AGE/DATE" can be amended by entering AGE or DATE respectively. The commands to redefine the command memory and the escape symbol for connections are described under CRD (Connection Command Redefine) in Chapter 9, "Connection Handler (Sub-tasks under CFS)".

Not all parameters that may be amended in CFS have a field in the SET mask. These are generally system-specific parameters, and can only be amended using the CFS Modify command (M L'...',C'...'). For further information, see page 18-.

Setting user-specific parameters can be automated by entering the respective commands in a CFS Startup file.

Example for setting parameters in a Startup file:

*002 FILE=NO Switch to the command field in the next mask

UO EXTNT Define a default User Option

ALLOC Display the Allocated Space instead of Last Page

SO AGE,A Sort Option: sort the file list on ascending AGE

DUM Display Used Memory instead of the time

CP '&CON /' Connection Prompt: n / (n = Conn. Nr)

CRD -=§ Amend the command memory symbol used in Conns.

NP Return to the CFS Selection mask

For a full description of the automated Startup facilities of CFS, refer to Chapter 19 "Procedure Language", and Chapter 20 "Startup".

Show Item: Display Text for Event

SI [date] Show Item. All information currently stored for an event is displayed. A full description of the command can be found in Chapter 14, "Event Scheduling System".

Show Item List: Event List

SIL [date] [+|-] | [ {+|-} n] | search

Show Item List. The abbreviated information of all Events within a particular time frame is displayed. All the Events can be searched for a particular string within their descriptive text. Various actions, such as moving or deleting events, or setting alarms can be performed from the SIL mask.

A full description of the command can be found in Chapter 14, "Event Scheduling System".

Show Item Short: Overview of Events in the System Line

SIS [date] [+|-] | [ {+|-} n]

Show Item Short. The dates of all Events within the required time frame are displayed in the 25th line (system line). The SIS command is particularly useful in CFS startup procedures.

A full description of the SIS command can be found in Chapter 14, Event Scheduling System".

Save the Displayed File List

SL [mn] Save List. The current file list is saved to a file.

mn is a 1 to 8 letter mnemonic code. Entering RL mn - entered as a command (see above), or in the 'FILENAME-SELECT' field of the Selection mask - will display this saved file list again.

The name of the save file is #CFS.SAVELIST., with the mnemonic code given in the SL command being appended as a suffix. The fixed portion of the file name, #CFS.SAVELIST., can be redefined by the systems administrator.

It can be seen from the above that the file lists saved with the SL ... command are temporary files, and will be erased by BS2000 at the end of the process.

If the file lists saved with SL are to be used again after LOGOFF for some other purpose, then the system administrator should change the prefix from #CFS.SAVE LIST. to CFS.SAVELIST. during CFS installation.

If no mnemonic code is specified with the SL command, then the Job name of the user process is used. If there is no Job name, then the TSN is used as the default. The same is true for the RL command (Restore List).

The SL command has the identical function to the DOCUMENTATION field in the CFS Selection mask. Some additional options can be specified in the DOCUMENTATION field.

Save Command Memory

SM [file | [lib] ([t/] element) ]

Save Memory. The contents of the CFS-internal Command Memory (FILENAME-SELECT and USER-ID field entries, command entries, Connection entries) are saved to a file, or to a PLAM library element.

file Name of the file to which the Command Memory contents should be saved.

lib ([t/] element)  Name of the library and the element to which the Command Memory contents should be saved. If no element type is specified, then the standard, S (Source) will be assumed.

([t/] element)  If the library name is not specified, then the name of the CFS userlib will be assumed. For a full description of the userlib, see Chapter 21.

If no file or element name is specified with the SM command, then the standard name of CFS.MEM.STD.jobname will be used, or CFS.MEM.STD.acct if no jobname was given at the LOGON.

Format of the SM File:

The Command Memory consists of 2 to 12 different sections:

1) Entries in the FILENAME-SELECT field of the Selection mask.

2) Entries in the Command field of the second CFS mask (File list).

3) Entries for Connection 0.

.........

12) Entries for Connection 9.

Each section of the Command Memory has a header record in the SM file consisting of one of the following types : "$FILENAME-SELECT:", "$COMMAND:", "$CON0:", ..., "$CON9:". Each entry will then be stored in the SM file as an individual record.

See also the commands AMC (Automatic Memory Compression) on page 18-, SM (Save Memory) on page 7-, as well as the pages 4-, 7-, 9-.

Define Standard Sort Option for File Lists

SO  { AGE | NAME [(o,l)] | SIZE | USER | NONE } [, A | D ]

The file list is normally sorted in ascending order on name (Standard sort criterion). Using the SO command, the user can define another field as the primary sort key, as well as the order (ascending/descending). Identical primary keys will then automatically be sorted in ascending name order. The SO command will enter a value in the SORT OPTION field of the Selection mask. Entering another value in the SORT OPTION field (see page 4-) will have a temporary effect, and will not affect the standard sort criterion set by SO. For additional information on sorting the file list, see also the SORT command on page 7-.

AGE The file list will be sorted according to the value in the AGE or DATE column. For PLAM libraries, the time of the last amendment (TIME) will be taken into account for the sort.

NAME [(o,l)] The file list will be sorted according to the full file or element name (Standard). The (o,l) option can be used to sort on a portion of the name. o represents the offset, and l the portion length. Standard: NAME(1,44).

Example: By using the Sort Option NAME(3,40), a list of PLAM library elements can be sorted whereby the elements with the same name but different types follow one another.

SIZE The file list will be sorted on the first column (LASTP or ALLOC for files, SPACE for libraries).

USER If a USER OPTION was specified during file selection, then entering USER as a Sort Option will result in the list being sorted on this characteristic. If no USER OPTION was specified, this Sort Option will not have any effect.

NONE The file or element list will be displayed unsorted.

A Ascending sort order (Standard).

D Descending sort order.

SO? The current Sort Option will be displayed.

Sort File List

SORT [sort-opt] The current file list is resorted. No new selection takes place. If no sort options are specified, then the list is resorted according to the criteria last specified. The same options may be given for sort-opt as for those that may be entered in the SORT-OPTION field of the Selection mask (see page 4-) or in the SO command (see page 18-).

sort-opt (o,l) | AGE | NAME [(o,l)] | SIZE | USER | NONE [, A | D ]

(o,l) Sort according to an absolute column number (o = Offset, l = Length).

The offset is the column number which appears at the top of the file list after issuing an SC command.

Specifying (8,1) for example, will cause the list to be sorted according to the data object type.

NAME [(o,l)] The file list is sorted according to the full file or element name (Standard). Specifying optional parameters (o,l), the names can be sorted on a portion of the file or element name. o specifies the offset, and l the length of the partial field. Standard: NAME(1,44).

Example: With PLAM libraries, specifying Sort Option NAME(3,40) will result in a sorted list whereby elements are sorted by name and then by type.

AGE The file list is sorted according to AGE, or DATE. The time of the last amendment of PLAM library elements is taken into account when sorting.

SIZE The file list is sorted on the contents of the first column (LASTP or ALLOC for files, SPACE for libraries).

USER If a USER OPTION is also specified when selecting files, the sorting is done on the value in the column specified in this option. If no USER OPTION is specified, this sort option has no effect.

NONE The file/element list is displayed unsorted.

A Ascending sort order (Standard).

D Descending sort order.

Note

When a sort option is explicitly specified, then the sort takes place over the entire file list, even if the list has been created incrementally by successive AL commands. In the standard case, the area to be sorted is restricted to an NP/AL command.

Examples:

SORT AGE

The current file or element list is sorted in ascending order according to the age of the data objects.

SORT SIZE,D

The current file list is sorted in descending order according to the LASTP entry.

Save Parameter Set

SP [COMP | FT | GUARD | SET] %name [, jrfile]

A parameter set will be saved, consisting of the selection criteria last specified, and the parameters last used for the File Transfer, Compare or SET commands.

COMP | FT | GUARD | SET

The parameters last used for the COMP/FT/GUARD/SET commands will be saved. For FT commands this includes the FTEP parameters.

Standard: Only the selection criteria are saved.

%name Name of the Parameter set under which the parameters should be saved.

jrfile Name of the JRSAVE file to which the parameter set should be saved.

Standard: CFS.JRSAVE. ... For further information, see page 27-.

Display all Processes started under the Job Report System

STAJ [jr-id] Status Job Report.

Display the status of all Enter jobs started with an E command.

For a full description of the STAJ, E, and all other Job Report commands (JR/ JRID/ JRF/ JRIC/ JRP/ JREP/ JRSH), see Chaper 11, "CFS Job Report System".

Set Window Size for Terminal Emulation

SWS nn BS2000 terminal emulation programs under Windows are not restricted to the 24*80 display of a 9750 terminal. This command allows the size of the screen to be modified, particularly to increase the number of lines displayed. An increased number of lines is particularly useful, for instance, when displaying large file lists in CFS, or in Display mode.

A prerequisite for this is that the emulation program must be running under the TCP-IP protocol. Current TCP-IP products include those from MPS and Intrasys.

If the SWS mode is not supported by an emulation package, an error message will be displayed when attempting to enable the SWS mode.

nn Number between 16 and 60. This value determines the number of lines which the terminal emulation will display in a screen.

NSWS The default window size of 24*80 will be reinstated.

Notes:

If SWS > 46, occasionally it can happen that the bottom portion of the screen will be truncated. In this case, the screen cannot be compressed to less than 4096 bytes (CSO function: Compress Screen Output).

If SWS is given a value greater than 46 from an active CFS Connection, the Hardcopy mode (HC command) cannot be used.

PLAM Library: Determine Age from the "User Date" Directory Field

UDAT PLAM Libraries: The Age indicator in an element list will be determined from the User Date. Standard: UDAT.

Notes:

When reorganising PLAM libraries, the Creation Date of all elements will be set to the current date (AGE=0). The User Date of the elements will not be affected by the reorganisation. To maintain relevant age indicators even during library reorganisation, use the UDAT mode.

When adding a file as an element to a PLAM library, CFS will set the element User Date to the file creation date. This can result in newly-created elements appearing in the file list (in UDAT mode) with an AGE > 0. The time column (time of the last amendment) will be set to 00:00, since TSOSCAT maintains only a creation date, and not the time.

Assign another Library as Userlib

UL library The specified library will be used with immediate effect as the CFS userlib. Information regarding the current userlib can be had from the SET mask; assigning a new library can also be done from here.

Standard: CFS.USERLIB (own userid)

For further information about the CFS userlib, see Chapter 21 "Userlib".

Define Standard User Options for the Selection Mask

UO [u-opt-1] [; [u-opt-2]] [; [u-opt-3]] [; [u-opt-4]]

The specified User Option(s) will be used with immediate effect as the default values for the CFS Selection mask. Information about the current default User Options can be obtained from the SET mask; assigning different options can also be done from this mask. Standard: no default User Option.

Notes:

User Options result in one or more freely selectable file characteristics being displayed in the file list, in addition to the standard CFS values. The user can enter a condition to select files on the basis of these characteristics. Multiple User Options should be separated by semicolons. A maximum of four User Options can be specified.

Entering the UO command without operands will reset the last Standard User Options to have been defined.

The UO command may not be chained with other commands.

The value for the first User Option to have been specified will be displayed in the special User Option column. Second, third or fourth User Options will overwrite the PASS, AGE and LASTP (SPACE) columns, respectively.

Two successive semicolons, ";;" , will result in that respective column not being overwritten with a User Option. See the last example on this page.

A User Option defined with UO will first be operable after the next selection. To activate a new User Option for the current file list, use the NP* command. NP* will not display the new User Option if the current selection already contains another User option.

Examples:

ALLO2;ALCNT;EXTNT;ALLOC

The User Option column will display the secondary space allocation (ALLO2). The PASS column will contain the number of utilised secondary allocations, the AGE column will contain the number of extents (EXTNT), and the LASTP column will contain the allocated disk space (ALLOC).

ALCNT;EXTNT;;ALLOC

The User Option column will contain the number of utilsed secondary allocations (ALCNT), and the PASS column will contain the number of extents (EXTNT). The AGE column will not be overwritten (;;). The LASTP column will contain the allocated disk space (ALLOC).

Define Standard User-ID for Selection

UID [ :x: | :*: | user-id | :x: user-id | :*: user-id ]

The specified userid will be used with immediate effect as the default value in the Selection mask. Information about the current standard userid can be obtained from the SET mask; assigning another userid can also be done from here.

user-id Select files from the specified userid on the default Pubset. The userid should be entered without the $ and following fullstop.

Standard: no default userid.

Notes:

Entering the UID command without operands will reset the last Standard Userid to have been defined.

A userid defined with UID will only become operable at the next selection.

Display/Set the VARIABLE ACTION Field in the Selection Mask

VAR Display the VARIABLE ACTION field in the Selection mask.

The user has two lines in which to enter the required Variable Action.

Display Disk Utilisation of a File

VSNSP file [, A] [, FILE=listfile] [, E]

The disk space used on individual volumes is displayed for the specified file.

A All. The disk space occupied by each individual extent of the file will be displayed

FILE=listfile [, E]

The output will not be to the screen, but to the specified file.

The parameter E (Extend) will cause an existing will to be extended.

Put CFS into a Wait condition

WAIT CFS is placed in a Wait condition. This Wait condition can be interrupted at any time by pressing K2 or any other data transfer key.

The Wait state of CFS is interruptable by asynchronous events. These may be the termination of an Enter job started by an E command (Job Report), or by messages destined for a subtask (connection) running in the background that need to be buffered by CFS.

Notes:

The WAIT command can be useful if subtasks (connections) running in the background produce sporadic output. If the user makes no input for a long time in either the basic task or in a subtask, the connection can be lost, since the messages cannot be processed by CFS in time. To preempt this situation, it is recommended that CFS be placed in the Wait state before any lengthy gap in input activity: enter WAIT in the command field of the basic task, or enter ^WAIT from any of the connections.

The Wait command is also useful if one or more connections are functioning in asynchronous mode (command ACn); for example, subconsoles (OCn $CONSOLE). Whilst in the Wait state, the messages from all asynchronous subtasks are displayed on the screen at the time at which they are received.

Display Hidden File List Entries

YANK All entries that were hidden by means of the Action Code "-" are restored to the file list.

Following the successful execution of the Action Code E, the names of those files that were erased will not appear in the current list. The YANK command can determine after the event which files were erased from the current list. If the ERT option (Erase with Retain of Tempfiles) is set, these files can also be retrieved. For more information, see page 18-.

Files are also removed from the list by CFS setting the "-" Action Code internally when they have been successfully processed by a Variable Action ON&... , and if the task switch 14 has been set (/SETSW ON=14). For further information, see page 5-. YANK can display these successfully processed files in the file list again.