FileManager ZOS
FileManager ZOS
SC19-3674-00
Note
Before using this document, read the general information under Notices on page 1201.
Contents v
Data in Virtual (option 5.8) . . . . . . . . . 375 Choosing the right function to enhance. . . . 400
Creating and supplying a procedure. . . . . . 401
Chapter 10. OAM Functions . . . . . 377 Procedure statement types . . . . . . . . 401
Introducing the Object Access Method . . . . . 377 Choosing between FASTREXX, REXX, and
Object Directory List (option 6.1) . . . . . . . 377 DFSORT for your procedure . . . . . . . 402
Object Browse (option 6.2) . . . . . . . . . 379 Coding DFSORT procedure statements . . . . 403
Object Print (option 6.3) . . . . . . . . . . 379 Coding REXX procedure statements . . . . . 405
Controlling print output . . . . . . . . . 379 Coding end of file procedure . . . . . . . 409
Object Update (option 6.4) . . . . . . . . . 380 Combining DFSORT and REXX statements in a
Object Erase (option 6.5). . . . . . . . . . 380 procedure . . . . . . . . . . . . . 410
Object Copy Functions (option 6.6) . . . . . . 380 Supplying a procedure to enhance File Manager
Backing up OAM objects . . . . . . . . . 380 processing . . . . . . . . . . . . . 411
Object to VSAM (option 6.6.1) . . . . . . . 381 How enhanced processing works . . . . . . . 413
Object to Sequential Data (option 6.6.2) . . . . 381 How REXX-enhanced processing works . . . 413
VSAM to Object (6.6.3) . . . . . . . . . 381 How DFSORT-enhanced processing works . . 414
Sequential Data to Object (option 6.6.4) . . . . 381 Enhanced processing modes . . . . . . . 414
Object to Object (option 6.6.5) . . . . . . . 381 Using templates with enhanced processing . . 417
Backing up a single OAM object . . . . . . 381 Working with an entire data set (DSEB only) or
Backing up multiple OAM objects . . . . . 381 per record . . . . . . . . . . . . . 417
Restoring OAM objects . . . . . . . . . . 382 Dropping a record from further processing . . 417
Restoring an object that was backed up Performance tips . . . . . . . . . . . 417
individually . . . . . . . . . . . . . 382 REXX and DFSORT Examples . . . . . . . . 418
Restoring one or more objects from a Printing data . . . . . . . . . . . . 418
multiple-object backup . . . . . . . . . 382 Copying data . . . . . . . . . . . . 419
Updating records in a data set. . . . . . . 420
Editing a data set . . . . . . . . . . . 420
Chapter 11. Using UNIX System
Examples of tasks that can be performed easily
Services and the Hierarchical File using FASTREXX . . . . . . . . . . . . 420
System . . . . . . . . . . . . . . 385 Record Editing . . . . . . . . . . . . 421
Specifying an HFS file . . . . . . . . . . 385 Writing one or more optionally edited records to
Using directories . . . . . . . . . . . . 386 one or more output files, depending on data in
Selecting files for processing . . . . . . . . 386 the input record . . . . . . . . . . . 421
Logical record length . . . . . . . . . . . 387 Determining whether to copy or print a member
Processing an HFS file . . . . . . . . . . 387 based on some condition inside the member . . 422
Viewing and editing HFS files . . . . . . . . 387 Relative positioning support . . . . . . . 422
Creating HFS files . . . . . . . . . . . . 388
Copying HFS files . . . . . . . . . . . . 388
Comparing HFS files . . . . . . . . . . . 389
Part 2. File Manager Reference 425
Printing HFS files . . . . . . . . . . . . 389
Finding a string in HFS files . . . . . . . . 390 Chapter 14. Panels and fields . . . . 429
Summary of File Manager panels. . . . . . . 429
Chapter 12. Introduction to Access Hierarchical File System panel . . . . . 433
Advanced Member Selection panel . . . . . . 433
programming with File Manager
AFP Print Browse panel . . . . . . . . . . 436
functions . . . . . . . . . . . . . 391 AFP Print Browse output . . . . . . . . . 438
Summary of File Manager functions . . . . . . 391 AIX Association Information panel . . . . . . 440
Using File Manager functions in REXX procedures AIX Entry Detail panel . . . . . . . . . . 441
or TSO clists. . . . . . . . . . . . . . 393 Allocate panel . . . . . . . . . . . . . 442
Invoking File Manager panels from REXX Allocate (Two) panel . . . . . . . . . . . 445
procedures or TSO clists. . . . . . . . . 394 Allocate (Three) panel . . . . . . . . . . 447
Invoking File Manager functions from a REXX Append panel . . . . . . . . . . . . . 449
procedure or CLIST in /BATCH mode . . . . 395 Browse panel . . . . . . . . . . . . . 450
Using File Manager functions in batch jobs . . . 395 Browse Entry panel . . . . . . . . . . . 454
Setting processing options in batch . . . . . 396 Catalog Services panel . . . . . . . . . . 459
Destination of File Manager print output . . . . 396 Catalog Services Data Set List panel . . . . . . 461
Handling errors . . . . . . . . . . . . 397 Clipboard Manager panel . . . . . . . . . 464
Compiler Language Selection panel . . . . . . 465
Chapter 13. Enhancing File Manager Compare Utility: Old and New panels . . . 466
processing . . . . . . . . . . . . 399 Compare Utility: Load module options panel . . . 470
Why enhance File Manager processing? . . . . 399 Compare Utility: Options panel . . . . . . . 474
The tasks you can enhance . . . . . . . . . 399 Compare Utility: Output Data Sets . . . . . . 484
Contents vii
WebSphere MQ Queue List panel . . . . . . 728 RBALEN primary command . . . . . . . . 797
Write Tape Mark panel . . . . . . . . . . 729 RCHANGE primary command . . . . . . . 798
RD primary command . . . . . . . . . . 798
Chapter 15. Primary commands . . . 731 RDF primary command . . . . . . . . . . 800
ABOUT primary command . . . . . . . . . 731 RECLEN primary command . . . . . . . . 800
AMSMSG primary command . . . . . . . . 731 RECOVER primary command . . . . . . . . 801
APPEND, APPENDX primary commands . . . . 732 RECSTATS primary command . . . . . . . . 801
ASSOCS primary command . . . . . . . . 733 REFRESH primary command . . . . . . . . 802
AUTORTRY primary command . . . . . . . 733 REFS primary command . . . . . . . . . 803
AUTOSAVE primary command . . . . . . . 734 REPLACE, REPLACEX primary commands . . . 803
BOTTOM primary command . . . . . . . . 735 RESET primary command . . . . . . . . . 804
BOUNDS primary command . . . . . . . . 735 RF primary command . . . . . . . . . . 806
CANCEL primary command . . . . . . . . 736 RFIND primary command . . . . . . . . . 807
CAPS primary command . . . . . . . . . 737 RIGHT primary command . . . . . . . . . 808
CASE primary command . . . . . . . . . 738 RP primary command . . . . . . . . . . 809
CE (Change Error) primary command . . . . . 738 RUNTEMP primary command . . . . . . . 810
CEDIT primary command . . . . . . . . . 740 SAVE primary command . . . . . . . . . 811
CHANGE/CX primary command . . . . . . 741 SAVEAS primary command (templates) . . . . 811
CHGASAVE primary command . . . . . . . 747 SAVEAS, SAVEASX primary commands (data) . . 812
COPY primary command . . . . . . . . . 748 SELECT primary command. . . . . . . . . 813
CUT primary command . . . . . . . . . . 750 SHADOW primary command . . . . . . . . 814
CREATE, CREATEX primary commands . . . . 751 SHOW primary command . . . . . . . . . 815
DEDIT primary command . . . . . . . . . 752 SHOWCOB primary command . . . . . . . 816
DELETE primary command . . . . . . . . 752 SLOC primary command . . . . . . . . . 817
DESCRIBE primary command . . . . . . . . 754 SORT primary command . . . . . . . . . 817
DOWN primary command . . . . . . . . . 754 SPLT primary command. . . . . . . . . . 820
DX primary command . . . . . . . . . . 755 SPLTJOIN primary command . . . . . . . . 820
EDIT primary command. . . . . . . . . . 755 STR primary command . . . . . . . . . . 821
END primary command . . . . . . . . . . 756 STATS primary command . . . . . . . . . 821
EXCLUDE/XX primary command . . . . . . 756 SV primary command . . . . . . . . . . 822
EXIT primary command . . . . . . . . . . 760 TAILOR primary command . . . . . . . . 822
EXPAND primary command . . . . . . . . 760 TEDIT primary command . . . . . . . . . 823
EXTENT primary command . . . . . . . . 761 TOP primary command . . . . . . . . . . 824
FE (Find Error) primary command . . . . . . 761 TPRINT primary command. . . . . . . . . 825
FKEY primary command . . . . . . . . . 763 TVIEW primary command . . . . . . . . . 825
FILE primary command . . . . . . . . . . 763 TYPE primary command . . . . . . . . . 826
FIND/FX primary command . . . . . . . . 764 UP primary command . . . . . . . . . . 826
FINDNOT primary command . . . . . . . . 773 UPDATE primary command . . . . . . . . 827
FORMAT primary command . . . . . . . . 775 VCONTEXT primary command . . . . . . . 827
HEX primary command . . . . . . . . . . 776 VER primary command . . . . . . . . . . 828
INFO primary command . . . . . . . . . 777 VIEW primary command . . . . . . . . . 829
JOIN primary command. . . . . . . . . . 777 VOLUME primary command . . . . . . . . 829
JUST primary command . . . . . . . . . . 778 XD primary command . . . . . . . . . . 829
KEY primary command . . . . . . . . . . 779 ZOOM primary command . . . . . . . . . 830
LEFT primary command . . . . . . . . . 779
LIBLIST primary command. . . . . . . . . 781 Chapter 16. Functions. . . . . . . . 831
LIST primary command . . . . . . . . . . 781 How to use this reference chapter . . . . . . 831
LISTVIEW primary command . . . . . . . . 782 How to read the syntax diagrams . . . . . . 831
LOCATE primary command . . . . . . . . 782 General tips about performance when you use File
NEXT primary command . . . . . . . . . 789 Manager functions . . . . . . . . . . . 833
NEXTREC primary command . . . . . . . . 790 File Manager functions . . . . . . . . . . 834
NRETRIEV primary command . . . . . . . 791 AUD (Print Audit Trail Report) . . . . . . 834
OFFSET primary command. . . . . . . . . 791 BSF (Backward Space File) . . . . . . . . 837
PACK primary command . . . . . . . . . 793 BSR (Backward Space Record) . . . . . . . 838
PASTE primary command . . . . . . . . . 793 BT (Create Tape File) . . . . . . . . . . 839
PIC primary command . . . . . . . . . . 794 BTB (Batch Template Build) . . . . . . . 841
PREFIX primary command . . . . . . . . . 795 BTU (Batch Template Update) . . . . . . . 849
PREVIOUS primary command . . . . . . . 795 CLM (Compare Load Module) . . . . . . 858
PREVREC primary command . . . . . . . . 796 DP (Disk Print) . . . . . . . . . . . . 866
PROFILE primary command . . . . . . . . 797 DRS (Disk Record Scan) . . . . . . . . . 868
QUIT primary command . . . . . . . . . 797 DSB (Data Set Browse) . . . . . . . . . 871
Contents ix
Support resources and problem Programming interface information . . . . . 1203
solving information . . . . . . . . 1195 Trademarks . . . . . . . . . . . . . 1203
Searching IBM support Web sites for a solution 1195
Searching the information center . . . . . 1195 Bibliography . . . . . . . . . . . 1205
Searching product support documents. . . . 1195 File Manager publications . . . . . . . . . 1205
IBM Support Assistant . . . . . . . . . 1196 Related publications for Problem Determination
Obtaining fixes . . . . . . . . . . . . 1196 Tools . . . . . . . . . . . . . . . . 1205
Receiving support updates through e-mail Related publications for COBOL. . . . . . . 1205
notification . . . . . . . . . . . . . . 1197 Related publications for PL/I. . . . . . . . 1205
Receiving support updates through RSS feeds 1198 Related publications for z/OS . . . . . . . 1205
If you need to contact IBM Software Support . . 1198 Softcopy publications . . . . . . . . . . 1205
Determining the business impact . . . . . 1199
Describing problems and gathering information 1199 Glossary . . . . . . . . . . . . . 1207
Submitting problems . . . . . . . . . 1200
Index . . . . . . . . . . . . . . 1211
Notices . . . . . . . . . . . . . 1201
File Manager for z/OS contains four flavors of File Manager, for working in
different environments or with different data formats:
v File Manager base component (described in this document), for working with
QSAM data sets, VSAM data sets, IAM data sets, PDS members, Websphere MQ
queues, CICS resource, or HFS files as an ISPF application or by means of the
File Manager Plug-in for Eclipse.
v File Manager DB2 component, for working with DB2 data sets
v File Manager IMS component, for working with IMSdata sets
v FM/CICS for working with CICS resources.
This document describes the File Manager Base component. For information about
the DB2, IMS, and CICS components, see these documents:
v File Manager Users Guide and Reference for DB2 Data, SC19-3675
v File Manager Users Guide and Reference for IMS Data, SC19-3676
v File Manager Users Guide and Reference for CICS, SC19-3677
In the rest of this document, the term "File Manager" refers only to the File
Manager Base component, not to the DB2, IMS, or CICS components.
This document assumes that you are familiar with using ISPF.
To use File Manager functions in batch jobs, you must already be familiar with
JCL.
To use File Manager functions in REXX procedures, you must already be familiar
with the REXX programming language.
For information about related products, see the Bibliography on page 1205.
The LookAt Web site also features a mobile edition of LookAt for devices such as
Pocket PCs, Palm OS, or Linux-based handhelds. So, if you have a handheld
device with wireless access and an Internet browser, you can now access LookAt
message information from almost anywhere.
To use LookAt as a TSO/E command, you must have LookAt installed on your
host system. You can obtain the LookAt code for TSO/E from a disk on your z/OS
Collection (SK3T-4269) or from the LookAt Web site's Download link.
Figure 1 on page xiv shows a sample syntax diagram that includes the various
notations used to indicate such things as whether:
v An item is a keyword or a variable.
v An item is required or optional.
v A choice is available.
v A default applies if you do not specify a value.
v You can repeat an item.
KEYWORD=default_choice
COMMAND_NAME required_variable
OPTIONAL_KEYWORD=variable KEYWORD= choice2
choice3
repeatable_item1 required_choice1
fragment_name optional_choice1 required_choice2
optional_choice2 required_choice3
,
DEFAULT_KEYWORD
repeatable_item2
KEYword
fragment_name:
( variable4 - variable5 )
OPTIONAL_KEYWORD1
OPTIONAL_KEYWORD2
OPTIONAL_KEYWORD3
Here are some tips for reading and understanding syntax diagrams:
Order of
reading Read the syntax diagrams from left to right, from top to bottom,
following the path of the line.
The symbol indicates the beginning of a statement.
The symbol indicates that a statement is continued on the
next line.
The symbol indicates that a statement is continued from the
previous line.
The symbol indicates the end of a statement.
Keywords Keywords appear in uppercase letters.
COMMAND_NAME
DEFAULT_KEYWORD
KEYword
required_variable
Required
items Required items appear on the horizontal line (the main path).
COMMAND_NAME required_variable
Optional
items Optional items appear below the main path.
OPTIONAL_KEYWORD=variable
Choice of
items If you can choose from two or more items, they appear vertically,
in a stack.
If you must choose one of the items, one item of the stack appears
on the main path.
required_choice1
required_choice2
required_choice3
optional_choice1
optional_choice2
DEFAULT_KEYWORD
KEYWORD1
KEYWORD2
repeatable_item1
repeatable_item2
fragment_name
.
.
.
fragment_name:
DEFAULT_KEYWORD
...
KEYWORD1
KEYWORD2
IBM or any other organizations will only use the personal information that you
supply to contact you about the issues that you submit.
This chapter provides an overview of the types of actions you can perform with
File Manager, a list of the types of data sets upon which you can perform these
actions and some concept information about templates, one of the main tools used
to view and edit data sets in File Manager.
For many of these tasks, you can use File Manager templates. A template provides a
logical view of a data set, based upon field definitions in a copybook, or else
created dynamically. If you use a template, you can:
v Format data according to record structures defined in the copybooks, or
dynamically define your own record structure
v Select the fields and records that you want to work with, adjust how fields are
displayed, select fields for copying, and set the contents of fields for created data
v Code record identification and selection criteria within File Manager panels, or
use File Manager's REXX interface to code complex criteria
v Copy data between fields of different data type and length; and
v Work with files containing multiple record structures
File Manager also provides utilities that allow you to manipulate data in other
ways:
v With the Tape Utility you can:
Copy tape files, optionally changing the block size and record format
Copy a logical volume from an Exported Stacked Volume to a physical tape
volume
Update tape records on-screen, while copying the records from one tape to
another
Compare two tapes byte-by-byte
Bypass tape blocks with data-check errors
Summarize the contents of a tape
v With the Disk Utility, you can look at and edit a file, based on the contents of
the data at each physical disk location. There is support for character and
hexadecimal format. Because the access is done at the level of the physical track,
all file types are supported, including BDAM. With the disk utilities, you can:
List data sets on a disk
Edit data on a specific track
Identify the disk extents of a data set
Search for data within a disk extent
v You can use the Object Access Method (OAM) Utility to list, view, print, update,
erase, copy, back up and restore OAM objects.
v The IDCAMS front end (Catalog Services) allows you to control the OS/390
IDCAMS utility from user-friendly File Manager panels.
You can view and edit or otherwise process these types of data:
v Sequential (PS) and partitioned (PDS or PDSE) data sets: A member of a
partitioned data set or a sequential data set, or like or unlike concatenations
thereof (when used as input), with any of these data set attributes:
PS data set type
- Basic
- Library
- Extended
- Large
- Compressed
Record format
- Fixed, variable, or undefined
- Blocked or unblocked
- Spanned
- ISPF packed format data
Record length
- For fixed-length data: 132760, 10-65535 (for tape using LBI)
- For variable-length data: 132752, 14-65531 (for tape using LBI)
- For spanned variable-length data: 116MB
v VSAM data sets:
ESDS, including spanned format
KSDS, including spanned format
RRDS (fixed-length or variable-length)
PATH (PATHs related to a non-unique alternate index are restricted to browse
only)
AIX
v HFS files: A file contained in the z/OS UNIX File System, including z/FS and
HFS:
Record format
Note: Throughout this publication, where the term data set is used, it generally
refers to any of the above resource types, rather than referring specifically to
traditional z/OS data sets, unless otherwise mentioned.
File Manager Version 12 is able to use copybooks that are stored in a PDS, a PDSE,
a CA-Panvalet library, or a library accessed using the Library Management System
Exit.
Templates
A File Manager template is a file that provides a particular interpretation of a data
set. The template defines a logical view that you can use to view and manipulate
the data in records as discrete fields. With a template, you can select and format
records and fields when editing, viewing, copying, printing and creating data sets.
Templates can be based upon a COBOL, HLASM, OR PL/Icopybook or can be
created dynamically. You can apply different templates to the same data, to achieve
different purposes. For example, you might create a number of templates with
different selection criteria in place, and then apply the template that defines the
subset of records that you need for a particular purpose. Also, you can apply the
same template to different data sets, provided that they have similar record and
field structures.
The File Manager Base, DB2 and IMS components all use templates. However,
these templates are not interchangeable between the components. You cannot, for
example, use a base template in the File Manager DB2 component. Dynamic
templates are only available within the Base component.
To work efficiently with these data sets, you need tools that recognize record
structure, allowing you to selectively process individual fields.
For example, if you use a text editor (such as the ISPF editor) to display an
application data set, then each record appears as a string of characters, with no
indication that the records consist of individual fields. Fields containing numeric
Even if you know the column boundaries of each field, editing an application data
set in a text editor can be difficult and tedious:
v If you want to find and replace data in a specific field, then you have to be
careful not to change the field length; otherwise, you could move the boundaries
of subsequent fields, and corrupt the record structure.
v If you want to find and replace data in numeric fields where the data has been
encoded in binary or packed decimal format, then you have to specify the find
and replace values in that format (typically, as hexadecimal values), rather than
as numeric values.
v If the file you are editing contains several record types (each with its own
structure), and you only want to find and replace data in one record type, then
you have to exclude other record types from editing.
To illustrate, here are some records containing a mixture of alphanumeric and numeric fields
displayed in the ISPF editor:
EDIT USERID.FMDATA(DATA2) - 00.02 Columns 00001 00072
000013 01Grant Smith
000014 01Andrew Apple 5 &
000015 01Graham Prestcott
The Grant Smith record contains the numeric value 94, stored in a binary
numeric field. To change this from 94 to 48, without using a template, you would
need to:
1. Display the hexadecimal values of the record data.
2. Determine the column positions occupied by the field.
3. Convert the numeric value 48 into its hexadecimal equivalent (X'30').
4. Overtype the old hexadecimal value of the numeric field (X'5E') with the new
value, or use a CHANGE command with the old and new hexadecimal values.
Here is the same record displayed in the File Manager editor using a template:
REC-TYPE NAME EMPLOYEE-NO AGE SALARY MONTH(1) MONTH(2)
#2 #3 #4 #5 #6 #7 #7
AN 1:2 AN 3:20 BI 23:2 BI 25:2 PD 27:4 BI 31:4 BI 35:4
<> <---+----1----+----> <---+-> <---+-> <---+--> <---+---> <---+--->
01 Grant Smith 7712 94 75000 6 15
To change the value of the AGE binary numeric field from 94 to 48, you can
simply overtype 94 with 48, or enter the following command (where #5 is the
field reference for the AGE field):
CHANGE 94 48 #5
Another situation in which you might want to use a template is when you are
copying data. When you use a copy utility that does not recognize record
structure, you are often limited to copying an entire data set, or a number of
records. If you want to copy only records with particular field values, or only
particular fields, then you must write a custom program.
When using templates with File Manager, you can specify criteria to select only the
records you want to copy, and to select the fields you want from the list of fields
in the record.
Notes:
1. For the DSEB and DSU functions, the template is not used during editing or updating; it
is only used during enhanced batch processing, when you call the File Manager REXX
external function PRINT with SNGL or TABL format.
The difference between using DSU to update data compared to using DSEB to edit data is:
v DSU operates on a per record basis. That is, each record in a data set is treated
separately, in sequence.
v DSEB allows you to move between the records in a data set as you choose, similar to
the way you can scroll around a data set in an edit panel.
For details on using the DSEB and DSU functions, see Chapter 13, Enhancing File
Manager processing, on page 399.
With any of these panels or functions, you can supply an existing template (created
dynamically or from a copybook), supply a copybook, or create a new dynamic
template. If you supply a copybook, then File Manager compiles it into a template
before use.
How you start File Manager in ISPF depends on how it has been installed on your
system. Typically, File Manager is installed as an option on your z/OS Primary
Option Menu:
Figure 2. z/OS Primary Option Menu panel showing File Manager option
Note: If File Manager is not an option on your menu, ask your system
administrator to explain the startup process used at your site.
When you start File Manager, the File Manager Primary Option Menu is
shown, with the current version information displayed in a pop-up message
box.
IBM* File Manager for z/OS Version 11 Release 1
Licensed Materials - Property of IBM
5655-W47
(C) Copyright IBM Corporation 1986, 2010 - All Rights Reserved.
* Trademark of International Business Machines
Command ===>
F1=Help F2=Split F3=Exit F4=CRetriev F7=Backward F8=Forward
F9=Swap F10=Actions F12=Cancel
Figure 3. File Manager Primary Option Menu panel with version information
RELATED TOPICS
Primary Option Menu panel on page 611
As File Manager is an ISPF application and ISPF applications are typically not
capable of running in an authorized state, File Manager will not (unless specific
ISPF customization has occurred) be authorized under ISPF. However, File
Manager may run in an authorized state when used in a batch job.
IBM File Manager for z/OS Version x Release x
(not APF authorized)
Service Levels of installed components
Base IMS DB2 CICS
English xxxxxxx xxxxxxx xxxxxxx xxxxxxx
Japanese xxxxxxx xxxxxxx xxxxxxx xxxxxxx
Korean xxxxxxx xxxxxxx xxxxxxx xxxxxxx
F1=Help F2=Split F3=Exit F9=Swap F12=Cancel
Figure 4. File Manager Primary Option Menu panel with example PTF information
RELATED TOPICS
VER primary command on page 828
ABOUT primary command on page 731
VER (Display Service Level) on page 1094
To display details about the current COBOL compiler, enter SHOWCOB on the
Command line of any panel. File Manager displays details about the current
COBOL compiler in a window.
RELATED TOPICS
SHOWCOB primary command on page 816
RELATED TOPICS
END primary command on page 756
EXIT primary command on page 760
Syntax
FILEMGR function_name
(1)
data_set_name
Notes:
1 The data_set_name parameter is only allowed for:
v The DSV function, to invoke View (option 1)
v The DSE function, to invoke Edit (option 2)
For example, from any ISPF Command line, you can enter the following command
to display the File Manager Print Utility (option 3.2) panel:
FILEMGR DSP
If you specify a valid data set name after DSV (Data Set View) or DSE (Data Set
Edit), File Manager:
v Bypasses the entry panel (where you would normally specify the data set name
and other options, such as the name of a stored template you might wish to use
when displaying the data set).
v Goes directly to viewing or editing the specified data set.
RELATED TOPICS
Using File Manager functions in batch jobs on page 395
Summary of File Manager panels on page 429
Chapter 16, Functions, on page 831
DSB (Data Set Browse) on page 871
DSE (Data Set Edit) on page 903
When you know the menu structure well, you can quickly jump to the required
panel by entering the full pathway through the menu options. For example,
entering 4.2.8 would take you directly to the Exported Stacked Volume Copy
panel.
You can also jump to any File Manager panel from any other panel, without
having to navigate the menu structure, by using an equals sign (=) to prefix the
option number. The equals sign instructs File Manager to start the menu
navigation from the Primary Options menu and not from your current location.
For example, if you were positioned on the Set Processing Options Menu panel,
entering 2 on the Command line would display the Set System Processing Options
panel (option 2 on the current menu), while entering =2 would display the Edit
Entry panel (option 2 on the Primary Options Menu panel).
v Type the menu option number on the Command line and press Enter. Repeat for
each nested menu until the required processing panel is displayed.
v Type an equals sign followed by the complete menu path to the required panel,
separating each menu level with a period, then press Enter.
Many File Manager panels have more information than can be seen in a single
screen, particularly when you are running in 80x24 display. When this happens, a
message is displayed in the top right corner of the panel.
To scroll back to the top of the panel, choose one of these methods:
v Press the Backward function key (F7) (this scrolls up by your default scroll
amount, usually one screen at a time)
v Enter BACKWARD or UP on the Command line (these commands scroll up by
your default scroll amount, usually one screen at a time)
v Enter TOP on the Command line (this takes you to the beginning of the panel)
RELATED TOPICS
Primary Option Menu panel on page 611
Scrolling to see data on page 80
UP primary command on page 826
DOWN primary command on page 754
TOP primary command on page 824
BOTTOM primary command on page 735
Issuing commands
Within the File Manager panels, you can use "primary" or "prefix" commands to
instruct File Manager to perform an action.
You enter primary commands on the Command line of File Manager panels. On
many of these panels, the most commonly used primary commands have been
assigned to function keys, also known as Programmable Function keys or PF keys.
Some primary commands are exclusive to a particular panel, although most are
available on several panels. Where a command is available on more than one
panel, its behavior might differ depending upon the context in which it is used.
You enter prefix commands in a special prefix field in most panels, and in the
prefix area within the editor panel. Prefix commands are generally exclusive to a
panel and details of their operation are provided within each panel description.
RELATED TOPICS
Chapter 15, Primary commands, on page 731
Chapter 14, Panels and fields, on page 429
When your string contains a mix of apostrophes and quotation marks, use two
consecutive quotation marks ("") to represent a " character within a string delimited
by quotation marks, or two consecutive apostrophes ('') to represent a ' character
within a string delimited by single quotation marks. For example, to find the
string, "he said, "Take it it's yours.", you would type:
FIND he said, "Take it its yours."
Note: This document uses the words quotation marks, or quotes to mean either " or
'.
.
.
.
Input Partitioned, Sequential or VSAM Data Set, or HFS file:
Data set/path name . . . . . ______________________________________________+
Member . . . . . . . . . . ________ Blank or pattern for member list
. Volume serial . . . . . . . ______ If not cataloged
.
.
File Manager displays a member name list when the Entry panel is processed
and the data set has been specified or selected.
v If the entry panel you are using includes the option, Advanced member
selection, and you want to select a range of PDS(E) members based on one
or more criteria,select that option to display the Advanced Member Selection
panel.
For details about selecting a range of PDS(E) members, see Selecting a range
of PDS(E) members on page 39.
3. For data sets which have not been cataloged, enter the serial number of the
volume which contains the data set in the Volume serial field.
4. Complete the remaining panel-specific fields, and then press Enter to process
the panel function.
If both the data set/path name and the member name have been fully
specified, the panel action proceeds to its next stage.
If you entered a pattern for the data set/path name or member name, the Data
Set Selection panel is displayed, followed by the Member Selection panel, as
needed. When you have made your selections from these panels, the Entry
panel action proceeds to its next stage.
5. When the Data Set Selection panel is displayed, select your data set by entering
an S in the Sel field adjacent to the required data set. You can only select one
name from this list.
6. When the Member Selection panel is displayed, select your members by typing
an S in the Sel field next to each member or with the SELECT primary
command, and then pressing Enter.
You can select as many names as required from this list. When the panel is
processed, the first member on the list is used in the relevant function. When
the function is completed, the next member on the list is used. For example, if
you are selecting several members to be edited, the first member is displayed in
the Edit Session panel. When you exit this panel, the next member is displayed,
and so on, until all selected members have been processed.
Notes:
a. To reset values entered in the prefix area that have not yet been processed,
use the RESET primary command.
b. To re-read the directory and display the current member list, use the
REFRESH primary command.
7. When you are selecting members, you might find it useful to sort the list of
displayed members. To do this, perform either of these actions
v Use the SORT primary command to sort the member list by up to two of the
displayed columns. The field names are the column headings. For example,
SORT SIZE CREATED sorts the list of members first by size and then by the
date created.
v Place the cursor on the column header of the column you want to sort and
press Enter.
Note: When you sort members, the sequence (ascending or descending) for a
given column is predetermined and consistent with ISPF.
USERID.FMN.DATA
USERID.FMN.TEMPLATES
USERID.COBOL.COPY
USERID.COBOL.SOURCE
USERID.PLI.COPY
USERID.PLI.SOURCE
USERID.MISC.DATA.BACKUP
USERID.WORK
Example 1
displays the only item with exactly one level of qualifier after USERID:
USERID.WORK
Example 2
displays the complete list of data sets with the USERID high-level qualifier.
Example 3
displays the following list (containing those data sets with exactly three qualifiers,
whose third-level qualifier contains exactly four characters):
USERID.FMN.DATA
USERID.COBOL.COPY
USERID.PLI.COPY
Example 1
.
.
.
Data set name . . . . . FMNUSER.DATA
. Member . . . . . . . . ________
.
.
Example 2
.
.
.
Data set name . . . . . FMNUSER.DATA
. Member . . . . . . . . FMNCT*
.
.
Example 3
.
.
.
Data set name . . . . . FMNUSER.DATA(NEWDATA)
. Member . . . . . . . .
.
.
Example 4
.
.
.
Data set name . . . . . FMNUSER.DATA(TEM*)
. Member . . . . . . . .
.
.
TEMPA
TEMPB
Example 5
.
.
.
Data set name . . . . . FMNUSER.DATA(*)
. Member . . . . . . . .
.
.
RELATED TOPICS
Selecting a range of PDS(E) members on page 39
Browse Entry panel on page 454
Edit Entry panel on page 536
Data Create Utility panel on page 510
Print Utility panel on page 616
Copy From panel on page 486
Copy To panel on page 492
Find/Change Utility panel on page 569
AFP Print Browse panel on page 436
Load Module Information panel on page 587
Compare Utility: Old and New panels on page 466
Template Workbench panel on page 690
Data Set Selection panel on page 514
Member Selection panel on page 596
SORT primary command on page 817
RESET primary command on page 804
REFRESH primary command on page 802
Selecting a range of PDS(E) members on page 39
Where allowed, you specify the name of the MQ manager or queue in the data set
name field in the form:
MQ:managerid:queuename
Where:
managerid
The ID of the MQ manager (the 4-character subsystem ID).
queuename
The name of a queue managed by that manager.
If you enter a pattern, when the Entry panel is processed, File Manager displays a
selection list allowing you to select a manager or a queue.
Patterns can contain a percent sign (%) to represent a single character, and an
asterisk (*) to represent any number of characters within one qualifier. Two
asterisks (**) represent any number of characters within any number of qualifiers.
RELATED TOPICS
Browse Entry panel on page 454
Compare Utility: Old and New panels on page 466
Copy From panel on page 486
Copy To panel on page 492
Create panel on page 507
Edit Entry panel on page 536
Find/Change Utility panel on page 569
Print Utility panel on page 616
View Entry panel on page 705
To specify a CICS resource in a non-CICS File Manager environment for base File
Manager and Eclipse, use the notation shown here. The same notation applies to
both panel and keyword fields. You can only specify generic values on panels.
rt:applid:rname
Where:
rt Resource type. Valid values are:
FI For a CICS file.
TD For a Transient Data Queue.
TS For a Temporary Storage Queue.
applid1 The VTAM applid of the CICS system. You can specify a generic name to
display a list of CICS systems if an FMNCICS DD describing CICS applids
has been allocated to the ISPF session. See the File Manager Customization
Guide for details.
rname The name of the resource. You can specify a generic name to select from a
list.
Notes:
1. To specify a CICS resource from File Manager when running under FM/CICS,
omit the applid parameter from the resource name:
rt:rname
Patterns (only usable on panels) can contain a percent sign (%) to represent a
single character, and an asterisk (*) to represent any number of characters within
one qualifier. Two asterisks (**) represent any number of characters within any
number of qualifiers.
For a list of functions that allow you to access CICS resources from ISPF using the
File Manager editor or browser, see Table 1 on page 27.
RELATED TOPICS
Accessing CICS resources
Browse Entry panel on page 454
Compare Utility: Old and New panels on page 466
Copy From panel on page 486
Copy To panel on page 492
Create panel on page 507
Edit Entry panel on page 536
Find/Change Utility panel on page 569
Print Utility panel on page 616
View Entry panel on page 705
Notes:
1. Plus commands: APPEND, COPY, CREATE, REPLACE, SAVEAS.
2. See File Manager Users Guide and Reference for CICS.
To search and edit a CICS Temporary Storage Queue, follow these steps:
1. From the Primary Option Menu panel, select option 2 (Edit) to display the Edit
Entry panel.
2. In the Data set/path name field, type "TS:" as shown in Figure 7 on page 28.
The "TS:" indicates to File Manager that you want to edit one or more
Temporary Storage Queues from a CICS application.
Note: To edit CICS Transient Data Queues, type "TD:"; to edit CICS files, type
"FI:".)
Processing Options:
Copybook/template Start position type Enter "/" to select option
3 1. Above 1. Key Edit template Type (1,2,S)
2. Previous 2. RBA Include only selected records
3. None 3. Record number Binary mode, reclen
4. Create dynamic 4. Formatted key Create audit trail
Use I/O exit
Command ===>
F1=Help F2=Split F3=Exit F4=Expand F7=Backward F8=Forward
F9=Swap F10=Actions F12=Cancel
3. Press Enter.
When you specify the type of CICS resource ("TS:", "TD:", or "FI:") on an entry
panel, but without any further qualification, File Manager next displays the
CICS Applid Selection List panel which lists the available CICS applications as
shown in Figure 8.
4. Select the CICS application you want by typing "S" in the entry field next to the
relevant applid (in this case, applid CICSTST1) as shown in Figure 9 on page
29.
5. Press Enter.
File Manager then displays a list of Temporary Storage Queues (because you
specified "TS:" on the Edit Entry Panel) for the selected CICS application as
shown in Figure 10.
..
.
6. Select the Temporary Storage Queue you want by typing "S" in the entry field
next to the relevant queue (in this case, KSDS10) as shown in Figure 11 on page
30.
..
.
7. Press Enter.
File Manager then displays the data in the selected Temporary Storage Queue
as shown in Figure 12.
Processing Options:
Copybook/template Start position type Enter "/" to select option
3 1. Above 1. Key Edit template Type (1,2,S)
2. Previous 2. RBA Include only selected records
3. None 3. Record number Binary mode, reclen
4. Create dynamic 4. Formatted key Create audit trail
Use I/O exit
Command ===>
F1=Help F2=Split F3=Exit F4=Expand F7=Backward F8=Forward
F9=Swap F10=Actions F12=Cancel
3. Press Enter.
When you specify the type of CICS resource ("TD:", "TS:", or "FI:") and the CICS
application on an entry panel, but without specifying the name of the CICS
resource, File Manager next displays a selection list of the Transient Data
Queues, Temporary Storage Queues, or files for the specified CICS application.
In this case, File Manager displays a list of CICS files for the specified CICS
application (CICSTST1) as shown in Figure 14.
4. You can now proceed to work with any of the CICS resources listed.
For more information about working with CICS resources in File Manager, see
File Manager Users Guide and Reference for CICS.
Table 1 on page 27 shows you the File Manager batch functions you can use with
CICS resources.
When you run File Manager batch functions with a CICS resource, be aware that:
v If you are specifying a batch keyword for a CICS TS queue that contains special
or lowercase characters, or a CICS TD queue that contains lowercase characters,
you must enclose the name of the resource in quotes like this:
crt:applid:rname
Any single quote in the resource name must be repeated. For example, to specify
the TS queue name 'quoted name', enter:
DSNIN=cTS:MYCICS:quoted name
v For DSG and DSC functions:
The DISP=MOD parameter appends to the TD (transient data) and TS
(temporary storage) queues. Records are always appended for CICS files.
The DISP=OLD parameter replaces the TD (transient data) and TS (temporary
storage) queues. This is ignored for CICS files where the data is always
appended
Shown here are some examples of running File Manager batch functions with a
CICS resource.
Example 1: Data set Generate: Creating a TS queue using a template
$$FILEM DSG DSNOUT=TS:PRODCICS:MYTSQ
$$FILEM RECSIZE=2000,
$$FILEM DISP=OLD,
$$FILEM TCOUT=MY.TEMPLATE.DSN(MYTP),
$$FILEM NLRECS=100
Example 2: Data Set Copy: Copying a flat file to a CICS intrapartition TD queue
$$FILEM DSC DSNIN=MYHLQ.QUEUE.DATA,
$$FILEM DSNOUT=TD:PRODCICS:MYIQ
Example 3: Data Set Print: Printing a CICS file using a template
$$FILEM DSP FORMAT=TABL,
$$FILEM TCIN=MY.TEMPLATE.DSN(MYTP),
$$FILEM DSNIN=FI:PRODCICS:MYKSDS
Example 4: Find/Change: Making changes to a CICS file
$$FILEM FCH ,
$$FILEM DSNIN=FI:PRODCICS:MYKSDS
CAPS ON
C ABC DEF 12 14
/+
Example 5: Data Set Edit Batch: Navigating a CICS file backwards and changing
a name
$$FILEM DSEB DSNIN=FI:PRODCICS:MYKSDS,PROC=*
BOT()
DO UNTIL(UP(1) = TOF)
IF FLDI(3,=,JOHN) THEN DO
OVLY_OUT(BILL,3)
UPDATE()
LEAVE
END
END
/+
Example 6: Data Set Copy: Copying a flat file into a temporary storage queue
$$FILEM DSC DSNIN=myhlq.flatfile,
$$FILEM DSNOUT=TS:TESTCICS:MYTSQ
Example 7: Data Set Compare: Comparing two files on different CICS systems
$$FILEM DSCMP TYPE=RECORD,
$$FILEM SYNCH=ONETOONE,
$$FILEM LIST=DELTA,
$$FILEM WIDE=YES,HILIGHT=YES,
$$FILEM DSNOLD=FI:PRODCICS:MYKSDS,
$$FILEM DSNNEW=FI:TESTCICS:MYKSDS
To return to the original view of the selection list, enter the RESET primary
command.
To rebuild the information required to display the selection list, enter the REFRESH
primary command.
RELATED TOPICS
REFRESH primary command on page 802
RESET primary command on page 804
RELATED TOPICS
Chapter 15, Primary commands, on page 731
You can also scroll using the primary commands UP, DOWN, LEFT, RIGHT, TOP,
and BOTTOM.
Examples
LEFT 8 Scrolls 8 columns to the left.
LEFT Scrolls left the number of columns indicated by the Scroll field.
LEFT CSR If the cursor is positioned on a record, scrolls left to the cursor
position; otherwise scrolls left one page.
UP 15 Scrolls up 15 lines.
UP Scrolls up the number of lines indicated by the Scroll field.
UP DATA Scrolls up one line less than a page of data.
RELATED TOPICS
UP primary command on page 826
DOWN primary command on page 754
LEFT primary command on page 779
RIGHT primary command on page 808
TOP primary command on page 824
BOTTOM primary command on page 735
Controlling how far you scroll: To control how far you scroll when you press one
of the scrolling function keys, enter a scroll amount in the Scroll field:
Scroll amount Scrolls...
PAGE One screen at a time
HALF Half a screen at a time
DATA One line or column less than a screen at a time
CSR To the cursor position (if the cursor is not
positioned on a record when the scroll is
performed, then the scroll amount defaults to
PAGE)
You can temporarily override the amount in the Scroll field by typing a scroll
amount on the Command line, then pressing a scroll function key. For example, if
you enter 8 on the Command line, then press the Right function key (F11), File
Manager scrolls right 8 columns.
Scrolling to the first or last line or column: To scroll to the first or last line or
first or last column in the selection list, type MAX (or M) on the Command line, then
press one of the scroll function keys. For example, typing M then pressing the Right
function key (F11) scrolls right to the last column.
You can also scroll to the first or last line by entering TOP or BOTTOM on the
Command line.
RELATED TOPICS
TOP primary command on page 824
BOTTOM primary command on page 735
Holding a column when scrolling left or right: You can set a "hold" option to
hold specific columns. Held columns are displayed at the left of the screen and are
always displayed regardless of your scrolling position or direction.
RELATED TOPICS
TAILOR primary command on page 822
Note: For any selection list, there is a default "held" column for which the sort
order is, again by default, ascending (A).
You can specify a column to be used in determining the sort order in any of these
ways:
v Setting the column attributes for a single column:
1. Scroll (if necessary) so that the column is displayed.
2. Perform any of these actions:
a. Position the cursor within the column filter and press Enter to display a
Column Settings panel.
b. Set the Sort value to A, D, or N according to how you want the column
sorted.
c. Press the Exit function key (F3) to return to the selection list.
or
a. Position the cursor within the column heading and press Enter. The
column sort order is changed to the default. The default sort order for the
column can be found in the Column Settings panel.
or
a. Tab past the column heading (to the rightmost position of the column
heading area) and press Enter.
b. Each time you tab to this position and press Enter, the sort order rotates
through ascending (), descending (), and none (no arrow displayed).
v Setting the column attributes for one or more columns:
Perform either of these actions:
1. Enter the TAILOR primary command to display a list of columns together
with their column attributes.
2. Set the Sort value to A, D, or N according to how you want the column sorted.
3. Press the Exit function key (F3) to return to the selection list.
or
1. Use the SORT command.
Note: When you change the sort order for a column, the sort order for all other
columns is set to none.
RELATED TOPICS
TAILOR primary command on page 822
For example, to search for the next occurrence of the string Apple in any mix of
uppercase and lowercase, enter this command on the Command line:
F APPLE
To find the next occurrence of the same string, use the RFIND command, or enter
the FIND command with no argument. A message is displayed if the string cannot
be found.
You can control the starting point, direction, and extent of the search with one of
these optional parameters before or after the search string: NEXT, PREV, FIRST,
LAST, ALL.
For example, to search for the last occurrence of the string Orange, enter either
of these commands on the Command line:
F ORANGE LAST
F LAST ORANGE
RELATED TOPICS
FIND/FX primary command on page 764
You can specify the display width of a columns in either of these ways:
v Set the column attributes for a single column:
1. Scroll (if necessary) so that the column is displayed.
2. Position the cursor within the column heading and press Enter to display a
Column Details panel.
3. Set the Width value to the number of characters you want to use to display
the column.
4. Press the Exit function key (F3) to return to the selection list.
v Set the column attributes for one or more columns:
1. Enter the TAILOR primary command to display a list of columns together
with their column attributes.
2. Set the Width value to the number of characters you want to use to display
each column
3. Press the Exit function key (F3) to return to the selection list.
RELATED TOPICS
TAILOR primary command on page 822
RELATED TOPICS
TAILOR primary command on page 822
To change the order in which data columns in a selection list are displayed:
1. Enter the TAILOR primary command to display a list of columns together with
their column attributes.
2. Set the Order value for each column according to the order (left to right) that
you want the columns displayed. The values you specify must be unique to
ensure that the columns are re-ordered as intended.
3. Press the Exit function key (F3) to return to the selection list.
To suppress a data column from being displayed in a selection list are displayed:
1. Enter the TAILOR primary command to display a list of columns together with
their column attributes.
2. For any column that you want to suppress from being displayed in the
selection list, set the Order value to 0 (zero). Note that columns whose Order
value is set to 0, are displayed after the other (ordered) columns.
3. Press the Exit function key (F3) to return to the selection list.
RELATED TOPICS
TAILOR primary command on page 822
RELATED TOPICS
HEX primary command on page 776
The Advanced member selection option lets you select a range of PDS(E)
members based on one or more of the following criteria:
v Similar names
v The user ID by which they were last updated
v The date they were created
v The date they were last modified
To select a range of PDS(E) members in this way, select the Advanced member
selection option on the relevant entry panel and press Enter.
RELATED TOPICS
Advanced Member Selection panel on page 433
Printing from File Manager on page 293
Finding and changing data in multiple PDS members on page 264
Copying data sets on page 247
Print Utility panel on page 616
Find/Change Utility panel on page 569
Copy From panel on page 486
Template Build Utility panel on page 684
SELECT primary command on page 813
Member Selection panel on page 596
For example, if you enter the following on a File Manager Command line:
DX 10
For example, if you enter the following on a File Manager Command line:
XD 10
Hex 00000010 = dec 16
RELATED TOPICS
DX primary command on page 755
XD primary command on page 829
Selecting a display format on page 69
Getting help
File Manager offers two levels of help information: context-sensitive field
information and Tutorial Help. The field help information provides a description of
your current field, lists the valid values or range of values that can be entered, and
gives the default field value where applicable. Tutorial Help is a context-sensitive
help system that provides detailed explanations of the File Manager panels and the
processes in which they are used. In addition, all error messages have an
associated full text explanation, which can help you to determine the cause of a
problem.
For example, Figure 15 on page 43 shows the message seen when F1 is pressed
from the RECLIMIT field in the Set Print Processing Options panel.
Command ===>
F1=Help F2=Split F3=Exit F4=CRetriev F6=Reset F7=Backward
F8=Forward F9=Swap F10=Actions F12=Cancel
The Tutorial Help system is organized with a Table of Contents structure that is
based upon the File Manager Primary Options menu. Each entry within the Table
of Contents leads to a main topic with a number of associated sub-topics. In
addition, there is an index that lists selected topics from the Tutorial Help,
alphabetically by subject.
To navigate Tutorial Help, enter one of the following commands in the Command
line on any Tutorial page:
BACK or B
To back up to the previously viewed page.
SKIP or S
To skip the current topic and go on to the next topic.
UP or U
To display a higher level list of topics.
TOC or T
To display the Table of Contents.
INDEX or I
To display the Tutorial Index. Once the Index has been displayed, use the
RIGHT (F11) and LEFT (F10) keys to scroll through the list, then position
your cursor on a subject and press ENTER (Ctrl) to display the topic.
Alternatively, you may use the following keys whenever you are in the tutorial:
ENTER (Ctrl)
To display the next sequential page within a topic.
HELP (F1)
To display the Help Tutorial page within the Tutorial Help system (that is,
the page that describes how to use Tutorial Help).
END (F3)
To terminate the tutorial.
UP (F7)
To display a higher level list of topics (instead of typing UP ).
DOWN (F8)
To skip to the next topic (instead of typing SKIP ).
RIGHT (F11)
To display the next sequential page within a topic (instead of pressing
ENTER ).
LEFT (F10)
To display the previous sequential page within a topic (instead of typing
BACK ).
Note: The listed keys are the default key mappings. As you can customize key
mappings, they may be different on your system.
Copybook or Template:
Data set name . . FMN.V11R1M0.SFMNSAM1
Member . . . . . . FMNCCPY Blank or pattern for member list
Processing Options:
Copybook/template Start position type Enter "/" to select option
1 1. Above 1. Key Edit template Type (1,2,S)
2. Previous 2. RBA Include only selected records
3. None 3. Record number Binary mode, reclen
4. Create dynamic 4. Formatted key
The field where the cursor is positioned is mandatory for this function
Command ===> ________________________________________________________________
F1=Help F2=Split F3=Exit F4=CRetriev F7=Backward F8=Forward
F9=Swap F10=Actions F12=Cancel
RELATED TOPICS
Messages on page 1175
You can update these default values by accessing the relevant processing option
panel.
To access a processing option panel, use any one of the following methods:
v From the File Manager Primary Options Menu:
1. Select Option 0 (Settings). The Set Processing Options Menu panel is
displayed.
2. Select the required processing options type from the menu.
v From any File Manager panel, use the Options pull-down menu to select the
required processing options type:
Command ===>
F1=Help F2=Split F3=Exit F4=CRetriev F7=Backward F8=Forward
F9=Swap F10=Actions F12=Cancel
v On the Command/Options line of any File Manager panel, enter an equals sign
(=), followed by the option number for the required processing type. For
example, to display the Set Tape Processing Options panel, enter =0.3.
When you select an option processing type, File Manager displays a panel listing
those options and their current values. The following notes apply to all of these
option panels:
v To change the value of an option, overtype its current value.
v To save the options you have changed and exit the panel, press the Exit function
key (F3).
Changes are saved in your ISPF user profile for future File Manager sessions.
They remain in effect until you change the option again.
v To exit a panel without saving changes, press the Cancel function key (F12).
v To reset all options on the panel to their installation defaults, enter RESET on the
Command line.
v The options on these panels only affect the behavior of File Manager panels. To
set options when programming with File Manager functions, use the equivalent
function keywords. You can set most options using the SET function (see page
1061). For Compiler Language Selection, COBOL, PL/I or HLASM options (for
compiling copybooks into templates), use the keywords on the same function
where you specify the copybook (the DSEB, DSC, DSG, DSM, DSP or DSU
functions).
The use of most of these processing options is discussed in the section that the
option affects. For example, the use of Set Print Processing Options panel is
described in the Printing from File Manager section of the Managing data sets
chapter. Only those processing options that affect more than one area of File
Manager's functionality are described in this section.
RELATED TOPICS
Set Processing Options panel on page 657
RELATED TOPICS
Setting your Print Processing Options on page 293
Set Print Processing Options panel (option 0.1) on page 654
The CYLHD option defines how File Manager interprets cylinder-head and
track-number values in disk functions. ABSOLUTE means the actual physical
addresses. RELATIVE means relative to the start of the data set.
The EOD option sets the end-of-data delimiter for tape input.
The User I/O Exit Specification section contains two fields that, together, control
whether or not you are able to use custom user I/O exits in tasks such as viewing,
editing, printing, copying or comparing data sets. User I/O exits are
custom-written programs that handle files that require pre- or post-processing not
offered directly by File Manager. This may include handling data compression or
encryption, or other non-standard activities performed on the data set records.
There are no restrictions on the programming language that you can use to write
an exit, however, the exit must be provided to File Manager in the
STEPLIB/ISPLLIB concatenation or their extensions (LINKLIST, LPA, and so on).
To allow the use of user I/O exits, several things must occur:
1. When File Manager is installed, the person doing the initial customization (the
FM Administrator) must have chosen to allow user I/O exits on a site-wide
basis.
If the FM Administrator chose not to allow user I/O exits, the Exit enabled
field is set to NO Disabled by installation options. You cannot change this
from within the File Manager panel and you cannot use I/O exits in online or
batch processing.
If the FM Administrator chose to allow user I/O exits, you can then set the Exit
enabled field to YES. Choosing YES means that when performing the following
tasks (via a panel or function), you have the option to use or not use a user
I/O exit:
v Viewing data sets (View panel only)
v Editing data sets (Edit panel, DSEB and DSU functions)
v Finding and changing data (Find/Change panel, FCH function)
v Copying data sets (Copy From and Copy To panels, DSC function)
v Creating data (Data Create panel, DSG function)
v Comparing data sets (Old and New panels, DSM function)
v Printing data sets (Print Utility panel, DSP function)
Choosing NO means that you are not able to select an exit in any of the File
Manager panels. However, you are still able to specify a user I/O exit in batch
processing.
2. Either you or someone in your organization must have developed your own
custom exit to be used. Sample programs and control block templates have
been provided for HLASM (High Level Assembler), COBOL, and PL/I but
these need to be tailored to your site needs.
If the FM Administrator has allowed user I/O exits, he or she may have
provided a default exit for you to use. If they have done so, the name is
displayed in the Default exit field.
You can override this system default with your own default exit, by changing
the name in this field. In each applicable panel or function, you can then
choose to accept or override the current default.
3. When you want to use a user I/O exit, regardless of whether you are using the
system default, your own default or specifying a unique exit at the individual
panel or function level, the name of the exit must be the name of a PDS(E)
member of a data set that is included in the current STEPLIB/ISPLLIB
concatenation for File Manager.
RELATED TOPICS
Set System Processing Options panel (option 0.2) on page 659
See Set Tape Processing Options panel (option 0.3) on page 661 for panel details.
File Manager assumes any non-blank lines define a JCL job card and copies the
information from these lines into generated JCL. If all the lines are blank, the JCL
generation process generates a basic job card using information from system
variables.
RELATED TOPICS
Setting processing options in batch on page 396
Set Batch Job Card Information panel (option 0.4) on page 645
RELATED TOPICS
Setting your template processing options on page 142
Compiler Language Selection panel on page 465
Set COBOL Processing Options panel (option 0.5.2) on page 646
Set PL/I Processing Options panel (option 0.5.4) on page 652
Set HLASM Processing Options panel (option 0.5.3) on page 649
Set Language and Compiler Specifications (option 0.5) on page 650
In an editor session, use the PROFILE primary command to display the current
settings.
Note: If you are viewing, editing, or printing data, the Options pull-down menu
choice to change these options is not available. The options may only be
changed before starting your View, Edit, or Print session. To change the
behavior for the current View, Edit, or Print session, use an equivalent
primary command (where available).
RELATED TOPICS
See VSAM Edit Sharing Options panel on page 712 for panel details.
See Set Temporary Data Set Allocation Options panel on page 663 for panel
details.
See Set Output Data Set Allocation Options panel on page 651 for panel details.
See Set Trace options panel on page 665 for panel details.
Terminal Characteristics
Screen format 1 1. Data 2. Std 3. Max 4. Part
Tip: You may need to scroll down this panel to find the list of Terminal Types.
4. Press Exit (F3) to save your selection and return to the z/OS Primary Option
Menu panel.
5. Restart File Manager.
National characters
File Manager uses the national characters shown in Table 2.
Table 2. National characters
Character Hexadecimal value Displayed as, in code pages 37 and 500
Dollar sign X'5B' $
Pound sign X'7B' #
At sign X'7C' @
Notes:
1. The dollar sign ($) and the pound sign (#) have special syntactical meaning in File
Manager syntax.
2. In countries using code pages other than 37 and 500:
v The above characters as represented on terminal keyboards might generate a different
hexadecimal representation, and this might cause an error or unwanted results. For
example, in some countries the $ character might generate a X'4A'.
v The above hexadecimal values might display as different characters to those shown.
When you enter File Manager commands in batch or online, use the keyboard
characters that correspond to the hexadecimal values shown in Table 2.
For the File Manager functions which SAF-rule controlled auditing may be applied
to, the SAF rules can be specified at a resource or function level allowing auditing
at the FUNCTION, UPDATE, or ALL level. Auditing at the ALL level indicates that
record reads and updates are recorded, UPDATE indicates only inserted, deleted,
or changed records are recorded, while FUNCTION records only the event.
If you have control-level audit access, the Create audit trail option is displayed on
the Edit Entry Panel and the WebSphere MQ Queue Editor Entry panel. If you
select this option, and no other SAF rule is in place for this function and resource,
auditing of inserted, deleted, or changed records is logged. If there is an existing
SAF rule for this function and resource, the level of audit specified in the SAF rule
applies.
Note: If you have changed the data in a View editor session, even though
you are not able to save the changes back to the same data set you
are viewing, you can save the changed data to another data set
(either existing or new, however MQ queues are not supported by
these commands) by issuing one of these primary commands:
APPEND
Appends specified records in the current editor session to
another (existing) data set.
CREATE
Creates another (new) member or data set from specified
records in the current editor session.
REPLACE
Replaces another (existing) member or data set with
specified records in the current editor session.
SAVEAS
Saves the currently exposed data in the current editor
session to another (new) member or data set, and switches
to an edit of the nominated member or data set.
RELATED TOPICS
Creating, replacing, and adding data using existing data on
page 240
The first time you make a change to the data in a View editor session, File
Manager displays a warning as shown in Figure 20 on page 54.
Figure 20. Warning pop-up displayed after first change in View editor session
When you exit from a View editor session by pressing the Exit function
key (F3), if you have made a change to the data in the editor session, File
Manager displays a warning as shown in Figure 21.
Figure 21. Warning pop-up displayed when exiting from a View editor session if changes
made to data
Edit Utility
The Edit Utility (option 2) allows you to view and change your data (by
inserting, deleting and otherwise modifying records), and save any changes
you make.
These instructions are given within the context of the File Manager editor. In most
cases, you can perform these actions in either Edit or View, in which case the term
"editor" is used. Similarly, the term "editor session" can indicate either a View
editor session or an Edit editor session.
Many of the tasks described in this chapter require the use of templates. For
information on how to define and edit templates, see Chapter 4, Creating and
editing templates, on page 129.
If your data has been written using the ISPF PACK option, you can choose to
unPACK the data for easy editing or edit the data in its PACKed format. You can
also choose to write previously unPACKed data to the ISPF PACK format. Packing
only applies to physical sequential data sets or to members of a PDS(E).
Note: This option does not allow you to save any changes you make to
the data.
2 Edit Displays the Edit Entry panel.
2. Specify your HFS file or data set name or name pattern, member name or
pattern and/or volume serial.
3. If required, specify a Starting position for the data, then select a Start position
type from the Processing Options.
When your data set is a KSDS file, you can specify a key of up to 250
characters, as the starting position. To make it easier to enter a key of this size,
you can expand the field by pressing the EXPAND function key (F4) or you can
scroll within the field by pressing the LEFT or RIGHT function keys (F10/F11).
When using a record number as the start position, you can specify a negative
number to start from the given number of records before the end of the data
set. The initial display is positioned at the specified record. Records prior to
your starting position are not visible.
Note: See also the use of the KEY primary command in step 9.
4. If required, specify a record limit. The count of displayed records commences
from the Starting position (which defaults to the top of the data set).
You can specify a record limit as the word MEMORY so that File Manager
loads only as many records as will fit comfortably into storage.
5. If required, select the Record Sampling field. Selecting this field will cause the
Record Sampling panel to display after the Entry panel has been processed.
You can use record sampling to specify a pattern for reading records from the
data set. In your pattern, you can specify a starting position, read a number of
records, skip a number of records, and then repeat the pattern until an end
point is reached. The end point might be a specified number of physical
records, a specified number of records selected by a template, the end of the
input file, or the maximum number of records that can safely fit within the
available virtual storage (whichever is reached first).
When record sampling is in effect:
v The values (if any) in the Start position and Record limit fields are carried
through into the Record Sampling panel.
v The skipped records are not presented or accessible within the session.
v The session will run in In-place mode and will only contain as many records
as will fit into the available virtual storage.
6. In Edit, if you only want to update records in the data set (without inserting or
deleting records), then select the Inplace edit option.
Note that you cannot insert or delete records when:
v Record Sampling is selected,
v A Record limit of MEMORY is specified,
v The data set is a VSAM file defined as NOREUSE, or
v A template is specified which indicates segmented records
v The data set is a QSAM LRECL=X that is too large to be contained in
memory
7. Type 3 (None) in the Copybook/template usage field.
Note: When this field is set to None, entries in the Copybook or Template
Data set name and Member fields are ignored.
8. In Edit, if required, select the Create audit trail option.
Note: To print an audit report, use Print audit trail report (see Edit Entry
panel on page 536).
9. Press Enter to process the panel.
If you have provided the complete name of your data set and data set member,
the Edit (or View) panel displays your data.
If you used a pattern to specify your data set or member, the Data Set Selection
or Member Selection panel is displayed. Select the required data set or
members from the list by typing an S in the Prefix field, then pressing Enter.
The Edit (or View) panel displays your data.
If your data set is a KSDS file, you can specify a position to jump to by issuing
the KEY primary command.
RELATED TOPICS
Specifying a data set and a member name on page 20
Scrollable input and display fields for long names on page 83
View Entry panel on page 705
View panel on page 699
Record Sampling panel on page 624
KEY primary command on page 779
Note: This process assumes that you have an existing template that you can use to
format your data. For details on creating new templates or editing an
existing template before use, see Chapter 4, Creating and editing
templates, on page 129.
1. Follow steps 1 to 6 in Starting an editor session without using templates on
page 55.
2. If required, select the Include only selected records option. This option is only
effective when using a template and you are using either:
v Record sampling, or
v A record limit of MEMORY
Note: If you have selected the Include only selected records option, the editor
session operates in an in-storage way.
3. In the Copybook or Template section of the panel, specify the data set in
which your copybook template or dynamic template is stored, or use a
wildcard character to select from a list.
Note: The Use I/O exit option only affects the data set that you are choosing to
view. It cannot be used to process the template or copybook that you are
using to format the data.
4. In the same section, specify the Member name or leave the Member name field
blank to choose from the list of Members in a partitioned data set.
5. In the Copybook/template usage field, type 1 to select the Above option.
Alternatively, if you have previously used a template with the input data set,
you can select option 2. Previous. The Previous option instructs File Manager
to ignore the contents of the Copybook or Template fields, and instead use the
template that you have most recently associated with the input data set.
If you want to edit the template before using it, select the Edit template field.
6. Press Enter to process the panel.
If you have provided the complete name of your input data set and data set
member and your template data set and data set member, the Edit (or View)
panel displays your data.
If you used a pattern to specify your data sets or members, the Data Set
Selection or Member Selection panels are displayed in the following order:
v Data Set Selection panel
v Template Data Set Selection panel
v Template Member Selection panel
v Member Selection panel
Select the required data sets or members from the lists by typing an S in the
Prefix field, then pressing Enter. The Edit (or View) panel displays your data.
RELATED TOPICS
Chapter 4, Creating and editing templates, on page 129
View Entry panel on page 705
View panel on page 699
Specifying a data set and a member name on page 20
1. From the File Manager Primary Option menu, select option 1. View.
2. In the Data set name field for the input data set, type
FMN.V11R1M0.SFMNSAM1.
3. In the Member field for the input data set, type FMNCDATA.
4. In the Copybook/template usage field, select option 3. None.
5. Press Enter.
Figure 23 shows what this data looks like without a template.
File Manager has used the first record type defined in the copybook to display
the data and the first set of records (REC-TYPE = 01) are now readable. Any
fields defined in the second record type (REC-TYPE = 02) that match fields
defined in the first type are also displayed.
To edit a template, and change the logical view of the data, enter TEDIT on the
Command line.
To select or create a template for the data, enter TVIEW on the Command line.
RELATED TOPICS
Chapter 4, Creating and editing templates, on page 129
TEDIT primary command on page 823
TVIEW primary command on page 825
Note: You do not need to have the Recognize and interpret ISPF packed data
option selected in order to convert data to packed format. However, you
need to have the option on, to be able to edit this data after it has been
packed.
Note: You cannot unpack data unless File Manager is able to recognize and
interpret the packed data format.
You can also pack or unpack data set members as you copy a member to another
data set or data set member.
Note: If you select the Use I/O exit option on the View Entry panel, the Recognize
and interpret ISPF packed data option is ignored. Packed data sets are
displayed in packed format.
RELATED TOPICS
PACK primary command on page 793
Viewing and changing packed data on page 60
Editor Options panel on page 541
Copying data sets on page 247
When a template has been used, the RECSTATS primary command also shows:
v The number of layouts
v The number of record elements selected
v The number of record elements not selected
v The number of record elements not selected due to the record data not meeting
selection criteria
v The number of record elements not selected due to the record length being
outside any layout length
v A list of layout names and the number of record elements belonging to each
layout
Note: Information on record elements not selected is not available if the Include
only selected records option is selected and this is an in-storage or sampling
editor session.
RELATED TOPICS
RECSTATS primary command on page 801
RELATED TOPICS
PROFILE primary command on page 797
Note: If you have selected more than one data set member to be viewed, the next
selected member on the list is now displayed.
In Edit, to end your editor session without saving your changes (that is, since the
previous SAVE command), enter CANCEL (or CAN) on the Command line, or press
the Cancel function key (F12). If you have made any changes to the data, File
Manager displays a message box asking you to confirm that you want to discard
the changes.
To end your Edit session and save any changes you have made, enter END on the
Command line, or press the Exit function key (F3).
RELATED TOPICS
END primary command on page 756
FILE primary command on page 763
CANCEL primary command on page 736
File Manager keeps only changed records in memory, unless using a MEMORY
record limit, or using record sampling, or using a segmented template with
selection criteria. If you run out of memory, the SAVE command may free some
memory, which would let you continue the Edit session.
Note: This command is not supported when editing a large file using an auxiliary
data set. In this case, you must end the Edit session to save the changes and
then re-edit the data set if you want to make further changes.
RELATED TOPICS
SAVE primary command on page 811
The display of this information is initially controlled by the Display RBA and
Length when browsing VSAM option in the relevant Editor Options panel.
However, in a Browse session you can use the RBALEN primary command to
change whether this information is displayed or not for that editor session.
In a Browse session, to display the RBA and record length when viewing a VSAM
file, do one of these:
v Ensure that the Display RBA and Length when browsing VSAM option in the
relevant Editor Options panel is selected, or
v Issue the command RBALEN ON
Figure 27 shows part of a VSAM file displayed in a Browse session with the RBA
and record length displayed on the leftmost side.
Figure 27. VSAM file displayed in Browse session with RBA and record length details
displayed
To display the VSAM file without the RBA and record length details, perform
either of these actions:
v Ensure that the Display RBA and Length when browsing VSAM option in the
relevant Editor Options panel is not selected,
Figure 28 shows the same VSAM file displayed in a Browse session with the RBA
and record length not shown.
Figure 28. VSAM file displayed in editor session with RBA and record length details not
displayed
RELATED TOPICS
RBALEN primary command on page 797
Editor Options panel on page 541
The prefix area also doubles as the prefix command entry area. You enter prefix
commands by overtyping the line number for the appropriate record.
RELATED TOPICS
How File Manager handles segmented data with related ID criteria on page
178
Support for variable-length arrays on page 137
Seeing why a record is not-selected on page 221
In an editor session, to see which prefix commands are valid for the current
environment, enter an "?" in the prefix area (against any listed line). File Manager
displays a list of the line commands you can enter, like those shown in Figure 29.
You can enter the following commands in the prefix area of the data display:
000300
cols ----+----10---+----2----+----3----+----4----+----5--- etc.
000500
Command ===>
F1=Help F2=Split F3=Exit F4=CRetriev F7=Backward F8=Forward
F9=Swap F10=Actions F12=Cancel
Figure 29. Using the ? prefix command to display a list of valid prefix commands
In an editor session, you can choose whether a prefix area is displayed next to the
data or not.
To specify the default position and display state of the prefix area for all editor
sessions, set these editor options on the relevant Editor Options panel:
v Display prefix area
v Display prefix area on the right
v Prefix area width (A,6,7,8,9)
To specify the default position and display state of the prefix area for the current
editor session, use the PREFIX primary command. For example:
v To display the prefix area on the right, enter PREFIX RIGHT.
v To display the prefix area as an 8-digit field, enter PREFIX 8.
v To display the prefix area with a width that automatically adjusts (from 6 to 9
digits wide) in order to display the record number, enter PREFIX A.
v To remove the display of the prefix area, enter PREFIX OFF.
You can use most prefix commands on either a single line or a block of consecutive
lines:
v To perform an operation on a single line, you enter the appropriate prefix
command.
Generally, you need to type over only the first 1 or 2 characters of the line number
to enter a prefix command. Sometimes, however, typing a single character can be
ambiguous. In the following example, it is unclear whether the intended prefix
command is R to repeat line 31700, or R3 to repeat the line three times:
031600
R31700
031800
In such cases, the editor assumes that you have not typed a number following the
prefix command. If you want to repeat the line three times, you can use any of the
following methods:
v Type one or more blanks following the R3:
R3 700
v Type R3 and press the Erase EOF key to clear the rest of the Line Command
field, or press the Erase EOF key and then type R3.
v Type one or more blanks after the R but before the number such that the
number when entered is different than the characters being overtyped.:
R 3700
v Type the number before the R, ensuring that the number when entered is
different than the characters being overtyped:
3R1700
To clear any outstanding commands in the prefix area, use the RESET PREFIX
command. See RESET primary command on page 804.
Prefix commands do not affect not-selected or suppressed records that are hidden
from display or represented by shadow lines. For example, if you use the MM
prefix command to mark a block of records for moving, then not-selected or
suppressed records that are hidden from display or represented by shadow lines
are not affected by the move, and are left behind at their original position. Prefix
commands do affect excluded records, even when they are hidden from display
(by SHOW EX OFF and SHADOW EX OFF).
RELATED TOPICS
PREFIX primary command on page 795
RELATED TOPICS
Chapter 15, Primary commands, on page 731
Note: The abbreviated form of these commands can also be entered in any prefix
command field.
Display formats
To determine which display format is best for your needs, review the display
format descriptions below.
CHAR
Character display format. This format is suitable for viewing or editing
unstructured text that is composed of characters that can be entered via the
keyboard.
LHEX Unformatted hexadecimal. This format has been superceded by the HEX
format. However, it has been retained within the product so that long-term
users of File Manager can continue working with Hexadecimal characters
in a familiar layout.
SNGL Single-record format (only available when using a template). Limits the
display to a single record. Each field might take up one or more lines,
depending upon the field information selected for display and the length
of the field name. SNGL display format is suitable for viewing information
that has been structured into fields and records, when you need to focus
on a single record.
This example shows the Ref (Field Reference), Field, Picture, Typ (Type),
Start and Len (Length) columns, and the Field column contains structure
information (copybook element level). The display of many of these
columns is optional (the default is for them to be displayed).
To change the information displayed in SNGL mode, enter one of the
following commands:
JUST Left justifies the numeric fields
PIC Displays or hides the Picture column
RDF Displays or hides the Redefines information (within the Field
column) and the redefined fields. This command also affects the
display of the redefined fields in TABL display.
REFS Displays or hides the Field References column
SLOC Displays or hides the Start column
STR Displays or hides the structure information in the Field column
TYP Displays or hides the Type and Length columns
These are toggle commands that change the display from on to off or off to
on, depending on the current status of the panel. The commands only
affect the current editor session, they do not change the default settings.
To change the default settings for editor panel:
Note: These options cannot be changed when you are in an editor session.
TABL Tabular format (only available when using a template). Arranges fields in
columns. This format is suitable for viewing information that has been
structured into fields and records and you need to review multiple records.
REC-TYPE NAME EMPLOYEE-NO AGE SALARY MONTH(1)
#2 #3 #4 #5 #6 #7
AN 1:2 AN 3:20 BI 23:2 BI 25:2 PD 27:4 BI 31:4
<> <---+----1----+----> <---+-> <---+-> <---+--> <---+---->
01 Grant Smith 7712 35 75000 6
01
. Andrew Apple 6645 53 78500 30
.
.
In TABL display format, only one record type in the data set is displayed
at any time. The column headings at the top of the screen reflect the fields
in the current record type. There are three lines in the headings:
field_heading
#n [R #n]
type start_column:length
<- ... ->
where:
field_heading
Defaults to the field name defined in the copybook. You can
change this by editing the template. For details, see Chapter 4,
Creating and editing templates, on page 129.
#n [R #n]
The field reference. You use this to refer to the field in File
Manager. For example, to limit the FIND primary command to
searching only certain fields, you specify the field references for
those fields.
If the field redefines another field, then this is shown by the R
notation, followed by the field it redefines. For example, #5 [R #4]
shows that this is field 5, which redefines field 4.
type The field data type.
start_column
The field start column.
length The field length.
<- ... ->
Ruler, indicating the size of the field.
Records of other types are suppressed from display: they are either hidden or
represented by shadow lines.
In CHAR, HEX and LHEX formats, and for alphanumeric fields in SNGL or TABL
formats, characters that cannot be displayed (non-displayable characters) are
represented as periods.
v You can display hexadecimal values under your formatted field data by entering
HEX ON on the Command line. For example, if you are viewing data in TABL
display format and your display looks something like this:
Order# # Items Date Time Seller Buyer (1) (1)
#6 #7 #9 #13 #18 #19 #31 #32
A00001 1 900227 010101 1144 20 25 9999
A00004 1 900310 100530 1144 10 15 0099
RELATED TOPICS
FORMAT primary command on page 775
HEX primary command on page 776
Zooming in to see all of a record on page 75
REFS primary command on page 803
TYPE primary command on page 826
Editor options (option 0.6) on page 49
Editor Options panel on page 541
Filtering record display using templates on page 218
2. Press Enter.
The column identification line is inserted in the data set or member after the
line in which you entered COLS. The column identification line moves with the
rest of the data when you scroll through the data set or member.
Note: You can use the COLS prefix command with the BOUNDS prefix command
to help check and reposition the bounds settings.
To remove the column identification line from the panel, either type D in the prefix
area that contains the =COLS> flag, or type RESET on the command line:
Figure 30 shows the boundary definition line with the COLS command typed in
the prefix area of the following record.
When you press Enter, File Manager inserts the COLS line, as shown in Figure 31
on page 75.
The zoomed display automatically scrolls to the column that was shown in the Col
field prior to zooming.
Note: This example shows data from the second record type in the sample data
set, as that record type holds more character information.
To zoom out, press the Zoom function key (F2) again. Zooming toggles between
zooming in on one record and zooming out to show multiple records. When you
zoom out, the display format returns to its setting prior to zooming in. For
example, if you zoom in when the display format is CHAR, then change to SNGL,
zooming out returns the display to CHAR format.
In SNGL or TABL display formats, when you zoom in on a record, just that record
is displayed in zoomed SNGL display format, as shown in Figure 33. This format
differs from normal SNGL display format, in that:
v In this display format, you cannot navigate between records.
In un-zoomed SNGL display format, you can navigate between records using
the PREVIOUS and NEXT primary commands or Previous function key (F10)
and Next function key (F11).
v When you view a record in zoomed SNGL display format, File Manager
displays all fields, regardless of whether or not they were selected for display in
the template.
Note: SNGL view with the STR command active provides a view of your record
structure that is identical to the ZOOM SNGL view and allows you to
scroll between the records.
In TABL or normal (un-zoomed) SNGL display format, File Manager only
shows the fields selected for display in the template. For instance, in the
example shown in Figure 33, if you edit the template to deselect the field
JOB-TITLE, in un-zoomed SNGL display format the record looks like this:
In TABL display format, zooming in automatically scrolls to the field that was at
the left of the screen when the display format was TABL.
RELATED TOPICS
ZOOM primary command on page 830
STR primary command on page 821
Selecting a display format on page 69
View panel on page 699
Editor panel on page 529
Changing the length of a record on page 128
Note: In SNGL and zoomed display formats, the record length is always displayed.
However, when viewing data in an editor session you can use the RECLEN
primary command to temporarily change the record length display options for the
current editor session:
RECLEN ON
Turn on the display of record lengths. (Record lengths are displayed on the
left of the data, unless the Display record length on the right editor
option is selected.)
RECLEN OFF
Turn off the display of record lengths.
RECLEN RIGHT
Turn on the display of record lengths and display record lengths on the
right of the data.
RECLEN n
Set the width of the record length display area to n characters, where n can
be 3, 4, 5, or 6.
RECLEN A
Set the width of the record length display area according to the value of
the record lengths.
Figure 35. Data displayed in an editor session with no record length details shown
To display the record length information on the left of the data, enter:
RECLEN LEFT
Alternatively, if the Display record length on the right option on the relevant
Editor Options panel is not selected, you can enter:
RECLEN ON
Figure 36 shows the same data displayed with the record length displayed on the
left of the data.
Figure 36. Record length details displayed in editor session on left of data
To display the record length information on the right of the data, enter:
RECLEN RIGHT
Alternatively, if the Display record length on the right option on the relevant
Editor Options panel is selected, you can enter:
RECLEN ON
Figure 37 on page 80 shows the same data displayed with the record length
displayed on the right of the data.
Figure 37. Record length details displayed in editor session on right of data
To set the width of the field length display area for all editor sessions, set the
Record length width option on the relevant Editor Options panel to A, 3, 4, 5, or
6. Setting this option to "A" causes the width of the record length area to be
automatically adjusted as required.
To change the width of the field length display area for the current editor session,
issue the RECLEN command. For example, to change the width of the field length
display area to 4, enter:
RECLEN 4
RELATED TOPICS
RECLEN primary command on page 800
Editor Options panel on page 541
Changing the length of a record on page 128
You can also scroll using the primary commands UP, DOWN, LEFT, RIGHT, TOP,
BOTTOM, NEXT and PREVIOUS. For details, see Chapter 15, Primary
commands, on page 731.
Note: If you specify a number of records greater than the number of subsequent
records, File Manager displays the **** End of data **** indicator. You can
then press the Previous function key (F10) to view the last selected record.
In SNGL display format, to move back n records, perform either of these actions:
v Enter PREVIOUS n on the Command line
v Enter n on the Command line and press Previous function key (F10)
Note: If you specify the MAX parameter, the first selected record is displayed. If
you specify a number of records greater than the number of prior records,
File Manager displays the **** Top of data **** indicator. You can then
press the Next function key (F11) to view the first selected record.
Examples
LEFT 8 Scrolls 8 columns to the left.
LEFT Scrolls left the number of columns indicated by the Scroll field.
LEFT CSR
If the cursor is positioned on a record, scrolls left to the cursor position;
otherwise scrolls left one page.
UP 15 Scrolls up 15 lines.
UP Scrolls up the number of lines indicated by the Scroll field.
UP DATA
Scrolls up one line less than a page of data.
RELATED TOPICS
UP primary command on page 826
DOWN primary command on page 754
LEFT primary command on page 779
RIGHT primary command on page 808
PREVIOUS primary command on page 795
NEXT primary command on page 789
TOP primary command on page 824
BOTTOM primary command on page 735
You can temporarily override the amount in the Scroll field by typing a scroll
amount on the Command line, then pressing a scroll function key. For example, if
you enter 8 on the Command line, then press the Right function key (F11), File
Manager scrolls right 8 columns.
You can also scroll to the first or last record by entering TOP or BOTTOM on the
Command line.
To reset your display after this has occurred, scroll to the top of the data set.
To avoid this situation, scroll down in increments, for example, DOWN 9999, until the
end of the data set is reached. Alternatively, if you know the last record number,
use the LOCATE command to go to that record. Once File Manager has recognized
the record number, you can scroll in any direction, using any of the various
scrolling methods, and this display situation does not reoccur.
RELATED TOPICS
Holding columns when scrolling left or right on page 165
In all display formats, you can scroll to a particular record number by typing the
record number in the Record field, then pressing Enter.
In all display formats except SNGL and TABL, you can scroll to a particular
column by typing the column number in the Col field, then pressing Enter.
In SNGL and TABL display format, you can use the LOCATE primary command to
scroll to a particular field, using either the field reference number or the Field
Name. For example:
LOCATE #5
or
LOCATE Age
When the field is an item in an array, you must specify a subscript in parentheses
to identify the occurrence that you want to locate. If your field is part of a
multi-dimensional array, you must specify a subscript for each dimension in the
array. For example:
L #7(5)
L #9(2,3)
In TABL display format, the LOCATE command scrolls your view so that the
specified field becomes the leftmost visible field. Once positioned on a field, you
can use the Down (F8) or Up (F7) commands (function keys) to scroll through the
records and maintain the same relative field view.
In SNGL display format, the LOCATE command scrolls your view so that the
specified field becomes the topmost visible field. Once positioned on a field, you
can use the Next (F11) or Prev (F10) commands (function keys) to scroll through
the records and maintain the same relative field view.
RELATED TOPICS
LOCATE primary command on page 782
Display fields The fields on File Manager panels that display information as a
result of some action you have taken. For example, when you
display data on the Browse, Edit, or View panel in a File Manager
editor session, the data set name displayed at the top of the panel
is a scrollable display field.
The following two sections describe how to work with both types of scrollable
field when entering or viewing longer fields.
You can recognise a scrollable field by the presence of one of the following
adjacent to the end of the entry field:
+ Plus sign. Indicates the field is scrollable to the right
- Minus sign. Indicates the field is scrollable to the left
+- Plus sign and minus sign. Indicates the field is scrollable to the right or left
If the length of the input field displayed on the panel is insufficient for the value
you want to enter, you can either:
v Progressively scroll to the right as you enter the value with the Right function
key (F11) or by entering the RIGHT primary command (with the cursor
positioned within the entry field), or
v Press the Expand function key (F4) if available, or enter the EXPAND primary
command, to display a window that allows you to enter the full length of the
value.
In the expand pop-up window, you can toggle the view of the data between
character and hex by issuing the commands HEX OFF and HEX ON.
Deleting data in scrollable input fields: If you want to delete all the data in a
field that is displayed as a scrollable input field, take care to ensure that you do, in
fact, delete all the data (and not just the displayed data).
If you use the field delete key combination to delete data, File Manager deletes
only the data that is currently displayed. If the field contains more data than is
displayed, the undisplayed data is left undeleted.
You can recognise a scrollable field (and where more data exists than can be shown
at one time on the panel) by the presence of one of the following adjacent to the
end of the display field:
+ Plus sign. Indicates the field is scrollable to the right
- Minus sign. Indicates the field is scrollable to the left
+- Plus sign and minus sign. Indicates the field is scrollable to the right or left
Note: The "+", "-", and "+-" signs are only shown adjacent to the end of a scrollable
display field when the data to be displayed is longer than the length of the
display field on the panel.
If the data to be displayed is longer than the length of the display field on the
panel, you can view the rest of the data by either:
v Progressively scrolling to the right by pressing the Right function key (F11) or by
entering the RIGHT primary command (with the cursor positioned within the
display field), or
v Pressing the Expand function key (F4) or entering the EXPAND primary
command to display a window that allows you to view the entire contents of the
field.
RELATED TOPICS
EXPAND primary command on page 760
Note: SORT requires that all data set records be memory-resident. If the entire
data set can not fit into your region storage, an error is reported and the
SORT execution aborted. If necessary, increase the region size to contain the
entire data set.
You can specify whether you want the data sorted in ascending (the default) or
descending sequence and, in Edit, you can restrict the sorting to excluded records
or not-excluded records only.
sorts a data set into ascending order, using the range 56-70 as the first key and
range 3-22 as the second key.
sorts a data set into descending order, using field #6 as the first key and field
#3 as the second key.
To restore a list to the KEY or SLOT NUMBER order (KSDS, VRDS, and RRDS
VSAM data sets):
1. Display your KSDS, VRDS, or RRDS VSAM data set in any display format.
2. Sort the data away from the KEY or SLOT NUMBER order by issuing a SORT
command, by moving or adding records or by editing the key field (KSDS
only). If you have edited your records, issue the SAVE command.
3. Restore your data to its KEY or SLOT NUMBER order by issuing the SORT
command followed by the KEY parameter, for example:
SORT KEY.
sorts a data set into descending order, using field #6 as the first key and field
#3 as the second key.
Examples
v If you are not using a template:
SORT 23 36
Sorts all records on columns 23 to 36 in ascending order.
SORT 77 80 D NX
(Edit only.) Sorts not-excluded records on columns 77 to 80 in
descending order (as if excluded records did not exist).
SORT 77 80 D 23 36 3 21
Sorts all records on columns 77 to 80 (primary sort key) in descending
order, then on columns 23 to 36 (secondary sort key) in ascending order,
then on columns 3 to 21 (minor sort key) in ascending order.
SORT KEY
Restores the records in a KSDS, VRDS, or RRDS VSAM data set into
their original keyed sequence.
SORT KEY behaves differently for RRDS and KSDS files. For RRDS files
the VSAM slot value is used as the sort key while KSDS files use the
key field. If new records are added to an RRDS file they are allocated a
slot value such that they sort to the end of the file when SORT KEY is
performed. New records added to the KSDS are sorted on the new key
value and the new records sorted to the appropriate position within the
file.
v If you are using a template (TABL display format):
SORT #7 D #6 #3
Sorts all records on the field with field reference number 7 (primary sort
key) in descending order, then on the field with field reference number 6
(secondary sort key) in ascending order, then on the field with field
reference number 3 (minor sort key) in ascending order,
SORT #6 X
(Edit only.) Sorts all excluded records on the field with field reference
number 6 in ascending order (as if non-excluded records did not exist).
RELATED TOPICS
SORT primary command on page 817
For example, to search for the next occurrence of the string James in any mix of
uppercase and lowercase, enter the following on the Command line:
F JAMES
To find the same string as you specified on the previous FIND primary command,
specify an asterisk (*) as the search string.
To limit the search for a string to only where it appears as a prefix in the data,
specify the PREFIX parameter.
To limit the search for a string to only where it appears as a suffix in the data,
specify the SUFFIX parameter.
To limit the search for a string to only where it appears as a "word" in the data,
specify the WORD parameter.
For example, the following command finds instances of an alphanumeric field (#3)
containing the character 0 (such as 1060 HAY ST), and instances of a numeric
field (#5) whose formatted numeric value is zero:
FIND 0 ALL #3,#5
Notes:
1. To find long strings that do not fit on the Command line, use the FX command.
2. To find and replace strings in multiple data sets or data set members, use the
Find/Change Utility.
3. To find and change a string or numeric value, open your data set in an Edit
session, then use the CHANGE or CX primary command.
4. By default, in SNGL or TABL display formats, if you enter the CHANGE,
FIND, or EXCLUDE command without specifying any field references, File
Manager searches all the visible fields based on the template attributes for each
field. That is:
v For a field with alphanumeric field attributes, the command performs a
string comparison between the search string and the field being searched.
v For a field with numeric field attributes, the command interprets the search
string as a number, and performs a numeric comparison with the numeric
value of the field being searched.
5. If you want to prevent numeric comparisons from occurring, you can explicitly
mark the argument as character by using the C'string' format. For example, this
command finds only instances of alphanumeric fields containing the character
"0":
FIND c0 ALL #3,#5
RELATED TOPICS
Handling long strings in CHANGE on page 110
Finding and changing data in multiple PDS members on page 264
Finding and replacing strings on page 107
Setting column ranges on page 113
FIND/FX primary command on page 764
CHANGE/CX primary command on page 741
The Extended Command Entry pop-up panel contains five lines (each 50 characters
long) that you use to enter all the FIND command parameters (but not the actual
keyword FIND or any of its abbreviations). File Manager treats the five lines on
the pop-up panel as contiguous, allowing you to specify a long search string and
any other parameters, using up to 250 characters in total.
Note: You can continue a string (or any other parameter) from the last position on
one line of the pop-up panel to the first position of the next line. However,
this does not mean that you need to completely fill a line before using the
next line. For example, you can specify the search string on the first of the
five lines and the other parameters on the next line. If you are not
specifying a quoted string and you do not use all of a line, File Manager
treats the unused part of the line as a single space. When you specify a
string with quotes, any trailing blanks and any leading blanks in the next
line are retained.
Figure 38 shows the Extended Command Entry pop-up panel for the FIND
command. This example searches for all occurrences of the string
dichlorodiphenyltrichloroethane in field #3 for non-excluded records only.
Figure 38. Extended Command Entry pop-up panel for the FIND command
RELATED TOPICS
Handling long strings in CHANGE on page 110
Handling long strings in EXCLUDE on page 91
FIND/FX primary command on page 764
When you enter the FE command, File Manager positions the cursor at the
beginning of the field in error and, if necessary, automatically scrolls the data to
bring the field into view.
To move the cursor to the next field in error, either enter the FE command again,
or press the RFind function key (F5).
To find and change numeric fields flagged as being in error (all asterisks in the field
display) to a specific numeric value, use the CE primary command.
RELATED TOPICS
FE (Find Error) primary command on page 761
CE (Change Error) primary command on page 738
Limiting the effect of editing changes on page 111
Changing invalid numeric fields in your data on page 111
View panel on page 699
Editor panel on page 529
After you have excluded records, you can limit the effects of the FIND, FE,
SHADOW and SORT commands to only those records that are excluded or only
those that are not-excluded. You do this by including one of the following option
parameters with the primary command:
X or EX
Affects only excluded records
NX Affects only not-excluded records
For example, the following command finds all occurrences of the string no,
No, NO, or nO in all not-excluded records:
FIND NO ALL NX
Notes:
1. If neither parameter is used with the primary command, both excluded and
not-excluded records are affected.
2. If an excluded record is affected by a primary command, either by using the EX
parameter or by not specifying an EXCLUDE parameter, the record becomes
not-excluded.
RELATED TOPICS
EXCLUDE/XX primary command on page 756
RESET primary command on page 804
The Extended Command Entry pop-up panel contains five lines (each 50 characters
long) that you use to enter all the EXCLUDE command parameters (but not the
actual keyword EXCLUDE or any of its abbreviations). File Manager treats the five
lines on the pop-up panel as contiguous, allowing you to specify a long search
string and any other parameters, using up to 250 characters in total.
Note: You can continue a string (or any other parameter) from the last position on
one line of the pop-up panel to the first position of the next line. However,
this does not mean that you need to completely fill a line before using the
next line. For example, you can specify the search string on the first of the
five lines and the other parameters on the next line. If you are not
specifying a quoted string and you do not use all of a line, File Manager
treats the unused part of the line as a single space. When you specify a
string with quotes, any trailing blanks and any leading blanks in the next
line are retained.
Figure 39 shows the Extended Command Entry pop-up panel for the EXCLUDE
command. This example searches for all occurrences of the string
dichlorodiphenyltrichloroethane in field #3.
Figure 39. Extended Command Entry pop-up panel for the EXCLUDE command
RELATED TOPICS
Handling long strings in CHANGE on page 110
Handling long strings in FIND on page 88
EXCLUDE/XX primary command on page 756
Note: The use of VSAM SHAREOPTIONS 3 files for multiple users where the
file may be updated is not recommended as VSAM offers no methods for
data integrity for SHAREOPTION 3 files. For this reason, results with
such files may be considered unpredictable.
Features include:
v Ensuring that an update you are about to commit to does not overwrite another
user's update (Edit only). This is referred to as record integrity checking.
v Ability to refresh the contents of an individual record at any time.
v Refreshing a record before displaying it in SNGL display format.
v Saving an individual record, or range of records, while remaining in the current
Edit session.
v Performing periodic SAVEs of a file after a specified number of changes (Edit
only).
v While processing a CHANGE command with the ALL operand, performing
periodic SAVEs of a file.
v Retrying the CHANGE process for a record that, when being SAVEd, has been
updated by another user.
since the record was retrieved. File Manager performs this check by comparing the
contents of the record at the time that it retrieved it with the contents of the
current record as it exists on the file.
With a heavily shared file it is possible that, between the time the record was first
fetched from the file and the time that you issued a SAVE command (or a save was
automatically issued due to the value of the Autosave frequency option, see
Saving a file after a given number of updates (Autosave frequency option) on
page 99), another user updated the same record that you are trying to update.
When File Manager detects that a record has been changed by another user, it is
called an integrity check.
Note: In the case of the saving scenario where the value of the CHANGE ALL
autosave frequency option (see CHANGE ALL, automatic saving and
retry on page 100) has triggered a file-wide SAVE during the CHANGE
command process, File Manager only displays an integrity check panel if the
Auto retry for CHANGE ALL option (see page 100) is set to OFF.
File Manager Record Updated by other user
Command ===> Scroll CSR
Format CHAR
Between the time the record was retrieved and the time a save was issued,
another user has updated the record that you are attempting to update. The
records are shown below and changes highlighted.
Enter SAVE to save this record anyway.
Enter CONTINUE Save anyway and dont ask again for other records.
Enter CANCEL to skip this update.
Enter ABORT to skip this update and halt performing other updates.
Col 1
Offset Pending record contents: Record contents as on file:
<----+----1----+----2----+----3--> <----+----1----+----2----+----3-->
000000 00000001A This is my change AAAAAA | 00000001AAAAAAAA meanwhile, user 2
000034 AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | updated this record AAAAAAAAAAAAA
000068 AAAAAAAAAAAA | AAAAAAAAAAAA
Figure 40. Integrity check variation 1: (Update attempted but record updated by another user)
File Manager Record Deleted by other user
Command ===> Scroll CSR
Format CHAR
Between the time the record was retrieved and the time a save was issued,
another user has deleted the record that you are attempting to update. The
record you are updating is shown below.
Enter SAVE to save this record anyway.
Enter CONTINUE Save anyway and dont ask again for other records.
Enter CANCEL to skip this update.
Enter ABORT to skip this update and halt performing other updates.
Col 1
Offset Pending record contents: Record deleted
<----+----1----+----2----+----3-->
000000 00000001AAMaking a change to a rec |
000034 ord that someone else deleted AAAA |
000068 AAAAAAAAAAAA |
Figure 41. Integrity check variation 2: (Update attempted but record deleted by another user)
File Manager Record Updated by other user
Command ===> Scroll CSR
Format CHAR
Between the time the record was retrieved and the time a save was issued,
another user has updated the record that you are attempting to delete. The
records are shown below and changes highlighted.
Enter SAVE to save this record anyway.
Enter CONTINUE Save anyway and dont ask again for other records.
Enter CANCEL to skip this update.
Enter ABORT to skip this update and halt performing other updates.
Col 1
Offset Record deleted Record contents as on file:
<----+----1----+----2----+----3--> <----+----1----+----2----+----3-->
000000 00000001AAAAAAAAAAAAAAAAAAAAAAAAAA | 00000001AAA Another user happily u
000034 AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | pdates the record AAAAAAAAAAAAAAAA
000068 AAAAAAAAAAAA | AAAAAAAAAAAA
Figure 42. Integrity check variation 3: (Delete attempted but record updated by another user)
In each integrity check panel, you have four options that are selectable by tabbing
to the keyword and pressing Enter. The options are:
SAVE Ignores the other update and applies your update. Use this option when
you are sure that the record should be set the way you have indicated (or
deleted).
CONTINUE
Ignores the other update and applies your update. Use this when you are
sure that the record should be set the way you have indicated (or deleted).
By using CONTINUE, you are instructing File Manager to also
automatically SAVE any further records which encounter an integrity
check.
Cancel this individual update (PF12 or CANCEL command)
Ignores your update to an individual record element. If you are changing a
record, this leaves your changes in your session and marks the record
element as having an integrity check.
Abort this and any following updates (ABORT command)
Operates like the Cancel option, but halts the process of the current
command so that you can correct or inspect an individual condition. For
instance, if integrity checks occur during the End process of an Edit
session, and an integrity check panel is displayed, entering ABORT stops
the saving process and re-enters the Edit to allow you to inspect records
before ending your session again.
RELATED TOPICS
SAVE primary command on page 811
SV primary command on page 822
In multi-line display formats (CHAR, HEX, LHEX, TABL), File Manager places an
indicator (=ICHK>) in the prefix area as shown in Figure 43 on page 96.
In the SNGL display format, File Manager displays a message line as shown in
Figure 44.
v When you enter an edit session (expecting to be able to insert and delete) but
the dataset is shared, File Manager displays an informational message advising
you that the file is shared and that the edit is in inplace mode.
v When ENDing an edit session and an integrity check occurs, you decide not to
save, File Manager displays an informational message advising you that the edit
session was re-entered.
RELATED TOPICS
PROFILE primary command on page 797
For example, assume you are editing a file in SNGL display format as shown in
Figure 45.
Figure 45.
When you enter the RF line command or the RF primary command and press
Enter, File Manager displays the refreshed record (assuming, for this example, that
another user has updated the record) as shown in Figure 46 on page 98.
Figure 46.
When you are using multi-line display formats (CHAR, HEX, LHEX, TABL), you
can refresh the contents of a record with either the RF or RFF primary command,
or the RF prefix command.
Note: If you do have any pending changes for a record, when you refresh the
record those changes are discarded without further warning. This can be
useful however if, for example, you want to undo your changes to a specific
record, or refresh its contents when an integrity check has occurred when
attempting to save your change.
RELATED TOPICS
RF primary command on page 806
For example, if you use the NEXT command (PF11) followed by the PREVIOUS
command (PF10), then you will see any updates made by another user to the
original record you were viewing. (This is only true if you do not have any
pending changes for the record.)
RELATED TOPICS
NEXT primary command on page 789
PREVIOUS primary command on page 795
RELATED TOPICS
SV primary command on page 822
These options apply only when editing VSAM files that are being shared.
Autosave frequency
Command ===>
F1=Help F2=Split F3=Exit F4=CRetriev F7=Backward F8=Forward
F9=Swap F10=Actions F12=Cancel
You can access the VSAM Edit Sharing Options panel by the Options pull-down
menu, or by means of the menu options.
You can also disable or enable the Autosave frequency option, or specify a
frequency value, by using the AUTOSAVE primary command.
What counts as an update?: For the purposes of the Autosave frequency option,
the following are counted as one update:
Overtyping the contents of a record
Changing the contents of a record by overtyping, regardless of the number
of characters changed, is counted as a single change. If you press Enter
and then overtype your changed record again, this is counted as a second
change.
Using a prefix command that alters record data
A prefix command that alters data, such as ">" (the command for shift
right), is counted as a single change. Use of a prefix command is counted
as only one change, even if the command is used to alter multiple records.
The CHANGE or RCHANGE primary command
When you issue the CHANGE or RCHANGE primary command without
the ALL operand, the command counts as one change for each record it
actually changes.
RELATED TOPICS
CHANGE/CX primary command on page 741
RCHANGE primary command on page 798
In a similar way to the Autosave frequency option, these options allow the change
process to count the number of changes made and perform a periodic SAVE of the
file being changed. In addition, the Auto retry for CHANGE ALL option is useful
for retrying changes to records which encountered an integrity check at the time of
the automatic save during the CHANGE command process.
When you select the CHANGE ALL autosave frequency option, it is highly
recommended that you specify a frequency and also select the Auto retry for
CHANGE ALL option in order to gain the most benefit from these two features.
For the CHANGE ALL autosave frequency option, changes are counted for each
record that is changed.
You can also change the setting of the CHANGE ALL autosave frequency option
and the Auto retry for CHANGE ALL option with the CHGASAVE and
AUTORTRY primary commands respectively.
RELATED TOPICS
CHANGE/CX primary command on page 741
CHGASAVE primary command on page 747
AUTORTRY primary command on page 733
Editing techniques
When you attempt to edit a data set, File Manager examines your editing options,
data set type and size, and uses one of three main variations of editing technique.
Although these techniques should be virtually transparent to you, they are
explained here.
The type of edit taking place is visible during the editor session by a denotation in
the top left of the editor panel title line:
Edit Denotes a full edit (that is, including the ability to insert and delete
records, and the ability to copy and move records).
See:
v In-memory edit on page 102
v KSDS edit on page 103
Aux Edit
Denotes a full edit (that is, including the ability to insert and delete
records, and the ability to copy and move records) where File Manager is
making use of a secondary file to enable the edit.
See:
v Auxiliary edit on page 102
Inplace Edit
Denotes that records may only be updated in place, and that the ability to
insert or delete records is not available.
See:
v In-place-in-memory edit
v In-place edit
If you do not need to insert or delete records, you can improve the performance of
the Edit session (especially when working with large files) by selecting the Inplace
edit option. This avoids the associated delays of copying to and from an auxiliary
file.
Note: Unless the text in other sections of this chapter explicitly refers to one of
these editing techniques, the information in this chapter applies to all
editing techniques. Differences between In-memory, Auxiliary, and In-place
editing are highlighted where applicable.
In-place-in-memory edit
This type of In-place edit keeps as many of the records of the data set in virtual
storage as will comfortably fit (or as many as specified by a record limit). The data
set is updated from these records kept in storage when you enter a SAVE, END, or
FILE command.
When File Manager uses this editing technique, it displays "Inplace Edit" in the top
left of the editor panel title line.
In-place edit
This type of In-place edit only keeps records in storage that are currently displayed
or that have been modified. The data records are replaced in the data set from the
modified records kept in storage when you enter a SAVE, END, or FILE command.
When File Manager uses this editing technique, it displays "Inplace Edit" in the top
left of the editor panel title line.
The distinctive thing about both In-place edits, as the name is intended to convey,
is that records may only be updated in place. Inserts, deletes, and record length
changes are not possible. Note that for VSAM RRDS in In-place mode, the delete
and insert commands have a slightly different meaning than normal, in that slots
may be marked as empty by the delete command and made active again by the
insert command.
RELATED TOPICS
Editing large files on page 103
In-memory edit
With this type of edit, File Manager first tests the available TSO region size and, if
the region is large enough, reads the entire data set into memory before displaying
the first screen of data. This may cause a noticeable delay whilst loading, but
subsequent operations are quicker. As with any usage of large amounts of TSO
region, a large File Manager editor region can also have a noticeable effect on other
address spaces or cause excessive paging.
When File Manager uses this editing technique, it displays "Edit" in the top left of
the editor panel title line.
The data set is completely rewritten from the records kept in storage when you
enter a SAVE, FILE, or END command.
Auxiliary edit
Auxiliary edit copies the original data set to a secondary data set. Only records
currently being displayed or that have been modified (by change, delete, insert) are
kept in storage. File Manager recreates the original data set from the secondary
data set and the In-memory changes when you enter a FILE or END command.
The SAVE command is not supported when editing a data set using this method.
You must end the editor session and re-edit the data set.
When File Manager uses this editing technique, it displays "Aux Edit" in the top
left of the Edit panel title line.
File Manager uses Auxiliary edit when you have not selected Inplace edit, or you
selected to edit an HFS file, or you selected to edit an SMS-compressed data set,
and:
v There is insufficient TSO region for In-memory edit, or
v You have specified a starting position or record limit
The auxiliary data set created by File Manager uses your TSO ID as the prefix
High Level Qualifier. Your site may have its own standards and naming
conventions for these data sets which result in the assignment of different storage
categories (for example, classes, units, or privileges).
RELATED TOPICS
Editing large files
Editor Options panel on page 541
KSDS edit
A VSAM KSDS file has, by its nature, the ability to insert and delete records,
without requiring them to be in sequence (as they are sequenced by VSAM in their
key order). Hence applications intending to add, change, or remove records (such
as File Manager) do not need to keep the entire file contents available (in order to
rewrite the entire file) when saving changes. So, for KSDS files, File Manager only
keeps new, changed, or deleted records in storage (as well as those currently being
displayed). So it is possible for File Manager to edit a KSDS file of any size,
without needing to employ the auxiliary edit technique described earlier.
When File Manager uses this editing technique, it displays "Edit" in the top left of
the editor panel title line.
If you do not select Inplace edit on the editor entry panel and perform either of
these actions:
v You attempt to edit a QSAM data set or a VSAM ESDS or RRDS data set
defined with the REUSE attribute but it is too large to fit into available memory,
v You attempt to edit a QSAM data set or a VSAM ESDS or RRDS data set
defined with the REUSE attribute, and you specify a start position or record
limit
File Manager uses an auxiliary file in order to fulfill your request and issues
progress messages periodically during the pre and post edit copy process.
Note: Special authority may be required for this function, depending on the
installation options. For more information, see the File Manager Customization
Guide.
Changing data
When editing a data set, you can change the data:
v In individual records by overtyping the data within the record or by entering a
prefix command in the prefix area next to each row. This method is useful when
you need to make ad hoc changes to specific records.
v In multiple records by entering primary commands on the Command line. This
method is useful when you need to apply global changes or changes to groups
of records that have a common denominator.
The effects of these changes can be limited by using command parameters or by
applying limiting methods (see Limiting the effect of editing changes on page
111).
The tasks described in this section are:
Changing data in individual records
Change data in multiple records on page 105
Locating labeled records on page 106
Changing the case of data on page 106
Finding and replacing strings on page 107
For example, File Manager treats the following 8-character numeric field as
having the value, 30,123:
30123
but treats the following 8-character numeric field as having the value, 30:
30 123
4. Press Enter (or any function key except Help (F1) or Cancel (F12)).
Your changes are saved in memory but not written to the file, and the changed
record becomes highlighted. You can change more than one record at a time
before entering the changes. Your accumulated record changes are only written
to file when you issue a SAVE, FILE, END or EXIT command.
For more information about creating and using labels, see Labelling record
ranges on page 116. For more information about using the LOCATE command,
see Finding specific data on page 87.
The CAPS and CASE primary commands control whether data in the data area is
translated to uppercase on input (CAPS, CAPS ON or CASE UPPER), or left alone
(CASE, CASE MIXED or CAPS OFF. As already mentioned, the initial setting of
the "convert to uppercase" feature at the start of an editor session is determined by
whether the CAPS initially ON - translate changed data to uppercase (CAPS)
option on the Editor Options panel is selected or not.
The CASE UPPER, CAPS or CAPS ON commands are similar to the ISPF editor
CAPS command. If you enter any of these commands, or the CAPS initially ON -
translate changed data to uppercase (CAPS) option is selected (and no CAPS or
CASE commands have been used in the current File Manager session):
v If you overtype any data in a record, then:
In CHAR, HEX or LHEX display format, the entire record is translated to
uppercase.
In SNGL or TABL display format, only the current field is translated to
uppercase.
v The CHANGE command treats the new (replacement) string as if it were
specified in all uppercase except in these case:
The new string is enclosed in quotation marks, prefixed by the letter C (for
example, C'New String')
The new string is specified as a hexadecimal string (for example, X'C1C2C3')
If either of the above is true, then the new string is not translated to uppercase.
The CAPS OFF, CASE, and CASE MIXED commands have the same effect. If you
enter any of these commands, or the CAPS initially ON - translate changed data
to uppercase (CAPS) option is unselected (and no CAPS or CASE commands have
been used in the current editor session):
v Translation to uppercase is turned off.
Any CAPS command overrides any previously entered CASE command, and any
CASE command overrides any previously entered CAPS command.
Note: In the ISPF editor with CAPS ON, a line is considered changed if you type
anything on the line (if you overtype a space with a space, it is considered to
be a change). However, in a File Manager editor session, overtyping a
character with the same character is not considered a change.
You can change the case of existing data to uppercase or to lowercase, without
having to input new data, by using prefix commands.
Caution: These prefix commands (LC, LCn, LCC, UC, UCn, UCC) affect all
characters in a record, not just characters in those fields with an
alphanumeric or character data type. This means that numeric data, such
as binary data or packed decimal data, can be corrupted by using these
commands.
4. On the Command Line, enter the CHANGE command, together with any
desired parameters, and the search and replace strings. For example:
CHANGE black white
See CHANGE/CX primary command on page 741 for details about the
syntax and parameters of the CHANGE command.
The CHANGE command highlights all occurrences of the search string or
numeric value in the entire data set.
To turn off the highlighting, enter the RESET FIND command.
If the CHANGE command changes data, then File Manager places the cursor at
the start of the changed data; if necessary, automatically scrolling to bring the
data into view.
To change the next occurrence of the string, press the RChange function key
(F6).
To find the next occurrence of the string and optionally change it, use a
combination of the RFind function key (F5) and the RChange function key (F6).
To find the same string as you specified on the previous CHANGE primary
command, specify an asterisk (*) as the search string.
To use the same replacement string as you specified on the previous CHANGE
primary command, specify an asterisk (*) as the replacement string.
To limit the search for a string to only where it appears as a prefix in the data,
specify the PREFIX parameter.
To limit the search for a string to only where it appears as a suffix in the data,
specify the SUFFIX parameter.
To limit the search for a string to only where it appears as a "word" in the data,
specify the WORD parameter.
To change all occurrences of the string (except those in not-selected or
suppressed records), use the ALL parameter with the change command.
The CHANGE command does not affect not-selected or suppressed records that are
hidden or represented by shadow lines. To include these records in a CHANGE
command, you need to show them. For details, see SHOW primary command on
page 815.
The CHANGE command does affect records that have been hidden using the
EXCLUDE command, unless you have used the NX parameter. If a change affects
an excluded record, it becomes not-excluded. For more information on using the
EXCLUDE command or EX and NX parameters, see Excluding records on page
115, CHANGE/CX primary command on page 741 or EXCLUDE/XX primary
command on page 756.
If you have zoomed in on a record, then the CHANGE command affects only that
record. See Zooming in to see all of a record on page 75.
Otherwise, for fixed-length files, or where the type of edit prevents record length
changes:
If string2 is longer than string1, then the change only occurs if there are
enough EBCDIC blank characters (X'40') at the end of the record to
accommodate the difference in length. File Manager maintains the same
record length by dropping blanks from the end of the record.
If string2 is shorter than string1, then File Manager maintains the same record
length by padding the end of the record with blanks.
v If you use the CHANGE command in SNGL or TABL display format to change a
non-numeric field, the change is the same as the above fixed-length
considerations except it applies to a field rather than a record. When record
length changes are possible, and the field being affected by the change overlaps
the end of the underlying record, File Manager may expand the record as
required to complete the change request. This only occurs when the underlying
record is shorter than the record structure.
If you use the CHANGE command in SNGL or TABL display format to change a
numeric field, then the length of string1 and string2 are not significant. For
example, if field #2 is a numeric field, then the following CHANGE command is
allowed, because string1 and string2 are interpreted as numeric values:
CHANGE 107 2 #2
For more information on changing values in numeric fields, see Searching
numeric fields on page 87.
v If the argument is a DBCS string, only data between a shift-out and shift-in is
searched for a match. For example, a DBCS blank X0E40400F does not find two
consecutive blanks in non-DBCS data.
The exception to this rule is in TABL or SNGL format where the field is a
graphic field. Unformatted graphic fields are not treated as DBCS.
For details on limiting the columns, fields or records searched by the CHANGE
command, see Limiting the effect of editing changes on page 111.
Examples
v If you are not using a template:
CHANGE CAT DOG
When zoomed in, changes the next occurrence of CAT to DOG in
the current record only. Otherwise, changes the next occurrence of
CAT to DOG.
CHANGE YELLOW ORANGE ALL
When zoomed in, changes all occurrences of YELLOW to ORANGE
in the current record only. Otherwise, changes all occurrences of
YELLOW to ORANGE in all records.
v If you are using a template, and the data is displayed in SNGL or TABL format:
CHANGE BLACK WHITE (#4 #7)
In TABL format, changes the next occurrence of BLACK to WHITE,
where BLACK is completely contained within either of the fields
represented by field references 4 and 7. In SNGL format, changes the
next occurrence of BLACK to WHITE, where BLACK is
completely contained within either of the fields represented by field
references 4 and 7, in the current record only.
CHANGE BLACK WHITE ALL #2,#8
In TABL format, changes all occurrences of BLACK to WHITE,
where BLACK is completely contained within either of the fields
Chapter 3. Viewing and changing data sets 109
Changing data
The Extended Command Entry pop-up panel contains five lines (each 50 characters
long) that you use to enter all the CHANGE command parameters (but not the
actual keyword CHANGE or any of its abbreviations). File Manager treats the five
lines on the pop-up panel as contiguous, allowing you to specify long from and
to strings and any other parameters, using up to 250 characters in total.
Note: You can continue a string (or any other parameter) from the last position on
one line of the pop-up panel to the first position of the next line. However,
this does not mean that you need to completely fill a line before using the
next line. For example, you can specify the from string on the first of the
five lines, the to string on the next line, and the other parameters on the
next line. If you are not specifying a quoted string and you do not use all of
a line, File Manager treats the unused part of the line as a single space.
When you specify a string with quotes, any trailing blanks and any leading
blanks in the next line are retained.
Figure 48 on page 111 shows the Extended Command Entry pop-up panel for the
CHANGE command. In this example, all occurrences of the string
dichlorodiphenyltrichloroethane in field #3 are to be changed to the string
trinitrophenylmethylnitramine for non-excluded records only.
Figure 48. Extended Command Entry pop-up panel for the CHANGE command
RELATED TOPICS
Handling long strings in EXCLUDE on page 91
Handling long strings in FIND on page 88
CHANGE/CX primary command on page 741
The find argument for the CE command is assumed to be a numeric field in error.
When a numeric field in error is found, it changes the field to the string specified
in the CE command. The specified string must, of course, be a valid numeric value.
To change the next field in error (to the same value), either enter the CE command
again, or press the RChange function key (F6).
To just find numeric fields flagged as being in error (without changing them), use
the FE primary command.
RELATED TOPICS
CE (Change Error) primary command on page 738
FE (Find Error) primary command on page 761
Limiting the effect of editing changes
Editor panel on page 529
additional methods that you can use to limit the effect of primary commands to
only those records that you want to change.
Notes:
1. SNGL and TABL display formats only.
Setting bounds
In CHAR, HEX and LHEX display formats, you can limit the columns that are
searched by the CHANGE, EXCLUDE and FIND commands by setting left and
right bounds. There are two methods of setting these bounds.
Method 1:
1. On the Command line, enter
BOUNDS col1 col2
(see BOUNDS primary command on page 735 for information about the
parameters of the BOUNDS command).
Note: This method is very quick but does not give you any visual feedback as to
where the boundaries lie.
Method 2:
1. In the prefix area of any record, enter BND.
A new row is inserted into the display, showing a left angle bracket (<) and, if
previously set, a right angle bracket (>).
File Manager Edit USERID.FMDATA(DATA1)
Col 1 Insert length 7996 Format CHAR
----+----1----+----2----+----3----+----4----+----5----+----6----+----7-
000025 02Tyrone Dallas Developer 92 Smith Street Belmont
BND < >
000026 02Rod Turnbull Manager 184 Alexander Dve Swan View
If no bounds have previously been set, the left bracket appears in the first
column of your records. If bounds have already been set, the left and right
brackets appear in their pre-set columns.
2. Change the bracket positions to suit your needs, by overtyping existing
brackets and typing in a left and, optionally, a right bracket.
3. Press Enter or use a function key to scroll through your data. The bounds are
updated.
Note: You can display as many bounds lines as you want, which allows you to
insert them at convenient locations while you are editing. When the Enter
key is pressed, the most recently changed bounds line is processed to reset
the boundaries. If you change more than one bounds line before pressing
Enter, the lowermost of the changed bounds lines is processed.
Regardless of which method you used to set the bounds, you can reset the bounds
to their default by entering the BOUNDS command without any parameters
(equivalent to BOUNDS 1 max_record_length).
To remove a bounds line from the display, enter D in the prefix area of the line. To
remove all bounds lines from the display, enter RESET in the Command line.
Note: Removing the bounds lines from the display does not remove the actual
bounds.
Note: When you specify a column range, all fields in the record data are searched
as if they were character fields. For numeric fields, this can cause
unexpected results.
If the second column that you specify is larger than the record size, then the record
size is used. If you specify a single column, then the character string must start in
the specified column.
RELATED TOPICS
Finding specific data on page 87
You specify the fields to be searched using #n field references. These are displayed
above each field in TABL display format, or next to each field in SNGL display
format. The search string is found only if it is completely contained within one of
the specified fields.
The search string is found if it is completely contained within one of the specified
fields. For example, the following command excludes all records containing the
characters the (in any mix of uppercase and lowercase) in field #5:
EXCLUDE ALL the #5
The following command finds the next record containing an uppercase letter A in
field #8 or #9:
FIND CA #8,#9
Fields that are items of a multi-dimensional array share the same field reference
number, but are differentiated by the dimension, using a subscript. For example,
given the following field references (shown in TABL display format):
(1,1) (1,2) (1,3) (2,1) (2,2) (3,2)
#9 #9 #9 #9 #9 #9
Excluding records
You can limit the records affected by the FIND, CHANGE and DELETE
commands, first by excluding some records from display, then by limiting those
commands to affecting only the not-excluded records, or only the excluded records.
After you have excluded records, you can limit the effects of the FIND, CHANGE
and DELETE commands to only those records that are excluded or only those that
are not-excluded. You do this by including one of the following option parameters
with the primary command:
X or EX
Search only excluded records
NX Search only not-excluded records
For example, the following command changes all occurrences of the string no,
NO or nO to No in all not-excluded records:
CHANGE NO CNo ALL NX
Notes:
1. If neither parameter is used with the primary command, both excluded and
not-excluded records are affected.
2. If an excluded record is affected by a primary command, either by using the EX
parameter or by not specifying an EXCLUDE parameter, the record becomes
not-excluded.
Regardless of the order in which you specify the two labels, the label
representing the smaller relative line number is used as the start of the range
and the label representing the larger relative line number is used as the end of
the range.
Your cursor is positioned on the first instance that occurs within the range.
Notes:
1. When using FIND or CHANGE, all instances of your search string are
highlighted, however, only those instances within the range are affected by the
command or by the RFIND (F5) and RCHANGE (F6) commands.
2. Once assigned, a label stays with the record, even if the record is moved.
3. A label is removed when the record containing the label is deleted.
4. Overtyping a label with a prefix command does not remove the label. When
the command is complete, the record label reappears.
5. You can move a label to another record by typing the same label on a new
record.
6. If the range you specify includes not-selected or suppressed records that are
hidden from display or represented by shadow lines, then those records are not
affected by the CHANGE, DELETE, EXCLUDE or FIND command.
7. If the range you specify includes excluded records and you either use the EX
parameter or do not specify an EXCLUDE parameter, the records are affected
by the primary command. If an excluded record is affected by a primary
command, the record becomes not-excluded.
In the following example, the label .HERE is assigned to record number 16 and the
label .THRE is assigned to record number 129:
.
.
.
00015 This is a data record.
.HERE This is a data record with a label.
00017
. This is a data record.
.
.
00128 This is a data record.
.THRE This is a data record with a label.
00130
. This is a data record.
.
.
Editor-assigned labels
Some labels are automatically assigned and maintained by the editor. These special
labels begin with the letter Z. (Your own labels, therefore, must not start with a
Z.) Unlike other labels, these editor-assigned labels do not necessarily stay with
the same record, but instead represent logical positions on the display. You can use
the following editor-assigned labels:
.ZCSR To the record on which the cursor is currently positioned.
To use this label:
1. Type the command and labels on the Command line but do not press
Enter.
2. Position your cursor anywhere in the record that you want to use as
the current position.
3. Press Enter. All records that lie between your cursor position and the
other label are included in the range, regardless of the order in the
labels occur in the data set or in which you specify the labels.
.ZFST To the first record (relative record number 1). This can be abbreviated to
.ZF.
.ZLST To the last record. This can be abbreviated to .ZL.
The following command changes the first occurrence of the string xxx in the range
of records from the current cursor position to the end of data:
CHANGE xxx yyy .ZCSR .ZLST
Note: Many of these actions are performed using prefix commands. Generally, you
need to type over only the first 1 or 2 characters of the line number to enter
a prefix command. Sometimes, however, typing a single character can be
ambiguous. In the following example, it is unclear whether the intended
prefix command is R to repeat line 31700, or R3 to repeat the line three
times, R31 to repeat the line 31 times or R317 to repeat the line 317 times:
031600
R31700
031800
In such cases, the editor assumes that you have not typed a number
following the prefix command. If you want to repeat the line three times,
you can type one or more blanks following the R3.
R3 700
Inserting records
When the display format is set to CHAR, HEX, LHEX or TABL formats, you can
insert new records into the data set. You cannot insert new records when the
display format is SNGL.
Note: The inserted records are not saved to the file until a SAVE, FILE, END or
EXIT command is issued.
Deleting records
You can delete records when in any display format, by using the DELETE primary
command. This allows you to delete all the records in a data set or to delete
multiple records based upon the following common factors:
v All excluded or not-excluded records (see Excluding records on page 115).
v All records that fall within a range specified by labels (see Labelling record
ranges on page 116).
v All excluded or not-excluded records that fall within a labeled range.
Examples
The following command deletes the next not-excluded record in the range of
records from the label .LABA to the label .LABB:
DELETE NX .LABA .LABB
In CHAR, HEX, LHEX or TABL display formats, you can also delete records by
using the D prefix command. Using the prefix command allows you to delete
individually selected records or blocks of records that have no other common
factor.
Note: The deletion of these records is not saved to file until a SAVE, FILE, END or
EXIT command is issued. You can recover these deleted records, before
ending your editing session, by using the RECOVER primary command.
Records are stored in the buffer in the order in which they were removed, so that
the command RECOVER 1 restores the last record to be deleted, RECOVER 2 restores
the last two records to be deleted, and so on. Recovered records are inserted after
the first record visible at the top of the data area. If the first visible line is ******
**** Top of data ****, the records are inserted at the beginning of the data set.
Inserted records appear in the order in which they were deleted.
For example, if records 1, 5 and 7 were deleted from the data set in that order, the
command RECOVER 1 would restore record 7, but RECOVER 3 would restore records
1, 5 and 7 in that order (not as 7, 5, 1).
Recovering a record removes it from the buffer. If you delete the recovered record,
before saving the first recovery, you cannot recover it a second time. This can lead
to loss of data. To prevent data loss, issue the SAVE command after each
RECOVER command.
Note: When using an auxiliary edit, in order to minimize the recovery buffer
usage and allow for many records to be deleted, only the ten latest deleted
records are kept in the recovery buffer.
Moving records
You can rearrange the display of your records by moving them up or down in the
data set. For record types other than KSDS, the new sequence of the records is
stored when you save the data set. In a KSDS, moving records while editing
120 File Manager for z/OS V12R1 User's Guide
Editing records within data sets
changes the displayed position of records, but has no effect on the stored data set.
For this reason, the Move prefix commands as described in the following are not
available for a KSDS. If you want to change the order of records in a KSDS, you
must change the key values.
Note: When you move records with the M, Mn, or MM prefix commands, instead
of moving the data after or before other records, you can choose to overlay
the moved records on existing records in the data set you are editing. For
details, see Overlaying data in existing records on page 122.
Note: When you copy records with the C, Cn, or CC prefix commands, instead of
copying the data after or before other records, you can choose to overlay the
copied records on existing records in the data set you are editing. For
details, see Overlaying data in existing records on page 122.
To repeat records:
1. Position your cursor in the prefix area of the first record that you wish to
repeat.
2. Type the R or Rn prefix command, where n represents the number of records to
be repeated, or type RR on the first of a block of records to be repeated and RR
in the prefix area of the last record in the block.
3. Press Enter. The copied records are inserted immediately below the last record
selected for repeating.
The data that is copied or moved overlays blanks in the destination records. This
allows you to rearrange a single-column list of items into multiple column, or
tabular, format.
Only blank characters in the records specified with O or OO are overlaid with
characters in the corresponding columns from the source records. Characters that
are not blank are not overlaid. The overlap affects only those characters within the
current column boundaries.
The number of source and receiving records need not be the same. If there are
more receiving records, the source records are repeated until the receiving records
are gone. If there are more source records than receiving records, the extra source
records are ignored. The overlay operation involves only data records. Special lines
such as BNDS and COLS are ignored as either source or receiving lines.
Figure 49 illustrates the O (overlay) prefix command. Suppose you were editing a
list in a single left-adjusted column and wanted to place portions of the list
side-by-side. First, using the ) (column shift right) command, shift a portion of the
list the appropriate amount to the right to overlay in a multiple column format.
Next, type MM in the prefix area to mark the beginning and end of the block of
records you want to move, then type OO in the prefix area to mark the destination
of the records you want to overlay.
When you press Enter, the editor overlays the records you marked to move on the
destination block. See Figure 50.
RELATED TOPICS
Editor panel on page 529
View panel on page 699
If you do not specify a range, all edit session data is copied to the clipboard.
You can use the X or NX operands to copy only excluded or non-excluded data
within the range to the clipboard. The default is both excluded and non-excluded
data.
Suppressed and not-selected sets are not copied to the clipboard. To include the
data referenced by those sets, first expose the sets by issuing the appropriate
SHOW command.
To replace the contents of the clipboard, use the REPLACE operand. This is the
default.
To add to the existing contents of the clipboard, use the APPEND operand.
If you do not specify a clipboard name on the command, File Manager saves the
data to the clipboard, DEFAULT.
When running under ISPF, clipboards created by File Manager can be accessed by
ISPF. Similarly, when running File Manager, clipboards created when running
under ISPF can be accessed by File Manager.
To view or edit an existing clipboard, issue the command CUT DISPLAY to display
the Clipboard Manager panel. This panel lists all the current clipboards.
If records in the clipboard are longer than the record length of the data set being
edited, the records are truncated.
Use the A or B prefix commands, or AFTER or BEFORE with a label, to specify the
destination of the records.
If you specified a name of a clipboard with the CUT command, you must use that
name on the PASTE command to retrieve the contents of that clipboard.
To empty the clipboard after the PASTE completes, use the DELETE keyword.
To copy the records from the clipboard (instead of moving them), use the KEEP
keyword.
RELATED TOPICS
CUT primary command on page 750
PASTE primary command on page 793
Clipboard Manager panel on page 464
Use the A (after) or B (before) line commands, or the AFTER or BEFORE keyword
with a label, to specify where the data is to be copied.
If you specify a member name as part of the COPY primary command, and you
have properly specified the "after" or "before" destination, the entire member or a
range of records in the member are copied in immediately.
Examples:
COPY memnam
Copies in entire contents of member memnam.
COPY (memnam) 2 10
Copies in lines 2 to 10 of member memnam.
You can specify a partially qualified or fully qualified data set name as part of the
command. This can be a data set or another partitioned data set.
Examples:
COPY seqds
Copies in entire contents of sequential data set seqds.
COPY userid.seqds
Copies in entire contents of sequential data set userid.seqds.
COPY pds(mem)
Copies in entire contents of member mem within partitioned data set pds.
COPY pds(mem) 6 10
Member list is displayed. Copies in lines 6 to 10 of member mem within
partitioned data set pds.
If you enter the COPY command without specifying a member name or a data set
name, after you have specified a destination and pressed Enter, File Manager
displays the Edit/View - Copy panel.
Example:
COPY AFTER .HERE
Displays the Edit/View - Copy panel.
The Edit/View - Copy panel allows you to enter the name of a data set or PDS
(and member) containing the data you want to copy. If you do not want to copy
the entire contents, you can specify the numbers of the first and last records to be
copied.
RELATED TOPICS
COPY primary command on page 748
Edit/View - Copy panel on page 540
Note: You cannot split or join a record when in SNGL or TABL display format, or
when zoomed in on a record.
For example, when the following record is split at the cursor position (underlined
character):
When you join two records, the text from the second record is combined with the
first record, overlaying the first record starting at the cursor position.
For example, when the following records (length=50) are joined at the cursor
position (underlined character):
----+----1----+----2----+----3----+----4----+----5
000000 **** Top of data ****
000001 aaaaaaaaaaaaaaaaaaaaaaaaa
000002 bbbbbbbbbbbbbbbbbbbbbbbbb
000003 cccccccccccccccccccccccccccccccccccccccccccccccccc
000004 **** End of data ****
To avoid the danger of unintentionally overlaying data in the first record, you can
use the SPLTJOIN command, which can be abbreviated to SJ. This command splits
or joins records depending upon the cursor position within a record. If the cursor
is after the last non-blank character in a record, the command performs a join. If
not, it splits the record.
Note: You may want to assign the SJ command to a function key, using the KEYS
command (see the ISPF User Guide Volume 1 for information on how to
assign commands to function keys).
Note: If you increase the record length, the new bytes added to the record are
blanks.
RELATED TOPICS
Displaying the record length on page 77
RECLEN primary command on page 800
Zooming in to see all of a record on page 75
Editor Options panel on page 541
In-place edit on page 101
Records that do not belong to a record type in the template are indicated
as not selected when viewing or editing, and are excluded when
comparing, copying1 or printing.
Record selection criteria
Determines which records, having been identified as belonging to a record
type, are to be selected.
Records that do not match the record selection criteria are indicated as not
selected when viewing or editing, and are excluded when comparing,
copying1 or printing.
Records that are not selected may not be included in the editor session,
depending on the setting of the Include only selected records option.
Furthermore, if the template describes segmented data, the record selection
criteria affects the selection of the entire physical record. When this occurs,
none of the segments belonging to the physical record are provided in an
editor session and they are excluded when comparing, copying, or
printing.
Field selection
Determines which fields are displayed (when viewing or editing) or
printed. This information is ignored when comparing, copying or creating
data sets.
When copying, if you want to exclude some fields in the input data set
from being copied to the output data set, then you need to create a To
copybook or dynamic template without those fields.
When comparing, if you want to exclude fields from the comparison, you
need to create an Old and a New copybook or dynamic template and
then remove the default field mapping for the fields to be excluded.
Field sequence
Overrides the default order in which fields are displayed (when viewing or
editing) or printed. By default, fields are displayed or printed in the order
in which they were defined in the copybook. This information is ignored
when comparing, copying or creating data sets.
When copying, if you want to change the order of fields in the input data
set and the output data set, then you need to create a To copybook or
dynamic template with the fields in the desired order.
Key sequence
Determines the sequence of fields to be included in a multi-segment key,
which can be used when performing a file comparison with keyed
synchronization.
Field headings
Overrides the default field headings when viewing, editing, comparing or
printing. (The default field headings are the field names defined in the
copybook.)
Field attributes
The field name, data type, starting column and length, as defined in the
dynamic template or in the copybook on which a template is based. These
attributes are fixed in a copybook template, as they are determined by the
underlying copybooks, but can be edited in a dynamic template.
If you make minor changes to field attributes in a copybook, you can (with
some restrictions) update the template generated from it, while keeping all
of the other existing information in the template.
RELATED TOPICS
Copying data sets on page 247
Comparing data sets using templates on page 278
Managing templates with the Template Workbench on page 169
The copybook template combines the layout information provided by the source
definition with additional information supplied by the user pertaining to
formatting, reformatting, record selection and data creation, to produce a logical
view of the data on which these functions can be performed.
In a copybook template, the field definitions (start position, length and type) are
not editable. However, copybook templates allow you to define a number of
different formats for use with data sets that contain multiple record types. Records
can be identified by type within a data set and each type can be associated with a
different format. This allows you to view data with different types at the same
time, and to view, edit or copy these records simultaneously. Copybook templates
also allow criteria editing by field or by a free format REXX selection expression.
To create a new copybook template, you begin with one or more copybooks
containing field definitions that describe the record structure of your data. When
you specify the copybook (or copybooks) on a panel, File Manager compiles the
descriptions into a template that you can save and reuse with any application data
set that has the same record structure.
In a COBOL copybook, each level-01 group item describes a record type in the
application data set. The elementary items in the group describe fields in the
record type. For example, the following copybook describes the record structure of
an application data set that contains two record types, ORDERS and ITEM:
01 ORDERS.
05 ORDER-ID PIC X(5).
05 CUSTOMER-ID PIC X(5).
05 ORDER-DATE.
10 ORDER-YEAR PIC 9(4).
10 ORDER-MONTH PIC 9(2).
10 ORDER-DAY PIC 9(2).
01 ITEM.
05 PRODUCT-ID PIC X(9).
05 QUANTITY PIC 9(4) BINARY.
05 UNIT-COST PIC 9(8) BINARY.
PL/I copybooks are similar to COBOL copybooks, in that the major structures
(level-1 names) describe record types and elementary names describe fields:
DECLARE 1 ORDER,
2 ORDERID CHAR(9),
2 CUSTOMERID CHAR(5),
2 ORDERDATE,
3 ORDERYEAR CHAR(4),
3 ORDERMONTH CHAR(2),
3 ORDERDAY CHAR(2);
DECLARE 1 ITEM,
2 PRODUCTID CHAR(9),
2 QUANTITY BIN(15),
2 UNITCOST BIN(31);
HLASM copybooks are similar to COBOL copybooks, in that the major structures
(DSECT names) describe record types and elementary names describe fields:
ORDER DESCT
ORDERID DS CL9
CUSTOMERID DS CL5
ORDERDATE DS 0CL8
ORDERYEAR DS CL4
ORDERMONTH DS CL2
ORDERDAY DS CL2
ITEM DESCT
PRODUCTID DS CL9
QUANTITY DS H
UNITCOST DS F
For information about coding copybooks, see the IBM COBOL Language Reference,
IBM VisualAge PL/I Language Reference, or the HLASM V1R5 Language Reference.
RELATED TOPICS
Specifying or updating the source definition for a copybook template on page
148
Advanced copybook selection on page 149
Set Language and Compiler Specifications (option 0.5) on page 650
Compiler Language Selection panel on page 465
Figure 51 on page 134 shows a simple example of segmented records, seen without
using a template:
----+----1----+----2----+----3----+----4----+----5----+
**** Top of data ****
01FINAccountant 020654John Browning 1875
01FINPurchasing Officer 021759Frederick Smith 1893
01FINAccounts Receivable 024163Annette Fielding 1856
01MKTSales Representative026584Jessica Simpson 1862
01MKTPromotions Manager 023579Catherine Jones 1812
01MKTMarket Research 021239Alan Johnson 1814
01ADMChief Executive 020124David Arrowsmith1801
01ADMSecretary/PA 024781Maryanne Davies 1802
01ADMReceptionist 026329Lizette Wilson 1800
01ADMClerical Officer 023571Stephen Hughes 1806
**** End of data ****
Figure 52 shows the copybook definitions needed to define each record segment:
----+----1----+----2----+----3----+----4----+----5
**** Top of data ****
01 DEPT.
03 Rec-Type PIC XX.
03 Dept-ID PIC XXX.
03 Job-Desc PIC X(20).
01 EMPLOYEE.
03 Rec-Type PIC XX.
03 Emp-ID PIC 9999.
03 Given-Name PIC X(10).
03 Family-Name PIC X(10).
03 Extension PIC 9999.
**** End of data ****
Figure 53 on page 135 shows the DEPT. records in TABL format, after a segmented
data template (generated from the copybook) has been applied.
Figure 53. TABL view of segmented data with the DEPT Record Type selected.
Note: Segmented data templates cannot be used for ISPF Packed data sets.
RELATED TOPICS
A dynamic template can only contain one record layout. All fields defined are
treated as Level 2 elementary items, with File Manager generating the Level 1
group item for the record. The generated Level 1 has a calculated record length,
determined by the rightmost byte referenced by the field definitions. Record
selection must be specified by field - you cannot specify a free format selection
expression for a dynamic template.
RELATED TOPICS
Creating dynamic templates on page 154
File Manager supports all data item level numbers except 88 (condition-names).
The literal value that you specify in a VALUE clause is used in the template to
specify the Start value (for numeric fields) or Pattern (for alphanumeric fields)
create attribute on the Field Attributes panel for that field.
File Manager uses this attribute to initialize the value of the field when creating
data or inserting new fields when copying data.
Note: A zero extent is not allowed for a PL/I dimension. If a bound is not
specified PL/I assumes a value of 1.
v REFER variable to declare the length of a string variable, character (AN),
varying-length character (VC) or zero-terminated character string (ZC) in bytes.
v File Manager also supports PL/I double-byte character variables (DB),
varying-length double-byte character (VD) and zero-terminated double-byte
characters (Z2) as byte pairs. File Manager also supports bit strings (BT) and
varying bit string (VB) variables.
v REFER variables can be declared as integer, fixed binary, packed decimal,
floating point, or character string variables.
v UNION declarations at any level which can have varying-length (REFER string
length or REFER array extents).
Note: UNIONS can contain overlays of different data types, which may require
template workbench record selection criteria or SHOW control if data is
not displayable.
appear in the record prior to the first variable-length array item, or, in the case
of PL/I REFER length, prior to the first string declared with a REFER length.
v If any of the following are true:
(COBOL copybook only.) The object is out of the range specified by the ODO
clause.
The actual record length does not match the calculated length of a record
with the number of array items specified by the object.
(PL/I copybook only.) The record length does not match the calculated length
of a record based on both string length REFERs and number of dimension
extents calculated from the lower and upper bound REFERS for each
dimension of an array.
When editing the data set, the prefix area contains the description =LGTH,
indicating that the record was not selected because of invalid length. (To
show these records, rather than hiding them with other not selected
records, select the Length error option on the Edit/Browse Options (option
0.8) panel.)
v In SNGL or TABL display format:
You can change the length of a record by changing the value of an object
field. This is an exception to the rule that the length of a record cannot be
altered in an Edit session, without using ZOOM.
When you change the value of an object field, then the number of items in
the array expands or contracts automatically.
New items are inserted at the end of the current array (and before any fields
that follow the array); numeric items are initialized to zero and alphanumeric
items are initialized to blanks.
Similarly, items are deleted from the end of the array, and any fields
subsequent to the end of the array are not affected.
For PL/I, the number of items in an array is determined by subtracting the
lower bound of the dimension attribute from the upper bound and then
adding one. If any REFER variables (fields) are specified as a lower or upper
bound of an array dimension, then changing the value of any REFER object
field inserts or deletes array items accordingly. For the TABL Format, if the
new number of array items exceeds the current number of TABL columns for
the array, File Manager expands the number of columns in the display and
adds new column headings. Similarly, if a PL/I string length REFER is
changed, the column width in TABL for each variable using that REFER is
changed.
(COBOL copybook only.) File Manager does not allow you to change the
object field to a value outside the range specified by the ODO clause (File
Manager supports an ODO lower value of 0.)
(COBOL copybook only.) Inserting a new record results in a record with the
minimum number of array items specified by the ODO definition. For
example, given the following ODO clause:
ODO-ONE OCCURS 0 TO 10 TIMES DEPENDING ON ODO-CNTRL-ONE.
then, when you insert a new record, the ODO-CNTRL-ONE field is initialized
to zero, and there are no ODO-ONE array items in the new record.
Given the following ODO clause:
ODO-ONE OCCURS 5 TO 7 TIMES DEPENDING ON ODO-CNTRL-ONE.
then ODO-CNTRL-ONE is initialized to 5, and there are five ODO-ONE array
items in the new record.
(PL/I copybook only.) Inserting a new record using a template that contains
REFER specifications results in one element for each array dimension. Upper
and lower bound REFER values are set to one.
v In CHAR, HEX or LHEX display format, changing the value of an object field
does not change the record length. In these display formats, changing the value
of an object field can result in a mismatch between the object field value and the
calculated length of the record with that many array items.
If you select Expose (do not group) records of types: Length error on the
Edit/Browse Options (option 0.8) panel then, in Edit (option 2), such records
appear with an =LGTH indicator in their prefix area.
The separated len fields created by File Manager for varying strings do not need
creation attributes, as the data content determines the len value.
In Edit mode, the data string field maximum display width is divided into
unprotected characters, up to and including the current length, and a protected
area beyond the current length in a non-display mode. VD strings require two
character positions for each double-byte value declared for the string, and two
character positions for each current length value that is unprotected. BIT strings
require one character position in the Edit panel for each bit value in the string.
Character positions beyond the current string length are in protected non-display
mode for VD and VB types.
The maximum string length for these string types can be declared as a constant or
as varying by specifying a REFER variable name that is present in the structure. If
declared with a REFER variable for maximum string length, then each record can
have different starting positions and data string display widths for that field and
any following fields. REFER variables may also be present in the structure to
define the bounds or extents of variables declared as dimensioned arrays.
Editing rules for PL/I varying length zero terminated string types
Character or Graphic data types with the PL/I VARYINGZ attribute (FM types ZC
and Z2) are shown in the Edit panels with one or two display characters added to
the end of the declared length. These screen positions contain X'00' or X'0000' when
the current length of the string is equal to the maximum declared length. The extra
positions are protected from data entry by File Manager.
RELATED TOPICS
Setting your HLASM processing options on page 145
produces:
Ref Field Name Picture Type Start End Length
**** Top of data ****
1 1 REC_TYPE01 AN 1 7 7
2 2 FIELD1 F,H,CL1 AN 1 7 7
3 3 FIELD1_O1 BI 1 4 4
4 3 FIELD1_O2 BI 5 6 2
5 3 FIELD1_O3 AN 7 7 1
**** End of data ****
Multiple values
If a DS or DC operand has multiple values associated with it, then a group
field is defined with child elements for each value with the suffix of "_Vn"
where n is the relative number of the value.
For example:
REC_TYPE01 DSECT
FIELD1 DS F1,2,3,H,CL1
produces:
Ref Field Name Picture Type Start End Length
**** Top of data ****
1 1 REC_TYPE01 AN 1 15 15
2 2 FIELD1 F1,2,3,H,CL1 AN 1 15 15
3 3 FIELD1_O1 AN 1 12 12
4 4 FIELD1_O1_V1 BI 1 4 4
5 4 FIELD1_O1_V2 BI 5 8 4
6 4 FIELD1_O1_V3 BI 9 12 4
7 3 FIELD1_O2 BI 13 14 2
8 3 FIELD1_O3 AN 15 15 1
**** End of data ****
Duplication factor
If a DS or DC operand has a duplication factor greater than 1, then the
resultant field is treated as a single dimensioned field that occurs the
number of times specified by the duplication factor.
For example:
REC_TYPE01 DSECT
FIELD1 DS 5F
produces:
Ref Field Name Picture Type Start End Length
**** Top of data ****
1 1 REC_TYPE01 AN 1 20 20
2 2 FIELD1(5) F BI 1 4 4
**** End of data ****
produces:
Ref Field Name Picture Type Start End Length
**** Top of data ****
1 1 REC_TYPE01 AN 1 1 1
2 2 FIELD1 AL.5 BT 1 1 1
**** End of data ****
prefix command enables you to interpret the ORG fieldname in the same
manner as a COBOL redefines or PL/I union statement.
Managing templates
You can create or edit a copybook template or a dynamic template "on the fly",
from any of the following panels:
v View Entry
v Edit Entry
v Utilities/Data Create
v Utilities/Print
v Utilities/Copy (From and To panels)
v Utilities/Compare (Old and New panels)
You can also create, edit and otherwise manage your templates, independently of
any particular task, within the Template Workbench.
You can customize the way that File Manager compiles templates by changing
your template processing options. You are able to choose whether File Manager
detects the programming language that you are using in your copybooks and then
automatically selects the appropriate compiler, or whether you want to force File
Manager to always use one type of compiler. You can also set the processing
options for the COBOL, HLASM, and PL/I compilers.
If you are creating a new template from an existing template model (using the CM
command on the Template Workbench (option 7) panel), File Manager does not
perform a compilation.
When you specify a copybook in a panel, batch job, REXX procedure or other
function, File Manager:
1. Checks whether the copybook is a complete source program , or contains only
field definitions.
If the copybook is not a complete program, then File Manager includes the
copybook in a shell program.
2. Invokes the compiler to check the syntax of the copybook, and to produce an
ADATA file.
RELATED TOPICS
Compiler Language Selection panel on page 465
Selecting your compiler language
Overriding Compiler Options on page 147
If the copybook does not contain any keywords that File Manager can
use to determine the language, then File Manager uses the COBOL
compiler.
If the compiler creates ADATA and produces a return code of less than
or equal to the Maximum Return Code specified in the compiler
processing options, then File Manager creates the template without any
prompting.
If the compiler creates ADATA but produces a return code greater than
the specified maximum, then File Manager displays a pop-up menu
where you can choose from various options, including using the other
compiler.
If no ADATA was created, then File Manager uses the other compiler
without prompting.
If the other compiler creates ADATA but the return code is greater than
the specified, then File Manager displays the pop-up menu.
If the other compiler does not create ADATA, then File Manager retries
the first compiler, and again displays the pop-up menu.
4. HLASM
Use the HLASM compiler.
RELATED TOPICS
Data description support on page 136
Compiler Language Selection panel on page 465
Note: File Manager now supports specifying additional SYSLIBs and REPLACE
text in the same copybook.
RELATED TOPICS
Set COBOL Processing Options panel (option 0.5.2) on page 646
For details on specifying From and To strings for the COBOL REPLACE
directive, see the IBM COBOL Language Reference.
For details on the effect of these compiler options, see the IBM COBOL
Programming Guide for OS/390 & VM.
1. From the Primary Option Menu panel, select 0 Settings, then 5 Compiler, and
3 HLASM.
The HLASM Processing Options panel is displayed.
2. If you have used additional SYSLIBS, enter the names of the data sets in the
Additional SYSLIB data set fields.
Members included by COPY directives must be found in the SYSLIB
concatenation. When you specify a copybook on a File Manager panel to create
a new template (or update an existing template), the SYSLIB concatenation
consists of the PDS of the copybook, plus up to ten additional PDSs that you
can specify on this panel. These PDSs are searched in order (PDS of the
copybook, followed by these additional PDSs, 110.)
RELATED TOPICS
Using HLASM copybooks with File Manager on page 140
For details on the effect of these compiler options, see the HLASM V1R5
Programmer's Guide.
RELATED TOPICS
Set PL/I Processing Options panel (option 0.5.4) on page 652
For details on the effect of these compiler options, see the IBM VisualAge PL/I
for OS/390 Programming Guide.
Note: If the template does not contain compiler options, then the compiler options
used are those currently specified for the execution or the relevant defaults.
RELATED TOPICS
You can also access the Preserve copybook library option on the Compiler
Language Selection panel.
RELATED TOPICS
Template Update Utility panel on page 685
Compiler Language Selection panel on page 465
Note: You can enter a generic member name to display a member list.
Select the process option 1. Above to use the copybook with the function. To
edit the copybook template prior to the function, select the Edit template option
and ensure you do not specify S for Type.
v Workbench (Option 7.1):
Specify the data set name and member name in the Copybook section and issue
the command you require without the Advanced copybook selection option
selected.
with Type set to S. This takes you to the advanced copybook selection panels
which allow you to change the source definitions and create a new template or
update an existing template.
v Workbench:
Select the option Advanced copybook selection and use the CC command with
a copybook data set name and member name to create a new template, or the U
prefix command with a template data set name and member name to update the
source definition for an existing template.
Note: You can also use the E command with the copybook data set name and
member name, provided the template data set and member names are left
blank.
Note: See Advanced copybook selection for a description of what you can do
when specifying advanced copybook source definitions for templates.
If the Edit template option is used from a function entry panel with a copybook
source definition, you are prompted to provide a template data set name (and, for
partitioned data sets, a member name) to save the template that has just been
created. Templates can be stored in sequential, PDS or PDSE data sets only.
RELATED TOPICS
Field Selection/Edit panel on page 561
Record Type Selection panel on page 632
Template Save pop-up panel on page 689
SAVE primary command on page 811
SAVEAS primary command (templates) on page 811
END primary command on page 756
b. If you specify a member that consists of an entire program, then you should
use the X prefix command to specify a statement range to extract the field
definitions you are interested in, otherwise you may get compile errors
when mixing with other members.
c. You can only edit members in a PDS or PDSE data set.
d. Library members may not be packed by ISPF.
4. When you have selected all of the members you want, press the Exit function
key (F3). The selected members are listed in the Copybook Selection panel.
From the Copybook Selection panel, you can display (and modify if necessary)
the current library list by entering the LIBLIST primary command.
5. Edit the list of members to suit your requirements. You can copy or move
members, insert or delete members and create new 01-level fields for any
member. You can also specify redefines or range values for a member
To add a new member:
a. Enter the I prefix command to insert a new row.
b. Type an asterisk or member name pattern in the Member field, then press
Enter
c. Select the new member name or names from the list. The list is not affected
by any pattern that you have entered on the Template Workbench, it is a
new list of all members in all selected databases, filtered by the pattern
entered on the Copybook Selection panel.
d. Press the Exit function key (F3). The selected members are inserted into
your list on the Copybook Selection panel.
To create a new 01-level field for a member:
a. On the Copybook Selection panel, type a Y in the 01 field adjacent to the
member.
b. In the adjacent Field Name field, type a name for your 01-level element.
This name must follow the naming conventions for the language of the
copybook. If the name is omitted, File Manager generates a random name
when the template is compiled.
To extract a subset of the copybook to be compiled into the template:
a. From the Copybook Selection panel, type an X in the Cmd field next to the
required copybook member to display the Redefines / Range Specifications
pop-up panel.
b. In the From statement field, specify the starting line number for the extract.
c. In the To statement field, specify the ending line number for the extract.
d. In the From string field, specify the string that File Manager is to search the
copybook for. The first statement that contains the string begins the extract.
e. In the To string field, specify the string that File Manager is to search the
copybook for. The first statement that contains the string ends the extract.
See the panel definition for a complete list of the prefix commands available.
6. To generate multiple record layouts for a source that contains more than one
record definition within a single level-01 structure:
a. From the Copybook Selection panel, type an X in the Cmd field next to the
required copybook member to display the Redefines / Range Specifications
pop-up panel.
b. In the Level field, specify the source level value to identify the COBOL
REDEFINES or the PL/I UNION clauses for generating new record layouts.
File Manager creates a separate record layout for each REDEFINES or
UNION clause at the specified level. After the first matching REDEFINES or
UNION clause is found, File Manager creates new layouts for the latter and
subsequent REDEFINES or UNION clauses for the same level and start
location. Header and trailing data items are included in each record layout.
RELATED TOPICS
Template types and structure on page 129
Template Workbench panel on page 690
Library List panel on page 583
Copybook Selection panel on page 500
LIBLIST primary command on page 781
UPDATE primary command on page 827
EDIT primary command on page 755
Redefines / Range Specifications panel on page 634
Note: If you do not provide a template data set name, File Manager creates a
temporary template, which you can then edit. Before you close the Template
Workbench, you can save the template by specifying a template name and
entering the SAVE command. Otherwise the template is discarded.
RELATED TOPICS
Template Workbench panel on page 690
When you are viewing or editing data using a segmented data template, the
following restrictions apply to template editing:
v You cannot update the Template for segmented data field in the Record Type
Selection panel (accessed with the TEDIT command).
v You cannot change the Record Identification Criteria, Related Identification
Criteria, or Selection Criteria set in the Field Selection/Edit panel (accessed with
the TEDIT command and then the E command on the Record Type).
v You cannot use the TVIEW command (which would otherwise display the
Template Workbench, allowing you to select or create a different template).
v The length of a segment is calculated as the length of the matching structure,
unless you provide a length field. Any binary or alphanumeric field less than 4
bytes in length can be set as the length field by editing the field attributes. If a
length field is provided, then File Manager uses the binary value provided as
the segment length and adjusts the structure length accordingly.
1. You can choose to specify record type definitions that do not contain any Record Identification Criteria. If File Manager cannot
match a segment (using Record Identification Criteria) with any of the other record types, it uses the first record type without any
Record Identification Criteria, whose length is less than or equal to the remaining length on the record, as a default segment.
v Issuing the TVIEW primary command on either the View or the Edit panel.
If it is accessed from an editor session, the Template Workbench contains two
additional options (RC - Run using copybook and RT Run using template).
2. In the Data set name field in the Model Template section, type the name of the
data set in which your existing template is stored.
Templates can be stored in PDS or PDSE data sets but not in a CA-Panvalet
library, or a library accessed using the Library Management System Exit.
3. If you know it, type the Member name of the template into the relevant field or
specify blanks or a pattern for the member name to have a member selection
list displayed. You can then select the required member from the list.
4. In the Data set name field in the Template section, type the name of an
existing data set, into which you want the new template to be saved.
Templates can be stored in PDS or PDSE data sets but not in a CA-Panvalet
library, or a library accessed using the Library Management System Exit.
5. In the Member field of the Templates section, type the name for your new
template.
If you want to copy the template model to another existing template (which
overwrites the existing template), specify an existing member name or specify
blanks or a pattern to have a member selection list displayed. You can then
select the required member from the list.
6. On the Command Line, type the CM command and press Enter.
File Manager generates and saves the template. A message is displayed in the
upper right corner of the panel, to indicate the success or failure of the process.
Note: If you do not provide a template data set name, File Manager creates a
temporary template, which you can then edit. Before you close the Template
Workbench, you can save the template by specifying a template name and
entering the SAVE command. Otherwise the template is discarded.
RELATED TOPICS
Template Workbench panel on page 690
When you are building the definitions without selection criteria, you must supply
the starting column, length and type of the data set fields that you wish to operate
upon.
When you are building the definitions with selection criteria, you must supply the
starting column and value for the data set fields that you wish to operate upon. If
you do not supply the length of a field, File Manager calculates it from the value
you specify. Similarly, if you do not supply the data type or operator for a field,
File Manager uses default values.
In either case, you can, optionally, supply your own field name to identify the
information.
Note: If you are running a screen width of 115 or greater, the Field Name field
can be displayed at the same time as the Start, Length and Type fields.
However, at any width less than this, you need to toggle the display
between Field Name and Start, Length and Type. The default is to
display Start, Length and Type. To toggle the display, ensure that your
cursor is not in a Value field and press the Right function key (F10) or
Left function key (F11).
5. Press the Exit function key (F3). The Template Save pop-up panel is displayed.
6. Type the name of an existing data set in the Data set name field.
Templates can be stored in PDS or PDSE data sets, but cannot be stored in
CA-Panvalet libraries.
7. Type a name for your new template in the Member field.
8. Press the Exit function key (F3). The template is saved and the next relevant
panel (depending upon your entry point) is displayed.
RELATED TOPICS
Manipulating the display of fields in records on page 164
Dynamic Template panel on page 524
Template Save pop-up panel on page 689
Tip: The RunTemp function key (F6) should not be used with the Template
Workbench nor any function which has selected batch execution.
Currently, this is not enforced and can lead to unpredictable results.
v Exit from the panel and, when prompted by the Template Save panel, choose
to save the template, run with a temporary template or cancel your changes.
You can also create a dynamic template from a copybook template while in an
editor session. To do this:
1. Enter CEDIT on the Command line of the View or Edit panel. The Record
Selection Criteria panel is displayed.
2. Type MD on the Command line and press Enter.
The Dynamic Template panel is displayed, containing the list of field
definitions generated from your copybook template. You can modify any of
these values.
3. Exit from the panel (press F3) and, when prompted by the Template Save
panel, choose to save the template, run with a temporary template or cancel
your changes.
RELATED TOPICS
CEDIT primary command on page 740
DEDIT primary command on page 752
Note: The Member mask works in the same way as the mask you can use
when copying data sets. For an explanation of how you can specify a
member name mask in the form of a member name pattern, see
Renaming members as you copy on page 252.
6. To run the Template Build Utility in batch, select the Batch execution
processing option.
Batch processing produces up to two reports: the Data Set List report (only
produced if a concatenated data set is used for input), and the Template Build
Report. Examples of each report are shown below.
Note: The Lib column is only displayed when more than one input data set is
found.
7. To replace templates that exist with the same name, select the Replace existing
templates processing option.
8. To specify a range of members to be selected, rather than a specific or generic
member name, select the Advanced member selection processing option.
9. To run without showing the member selection list, select the Skip member list
processing option. This option is ignored if errors are found (such as duplicate
member names due to the rename mask).
RELATED TOPICS
Template and Copybook Utility functions panel on page 683
Template Build Utility panel on page 684
Member Selection panel on page 596
Editing a template
You can perform template editing:
v From any panel that has the Edit template option
v From the Template workbench
v By using the appropriate template primary commands from an editor session.
Template commands from within an editor session may be restricted in function,
depending on the type of Edit or View being performed.
v By using the E command from the template update utility member list (option
7.4).
To perform a template edit, you can either select the Create dynamic option or, on
panels with the Edit template option, you can select that option and set Type to
one of the following:
Blank Normal record type or field/selection edit for single layout copybooks or
templates.
S To edit the source definition using the advanced copybook selection
process.
1 To perform criteria edit by field for identification criteria before the
field/selection edit. This provides a fast path when you just want to
specify criteria by field.
2 To perform criteria edit by field for selection criteria before the
field/selection edit. This provides a fast path when you just want to
specify criteria by field.
The options above are ignored for dynamic templates. If you specify Create
dynamic or edit an existing dynamic template, then File Manager always takes you
to the dynamic edit panel.
Edit template
Field selection
edit
v Press the Exit function key (F3) to save the changes and display the next
relevant panel (for example, the View panel). The message "Template saved"
appears in the upper right corner of the panel.
Note: Unlike when creating a new template, the Template Save pop-up panel
is not displayed at this point. The previous version of the template is
automatically replaced by the changes you have made.
v Type SAVE on the Command line and press Enter. You can then choose to
make further changes, continue to the next relevant panel or return to your
entry panel.
v Type SAVEAS on the Command line and press Enter. Specify the data set
(and member name if a PDS) of the new template and press the Exit function
key (F3). You can then choose to make further changes, continue to the next
relevant panel or return to your entry panel. The new template is used in
place of the original for the current function.
v Press RunTemp function key (F6) to display the next relevant panel using the
changes you have made but without saving those changes.
v Press Cancel function key (F12) to return to your entry panel without saving
the changes.
Note: Unlike when creating a new template, the Template Save pop-up panel
is not displayed at this point. The previous version of the template is
automatically replaced by the changes you have made.
v Type SAVE on the Command line and press Enter. You can then choose to
make further changes, continue to the next relevant panel or return to your
entry panel.
v Type SAVEAS on the Command line and press Enter. Specify the data set
(and member name if a PDS) of the new template and press the Exit function
key (F3). You can then choose to make further changes, continue to the next
relevant panel or return to your entry panel. The new template is used in
place of the original for the current function.
v Press RunTemp function key (F6) to display the next relevant panel using the
changes you have made but without saving those changes.
v Press Cancel function key (F12) to return to your entry panel without saving
the changes.
RELATED TOPICS
Manipulating the display of fields in records on page 164
You can filter template member selection to select only templates that reference a
certain copybook or copybooks. You can specify a generic copybook filtering name.
1. Select option 7. Templates from the Primary Option Menu panel to display the
Copybook and Template Utility Functions panel.
2. Select option 4. Update from the Copybook and Template Utility Functions
panel to display the Template Update Utility panel.
3. On the Template Update Utility panel, enter the details to select the templates
you want to update:
v In the Template Data set name field, specify a fully-qualified or generic data
set name to identify the data set (which must be partitioned).
v In the Template Member field, you can specify the name of a member of a
partitioned data set.
v In the Template Copybook filter field, you can specify up to 4 member
names or patterns to be used as a filter so that only templates referencing
those copybooks, or copybooks that match the member patterns, are selected
for processing.
4. In the Output Template Data set name field, you can specify a fully-qualified
or generic data set name to identify the output data set where the updated
templates are to be stored. If you leave this field blank, then the update takes
place on the input data set.
5. In the Output Template Member mask field, you can specify a rename mask so
that the updated templates are stored under an alternative name.
6. Select the processing options:
v To run the function in batch, select Batch execution.
v To replace like-named members in the output partitioned data set, select
Replace members.
v To specify a range of members to be selected, rather than a specific or
generic member name, select Advanced member selection.
v To use the library data sets specified on the entry panel select Use library
data sets.
v To run without showing the member selection list, select Skip member list.
This option bypasses the member list panel and processes all the qualifying
members. If an error (like a duplicate output name) results from the specified
parameters, then the member list panel is displayed with the errors
highlighted.
v To run the function without saving the resulting members, select Check
mode - no update.
v If necessary, select the Preserve copybook library option to ensure that, if a
copybook still exists in the library that it was previously found in and that
library is in the list that the update is using, then that version of the
copybook is used if:
Press F11 (Right) to scroll right to display the Description column, and F10
(Left) to return to the original display.
9. In the prefix area (Sel), type any of the following prefix commands and press
Enter to perform the associated action:
v To browse a template, type the B prefix command. The member is displayed
using the ISPF Browse panel (not the File Manager Browse panel).
v To invoke template editing, type the E prefix command. File Manager
invokes template editing.
v To invoke the template source definition edit and interactive update process
for the template, type the U prefix command. File Manager displays the
Copybook Selection panel.
v To select a template for updating, type the S prefix command. File Manager
saves the updated template.
RELATED TOPICS
Template and Copybook Utility functions panel on page 683
Template Update Utility panel on page 685
.
.
.
File Manager Field Selection/Edit
Cmd Seq SHE Ref Rdf Field Name Type Start Length
**** Top of data ****
___ ___ 1 1 REC-TYPE01 AN 1 80
___ ___ S 2 2 REC-TYPE AN 1 2
___ ___ S 3 2 NAME AN 3 20
___ ___ 4 2 EMPLOYEE-NO BI 23 2
---------------------- Record Identification Criteria -------------------------
.
.
.
3. To remove the selection status, type the S command in the Cmd field adjacent
to a selected field. If you remove the selection status from all fields in the
record type, File Manager reverts to its default behavior, which is to display or
print all fields.
You can toggle between selecting and deselecting more than one line at a time by
entering one of the following selection commands:
SS Selects and deselects a block of lines.
Enter SS twice: first in the Cmd field at the start of the block you want to
select or deselect, and second, at the end of the block. File Manager toggles
the selection status of each line in the selected block.
Sn Selects and deselects n lines.
Enter Sn in the Cmd field of the first line you want to select or deselect.
File Manager toggles the selection status of each line, starting from the first
line selected for n lines.
S* Selects and deselects a block of lines, starting from the first line selected
and then all subsequent lines.
Enter S* in the Cmd field of the first line you want to select or deselect.
File Manager toggles the selection status of each line, starting from the first
line selected to the last line.
RELATED TOPICS
Field Selection/Edit panel on page 561
Editing a template on page 158
Any fields with sequence numbers are displayed before fields without sequence
numbers. Fields with sequence numbers are displayed in the relative order of the
sequence numbers. Sequence numbers do not need to start at 1, or be consecutive.
The remaining fields (without sequence numbers) are displayed in their default
order.
When you hold a field, H appears in the middle position of the SHE column on
the Field Selection/Edit panel, and 1 appears in the Seq column to show it is the
first held field. If you hold a second field, 2 appears in the Seq column to show
it is the second held field, and so on.
Note: The sequence numbers of held fields are independent of any other sequence
number you might add. Held fields always appear as the leftmost columns
on the screen (in the order that you held them when editing the template)
and take priority (as far as the left-to-right display is concerned) over other
fields.
The field heading may determine the width of the display column. The default
output width is the maximum of the number of characters needed to show the
field heading (or field name, if no heading is specified), and the number of
characters needed to show the value of the field. The following figures
demonstrate how changing a field heading can change the display width of the
field.
.
.
.
REC-TYPE NAME EMPLOYEE-NO AGE SALARY MONTH(1)
#2 #3 #4 #5 #6 #7
AN 1:2 AN 3:20 BI 23:2 BI 25:2 PD 27:4 BI 31:4
<> <---+----1----+----> <---+-> <---+-> <---+--> <---+---->
**** Top of data ****
01 Grant Smith 7712 35 75000 6
01
. Andrew Apple 6645 53 78500 30
.
.
.
.
.
Type NAME Emp # AGE SALARY Mth(1) Mth(2)
#2 #3 #4 #5 #6 #7 #7
AN 1:2 AN 3:20 BI 23:2 BI 25:2 PD 27:4 BI 31:4 BI 35:4
<> <---+----1----+----> <---+-> <---+-> <---+--> <---+----> <---+---->
**** Top of data ****
01 Grant Smith 7712 35 75000 6 15
01
. Andrew Apple 6645 53 78500 30 22
.
.
Note: While the width of the Employee-No field has reduced, the width of the
Month column has not changed. This is because the Month field has a Type
of BI and Length of 4. The maximum value that can be entered into a field
of this type has 9 digits, therefore, the default output width is 9 characters.
To reduce the width of the Month fields, you would need to modify the
field attributes.
panel. You can also specify data create attributes on this panel . The panel comes
in two flavors: one for alphanumeric fields and the other for numeric fields.
To change the output width, enter the new width into the Output width field.
The output width is the number of character positions used by edit, view, and
print panels to show the field in TABL display or print format. The default output
width is the maximum of the number of characters needed to show the field
heading (or field name, if no heading is specified), and the number of characters
needed to show the value of the field, as determined from the field definition.
The minimum width allowed is six characters. The maximum is 30 or the field
width + 10 (whichever is the greater).
You can set any field less than 4 bytes long to be the length field during a
segmented template edit. You can specify the length as inclusive or exclusive. If a
non-blank value is provided, then the segment length is determined from the
binary value contained in the field, and for exclusive fields the field length is
added to this value.
To change the output width, enter the new width into the Output width field. The
output width is the number of character positions used by edit, view, and print
panels to show the field in TABL display or print format. The default output width
is the maximum of the number of characters needed to show the field heading (or
field name, if no heading is specified), and the number of characters needed to
show the value of the field, as determined from the field definition, including a
sign character and decimal point.
To display leading zeros on numeric fields in SNGL and TABL display format,
enter YES in the Leading zeros field. The default is NO (suppress leading zeros).
The following figure demonstrates how field headings and output widths affect the
column width display.
.
.
.
Type NAME Emp # AGE SALARY Mth(1) Mth(2) Mth(3)
#2 #3 #4 #5 #6 #7 #7 #7
AN 1:2 AN 3:20 BI 23:2 BI 25:2 PD 27:4 BI 31: BI 35: BI 39:
<> <---+----1----+----> <---+-> <---+-> <---+--> <---+> <---+> <---+>
**** Top of data ****
01 Grant Smith 7712 35 75000 6 15 42
01
. Andrew Apple 6645 53 78500 30 22 46
.
.
Figure 61. Data set displayed using field headings and output width adjustment
You can set any field less than 4 bytes long to be the length field during a
segmented template edit. You can specify the length as inclusive or exclusive. If a
non-blank value is provided, then the segment length is determined from the
binary value contained in the field, and for exclusive fields the field length is
added to this value.
When you change the type to AX, the fields are displayed or printed in long
hexadecimal format (as opposed to character format).
Figure 62. Field Selection/Edit panel showing VEHICLE-TYPE flagged to display in long
hexadecimal mode
Note: If you do not provide a template data set name, but have entered the details
of a copybook, File Manager creates a temporary template to edit and use to
view data. Before exiting the current panel, you can save the template by
specifying a template name and entering the SAVE command. Otherwise the
template is discarded.
.
.
.
Template:
Data set name . FMN.RFM0569.PDSE
Member . . . . TMPLB1
.
.
.
File Manager displays the Record Type Selection panel which lists each of the
level-01 layouts in the template.
3. Select (if currently unselected) the Template for segmented data option.
4. Type the E prefix command in the Cmd field against the layout for which you
want to specify related ID criteria (but which is held in another segment).
5. Press Enter.
File Manager displays the Field Selection/Edit panel showing the selected
layout.
Notes:
a. The 0 Rid line at the top of the panel is blank (unless you have previously
specified a related ID expression).
b. The ability to OR the identification criteria with related ID by selecting the
processing option.
6. To enter or edit a related ID expression, type 0 (zero) on the command line
and press Enter.
For the selected layout, File Manager displays the RID Selection panel listing
the other level-01 layouts in the template.
7. Type the E prefix command in the Cmd field against the layout in which the
related ID criteria are held.
.
.
.
8. Press Enter.
File Manager displays the Related ID expression panel showing the selected
layout.
Notes:
a. The ability to OR the related criteria with other related ID by selecting the
processing option.
9. On the 0 Rid line at the top of the Related ID expression panel, specify (or
edit) the related ID expression. Alternatively, type 0 (zero) on the command
line and press Enter to specify the related ID expression by field.
Typically, the related ID expression specifies the field, and the value it
contains, in the layout holding the related ID.
10. Press the Exit function key (F3) to return to the RID Selection panel.
11. Press the Exit function key (F3) again to return to the Field Selection/Edit
panel.
You will now see the related ID expression on the 0 Rid line at the top of the
Field Selection/Edit panel.
12. On the 1 Id and 2 Sel lines, specify record identification and or selection
criteria by field as required.
..
.
Col 1 Insert Length 8160 Record AT TOP Format CHAR
----+----10---+----2----+----3----+----4----+----5----+----6----+----7--
****** **** Top of data ****
000001 1234AsegBsegBsegCsegCsegCsegDsegDsegDsegDseg
000002 0202BsegBsegDsegDseg
000003 1232AsegBsegBsegCsegCsegCsegDsegDseg
..****** **** End of data ****
.
.
.
.
File Manager Record Type Selection Line 1 of 2
.
.
.
File Manager Field Selection/Edit Line 1 of 5
Note: The segment header contains the number of each of the following
segments that occur.
.
.
.
File Manager Field Selection/Edit Line 1 of 3
.
.
.
File Manager RID Selection for SEG-A Line 1 of 4
Press Enter.
.
.
.
File Manager Related Id expression for SEG-A Line 1 of 5
Note: We use SEGCNT and compare it to the value in the header to ensure
that the number of SEG-A identified is determined by the header value.
SEG-B, SEG-C, and SEG-D are all defined with a similar expression as follows:
.
.
.
File Manager Related Id expression for SEG-B Line 1 of 5
.
.
.
File Manager Related Id expression for SEG-C Line 1 of 5
.
.
.
File Manager Related Id expression for SEG-D Line 1 of 5
Viewing the data with a segmented template produces the following where
we can see the header segment has been used to determine the number of
following segments.
.
.
.
View FMN.RFM0757.SEGTEST(SEG2) Top of 3
Record AT TOP Format TABL
SEG-NUM-A SEG-NUM-B SEG-NUM-C SEG-NUM-D
#2 #3 #4 #5
ZD 1:1 ZD 2:1 ZD 3:1 ZD 4:1
<> <> <> <>
****** **** Top of data ****
000001 1 2 3 4
- - - - - -1- - - SEG-A - - - - - - - - - - - - - 1 Line(s) suppressed
- - - - - -1- - - SEG-B - - - - - - - - - - - - - 2 Line(s) suppressed
- - - - - -1- - - SEG-C - - - - - - - - - - - - - 3 Line(s) suppressed
- - - - - -1- - - SEG-D - - - - - - - - - - - - - 4 Line(s) suppressed
000002 0 2 0 2
- - - - - -2- - - SEG-B - - - - - - - - - - - - - 2 Line(s) suppressed
- - - - - -2- - - SEG-D - - - - - - - - - - - - - 2 Line(s) suppressed
000003 1 2 3 2
- - - - - -3- - - SEG-A - - - - - - - - - - - - - 1 Line(s) suppressed
- - - - - -3- - - SEG-B - - - - - - - - - - - - - 2 Line(s) suppressed
- - - - - -3- - - SEG-C - - - - - - - - - - - - - 3 Line(s) suppressed
. - - - - - -3- - - SEG-D - - - - - - - - - - - - - 2 Line(s) suppressed
.
.
denote that these segments could not be identified. In SNGL format (as
there is no prefix area), a message is issued.
Editor mode of operation
Editing or viewing of segmented data is performed in one of two modes:
In-place, unrestricted size
This mode is used when the template does not contain selection
criteria.
In-memory and in-place
In this mode, only as many records as will fit comfortably into the
current virtual storage are loaded. Only segments of physical
records meeting the template selection criteria are loaded into
storage. Only records that are selected are loaded into memory, so
this does not restrict the scenario where selection criteria are
intended to give a few result records from a large file. This mode is
used when the template contains any selection criteria. If you want
to examine records and segments occurring later in the file than
would be expected to fit into the available storage, you can use the
Start position field.
Identification and selection currency for Edit and View
Identification and selection criteria are only applied to the records and
segments at the time of loading the data into memory (assuming selection
criteria have been supplied and this is an in-memory Edit or View) for the
editor session. They are not re-assessed at any time during the editor
session. For Edit, this means that data changes to segments that potentially
affect the segment type, or would have disqualified the record or segment
for selection, are not acted on in the current Edit session. To reflect this
type of change to the data, it may be saved and the edit session re-entered.
Major changes that might cause the update process to produce unwanted results
include:
v Changing field names and field data types
v Changing field names and the order of fields in a record
However, if the criteria refer to a field that has been deleted in the copybook, then
the update process displays the Field Selection/Edit panel, with references to
deleted fields changed to #0. Edit the criteria, removing or replacing the obsolete
field references, then press the Exit function key (F3) to continue with the update
process.
If you change the data type of a field to a dissimilar data type (for example,
numeric to non-numeric, or vice versa), then the update process discards any field
attributes that you might have defined for that field (such as create attributes).
Note: File Manager ignores the Copybook: Data set name field and instead uses
the data set names which were used to create or update the template.
You must specify the PDS member name of the copybook you want to use, and the
data set name or PDS member name of the template you want to update. The
copybook you specify is validated by compiling it with the compiler. For a
description of the compilation process, and information about what you can do if
errors occur, see Data description support on page 136.
To do so:
1. From the View or Edit panel, type TView on the Command Line and press
Enter.
The Template Workbench main panel is displayed, with the details of the
currently used copybook and/or template in the relevant fields.
The View or Edit panel displays the data, using the newly specified copybook
or template.
Note: These two commands are not available when you enter the Template
Workbench through option 7.1.
When you enter RC, you are in effect using a temporary template created from the
copybook you specify. You cannot edit this template before the panel is run, and
the template is not saved. If you want to edit or save the template, use the CC
command, and then use the RT command.
To use RC you must specify the PDS member name of the copybook you want to
use. The copybook you specify is validated by compiling it with the compiler. For
a description of this process, and information about what you can do if errors
occur, see Data description support on page 136.
If you use the RT command, the template can be either a permanent one
previously saved in a PDS member, or a temporary one created for the current
panel using the CC command.
Within the Template Workbench and the Copy Utility, the templates are known as
the From and To templates. Within the Compare Utility, they are known as the
Old and New templates. However, the template definitions and field mapping
information are independent of any utility and templates intended for use in the
Compare Utility can still be created and edited in the Template Workbench.
You specify field mapping information in the To (or New) template. For each
field in the To template, the field mapping defines which field in the From (or
Old) template (if any) are copied to or compared with the field in the To
template.
After you enter an MC or MT command, File Manager displays the Map To panel,
where you can specify a To template, and use the EM or GE commands to begin
editing its field mapping (see Map To panel on page 591).
RELATED TOPICS
Mapping fields between templates on page 186
Copying data sets on page 247
Comparing data sets on page 275
The EM (Edit mapping) command displays the field mapping for editing. If there
is no existing field mapping in the To template, then the EM command generates
default field mapping (effectively, performing a GM command before displaying
the field mapping for editing).
The GE command is similar to EM, except that it always regenerates the default
field mapping in the To template (replacing any existing field mapping) before
displaying the field mapping for editing.
For details on editing the field mapping, see Mapping fields between templates
on page 186.
When you select more than one field at a time, File Manager displays the From
(or Old) Field Mapping panel (see From (or Old) Field Mapping panel on page
573) for the next selected field each time you press the Exit function key (F3).
When you are viewing the last selected field and press the Exit function key (F3),
File Manager returns you to the Field Mapping panel (see Field Mapping panel
on page 559).
When you use the Copy Utility (option 3.3) to copy data from one data set to
another data set, you specify the fields you want scrambled by marking those
fields for scrambling in the output template.
You mark a field for scrambling by setting the scrambling options for that field in
the template.
You can specify or change scrambling options on the Field Attributes panel. The
panel comes in two flavors: one for alphanumeric fields and the other for numeric
fields.
Selecting a field for specifying scrambling options on page 183
After you have updated the scrambling options for a field (or any of the other field
attributes), when you return to the Field Selection/Edit panel you will see an "E"
for that field in the E column (under the "SHE" heading) indicating that the
attributes for that field have changed.
The scrambling options determine how the input data is scrambled (if at all) when
it is copied to an output dataset.
RELATED TOPICS
Specifying the scramble type
Specifying the value option on page 184
Specifying value input and out columns on page 185
Specifying range values on page 185
Specifying a value data set name on page 185
Specifying and editing a value list on page 186
field values as stored in the data set. Their lengths are determined by the
respective input and output fields that have been mapped for the copy
operation. If a matching input field value is found, then the corresponding
output field value is obtained from the matching record. If no match is
found, then the field is initialized to zero, or the value determined by the
data create attributes.
4 ("Exit")
Data scrambled using a scrambling exit (as specified on a separate panel).
For details about writing a scrambling exit, see the File Manager
Customization Guide.
RELATED TOPICS
Specifying the value option
Specifying value input and out columns on page 185
Specifying range values on page 185
Specifying a value data set name on page 185
The way in which you select, or specify, this option differs according to whether
the associated field is alphanumeric or numeric:
v For alphanumeric fields, do one of these:
Deselect the Value option by entering a blank.
Select the Value option by entering a "/".
v For numeric fields, do one of these:
Deselect the Value option by entering a blank.
Select a range by entering "1".
Select the Value option by entering "2".
Note: This value is only required when you select Scramble Type 3 ("Translate").
The output column field Out defines the start location of the output field value on
the value data set and is used in these ways during a copy operation:
v Translate. If an input field value is matched on the value data set, then the
corresponding output value is used.
v Random or Repeatable. The input value is used to randomly, or repeatably,
select an output value from the value data set.
The length of the field is the field length as displayed on the Field Attributes
panel.
Note: This value is required when you select Scramble Type 3 ("Translate").
You specify the minimum value of the range in the Min field and the maximum
value of the range in the Max field.
You can only select the range option with random and repeatable scrambling. The
output value is randomly or repeatably selected from a number within the
specified range.
If you select Scramble Type 3 ("Translate"), then the data set must contain the
input and output values in the locations provided in the input and output
columns.
If you select Scramble Type 1 ("Random") or 2 ("Repeatable"), then the data set
must contain the output value in the locations provided in the output column.
Note: This field is required when you select Scramble Type 3 ("Translate"). If you
select Scramble Type 1 ("Random") or 2 ("Repeatable"), and also select the
Value option, then you can optionally provide a data set name. If you leave
this field blank having selected the Value option, you are prompted to enter
the value list to be stored in the template.
For random and repeatable scrambling, you can specify a value list inline by
leaving the value data set field (Dsn) blank and selecting the Value option.
To edit the related value list, select the Value option and press Enter. File Manager
displays the Value List Edit panel.
The values you provide must be valid for the corresponding field type. Deleting a
value list turns off the value list option on the previous panel.
Use the FIND and LOCATE commands to bring a value containing or starting with
a given string to the current line.
You can use prefix commands to copy, insert, move, repeat or delete lines.
RELATED TOPICS
Value List Edit panel on page 697
First, File Manager pairs record types in the templates by looking for matching
field names. Then, within each pair of record types, File Manager maps fields with
matching names. The following two examples show the default results of this
mapping in the copy and compare processes.
REC-TYPE-B NEW-TYPE-B
FIELD-B1 FIELD-B1
FIELD-B2 FIELD-B2
FIELD-B3 3
Given an input data set that consists of three records (one of each type defined in
the From template), like this:
FIELD-A1 FIELD-A2 FIELD-A3 REC-TYPE-A
then copying the input data set would result in an output data set like this:
FIELD-A1 FIELD-A2 NEW-TYPE-A 2
Notes
1 File Manager pairs record types by matching field names within the record
types; the names of the record types (level-01 group items, in the
copybooks) are not important.
2 There is no matching FIELD-A3 in the To template NEW-TYPE-A, so this
field is not copied to the output data set.
3 There is no FIELD-B3 in the From template to map to this FIELD-B3 in
the To template. The field is inserted in the output data set; its value is
initialized according to the field create attributes (if they exist) in the To
template, or to zero (if it is a numeric field) or blanks (if it is an
alphanumeric field).
4 There is no record type in the To template containing fields named
FIELD-C1 or FIELD-C2, so the REC-TYPE-C record type in the From
template is not paired with any record type in the To template (even
though the To template contains a record type named REC-TYPE-C). The
REC-TYPE-C record from the input data set is copied intact to the output
data set. To stop this record from being copied, you need to edit the
From template and deselect the REC-TYPE-C record type.
5 The REC-TYPE-C record type definition in the To template is unused,
and has no effect on the copy.
OLD-TYPE-B NEW-TYPE-B
FIELD-B1 FIELD-B1
FIELD-B2 FIELD-B2
FIELD-B3 3
With the above field mapping, an Old data set containing one record of each
type defined in the Old template:
FIELD-A1 FIELD-A2 FIELD-A3 OLD-TYPE-A
and a New data set containing one record of each type defined in the New
template:
FIELD-A1 FIELD-A2 NEW-TYPE-A
v The REC-TYPE-C records are not compared because there is no mapping match
between the fields in the OLD-TYPE-C record and any record in the "New"
template.4
Notes
1 File Manager pairs record types by matching field names within the record
types; the names of the record types (level-01 group items, in the
copybooks) are not important.
2 There is no matching FIELD-A3 in the New template NEW-TYPE-A, so
this field is not mapped and is not used in the comparison.
3 There is no FIELD-B3 in the Old template to map to this FIELD-B3 in the
New template, so this field is not mapped and is not used in the
comparison.
4 There are no fields named FIELD-C1 or FIELD-C2 in any record type in the
New template, so the OLD-TYPE-C record type in the Old template is
not paired with a record type in the New template.
The New data in the REC-TYPE-C record is reported using the field
descriptions in the NEW-TYPE-A record type. This is because the templates
do not contain record identification criteria and NEW-TYPE-A is the first
record type in the New template with a length matching the length of
the REC-TYPE-C record in the New data set.
The Old data is not reported because there is no mapping match
between the fields in the OLD-TYPE-C record and any record in the "New"
template. Instead, the message " *** Old data is not mapped to any data ***
" is reported.
To access the field mapping when performing a copy, you must have specified
both a From and a To template and selected the Edit template mapping
option in the To panel (see Copying using a copybook or template on page
253).
To access the field mapping when performing a compare, you must have specified
both an Old and a New template in the first two panels and selected the 2.
Formatted Compare Type and Edit template mapping option in the third panel
(see Comparing data sets on page 275).
3. On the Map From panel, specify a copybook (if you want to create a new
template) or an existing template that you plan to use for a To or New
template.
4. Enter an EM (Edit mapping) command to edit the field mapping in that
template.
Note: Template mapping information is used by both the Compare and Copy
Utilities. When using the Template Workbench, the panel labels are those
used by the Copy Utility (From and To).
Regardless of the method used to edit the field mapping, one of the following
occurs:
v If the To template was generated from a copybook containing only one record
type or was created as a dynamic template, the Template Mapping panel is
displayed. (For panel details, see Field Mapping panel on page 559.)
v If the To template was generated from a copybook containing more than one
record type, the Record Type Mapping panel is displayed. (For panel details, see
Record Type Mapping panel on page 630).
Note: The examples in this section assume that you are editing the field
mapping from within the Template Workbench.
To edit the mapping for a particular record type in the To template, type an S in
the adjacent Sel column and press Enter.
File Manager displays the Field Mapping panel, showing the existing mapping
between the fields in the To template record type and fields in the From
template.
To FMN.SFMNSAM1(FMNCCPY2)
From FMN.SFMNSAM1(FMNCCPY)
Cmd Lv To Field Name Type Len Lv From Field Name Type Len
**** Top of data ****
1 NEW-TYPE01 AN 84 | 1 REC-TYPE01 AN 80
2 REC-TYPE AN 2 | 2 REC-TYPE AN 2
2 NAME AN 20 | 2 NAME AN 20
2 SERIAL-NO BI 4 |
2 AGE BI 2 | 2 AGE BI 2
2 SALARY PD 4 | 2 SALARY PD 4
2 MONTH BI 4 | 2 MONTH BI 4
**** End of data ****
In the example panel above, note that there is no From field against the To
field SERIAL-NO. This field is unmapped.
To set up or change the mapping for a field in the To template, enter S against
the field name. The From Field Mapping panel is displayed, listing the fields in
the From template that you can map to the selected To field:
This screen is similar to the Primary Field Selection/Edit panel, on page 562. You
edit fields in the same way, by entering E against the field name. For copying in
particular, you may wish to edit a field so that you can set the create attributes for
the field. These are described in detail in Changing the attributes for an
alphanumeric field on page 167 and Changing the attributes for an alphanumeric
field on page 167.
The information at the top of the panel shows you the current mapping. In the
panel above, the To field is SERIAL-NO. There is currently no From field,
because there is no From field that has the same name.
..
.
File Manager From Field Mapping
To template/copybook : FMN.SFMNSAM1(FMNCCPY2)
From template/copybook : FMN.SFMNSAM1(FMNCCPY)
To field . . . . . . : #4 SERIAL-NO
From field . . . . . . : #4 EMPLOYEE-NO
..Corresponding(Y/N) . . : N (Auto map for group items).
.
Press the Exit function key (F3) to return to the Field Mapping panel. This panel
now shows that EMPLOYEE-NO is mapped to SERIAL-NO.
..
.
File Manager Field Mapping Line 1 of 7
To FMN.SFMNSAM1(FMNCCPY2)
From FMN.SFMNSAM1(FMNCCPY)
Cmd Lv To Field Name Type Len Lv From Field Name Type Len
**** Top of data ****
1 NEW-TYPE01 AN 84 | 1 REC-TYPE01 AN 80
2 REC-TYPE AN 2 | 2 REC-TYPE AN 2
2 NAME AN 20 | 2 NAME AN 20
2 SERIAL-NO BI 4 | 2 EMPLOYEE-NO BI 2
2 AGE BI 2 | 2 AGE BI 2
2 SALARY PD 4 | 2 SALARY PD 4
2 MONTH BI 4 | 2 MONTH BI 4
.. **** End of data ****
.
Note: This is useful when your To template contains only one record type that
you wish to map to a second record type in your From template.
If you do want to map the elementary items in a From group item with the
elementary items in a To group item then, before selecting the From group
item on the From Field Mapping panel, type Y in the Corresponding (Y/N) field.
This instructs File Manager to automatically map subsidiary items with the same
name in the From and To group items. (This is just a quick way to set up the
mapping for these items; after File Manager has set up these mappings, you can
edit themdelete the mapping, or map to a different itemas if you had
manually set up the mapping.)
When you select more than one field at a time, File Manager displays the From
Field Mapping panel (see From (or Old) Field Mapping panel on page 573) for
the next selected field each time you press the Exit function key (F3). When you
are viewing the From Field Mapping panel for the last selected field and press the
Exit function key (F3), File Manager returns you to the Field Mapping panel (see
Field Mapping panel on page 559).
The rules that apply to the field are exactly the same as those used when creating a
new data set. For more information, see Managing templates on page 142.
This means that you can use a template that is different from the From or Old
template you used to set up the mapping, provided that the structure of the new
From or Old template does not differ from the structure of the original From
or Old template. That is, no fields that have been used in the mapping are in a
different position or have a different name. The new From or Old template
can, however, have different selection conditions.
Notes:
1. The category alphanumeric includes the COBOL categories: alphabetic, alphanumeric,
alphanumeric-edited, numeric-edited, and DBCS. PICTURE clause editing characters are
ignored. Group fields are treated as elementary alphanumeric fields.
2. The from field must consist only of numeric characters, and is treated as a numeric
field.
3. The category numeric integer includes the following COBOL data types: binary
(comp or comp-4 items), packed decimal (comp-3 items), and zoned decimal (PIC 9(n)
items). The decimal items cannot have an implied decimal point.
4. The category numeric non-integer includes packed and zoned decimal items with an
implied decimal point and one or more decimal digits.
5. The category floating point includes the COBOL floating point data types (comp-1 or
comp-2 items). These are representations of real numbers stored with a mantissa and
exponent.
These rules describe how a validly mapped from field is moved to a to field.
When the to field is:
Alphanumeric
The data is aligned at the leftmost character position and, if necessary,
truncated or padded with spaces at the right. The COBOL JUSTIFIED
clause, if specified, is ignored.
If the from field is a numeric field, the absolute (unsigned) value is used.
If the field is defined as signed and the sign occupies a separate character,
that character is not moved, and the sending item is considered to be one
less character than the actual size.
Numeric
The data is aligned on the assumed decimal point and, if necessary,
You can also navigate to the Copybook View and Print Utility panel by:
1. Selecting option 7. Templates from the Primary Option Menu panel to display
the Copybook and Template Utility functions panel, and then
2. Selecting option 2. Print from the Copybook and Template Utility functions
panel to display the Copybook View and Print Utility panel.
You can view the report in foreground (view), print the report to your current
print data set, or submit a batch job to print the report. When using foreground
execution, you can view and print multiple members by selecting them from a
member list. When using batch execution, you can specify a generic member name
to print multiple members.
7. To show start and end values as hexadecimal offsets, select the Show
start/end as hex offset option.
8. To show length values as hexadecimal, select the Show length in hex option.
9. To show template criteria, select the Show template criteria option.
The information shown when you select the Show template criteria option
depends on the type of input data set:
RELATED TOPICS
Utility Functions menu panel on page 695
Template and Copybook Utility functions panel on page 683
Copybook View and Print: Entry panel on page 502
You specify record identification criteria and record selection criteria using
comparison expressions. When you specify criteria, you should be aware of the
potential for incurring processing overheads as a result of invoking REXX to
resolve the criteria expressions.
RELATED TOPICS
Selecting records by record type
Specifying record identification criteria on page 198
Specifying record selection criteria on page 200
RELATED TOPICS
Field Selection/Edit panel on page 561
RELATED CONCEPTS
Improving performance using internal expression processing on page 207
For example, in the following copybook definition, the Orders and Item records are
of different lengths. As such, they can be selected and displayed without additional
identification criteria.
01 ORDERS.
05 ORDER-ID PIC X(5).
05 CUSTOMER-ID PIC X(5).
05 ORDER-DATE.
10 ORDER-YEAR PIC 9(4).
10 ORDER-MONTH PIC 9(2).
10 ORDER-DAY PIC 9(2).
01 ITEM.
05 PRODUCT-ID PIC X(9).
05 QUANTITY PIC 9(4) BINARY.
05 UNIT-COST PIC 9(8) BINARY.
However, if the records are of identical length, such as in the sample copybook
shown below, File Manager is unable to distinguish between these records unless
some record identification criteria is used. By examining the data, we can
determine that in all REC-TYPE01 records, the REC-TYPE field contains the value
'01', and in all REC-TYPE02 records, the REC-TYPE field value is '02'. In this case,
both record types include a REC-TYPE field, however, each record type does not
need to use the same field in its identification.
01 REC-TYPE01.
05 REC-TYPE PIC XX.
05 NAME PIC X(20).
05 EMPLOYEE-NO PIC 9(4) BINARY.
05 AGE PIC 9(4) BINARY.
05 SALARY PIC 9(7) PACKED-DECIMAL.
05 MONTH PIC 9(8) BINARY OCCURS 12 TIMES.
If any record types in your data have the same record length, it is strongly
recommended that you specify record identification criteria to allow File Manager
to distinguish between them. Otherwise, the results can be unpredictable.
Even if the length of each record type is unique, it is still recommended that you
specify record identification criteria for every record type, to help isolate records
that match the length of a valid record type but contain data that is invalid for that
type.
Once your records can be identified by type (either by the record length or by
record identification criteria), File Manager automatically suppresses the display of
all but one record type, depending upon the setting of the editor option Expose
(do not group) records of types: Suppressed. By default, the first record type
identified is displayed.
RELATED TOPICS
Defining criteria expressions on page 201
Displaying suppressed records on page 218
RELATED CONCEPTS
About expression processing on page 207
RELATED TOPICS
Defining criteria expressions on page 201
Displaying not-selected records on page 220
RELATED CONCEPTS
About expression processing on page 207
This can be done in a number of ways. For example, from the View Entry, Edit
Entry or various Utilities panels, you can select the Edit Template option; on
the View or Edit panels, you can enter the TE command; or on the Template
Workbench panel, you can enter the E command.
2. If there are multiple record types in your template, enter E in the prefix
command line, adjacent to the record type you want to edit.
3. In the Field Selection/Edit panel, enter a positive or negative number, between
-32760 and 32760, in the Offset field.
The offset value is added to the record length of the Level 01 field and to the
starting position of all fields within the record type.
To specify record identification or record selection criteria, you can enter a freeform
expression into a relevant field or you can build the expression by field. These
methods are mutually exclusive. If you create a freeform expression and then
create an expression by field, your freeform expression is overwritten. Once you
have specified an expression by field, you cannot enter a free form expression until
you delete the by field expression from the relevant panel.
RELATED TOPICS
Entering criteria as a freeform expression on page 202
Entering criteria by field on page 203
RELATED CONCEPTS
About expression processing on page 207
Logical operators, such as AND (&) and OR (|) can be used to create multiple
criteria expressions. Parentheses can be used to control the order of evaluation in
calculations and criteria expressions.
Note: At least one field reference must be made in the criteria expression. It is
common practice to put this reference on the left side of the equation,
although it works equally well on the right side. That is, while #5 > 100 is
the more usual way of expressing this criteria, writing it as 100 <= #5 does
not cause an error (note the reversal of the comparison operator). If no field
reference is included, the criteria are evaluated as either true or false on
their own merit and, when true, all records are returned or, when false, all
records become not-selected.
RELATED CONCEPTS
About expression processing on page 207
Improving performance using internal expression processing on page 207
Overview of REXX expressions on page 209
Comparison operators on page 212
Arithmetic operators on page 213
202 File Manager for z/OS V12R1 User's Guide
Defining criteria expressions
For the purpose of entering criteria "by field", these panels operate in an identical
manner.
Note: When exiting from the Record Identification Criteria or Record Selection
Criteria panels, your "by field" expression replaces any existing freeform
expressions in the relevant field of the Field Selection/Edit panel.
For example, using the sample data, you may want to display all the Programmers
or Developers in your list. To do this, you would need the Job Title field to appear
twice in the panel, each with an operator and value, and you would use the OR
connector to join them.
..
.
Cmd Con ( Field Name Op Value )
*** **** Top of data ****
___ ___ _ REC-TYPE02 ___ __________________________________________ _
___ AND _ REC-TYPE ___ __________________________________________ _
___ AND _ NAME ___ __________________________________________ _
___ AND _ JOB-TITLE =__ Programmer________________________________ _
___ OR_ _ JOB-TITLE =__ Developer_________________________________ _
___
.. AND _ ADDR1 ___ __________________________________________ _
.
You can refer to a subscripted data item on the "by field" display, and optionally
enter a subscript, operator, and one or more values. The expression generated uses
the TFLD external REXX function.
Alternatively, you can code a free-form expression that refers to any or all the
elements of an array by using the TFLD external REXX function.
Enter "1" to display the Record Identification Criteria panel shown in Figure 69:
Figure 70 shows criteria expressions specified for some of the dimensioned fields
within MONTH-DETAILS:
In Figure 70:
v The default subscript is (ANY) indicating that at least one element must satisfy
the condition.
v (ALL) indicates that all elements must satisfy the condition.
v (1) indicates the first element must satisfy the condition.
After entering the criteria as shown in Figure 70 on page 205, pressing F3 causes
File Manager to generate the expression:
TFLD(#7(ALL),>,5000) & #8(1) = Kimberly & TFLD(#11,CO,SMITH,JONES)
Note: The TFLD function is generated (instead of the FLD_CO function) when the
CO, or CO operators are specified.
RELATED TOPICS
TFLD on page 1164
Record Identification Criteria panel on page 621
RELATED TOPICS
Dynamic Template panel on page 524
RELATED CONCEPTS
About expression processing on page 207
Improving performance using internal expression processing on page 207
Overview of REXX expressions on page 209
Comparison operators on page 212
Arithmetic operators on page 213
Logical (boolean) operators on page 214
Useful functions on page 215
REXX stands for the REstructured eXtended eXecutor language. REXX is a general
purpose programming language, similar to PL/I. It includes extensive parsing
capabilities for character manipulation, extensive mathematical capabilities, and
numerous built-in functions that perform various processing, searching, and
comparison functions.
REXX programs are usually run by a language processor (interpreter). That is, the
program is run statement-by-statement, without first being translated to another
form (compiled). Because of the interpretive nature of REXX, File Manager is able
to exploit the power of REXX when processing record identification and record
selection criteria.
Much of the information in this section has been extracted from the z/OS TSO/E
REXX Reference and z/OS TSO/E REXX User's Guide. For more detailed information
about REXX, refer to those manuals.
For an expression to be eligible for internal processing, it must consist only of:
v Literal strings: These include ordinary quoted strings as well as binary and
hexadecimal strings. For a more detailed description of literal strings, see
Overview of REXX expressions on page 209.
v Numerics: Unlike REXX, the internal expression processor distinguishes between
character and numeric types. To ensure internal processing uses the correct
numeric value, enter numeric data as unquoted strings.
For example, the internal expression processor treats the string 5 as a number
and compares it equal to any other numeric with a value of five. However, it
treats the string 5 as character data and compares it equal to a string
containing X'F5' (with optional leading and trailing blanks for non-strict
comparison). REXX treats both strings the same and handles them as character
data, but allows them to behave as numbers in appropriate contexts.
Non-floating point numerics are limited to 31 decimal digits, and floating point
numerics are limited to the range of numbers that can be stored as a
double-precision floating point number. See Handling floating point numbers
on page 211 for a more complete discussion of how the internal processor and
REXX differ in the way they handle floating point numbers.
v Comparison operators: The internal expression processor supports all the REXX
comparison operators.
The internal processor performs numeric comparisons when both operands are
numeric or contain numeric data (formatted references to numeric fields, or FLD
references specifying a numeric formatting type); bit comparisons when both
operands are bit fields; otherwise, the internal processor performs character
comparisons.
Where both operands have the same value, numeric comparisons match
regardless of the length and type of the data. Bit comparisons match only when
both bit fields are the same. Leading zero-bits are ignored in the longer field if
the fields are not the same length. Character comparisons match only if the two
strings are identical, except that leading and trailing blanks are ignored by the
non-strict operators. The internal expression processor compares character
strings byte by byte according to the standard EBCDIC collating sequence and,
where a shorter string matches a longer string up to the end of its length, the
longer string is deemed to be greater.
v Logical operators: The only logical operators that the internal processor allows
are the AND (&), OR (|), exclusive OR (&&) and NOT ( or \) operators.
v Arithmetic prefix operators: You can use the plus (+) and minus () operators
before decimal numerics (to indicate sign), and before and within floating point
numerics as defined by the REXX syntax.
v File Manager field references: The internal expression processor supports both
formatted and unformatted references when evaluating identification or selection
criteria. Field references are not supported in FASTREXX procedures.
v Function invocations: The following functions can be included in an expression
that is to be processed internally:
FLD
FLD_CO
FLD_TM
FLD_TYPE
FLDI
FLDO
I_LENGTH
O_LENGTH
PRTCOUNT
RECSIN
RECSOUT
SEGCNT
SEGNO
TESTC
TESTN
TFLD
v Parentheses
RELATED CONCEPTS
Comparison operators on page 212
210
Using internal (FASTREXX) processing on page 406
FLD on page 1123
The terms you can use in a selection criteria expression are described below.
Literal strings
A literal string is a sequence including any characters and delimited by the
quotation single mark () or the double quotation mark ("). Use two
consecutive double quotation marks ("") to represent a " character within a
string delimited by double quotation marks. Use two consecutive quotation
marks () to represent a character within a string delimited by quotation
marks. A literal string is a constant and its contents are never modified
when it is processed.
These are valid strings:
Fred
"Dont Panic!"
You shouldnt /* Same as "You shouldnt" */
A string followed immediately by a ( is considered to be the name of a
function. If followed immediately by the symbol X or x, it is considered to
be a hexadecimal string. If followed immediately by the symbol B or b, it is
considered to be a binary string.
A hexadecimal string is a literal string, expressed using a hexadecimal
notation of its encoding. It is any sequence of zero or more hexadecimal
digits (0-9, a-f, A-F), grouped in pairs. A single leading 0 is assumed, if
necessary, at the front of the string to make an even number of
hexadecimal digits. The groups of digits are optionally separated by one or
more blanks, and the whole sequence is delimited by single or double
quotation marks, and immediately followed by the symbol X or x. (Neither
x nor X can be part of a longer symbol. A hexadecimal string is a literal
string formed by packing the hexadecimal digits given. Packing the
hexadecimal digits removes blanks and converts each pair of hexadecimal
digits into its equivalent character, for example: C1X is the same as the
character "A".
Hexadecimal strings let you include characters in a program even if you
cannot directly enter the characters themselves. These are valid
hexadecimal strings:
ABCDx
"1d ec f8"X
"1 d8"x
When you refer to a field in an array, you must qualify the field reference
with the required number of subscripts enclosed in parentheses and
separated by commas. The number of subscripts you specify must equal
the number of dimensions in the array that contains the field you are
referencing. In COBOL terms, there must be a subscript for each OCCURS
clause in the hierarchy containing the field, including any OCCURS clause
for the field itself. Each subscript you specify must be a positive integer in
the range 1 to the maximum number of occurrences of the field as
specified in the OCCURS clauses. If the field you refer to is in a
variable-length array (specified using the OCCURS DEPENDING ON
clause), you should ensure that you do not refer to an occurrence of the
field that, for any given record, might not exist. If you do refer to a
non-existent field, the selection criteria cannot be satisfied, and the record
is not selected.
RELATED CONCEPTS
Support for variable-length arrays on page 137
v Use hex strings and unformatted field references instead of external format to
precisely represent internal floating point values. For example, instead of #2 =
-2.2527494E+08 you can use #U2 = x2c(C7D6D6C4). This technique can only be
applied if your expression requires REXX, because the x2c() function is not
processed internally.
v Comparing floating point fields with different precisions using REXX might not
produce the results expected because the external representations of floating
point numbers with values that match (with or without rounding) but with
different precisions are generally not the same. For example, the external
representation of C7D6D6C4x (-2.2527494E+08) is different from that for
C7D6D6C4 00000000x (-2.2527494400000000E+08) because the extra precision of
the field produces a more precise external representation. This situation, where
the internal values match exactly can be handled in REXX by truncating the
longer field (assuming #2 refers to a short float and #3 refers to a long float):
#U2 = Substr(#U3,1,4)
Simulating the rounding process to achieve the same results as the internal
processor, and therefore achieving a more general test of equality between fields
of different precision requires the following extraordinary expression:
#U2 = d2c(c2d(Substr(#U3,1,4))+Substr(x2b(c2x(Substr(#U3,5,1))),1,1),4)
This works by:
Truncating the long float to four bytes and converting it to decimal.
Adding the high-order byte of the discarded half of the characteristic.
Converting the result back to internal format.
The addition is valid because the characteristic is in the rightmost bits of the
field, and any carry from the addition increments the mantissa as required. The
only case it does not handle is that of exponent overflow.
Comparison operators
REXX comparison operators compare two terms and return the value 1 if the result
of the comparison is true, or 0 otherwise. Comparison operators can compare
numbers or character strings. The most commonly used comparison operators are:
Operator Meaning
= Equal
=, \= Not equal
< Less than
<, \< Not less than
> Greater than
>, \> Not greater than
<= Less than or equal to
>= Greater than or equal to
>< Greater than or less than (same as not equal)
<> Less than or greater than (same as not equal)
The not character (), is synonymous with the backslash (\). You can use the two
characters interchangeably.
When comparing terms using these comparison operators, if both terms in the
expression are numeric, REXX performs a numeric comparison. Otherwise, both
terms are treated as character strings and REXX performs character comparison. (A
number in REXX is a string that contains one or more decimal digits, an optional
decimal point, and an optional leading sign character. The string can contain one
or more leading or trailing blanks, and the sign character can be separated from
the digits by one or more blanks.)
In a character comparison, leading and trailing blanks are ignored, and the shorter
string is padded with blanks on the right. Character comparisons are
case-sensitive. Therefore, you should delimit character strings with quotation
marks to prevent lowercase characters being translated to upper case. For example,
if the field #4 contains the value MixedCase both the following comparison
operations would be true:
#4 = MixedCase
#4 = MixedCase
When you use the == comparison operator (strictly equal), the two character strings
being compared must be identical (character by character) and of the same length
to be considered strictly equal. Leading and trailing blanks are significant. For
example, continuing the example using field #4 that contains the value MixedCase,
only the first of the following comparison operations would be true:
#4 == MixedCase
#4 == MixedCase
Similarly, the strict comparison operators such as >> or << carry out a simple
character-by-character comparison, with no padding of either of the strings being
compared. The comparison of the two strings is from left to right. If one string is
shorter than and is a leading substring of another, then it is smaller than (less than)
the other. The strict comparison operators do not attempt to perform a numeric
comparison on the two terms, and should not be used to compare numeric fields.
Arithmetic operators
You can process numeric terms in comparison expressions using the arithmetic
operators:
Operator Meaning
Chapter 5. Filtering records with templates 213
Defining criteria expressions
+ Add
- Minus
* Multiply
/ Divide
% Integer divide (divide and return the integer part of the result)
// Remainder (divide and return the remainder--not modulo, because
the result might be negative)
** Power (raise a number to a whole-number power)
Prefix - Same as the subtraction: 0 - number
Prefix + Same as the addition: 0 + number
You can use these operators to produce an intermediate result that you can
compare with another term. For example, if the field #6 contains a numeric value
representing an employee's annual salary, and the fields #15 and #23 contain
numeric values representing the employee's annual travel allowance and annual
bonus, respectively, you could use the following comparison to select records for
employees with a combined annual payment of greater than $100,000:
(#6 + #15 + #23) > 100000
For another example, if field #45 contains the number of sick days an employee is
entitled to annually, and the field #46 contains the number of sick days an
employee has used in the current year, you could use the following comparison to
select records for employees who have used 50% or more of their sick day
entitlements:
(#46 / #45) >= .5
For example, * (multiply) has a higher priority than + (add), so 3+2*5 evaluates as
13 (rather than the 25 that would result if strict left to right evaluation occurred).
To force the addition to occur before the multiplication, you could rewrite the
expression as (3+2)*5. Adding the parentheses makes the first three tokens a
sub-expression.
Logical expressions are used in complex comparisons and can act as checkpoints to
stop unwanted conditions (such as testing a field for a value of zero before using it
as a divisor). When you have a series of logical expressions, for clarification, use
one or more sets of parentheses to enclose each expression. For example:
(#46 = 999) | ((#45 > 0) & (#46 / #45) >= .5)
Useful functions
REXX provides a rich set of built-in functions, including character manipulation
and conversion functions. Some of these functions might be of use when you are
writing your comparison expressions, and they are described below. File Manager
also provides some functions that might be of use. They are also described below.
To call a function, type the function name directly followed by one or more
arguments within parentheses. There can be no space between the function name
and the left parenthesis. For example:
function(arguments)
Some of the built-in functions provided by REXX that you might find useful are:
ABS()
Syntax
ABS (number)
Returns the absolute value of a number. For example, if you want to select
records in which field #12 contains a value in the range -10 to +10, you
could specify:
ABS(#12) <= 10
MAX()
Syntax
MAX ( number )
Returns the largest number from the list specified. For example, if you
want to select records in which any of fields #10, #11, or #12 contains a
value greater than 55, you could specify:
MAX(#10, #11, #12) > 55
MIN()
Syntax
MIN ( number )
Returns the smallest number from the list specified. For example, if you
want to select records in which any of fields #10, #11, or #12 contains a
value less than 0, you could specify:
MIN(#10, #11, #12) < 0
POS()
Syntax
search starts. For example, if you want to select records in which any
character in field #22 is a blank, you could specify: POS( ,#22) > 0.
SUBSTR()
Syntax
SUBSTR ( string,n )
,
length ,pad
Returns the substring of string that begins at the nth character and is of
length length, padded with pad if necessary. n is a positive whole number.
If n is greater than the length of string, then only pad characters are
returned.
If you omit length, the rest of the string is returned. The default pad
character is a blank.
For example, if you want to select records in which characters 4-6 of field
#22 are the string 'NOT', you could specify:
SUBSTR(#22,4,3) == NOT
The functions provided by File Manager that you might find useful are shown
below.
FLD() Refer to a field from the current input record. For details, see FLD on
page 1123.
COntains()
Check a field for a list of character values. For details, see CONTAINS
on page 1121.
NCOntain()
Check a field for a list of numeric values. For details, see NCONTAIN on
page 1140.
Example 5
Select records in which the 4-byte packed decimal field starting at position
17 in the record contains a negative value
FLD(17,4,P) < 0
Example 6
Select records in which either the transaction value (field #27) is greater
than $50,000.00 and the purchase order number (field #25) starts with
characters other than 'TX', or the transaction value is greater than $70,000
and the supplier number (field #23) is 984545, but not if both sets of
conditions are true
(#27 > 50000.00 & SUBSTR(#25,1,2) == TX) &&
(#27 > 70000.00 & #23 = 984545)
You can choose to hide suppressed record groups from display, or represent them
by shadow lines:
- - - - - record type - - - - - - - - - - - n Line(s) suppressed
In TABL display format, you can only show fields from one record type on the
screen at a time. Records belonging to other record types are either grouped and
re-displayed as suppressed record lines or, if SHOW SUP ON is in effect or the
Expose option Suppressed on the Editor Options panel is selected, represented
by a line containing the name of their respective record type. In other display
formats, there is no display limitation and the contents of records belonging to
other record types are displayed.
Note: Suppressed records are only hidden from display. They are still selected and
are still included in any print, copy or create data functions.
You can control whether the suppressed record groups are completely hidden or
are represented by shadow lines.
v To hide the shadow line for suppressed record groups, enter SHADOW SUP OFF on
the Command line The shadow lines disappear, and SHAD appears at the top left
of the screen, indicating that there are records that are hidden because shadow
lines have been turned off.
You can also hide the shadow line for suppressed records by deselecting the See
shadow lines option, Suppressed, on the Editor Options panel.
v To turn on shadow lines for suppressed record groups, enter SHADOW SUP ON on
the Command line.
You can also turn on shadow lines for suppressed records by selecting the See
shadow lines option, Suppressed, on the Editor Options panel.
RELATED TOPICS
Managing templates on page 142
Defining criteria expressions on page 201
SHOW primary command on page 815
SHADOW primary command on page 814
3. Move the cursor to a shadow line for the suppressed record type you want to
view.
4. Press Enter. The suppressed records are displayed and the previous record type
becomes suppressed.
RELATED TOPICS
Managing templates on page 142
Defining criteria expressions on page 201
Record Selection Criteria panel on page 627
Record Identification Criteria panel on page 621
SHADOW primary command on page 814
VIEW primary command on page 829
You can choose to show not-selected records, hide them, or represent them by
shadow lines.
- - - - - - - - - - - - - - - - - - - - - - n Line(s) not selected
v To show not-selected records, enter SHOW NOT ON on the Command line. (In
SNGL or TABL display format, the record data is formatted according to the
structure of the current record type.)
You can also show not-selected records by selecting the Expose option, Not
selected, on the Editor Options panel.
v To group not-selected records, enter SHOW NOT OFF on the Command line. The
records are either completely hidden or represented by shadow lines, depending
on the current setting of the SHADOW command.
v To turn on shadow lines for not-selected records, enter SHADOW NOT ON on the
Command line.
You can also turn on shadow lines for not-selected records by selecting the See
shadow lines option, Not selected, on the Editor Options panel.
v To turn off the shadow lines, completely hiding all but the selected records of
the current record type, enter SHADOW NOT OFF on the Command line. The
shadow lines disappear, and SHAD appears at the top left of the screen, indicating
that there are records that are hidden because shadow lines have been turned
off.
You can also turn off the shadow lines by deselecting the See shadow lines
option, Not selected, on the Editor Options panel.
RELATED TOPICS
Managing templates on page 142
Defining criteria expressions on page 201
SHOW primary command on page 815
SHADOW primary command on page 814
When you use the SHOW command (or one or more of the Expose options on the
on the Editor Options panel is selected) to show not-selected records, the prefix
area (if displayed) indicates why each record was not selected. One of the
following values is displayed in the prefix area of each not-selected record:
=DATA
Indicates the record was not selected because, although it matched one of
the record types identified in the template, it did not match the record
selection criteria provided for that record type.
=LGTH
Indicates the record was not selected because one of the following is true:
v The record length did not fall within the valid range for any of the
record types in the template.
v The record length falls within the valid range for a record type in the
template, but that record type contains a variable-length array, and the
record length is not consistent with the value of the field that defines the
number of items in the array.
RELATED TOPICS
Managing templates on page 142
Defining criteria expressions on page 201
Support for variable-length arrays on page 137
SHOW primary command on page 815
SHADOW primary command on page 814
In this display format, shadow lines are not displayed. If SHOW NOT OFF is in
effect, then not-selected records are hidden; if SHOW SUP OFF is in effect, then
suppressed records are hidden.
If you use the Next function key (F11) or Previous function key (F10) to scroll
through records in SNGL display format, then the only indication that a hidden
record has been skipped is that the record number (shown in the upper right
corner of the screen) skips accordingly.
If you display a not-selected record in SNGL display format, then the record type
used to format the data is the record type that was current prior to showing the
not-selected record.
RELATED TOPICS
Managing templates on page 142
Defining criteria expressions on page 201
SHOW primary command on page 815
SHADOW primary command on page 814
VIEW primary command on page 829
71
Examples
In SNGL display format, to show only the selected records for the current record
type, enter:
(as you step through the records using the Next function key (F11) and the
Previous function key (F10), the field headings change to match the type of the
current record)
(not-selected records are formatted according to the record type that was current
prior to moving to that record).
RELATED TOPICS
SHOW primary command on page 815
SHADOW primary command on page 814
To view a different segment type in the Edit panel you can use the method
described above or you can:
1. Enter the V command in the prefix field for the appropriate shadow line.
Because segmented records typically have many segment types, each of which will
display as a separate shadow line, you may find it convenient to hide the shadow
lines while looking at a particular segment type. To do this:
1. Enter the SHAD SUP OFF primary command on the command line.
For example, if this command is applied to the sample data seen in Figure 53 on
page 135, the result would be:
SHAD
REC-TYPE DEPT-ID JOB-DESC
#2 #3 #4
AN 1:2 AN 3:3 AN 6:20
<> <-> <---+----1----+---->
****** **** Top of data ****
000001 01 FIN Accountant
000003 01 FIN Purchasing Officer
000005 01 FIN Accounts Receivable
000007 01 MKT Sales Representative
000009 01 MKT Promotions Manager
000011 01 MKT Market Research
000013 01 ADM Chief Executive
000015 01 ADM Secretary/PA
000017 01 ADM Receptionist
000019 01 ADM Clerical Officer
****** **** End of data ****
Figure 74. Segmented records with suppressed shadow lines turned off.
To switch the segment types, you need to redisplay the shadow lines (SHAD SUP
ON), then re-apply the VIEW command to the required Record Type.
To view all the segment types in SNGL mode, you need to display the suppressed
records, by entering the SHOW SUP ON command. When the suppressed records
are displayed, the NEXT (F11) and PREVIOUS (F10) commands scroll through each
segment type, treating each as a separate record. To scroll through the physical
records, you can use the NEXTREC (Shift+F11 or F23) and PREVREC (Shift+F10 or
F22) commands. These commands take you to the beginning of the next or
previous physical record, that is, you will view the first segment type of each
record. You can also use the UP (F7) or DOWN (F8) commands to scroll within the
current record.
To find a segment type and then scroll through segmented data in SNGL display
mode, viewing the same segment type:
1. Enter the SHOW SUP ON command to display all the segment types.
2. Use the NEXT command (F11) to scroll through the segment types until the
type you want is displayed.
3. Enter the SHOW SUP OFF command. This hides the display of the suppressed
records.
4. Use the PREV or NEXT commands to scroll, looking at the same segment type
each time.
To switch the segment types, you need to redisplay the suppressed records (SHOW
SUP ON), scroll to the desired segment type and then re-hide the suppressed
records.
RELATED TOPICS
NEXTREC primary command on page 790
The offset value is an integer between -32760 and 32760, which is applied to one or
more Level 01 fields in the template. The starting position of each field within the
Level 01 record structure is increased or decreased by this value. A positive offset
moves the fields to the right and some fields might be mapped beyond the length
of the record. Data that falls beyond the length of the record is not represented.
You cannot edit a field where the data you supply would fall beyond the physical
end of the record (whether the record is of fixed or variable length). A negative
offset moves the fields to the left and all fields with a resultant zero or negative
start location are removed from the display.
All required fields must have a positive start location. Required fields are fields
such as OCCURS DEPENDING ON target fields, PL/I REFER fields, or fields
referenced in record identification or record selection criteria. If a required field
would have a negative or zero start column value under the supplied offset, the
offset is invalid, and thus not allowed. If the first element of a dimensioned field is
at a zero or negative start location, that field (all array elements) is removed from
the display.
The offset is applied before values are calculated for use in identification or
selection criteria.
RELATED TOPICS
OFFSET primary command on page 791
Managing templates on page 142
Selecting records with templates on page 197
Defining criteria expressions on page 201
Manipulating the display of fields in records on page 164
and your data records, without a template, consisted of (note the header
information in bold):
----+----1----+----2----+----3----+----4----+----5----+----6----+----7----+---
000000000102Grant Smith Developer 22 Montrose St Thornlie
000000000202Andrew Apple Developer 44 Eagle Rise Riverton
000000000302Graham Prestcott Developer 256 Hay St Cannington
000000000402Bill Somers Developer 84 Murchison Rd Dianella
000000000502Ted Dexter Developer 92 Smith St Belmont
000000000602Roddy Armstrong Manager 184 Alexander Dve Swan View
applying the template generated from this copybook would display your data as:
REC-TYPE NAME JOB-TITLE ADDR1 ADDR2
#2 #3 #4 #5 #6 +
AN 1:2 AN 3:20 AN 23:14 AN 37:20 AN 57:20
<> <---+----1----+----> <---+----1---> <---+----1----+----> <---+----1--
00 0000000102Grant Smit h Deve loper 22 Montro se St Th
00 0000000202Andrew App le Deve loper 44 Eagle Rise Ri
00 0000000302Graham Pre stcott Deve loper 256 Hay St Ca
00 0000000402Bill Somer s Deve loper 84 Murchi son Rd Di
00 0000000502Ted Dexter Deve loper 92 Smith St Be
00 0000000602Roddy Arms trong Mana ger 184 Alexan der Dve Sw
By adjusting the template with an offset of 10, the records would display as:
REC-TYPE NAME JOB-TITLE ADDR1 ADDR2
#2 #3 #4 #5 #6 +
AN 11:2 AN 13:20 AN 33:14 AN 47:20 AN 67:20
<> <---+----1----+----> <---+----1---> <---+----1----+----> <---+----1--
02 Grant Smith Developer 22 Montrose St Thornlie
02 Andrew Apple Developer 44 Eagle Rise Riverton
02 Graham Prestcott Developer 256 Hay St Cannington
02 Bill Somers Developer 84 Murchison Rd Dianella
02 Ted Dexter Developer 92 Smith St Belmont
02 Roddy Armstrong Manager 184 Alexander Dve Swan View
applying the template generated from this copybook would display your data as:
REC-RDW REC-TYPE NAME JOB-TITLE ADDR1
#2 #3 #4 #5 #6
BI 1:4 AN 5:2 AN 7:20 AN 27:14 AN 41:20
<---+----1> <> <---+----1----+----> <---+----1---> <---+----1----+---->
**** Top of data ****
-252524647 an t Smith Deve loper 22 Montrose St Thor
-252526187 dr ew Apple Deve loper 44 Eagle Rise Rive
-252524647 ah am Prestcott Deve loper 256 Hay St Cann
By adjusting the template with an offset of -4, the records would display as:
REC-TYPE NAME JOB-TITLE ADDR1 ADDR2
#3 #4 #5 #6 #7 +
AN 1:2 AN 3:20 AN 23:14 AN 37:20 AN 57:20
<> <---+----1----+----> <---+----1---> <---+----1----+----> <---+----1--
**** Top of data ****
02 Grant Smith Developer 22 Montrose St Thornlie
02 Andrew Apple Developer 44 Eagle Rise Riverton
02 Graham Prestcott Developer 256 Hay St Cannington
02 Bill Somers Developer 84 Murchison Rd Dianella
02 Ted Dexter Developer 92 Smith St Belmont
02 Roddy Armstrong Manager 184 Alexander Dve Swan View
Note: Under some circumstances, when you use the OFFSET command in an
editor session, the command only affects the display formatting of
records. You must re-enter the editor session for the select of records or
segments to reoccur. These circumstances apply on one of these
situations:
v A template indicating segmented records and some selection criteria
are present
v Record sampling
v A record limit of MEMORY
For more information on using the OFFSET primary command, see OFFSET
primary command on page 791.
2. When you are editing a template, you can enter an offset value in the Field
Selection/Edit panel to change the starting position of the currently displayed
layout. If the template contains more than one Level 01 field, you can use the
OFFSET primary command in the Record Type Selection panel to change one
or more Level 01 fields. If you wish, you can save the offset changes in the
template, so that they apply to subsequent editor sessions. For more
information about specifying an offset in a template, see Specifying offset
values on page 200.
3. When you are running a File Manager function using a template, batch
keywords let you specify offset values. The following functions support the use
of offset keywords:
Function Keywords
DSC OFFSETIN, OFFSETOUT
DSEB OFFSETIN
DSM OFFSETOLD, OFFSETNEW
DSP OFFSETIN
DSU OFFSETIN
For more information about using these keywords, see the relevant function
description in Chapter 16, Functions, on page 831.
Similar tasks can be performed on HFS files and between z/OS data sets and HFS
files. They are described in Chapter 11, Using UNIX System Services and the
Hierarchical File System, on page 385.
Note: The use of data set lists is not yet supported through the FM/CICS
interface.
Data set lists are lists of up to 30 data set names, and optionally the names of the
volumes on which the data sets reside, member names, Copybook or Template
data set names, and member names.
File Manager maintains a special dynamic reference list (called REFLIST) of the
last 30 data sets referenced by the function entry panel.
Note: Merely typing a data set name in a panel does not cause File Manager to
add that name to the reference list. The data set name has to be actually
allocated by File Manager before it is added to the reference list.
In addition to File Manager maintaining the reference list, you can create and
maintain your own personal data set lists with details of up to 30 data sets in
each list. You allocate a name to each personal data set list you create so that you
can identify it. You can use personal data set lists to retrieve frequently used data
set names and to create customized data set lists. This facility is similar to ISPF
personal data set lists, but the lists are not interchangeable between ISPF and File
Manager.
Each list (that is, REFLIST and any personal data set lists you have created)
includes the data set name and provision for storing associated details such as
member name, volume serial, copybook or template data set name, and member
name.
File Manager maintains data set lists for each user ID, across functions, and from
one File Manager session to another. For example, say you browsed a data set a
few days ago and now want to print some records from that same data set, you
can find the details of that data set in REFLIST (and any personal data set lists you
may have added the data set details to) providing you have not accessed more
than 30 data sets in the meantime.
You can open any list (making it the current data set list) and retrieve details to
the function entry panel.
Whenever you view or edit a data set, File Manager records the name of the data
set in the reference list (REFLIST). If you specified a volume name on the function
entry panel, or a member name for a PDS data set, File Manager also records those
details in the reference list. For a PDS, if you do not enter a member name on the
function entry panel, but instead select it from the member selection list, File
Manager records just the data set name.
File Manager also records the copybook or template data set name and member
name, but only if they are used. For example, if the Copybook/template processing
option is set to 3. None then, even if the Copybook or Template Data set name
and Member entry fields are not blank, File Manager does not record the contents
of those entry fields in the reference list as those details were not used. This avoids
the reference list (and potentially any personal data set lists) from holding
irrelevant and unnecessary information.
You create personal data set lists by typing in the data set names (and optionally
other details), or by saving an existing list (including the reference list) with a new
name.
The following sections describe each method of accessing data set lists.
RELATED TOPICS
Personal Data Set List panel on page 608
Personal Data Set Lists panel on page 610
Fastpath commands
You can use the following fastpath commands to access and manage data set lists:
REFA Adds the name of the data set (and associated information) most recently
referenced by the function entry panel to the specified data set list.
REFD Displays the list of data set lists.
REFL Displays the current data set list.
RELATED TOPICS
Personal Data Set List panel on page 608
Personal Data Set Lists panel on page 610
To make a data set list the current data set list, perform either of these actions:
1. Enter the REFD fastpath command to display the Personal Data Set Lists panel.
2. Open the required data set list by typing the O line command alongside the
name on the list.
1. Save an existing list to a new name. The newly-saved list becomes the current
data set list.
RELATED TOPICS
Personal Data Set List panel on page 608
Personal Data Set Lists panel on page 610
v Start with an empty list by selecting the Personal Data Set Lists option from the
Process pull-down menu on the function entry panel, and use the N (New list)
line command to create a new list, then enter the data set names and optional
additional information (member name, volume, copybook or template data set
name and member name) and use the A (Save as) line command to save it with
whatever name you choose.
v Start with the reference list (REFLIST) by selecting the Personal Data Set Lists
option from the Process pull-down menu on the function entry panel, and use
the A (Save as) line command to save it with a new name, and then change the
list as needed.
v Start with another personal data set list by selecting the Personal Data Set Lists
option from the Process pull-down menu on the function entry panel, and use
the A (Save as) line command to save it with a new name, and then change the
list as needed.
Notes:
1. For details about how to add a description to a data set entry, see Adding a
description to an entry in a data set list on page 233.
2. The N (New list) and A (Save as) line commands are also available when you
are modifying an open list.
RELATED TOPICS
Personal Data Set List panel on page 608
Personal Data Set Lists panel on page 610
Adding a new entry to a data set list: There are three ways you can add a new
entry to a data set list:
v Overtype an existing entry on the list
For an existing entry on the data set list, overtype the details with new
information. If necessary, you can also enter new details on any blank lines.
v Editing the list
1. Use the REFL fastpath command or the Process drop-down menu to display
the data set list you want to edit on the Personal Data Set List panel.
2. Enter the E (Extended Edit) line command to display the Edit Personal Data
Set List panel.
3. Type in the details of the new data set entry. When you are adding a new
entry to a data set list, you might find the following line commands useful:
I Insert a list entry
R Repeat a list entry
v Using the REFA fastpath command
Use the REFA fastpath command to add the name of the data set (and associated
information) most recently referenced by the function entry panel to the
specified data set list.
For example:
REFA NEWLIST
adds the name of the data set most recently referenced by the function entry
panel to the data set list, NEWLIST.
The list name must begin with an alphabetic character, followed by any valid
alphanumeric character for a total length of up to 8 characters. If the specified
list name does not exist, File Manager creates it.
Note: For details about how to add a description to a data set entry, see Adding a
description to an entry in a data set list.
RELATED TOPICS
Personal Data Set List panel on page 608
Personal Data Set Lists panel on page 610
Edit Personal Data Set List panel on page 538
Deleting an entry from a data set list: To delete an entry in a data set list:
1. Use the REFL fastpath command or the Process drop-down menu to display
the data set list you want to edit on the Personal Data Set List panel.
2. Enter the E (Extended Edit) line command to display the Edit Personal Data Set
List panel.
3. Type D (Delete a list entry) against the data set entry you want to delete and
press Enter. File Manager deletes the entry from the list.
RELATED TOPICS
Edit Personal Data Set List panel on page 538
Changing details for an existing entry in a data set list: To change the details for
an existing entry in a data set list:
1. Perform either of these actions:
v To modify the current data set list, either use the REFL fastpath command or,
on the function entry panel select the Current Data Set List option from the
Process pull-down menu, to open and display the current data set list, and
modify the list as required.
v To modify a data set list other than the current data set list, either use the
REFD fastpath command or, on the function entry panel select the Personal
Data Set Lists option from the Process pull-down menu, to display the list of
data set lists and use the O (Open) or E (Edit) line command on the Personal
Data Set Lists panel to open and display the required data set list, and
modify the list as required.
2. Change any of the existing information by overtyping it.
Note: For details about how to add a description to a data set entry, see Adding a
description to an entry in a data set list.
RELATED TOPICS
Personal Data Set List panel on page 608
Personal Data Set Lists panel on page 610
Adding a description to an entry in a data set list: You can add a description to
an individual entry within a data set list. For example, you might want to further
identify a data set called EMPOSEAS with the description "Employees who have
worked overseas in the last five years".
To add or view descriptions while modifying a personal data set list, on the
Personal Data Set panel, perform either of these actions:
v Type the E (Extended Edit) line command to display the Edit Personal Data Set
List panel.
v Enter the LISTVIEW command.
File Manager changes the format of the display to include an extra (third) line
where you can add or view the description for that data set entry.
RELATED TOPICS
Personal Data Set List panel on page 608
Personal Data Set Lists panel on page 610
Edit Personal Data Set List panel on page 538
LISTVIEW primary command on page 782
RELATED TOPICS
Personal Data Set List panel on page 608
When File Manager retrieves details from a data set list, it fills the Data set name
entry field on the panel with the retrieved name. If other details (such as the
associated member name, volume serial, copybook or template data set name and
member name details) are also stored for that entry in the data set list, File
Manager also retrieves those details and fills the corresponding entry fields on the
panel with the retrieved names.
Note: You can only retrieve details from the current data set list. See Making a
list the current data set list on page 231.
Point-and-shoot retrieval
To retrieve a data set name from the current data set list:
1. Open the required data set list to make it the current data set list. (See Making
a list the current data set list on page 231.)
2. Place the cursor in the field to the left of the data set name you want, and press
Enter.
The function entry panel is redisplayed with the selected name in the Data Set
Name field and any associated information in the other entry panel fields.
RELATED TOPICS
Personal Data Set List panel on page 608
Personal Data Set Lists panel on page 610
Edit Personal Data Set List panel on page 538
NRETRIEV primary command on page 791
The commands for which you may find it helpful to allocate a PF key are:
LISTVIEW
On the Personal Data Set List panel, toggles the format of the display to
include an extra (third) line where you can add or view the description for
that data set entry.
On the Personal Data Set Lists panel, toggles between the standard and
extended list format. The extended list format shows the first 6 data set
names for each list.
NRETRIEV
Retrieves the details of the first data set entry from the current data set list.
Repeated use of NRETRIEV returns details of the next data set in the
current data set list. You can only use NRETRIEV on the function entry
panel.
REFD Displays the list of data set lists.
REFL Displays the current data set list.
To allocate PF keys to one or more of the above commands, use the ISPF
command, KEYS.
With this utility, you can specify the number of records that are to be created and
how they are to be initialized. You can use fill characters and patterns to initialize
the data. By using a copybook or a template, you can also initialize records at the
field level. You can change the data create attributes for individual fields by editing
the template.
7. If you have specified the name of a new data set and you want to use another
data set as a model, spedify the name of the model data set in the Like data
set field.
8. Select your Disposition Processing Option.
1. Old/Reuse
Choose this option when you want your new data to initialize from
the beginning of an existing data set, replacing any existing records.
Note: If your VSAM data set is set to NOREUSE, selecting this option
results in an error when the panel is processed.
2. Mod
Choose this option when you want your new data to be appended to
any existing records in the data set.
Note: This option is only applicable to PDS or PDSE members. You cannot
specify Pack if you have elected to use an I/O exit.
14. Press Enter.
If you have specified an existing data set and the process is successful, a
message is displayed to show the number of records written to the file.
If you have specified a new data set name, you are asked to allocate it. When
the data set has been successfully allocated, the Data Create panel is displayed
again, with a message to show the number of records written to the file.
RELATED TOPICS
Specifying a data set and a member name on page 20
Allocating a new data set on page 240
Using File Manager functions in batch jobs on page 395
Initialization can be performed at two levels: record level and field level.
Field-level initialization takes place when you specify that a copybook or template
is to be used. In this case, the record is first filled with the character specified by
the Fillchar entry field. Selected fields are then individually initialized using the
field create attributes specified in a template.
When File Manager is creating a data set, it uses only the first record type
described in the template. The length of the records written depends upon whether
the records are fixed-length or variable-length, and the length of the record
description in the template:
v For fixed-length records, all records are created with the record length specified
for the data set. If the length of the record in the template is less than the data
set record length, the records are padded with the value specified for the
Fillchar field.
v For variable-length records, the length of each record depends upon the length
of the record built using the field attributes in the template. If the template
record description contains one or more variable-length arrays, the length of the
record varies according to the values assigned to the objects of the OCCURS
DEPENDING ON clauses or, in the case of a template created from a PL/I
copybook, arrays or variables whose number of elements or length is controlled
by a REFER variable.
Note: The length of the record in the template must always be less than or equal
to the maximum data set record length.
RELATED TOPICS
Setting the Data Create Attributes in your template on page 240
Specifying a data set and a member name on page 20
Allocating a new data set on page 240
RELATED TOPICS
Creating data without using a template on page 236
Creating data sets using a template on page 238
Allocate panel on page 442
DFSMS Using Data Sets
RELATED TOPICS
Field Attributes panel - alphanumeric fields on page 548
Field Attributes panel - numeric field on page 554
You can create or replace data in a member of a partitioned data set (PDS or PDSE)
or a sequential, VSAM, or z/FS data set, using data from one or more lines of the
data in the current editor session.
You can also add data to a sequential, VSAM, or z/FS data set, using data from
one or more lines of the data in the current editor session.
v To create data in a new member or a new data set using one or more lines of the
data in the current editor session, use the CREATE (or CREATEX) primary
command. See Creating a new member or data set using data from an edit
session.
v To replace data in an existing member or a data set with one or more lines of the
data in the current editor session, use the REPLACE (or REPLACEX) primary
command. See Replacing a member or data set using data from an edit session
on page 243.
v To add data to an existing data set using one or more lines of the data in the
current editor session, use the APPEND (or APPENDX) primary command. See
Adding data to a data set using data from an edit session on page 244.
v To create data in a new member or a new data set using all of the data in the
current editor session, use the SAVEAS (or SAVEASX) primary command. See
Using all the data from an edit session to create a new member or data set on
page 245.
To specify the lines to be put into the new member or data set, use one of these:
v C or CC prefix commands (to copy lines)
v M or MM prefix commands (to copy lines, then delete them)
v A label range. (You must specify the "from" and "to" labels on the REPLACE
command.)
Note that the lines that are copied or moved to the specified data set or member
are only those lines which are not grouped. This means that lines in any of these
groups are not copied (or moved):
v Excluded groups.
v Suppressed groups (groups of other record types when using a template).
v Not-selected groups (groups of not-selected records when using a template).
This allows for a wide variety of control over what you create in the target
member or data set, matching the current SHOW settings in the editor session.
If you specify the member name or data set name as part of the CREATE primary
command, and the move or copy line commands (or range operand) are entered,
the new member or data set is created immediately from the data in the current
editor session. The allocation attributes for a data set created in this way are taken
from the data set in the current editor session.
When the current editor session is using a PDS, you can enter the member name
with or without parentheses which is taken to mean a member within the same
PDS.
You can specify a partially-qualified or fully-qualified data set name as part of the
command.
Examples:
CREATE MEMNAM
Creates the new member, MEMNAM.
CREATE (MEMNAM)
Creates the new member, MEMNAM.
CREATE datasetname(MEMB1)
Creates member, MEMB1.
CREATE userid.datasetname(MEMB2)
Creates member, MEMB2.
CREATE userid.datasetname
Creates data set userid.datasetname, based on the current data set attributes.
If you enter the CREATE command without a member name or data set name, or
you enter the extended version of this command, CREATEX (or its abbreviation,
CREX), File Manager displays an extended create panel allowing you to enter the
name of a target data set and, optionally, member. This panel also allows you to
decide what data set to use as a model, or, if you want, to manually enter
allocation attributes for the target data set. Otherwise, the default data set
attributes are taken from the data set on which the editor session is currently
operating.
Examples:
CRE .STRT .END
Displays an extended create panel where you can enter the data set name
and, optionally, the member name.
CREX userid.dataset
Displays an extended create panel where you can enter the data set name
and, optionally, the member name.
The Pack option on the extended create panel allows you to choose whether the
data being created is stored in ISPF packed or standard format. The displayed
default reflects the current pack mode of the data being edited or viewed.
After the create processing is completed, File Manager returns you to the existing
editor session.
Notes:
1. In a CICS environment, CICS resources are not available as a target for this
command. Also, MQ resources are not available as a target for this command.
2. If the target file for a CREATE is a KSDS VSAM, the occurrence of duplicate
keys causes an informational message to be displayed, but processing of the
command continues.
RELATED TOPICS
CREATE, CREATEX primary commands on page 751
To specify the lines to be put into the new member or data set, use one of these:
v C or CC prefix commands (to copy lines)
v M or MM prefix commands (to copy lines, then delete them)
v A label range. (You must specify the "from" and "to" labels on the REPLACE
command.)
Note that the lines that are copied or moved to the specified data set or member
are only those lines which are not grouped. This means that lines in any of these
groups are not copied (or moved):
v Excluded groups.
v Suppressed groups (groups of other record types when using a template).
v Not-selected groups (groups of not-selected records when using a template).
This allows for a wide variety of control over what you create in the target
member or data set, matching the current SHOW settings in the editor session.
If you specify the member name or data set name as part of the REPLACE primary
command, and the move or copy line commands (or range operand) are entered,
the new member or data set is created immediately from the data in the current
editor session. The allocation attributes for a data set created in this way are taken
from the data set in the current editor session.
When the current editor session is using a PDS, you can enter the member name
with or without parentheses which is taken to mean a member within the same
PDS.
You can specify a partially-qualified or fully-qualified data set name as part of the
command.
Examples:
REPLACE MEMNAM
Replaces or creates the new member MEMNAM.
REPLACE (MEMNAM)
Replaces or creates the new member, MEMNAM.
REPLACE datasetname(MEMB1)
Replaces or creates member, MEMB1.
REPLACE userid.datasetname(MEMB2)
Replaces or creates member, MEMB2.
REPLACE userid.datasetname
Replaces or creates data set userid.datasetname, based on the current data set
attributes.
If you enter the REPLACE command without a member name or data set name, or
you enter the extended version of this command, REPLACEX (or its abbreviation,
REPLX), File Manager displays an extended replace panel allowing you to enter
the name of a target data set and, optionally, member. This panel also allows you
to decide what data set to use as a model, or, if you want, to manually enter
allocation attributes for the target data set. Otherwise, the default data set
attributes are taken from the data set on which the editor session is currently
operating.
Examples:
REPL .STRT .END
Displays an extended replace panel where you can enter the data set name
and, optionally, the member name.
REPLX userid.dataset
Displays an extended replace panel where you can enter the data set name
and, optionally, the member name.
The Pack option on the extended replace panel allows you to choose whether the
data being created is stored in ISPF packed or standard format. The displayed
default reflects the current pack mode of the data being edited or viewed.
After the replace processing is completed, File Manager returns you to the existing
editor session.
Notes:
1. In a CICS environment, CICS resources are not available as a target for this
command. Also, MQ resources are not available as a target for this command.
2. If the target file for a replace is a KSDS VSAM, the occurrence of duplicate keys
causes an informational message to be displayed, but processing of the
command continues.
RELATED TOPICS
REPLACE, REPLACEX primary commands on page 803
Replace panel on page 641
Note that the lines that are copied or moved to the specified data set are only
those lines which are not grouped. This means that lines in any of these groups are
not copied (or moved):
v Excluded groups.
If you specify the data set name as part of the APPEND primary command, and
the move or copy line commands (or range operand) are entered, the specified
data in the current editor session is appended to the data set immediately.
You can specify a partially-qualified or fully-qualified data set name as part of the
command.
Example:
APPEND userid.datasetname
Appends data to userid.datasetname.
If you enter the APPEND command without a data set name, or you enter the
extended version of this command, APPENDX (or its abbreviation, APPX), File
Manager displays an extended append panel allowing you to enter the name of a
target data set.
Examples:
APP .STRT .END
Displays an extended append panel where you can enter the data set
name.
APPX userid.dataset
Displays an extended append panel where you can enter the data set
name.
The Pack option on the extended append panel allows you to choose whether the
data being created is stored in ISPF packed or standard format. The displayed
default reflects the current pack mode of the data being edited or viewed.
After the append processing is completed, File Manager returns you to the existing
editor session.
Notes:
1. In a CICS environment, CICS resources are not available as a target for this
command. Also, MQ resources are not available as a target for this command.
2. If the target file for an append is a KSDS VSAM, the occurrence of duplicate
keys causes an informational message to be displayed, but processing of the
command continues.
RELATED TOPICS
REPLACE, REPLACEX primary commands on page 803
Replace panel on page 641
Note that the lines that are copied to the specified data set or member are only
those lines which are not grouped. This means that lines in any of these groups are
not copied:
v Excluded groups.
v Suppressed groups (groups of other record types when using a template).
v Not-selected groups (groups of not-selected records when using a template).
This allows for a wide variety of control over what you create in the target
member or data set, matching the current SHOW settings in the editor session.
If you specify the member name or data set name as part of the SAVEAS primary
command, the new member or data set is created immediately from the data in the
current editor session. The allocation attributes for a data set created in this way
are taken from the data set in the current editor session.
When the current editor session is using a PDS, you can enter the member name
with or without parentheses which is taken to mean a member within the same
PDS.
You can specify a partially-qualified or fully-qualified data set name as part of the
command.
Examples:
SAVEAS MEMNAM
Replaces or creates the member, MEMNAM.
SAVEAS (MEMNAM)
Replaces or creates the member, MEMNAM.
SAVEAS datasetname(MEMB1)
Replaces or creates member, MEMB1.
SAVEAS userid.datasetname(MEMB2)
Replaces or creates member, MEMB2.
SAVEAS userid.datasetname
Replaces or creates data set userid.datasetname, based on the current data set
attributes.
If you enter the SAVEAS command without a member name or data set name, or
you enter the extended version of this command, SAVEASX, File Manager displays
an extended saveas panel allowing you to enter the name of a target data set and,
optionally, member. This panel also allows you to decide what data set to use as a
model, or, if you want, to manually enter allocation attributes for the target data
set. Otherwise, the default data set attributes are taken from the data set on which
the editor session is currently operating.
Examples:
SAVEAS Displays an extended Saveas panel where you can enter the data set name
and, optionally, the member name.
SAVEASX userid.dataset
Displays an extended Saveas panel where you can enter the data set name
and, optionally, the member name.
The Pack option on the extended Saveas panel allows you to choose whether the
data being created is stored in ISPF packed or standard format. The displayed
default reflects the current pack mode of the data being edited or viewed.
After the saveas processing is completed, the editor session you are returned to is
an edit of the target PDS member or data set as specified, and the previous
member or data set is released without any save occurring. Also note that any
starting position, record limits, or sampling information that may have been
previously specified, is not active for this edit of the SAVEAS target data set.
Notes:
1. In a CICS environment, CICS resources are not available as a target for this
command. Also, MQ resources are not available as a target for this command.
2. If the target file for a SAVEAS is a KSDS VSAM, the occurrence of duplicate
keys causes an informational message to be displayed, but processing of the
command continues.
RELATED TOPICS
SAVEAS, SAVEASX primary commands (data) on page 812
Saveas panel on page 642
You can also invoke the Copy Utility by issuing the COPY line command (or by
selecting Copy from the Process pull-down menu) on the Data Set List panel,
reached using the Catalog Services Utility (3.4). For more information, see
Working with a list of catalog entries on page 308.
With or without templates, you can enhance File Manager copy processing by
specifying a REXX procedure or DFSORT statements. Using a procedure potentially
allows you greater flexibility than any of the choices listed here, but it involves the
extra complexity of programming.
With or without templates, you can copy records where the input and output data
sets have different:
v Record formats
v Record lengths
v Block sizes
Concatenated partitioned data sets with like attributes are fully supported.
Mixed partitioned data sets with like and unlike attributes are processed
correctly providing that the members being selected for processing come from
libraries with matching attributes, otherwise errors may be reported.
v Select the records to be copied using the start key (VSAM only), skip and copy
count fields, or a conditional expression defined in an input template.
v Change file attributes. You can copy records where the input and output data
sets have differing record formats, record lengths or block sizes. The copy
process truncates or pads records appropriately. To specify a pad character to be
used, use the PAD processing option on the Set Processing Options (option 0)
panel.
v Copy selected fields, change the size of fields, and create new fields in the
output file by using a From template with a To template.
v Generate data in external format
v Allocate a non-VSAM data set, or define a VSAM data set.
v Copy sequential data sets or PDS or PDSE members, converting the data to or
from ISPF PACK data format.
Note: File Manager supports the copying of Load Modules, when the following
conditions are met:
v Your input and output data sets are PDS or PDSEs.
v Your TSO environment is active (and you can use the TSO authorized
program services), or you are running File Manager as
program-authorized.
v You have not specified a REXX or DFSORT user procedure.
v You have not specified Start key, Skip or Copy counts.
v You are not using templates.
v You do not request member record counts.
If you are not using a template for your copy, use the Copy Utility panel (see
Figure 142 on page 487) as follows:
1. From the Primary Option Menu panel, select option 3. Utilities and then option
3. Copy.
Note: If you enter details in the Member field and select the Advanced
member selection option, File Manager populates the Member name
field on the subsequent Advanced Member Selection panel with the
same value.
3. Set your record-level selection, using the following entry fields on the Copy
Utility panel:
Start key
If required, specify a Start key for the data (VSAM only). Copying
starts at the first record with a key or slot number greater than or equal
to the specified value. If the key contains lowercase characters, blanks,
or commas, enclose it in quotation marks. Keys may also be in
hexadecimal format (e.g. X'0102').
Skip count
If required, specify a Skip Count for the data. Copying starts after
skipping the number of records specified in the field.
Include
If required, specify the number of physical records that to be included
in a repeating sample from a data set. Both Include and Repeat Skip
fields must have non-zero values for sampling to take effect.
Repeat skip
If required, specify the number of physical records to be skipped in a
repeating sample from a data set. Both Include and Repeat Skip fields
must have non-zero values for sampling to take effect.
Copy count
Specify the number of records to be copied. Enter ALL to copy all
records.
Note: The Start key and Skip count fields are mutually exclusive.
4. Select 2. None in the Copybook/template usage field.
Note: When this field is set to None, data in the Copybook or Template Data
set name and Member fields is ignored.
5. Select the processing options that you want:
Batch execution
Select this option when you want to generate the JCL needed to run the
function in batch. The generated JCL is displayed in an Edit session.
Use proc
Select this option when you want to run a REXX procedure or DFSORT
statements in conjunction with your copy action, and then specify the
procedure name in the adjacent field.
Note: This option is only available when File Manager is installed with
the option USEIOX=ENABLE, and the Exit enabled field in the
Set System Processing Options panel is set to YES. If a default is
specified with either of those options, it is displayed in the field
to the right of Use I/O exit.
Do not select this option if you plan to use the ISPF Packing
option on the next panel.
Skip member selection list
Select this option when you have either used a generic name in the
Member field or specified Advanced member selection, and want to
copy all members that match the name or range of names, without
further refining the member list. This option is ignored if errors are
found whilst copying.
Directory integrity
Forces an override of the default PDS(E) member processing method
which allows for faster PDS directory access.
This option has significant performance impact. When selected, the
members are processed in a way which allows concurrent directory
updates as File Manager accesses the members using current directory
information.
When not selected, the member processing is performed faster, but may
be affected by PDS(E) directory updates, possibly causing I/O errors if
the data set is updated concurrently.
Report PDS record counts
Select this option when you want the count of records for copied
PDS(E) members to be displayed (online) or printed (batch).
6. Press Enter. The Copy To panel is displayed.
7. Type the To data set details. Use a combination of the Data set name,
Member, and Volume serial entry fields (the volume serial is only required for
data sets which are not accessible via the system catalog) to specify the data set
(and PDS(E) member if appropriate) to which you want to copy the data.
If the output data set does not exist, File Manager displays the Allocation
panels to help you create a new data set.
8. Select the processing options for the Copy To panel:
DISP Determines the disposition of the To (output) data set. Specify OLD
or MOD.
1. OLD
Select this option when you want the copied records to be
placed into the To data set, starting from the beginning of the
data set and overwriting any existing records.
2. MOD
Select this option when you want the copied records to be
appended to the end of an existing output data set.
Note: SMS might modify the allocation of new data sets on your
system. For details, contact your SMS Administrator.
Replace members
Select this option when you want to replace like-named members in an
output partitioned data set.
Use I/O exit
Select this option when you want to run a user I/O exit that processes
the To (output) data set in conjunction with the copy action. If
selected, specify the exit name in the adjacent field.
If you specify an I/O exit, you cannot use the ISPF Packing option.
ISPF Packing
Provided that the output data set is a sequential, PDS or PDSE file, an
I/O exit routine is not used and the DISP is set to OLD, select one of
these options to control the copy behavior when processing data that is
in ISPF PACK format.
1. Asis
Select this option when you want File Manager to write the
output in the same format (packed or unpacked) as the input
records. If the input data is packed, it is unpacked for the
processing operation, and then written out in ISPF PACK
format.
2. Unpack
Select this option when you want File Manager to write the
output in unpacked format, regardless of the format of the
input records. If the input data is packed, it is unpacked for the
processing operation, and then written out without the ISPF
PACK format.
3. Pack
Select this option when you want File Manager to write the
output in ISPF PACK format, regardless of the format of the
input records. If the input data is packed, it is unpacked for the
processing operation, and then written out in the ISPF PACK
format.
4. None
Select this option when you do not want File Manager to check
for packed records or unpack records for processing. If the
input data is packed, any processing actions operate on the
records in their packed format.
This is the only option allowed when an I/O exit has been
specified, when the Disposition is set to MOD or when the
Copy To data set is not a sequential file or PDS(E) member.
5. Skip
Select this option when you want to halt the copying or
processing actions, if the input data is packed.
9. Press Enter.
If you selected the Advanced member selection option, File Manager displays
the Advanced Member Selection panel:
a. Specify the selection criteria to select the members you want to copy and
press Enter.
b. If you have left the Member name field on the Advanced Member Selection
panel blank or have entered an asterisk (*) or a mask, (and you did not
select the Skip member name list on the Copy From panel), File Manager
displays the Member selection panel. In this case, select the members you
want to copy (either by typing an S in the Cmd field, or with the SELECT
primary command) and press Enter.
File Manager copies the selected data in the From data set to the To data
set.
Care must be taken when attempting to combine the Use proc, Use I/O exit and
ISPF Packing options. You cannot use an I/O exit and the ISPF Packing option at
the same time. You can provide a procedure and use an I/O exit or the ISPF
Packing option but you cannot include *Fastproc DFSORT statements in your
procedure.
RELATED TOPICS
Allocating a new data set on page 240
Copy From panel on page 486
Copy To panel on page 492
Specifying a data set and a member name on page 20
DSC (Data Set Copy) on page 879
Selecting a range of PDS(E) members on page 39
Advanced Member Selection panel on page 433
3. In the Copy To panel, enter a new member name mask in the form of a
member name pattern.
A member name pattern can consist of any characters that are valid in a
member name and two special pattern characters: the asterisk (*) and percent
sign (%).
Asterisk (*)
The asterisk is a place-holding character that means multiple characters
with no change. Only one asterisk should appear in the mask. Any
subsequent asterisk characters are treated as percent signs. For example,
if you enter:
ABC*
The renamed members all begin with ABC followed by the remainder
of the old member name.
Percent sign (%)
The percent sign is a place-holding character that means a single
character with no change. As many percent symbols as necessary may
appear anywhere in a member name. For example, if you enter:
%%%A*
The table below summarizes how the Copy Utility uses information in the From
and To templates:
By default, the Copy Utility maps fields in the From template to fields with the
same name in the To template. You can edit the field mapping in the To
template, and either delete the mapping for a field (so that its value in the output
data set is initialized, rather than copied from the input data set), or specify
yourself which field in the From template is mapped to a field in the To
template.
The Copy Utility truncates or pads records appropriately. You can specify the pad
character in the PAD field on the Set Processing Options (option 0) panel.
If you are using a copybook or template for your copy, use the Copy Utility panel
(see Figure 142 on page 487) as follows:
1. From the Primary Option Menu panel, select option 3. Utilities and then option
3. Copy.
The Copy Utility panel is displayed.
2. Enter the From data set details.
3. Enter the From copybook or template details. Use a combination of the Data
set name and Member entry fields to specify the copybook or template that
describes the data in the From data set.
You can select data for copying at either record level or field level:
v For record-level selection, set the record identification and record selection
criteria in your From template.
v For field-level selection, use a From template with a To template, and
specify the selected fields, field attributes and field mapping in your To
template.
If you specify both record-level and field-level selection, File Manager first
selects data at record level, then at field level.
4. Select Copybook/template Processing Option 1. Above or 3. Create dynamic
press Enter.
If you selected option 1, an extended version of the Copy To panel appears.
This form of the panel allows you to specify the To copybook or template.
If you selected option 3, then you must create the dynamic template. Once you
have done so, the extended Copy To panel is displayed.
5. Type the To data set details.
6. Select Copybook/template Processing Option 1. Above, 2. Noneor 3. Create
dynamic press Enter.
7. If you selected option 1, enter the To copybook or template details. Use a
combination of the Data set name and Member entry fields to specify the
copybook or template that contains field selection and mapping information for
your To data set.
8. If required, select the Edit template mapping option. When the template is
displayed, you can specify the mapping of input fields to output fields the data
creation patterns for new fields.
9. Press Enter. File Manager copies the selected data in the From data set to the
To data set.
RELATED TOPICS
Copying without using a template on page 248
Specifying a data set and a member name on page 20
Mapping fields between templates on page 186
DSC (Data Set Copy) on page 879
Scrambling data
Scrambling data allows you to create test data based on production (or "live") data,
but with the ability to change the values of certain fields. In this way, you can
avoid sensitive or confidential information appearing in test data.
For scrambling to occur during the copy process, you must supply an output
template which has mapped fields marked for scrambling.
Scrambling rules
File Manager scrambles data according to these rules:
v If you do not specify any value or range options:
Uppercase alphabetic characters are scrambled to other uppercase alphabetic
characters.
Lowercase alphabetic characters are scrambled to other lowercase alphabetic
characters.
DBCS characters are scrambled to other DBCS characters.
Numerics are scrambled to other numerics.
Any other characters remain unchanged.
Repeatable scrambling produces unique results for numeric fields defined
with Leading zeros set to YES, and all non-numeric and non-DBCS fields.
v If you provide a value list, then the field is populated with a value from the list.
v If you provide a range, then the resultant number is in the range provided.
v If you specify a scramble type of random or repeatable and also the value option
and a value data set, then the field is populated with a value from the data set.
v If you specify a scramble type of translate, then the input field value is matched
and the corresponding output value is used from the value data set.
RELATED TOPICS
Specifying scrambling options on page 182
Field Attributes panel - alphanumeric fields on page 548
Field Attributes panel - numeric field on page 554
Value List Edit panel on page 697
Scramble Exit Specification panel on page 642
RELATED TOPICS
Segmented data templates on page 133
Setting up a template to be used with segmented data on page 153
external format rules to the data in a character format determined by the input
template. The output of a copy operation has an external format which can be
recognized by applications on various platforms.
Currently, you can request that the output of the copy operation be "well- formed"
XML data (the concept and terminology of Extensible Markup Language can be
found in the XML Specification 1.0 from the World Wide Web Consortium,
www.w3.org). The output format derived from the input template also conforms to
XML rules. A typical record in the output file is an XML line corresponding to an
elementary data item in the input record, and has the format:
start-tag content end-tag
where start-tag and end-tag include the data item name and content is a character
representation of the data item.
and the input record with an Order ID of O1002 and a Customer ID of C0015
made on 20050110, the corresponding sequence of XML lines is:
<ORDER>
<ORDER-ID>O1002</ORDER-ID>
<CUSTOMER-ID>C0015</CUSTOMER-ID>
<ORDER-DATE>
<ORDER-YEAR>2005</ORDER-YEAR>
<ORDER-MONTH>01</ORDER-MONTH>
<ORDER-DAY>10</ORDER-DAY>
</ORDER-DATE>
</ORDER>
File Manager assumes that the names used in a copybook or template are
legitimate XML names according to the XML specification. It does not check that
each data name, other than FILLER, is unique within the containing group.
However, names which do not start with a letter or an underscore are prefixed
with an underscore.
The format of elementary data depends on the input template or copybook. The
result is similar to the output from the Print Utility. Numeric data is converted to
character representation. File Manager removes leading zeros and blanks, trailing
blanks, skips a positive sign, and so on. Character data is included into the XML
content with trailing blanks removed (leading blanks are significant in data and are
not suppressed).
There are situations when data cannot be represented in the XML output by its
value. Data may not match the data type requirements. For example, when a
numeric field contains non-numeric characters. Character data can contain
non-printable and special characters. Non-printable characters are defined by the
default (or customized) FMNTRTBS translation table. The following special
characters have special meaning in the XML output and require different
representation:
">" (greater than)
"<" (less than)
"'" (apostrophe)
"'" (quote)
"&" (ampersand)
The XML output is generated in the character set of the input data (EBCDIC,
DBCS), but can optionally be converted to Unicode. File Manager uses standard
z/OS support for Unicode, assuming that appropriate infrastructure and services
are present. Conversion to Unicode is possible if the conversion environment is
created and activated (for details, see the z/OS Support for Unicode Using Conversion
Services). File Manager assumes CCSID 0037 for EBCDIC, 0939 for DBCS (MBCS),
and 1200 for Unicode.
You can tailor the format and content of the XML output by specifying:
v How to represent special characters
v How to represent non-printable characters
v How to represent invalid data
v Whether FILLER should be included or ignored
v Whether redefinitions are to be included or ignored
v Whether to get the XML output in the character set of input data (EBCDIC,
DBCS) or in Unicode
v The number of blanks used to indent each logical level of XML tag nesting for
better readability (logical levels 1, 2, 3, and so on), are assigned by FM by
renumbering user levels specified in the copybook (for example 01, 05, 10, and
so on)
In the cases of invalid data, non-printable and special characters, the attributes
document the actual processing of particular data rather than the parameters
specified. For example, if a data field contains both non-printable and special
characters, with SKIP and REPLACE as the corresponding parameters, the content
is skipped. REPLACE is inconsistent with SKIP in this case and is ignored. In
general, if a data field contains both special and non-printable characters, SKIP and
HEX have precedence over all other options. CDATA has less priority than SKIP
and HEX, but higher priority than the rest of the options.
The XML output can be any data set allowed by the Copy Utility, except for VSAM
KSDS. The output data set may be fixed or variable in length. If you want an
output record created for each XML line, make sure that the maximum logical
record length (LRECL) can contain the largest generated XML line. The size of the
line depends on the names used in the template, the maximum length of the
character representation of values, and the way the special and non-printable
characters and invalid data are processed. Some special characters are substituted
with strings, some data presented in hexadecimal form, and so on. This can make
the line considerably longer than expected. If you want each XML line to be placed
in a single output record, and the record is not long enough for a particular XML
line, File Manager truncates the XML line, ends processing and reports an error
(and, if in batch, sets a tailorable condition code of 8 indicating a truncation error).
If you decide that an XML line can span multiple output records, the output
dataset can have any logical record length.
RELATED TOPICS
Specifying a data set and a member name on page 20
Copy From panel on page 486
Copy To panel on page 492
DSC (Data Set Copy) on page 879
To maintain the integrity of JCL syntax as you copy, in the Copy From panel:
1. Select the JCL Source format option.
2. Select the Use proc option.
3. Specify the remainder of your copy details as required and press Enter.
4. Specify details on the Copy To panel as necessary and press Enter.
File Manager copies the selected data in the From data set to the To data
set, maintaining the integrity of any JCL where the JCL is changed during the
copy process.
RELATED TOPICS
Copy From panel on page 486
Copy To panel on page 492
DSC (Data Set Copy) on page 879
Working with files or members containing JCL on page 273
You can code any number of DFSORT or REXX statements and functions to
manipulate the output record, select specific records, print reports and tally
numeric values.