———————————————————
SirFile User's Guide
(Model 204 File Monitor)
———————————————————
Sirius Software, Inc.
875 Massachusetts Avenue, Suite 21
Cambridge, MA 02139
Telephone: (617) 876-6677
FAX: (617) 234-1200
E-mail: [email protected]
March 14, 2006
© 2006 Sirius Software, Inc.
——————————————————————————————————————————
Proprietary Notices
——————————————————————————————————————————
——————
Proprietary Notices
The following products:
●
●
●
●
●
●
●
SirDBA
SirFile
SirLib
SirMon
SirPro
SirScan
UL/SPF
are proprietary products of Sirius Software, Inc.:
Sirius Software, Inc.
875 Massachusetts Avenue, Suite 21
Cambridge, Massachusetts 02139
USA
1.617.876.6677
Model 204™ is a proprietary product of Computer Corporation of America:
Computer Corporation of America
500 Old Connecticut Path
Framingham, Massachusetts 01701
USA
1.508.270.6666
——————————————————————————————————————————
SirFile User's Guide
iii
——————————————————————————————————————————
Proprietary Notices
——————————————————————————————————————————
——————————————————————————————————————————
iv
SirFile User's Guide
——————————————————————————————————————————
Contents
——————————————————————————————————————————
——————————————————————————————————————————
vi
SirFile User's Guide
——————————————————————————————————————————
Introduction to UL/SPF
——————————————————————————————————————————
——————
CHAPTER 1
Introduction to UL/SPF
UL/SPF is a family of products implemented as User Language application subsystems
and designed to function together in a Model 204 online. Each product in the family can
be installed and run independently, or each can be installed and run as a component of
the integrated UL/SPF (User Language / System Productivity Facilities) framework.
All UL/SPF products share a common "look and feel" that is modelled upon IBM's ISPF
facilities. UL/SPF supplants the sometimes arcane command language of Model 204,
providing a highly productive full screen interface to a variety of common Model 204
functions. UL/SPF enhances the capabilities of Model 204 and bypasses many of its
restrictions, enabling the performance of routine tasks that were previously impossible or
prohibitively time-consuming.
UL/SPF comprises the following products:
SirDBA
A system that analyzes Model 204 databases to determine their logical
structure, populating an internal catalog. SirDBA is distributed as a
component of the Sir2000 Database Analysis Tools.
SirFile
A comprehensive facility both for monitoring the physical storage utilization
of Model 204 database files and for warning users of the need for file
reorganizations. SirFile maintains historical information that allows it to
predict when file sizing problems will occur, allowing a DBA to take
preventative action before an application outage results.
SirLib
A powerful and flexible system that provides change management and
configuration control for Model 204 User Language applications. SirLib is
fully integrated within the Model 204 programming environment, supporting
unique Model 204 constructs such as file groups, while remaining nearly
transparent to programmers.
SirMon
SirPro
A comprehensive facility for monitoring the performance and availability of
Model 204 online systems. SirMon combines the real time monitoring of
Model 204 performance with intelligent full screen displays that facilitate
System Manager duties.
A collection of powerful and easy to use tools for programmers, database
administrators, and application managers. SirPro provides programmers
with powerful facilities for managing large libraries of User Language
procedures, and it provides system managers with intuitive ISPF-like front
ends to many arcane Model 204 system management commands.
——————————————————————————————————————————
SirFile User's Guide
1
——————————————————————————————————————————
Introduction to UL/SPF
——————————————————————————————————————————
SirScan
A high performance utility that allows users in a Model 204 online to
browse the contents of its journal in real time. SirScan permits ordinary
users to view journal entries generated by their own online session, and it
allows users in ADMIN SCLASSes to browse journal entries for any set of
users. The data is displayed in a full-screen browser with powerful
searching commands and filtering options.
In addition, a number of subsystems that are not linked into the UL/SPF menuing
structure may be accessed via APSY-transfer from the UL/SPF applications. One such
subsystem is FACT, a utility for browsing SirFact dumps.
There are also many sample web and client-server applications developed for the Janus
product family that are distributed and installed along with the UL/SPF products. These
include JANCAT, an application that builds normalized views of Model 204 data for use
by Janus Specialty Data Store applications, and JANSSL, a system for creating and
managing SSL certificate requests.
1.1 UL/SPF Packaging and Installation Requirements
All of the UL/SPF products are Model 204 application subsystems written in User
Language. UL/SPF is distributed as a set of Model 204 files in a backup format
produced by the Model 204 DUMP command. As of UL/SPF Version 6.8, all User
Language based products are distributed in a single Model 204 procedure file called
SIRIUS.
UL/SPF makes extensive use of specialized User Language $functions provided by
Sirius Software. These $functions enable the creation of powerful User Language
application systems that can support complex environments with minimal server size
requirements. The $functions are part of the Sirius Mods, which must be installed
according to the instructions contained in Sirius Mods Installation Guide before any
UL/SPF product will work.
Although all of the Sirius Functions are documented in the Sirius Functions Reference
Manual, their use is controlled by a product authorization mechanism. Many functions
require that a specific UL/SPF product be authorized. Some functions may only be
invoked from an authorized procedure that has been “signed” by Sirius. The SI RI US
command may be used to examine the status of all Sirius products installed in a
Model 204 online.
——————————————————————————————————————————
2
SirFile User's Guide
——————————————————————————————————————————
Integrating UL/SPF with Other Subsystems
——————————————————————————————————————————
1.2 Integrating UL/SPF with Other Subsystems
UL/SPF and any of its constituent products can be easily integrated with other User
Language subsystems. Whenever a UL/SPF component product is exiting, it first
checks to see if the global variable SI RI US. COMM exists and has a non-null value. If so,
the UL/SPF product performs a subsystem transfer using the value in SIRIUS.COMM as
the name of the target subsystem.
For example, the following code fragment lets you transfer into SIRMON, and then,
when SIRMON exits, control is transferred to the application subsystem MENUSYS,
provided that NEXTPROC is the current subsystem's communication global variable:
%RC = $SETG( ' SI RI US. COMM' , ' MENUSYS' )
%RC = $SETG( ' NEXTPROC' , ' XFER' )
%RC = $SETG( ' XFER' , ' SI RMON' )
STOP
In addition to the individual User Language subsystems that implement the UL/SPF
products (SirDBA, SirFile, SirLib, SirMon, SirPro, and SirScan), Sirius distributes an
umbrella UL/SPF subsystem: The ULSPF subsystem provides a menu that contains
entries for all UL/SPF components installed at a site.
The UL/SPF subsystems support fast path navigation. For example, a SirMon user can
transfer into SirPro Option 1 by typing:
=M. 1. 1
1.3 Related Manuals
The following manuals are available for public download at
http://sirius-software.com/maint/manlist, and they may also be obtained by
contacting Sirius Software:
●
●
●
●
●
●
●
●
●
●
SirDBA User's Guide
SirFile User's Guide
SirLib User's Guide
SirMon User's Guide
SirPro User's Guide
SirScan User's Guide
UL/SPF Installation and Maintenance Guide
Sirius Mods Installation Guide
Sirius Functions Reference Manual
Sirius Messages Manual
The following manuals are part of the Model 204 documentation set available from the
Computer Corporation of America:
——————————————————————————————————————————
SirFile User's Guide
3
——————————————————————————————————————————
Introduction to UL/SPF
——————————————————————————————————————————
●
●
●
●
Model 204 Command Reference Manual
Model 204 File Manager's Guide
Model 204 System Manager's Guide
Model 204 User Language Manual
——————————————————————————————————————————
SirFile User's Guide
4
——————————————————————————————————————————
Overview and Setup for SirFile
——————————————————————————————————————————
——————
CHAPTER 2
Overview and Setup for SirFile
SirFile is a comprehensive facility for monitoring the physical storage utilization of
Model 204 database files and warning users of the need for file reorganizations.
SirFile requires only a single screen of setup information to determine “thresholds,” after
which it automatically performs a pass through the online database files, checking to see
if any file has exceeded a threshold. The process that evaluates files is called the
refresh process. The refresh process performs two types of checks:
●
It compares the current state of each file against the threshold settings to see if any
file statistic is above the critical value for that statistic.
●
It maintains a database of table usage information which it uses to determine rate of
growth and to predict when thresholds will be exceeded.
During the initial database load, all files added to the SirFile database are compared to
the system default thresholds. After the initial load, the user may override the system
default thresholds with file-specific thresholds for files that require higher or lower levels
of monitoring.
If any file table is above a threshold, SirFile flags the file with a warning, causing it to be
highlighted in SirFile. Once SirFile has stored at least one sample snapshot of a file, it
begins calculating the date at which each table will fill — assuming any table is showing
growth. If the predicted fill date falls within a user-settable number of days, SirFile posts
a prediction to the file, and the file is highlighted in the SirFile screens. When a
prediction or warning is posted using a periodic refresh, a message can also be sent to
the audit trail, as well as to a list of user IDs.
The file parameters that are evaluated for table-full status are ARETRIES, BFULLP,
CRETRIES, CFULLP, DFULLP, EXTNADD, OVFLADD, EOVFLADD, and SPILLADD.
The database refresh portion of SirFile is quite efficient, however it is the most expensive
operation in SirFile. Therefore, several options are provided for determining when to
perform a refresh, and for determining when to calculate CFULLP, generally the most
expensive of the refresh calculations.
For more information, see:
●
●
——————————————————————————————————————————
SirFile User's Guide
5
——————————————————————————————————————————
Overview and Setup for SirFile
——————————————————————————————————————————
●
calculating CFULLP
The SirFile refresh process is always in “learn” mode. Any file that is open when a
SirFile refresh is run is automatically added to the SirFile database, using the default
thresholds for comparison.
2.1 Files available for SirFile Monitoring
For SirFile to collect information on a file, it must be open in the region by some user or
subsystem. To guarantee that certain files are included in the initial load, those files can
be opened manually before initiating the refresh process. Because storing user-entered
passwords would violate most sites' security, SirFile uses a variety of methods to make
files available to itself without needing to store passwords.
1. If a file is open in the region, or SirFile manages to open the file with default
privileges, the file is added to the database and no user intervention is required.
2. The first time SirFile collects data for a file it adds the file to its Application
Subsystem definition (with low privileges in the “USER” SCLASS and high privileges
in the “ADMIN” SCLASS). Thereafter, no password is required for SirFile to open
the file. Files that are prefixed “CCA” are exempted from this operation, as these
files cause problems in SUBSYSMGMT.
3. If SirFile has a file in its database that requires a password, and a non-periodic
refresh is running (other than SIRFILE BATCH), you are prompted for the password.
4. If SIRFILE BATCH or a periodic refresh is running, SirFile skips any file it cannot
open.
2.2 File enqueuing
Besides its APSY procedure file and the UL/SPF file SIRLOCAL, SirFile requires update
access to CCASYS. All other files, even if they are defined to SirFile as optional APSY
files, are closed and freed from the subsystem at the end of each user's SirFile session.
This is done to reduce enqueuing problems.
——————————————————————————————————————————
6
SirFile User's Guide
——————————————————————————————————————————
Getting Started
——————————————————————————————————————————
2.3 Getting Started
Installation of SirFile is covered in the UL/SPF Installation and Maintenance Guide.
SirFile should be installed as a private application subsystem. To access the system,
the privileged user types “SIRFILE” on the Model 204 command line of the region
containing the software. An initial System Default thresholds screen is presented.
- - - - - - - - - - - - - -
*
*
*
Se t t hr e s hol d va l ue s f or f i l e wa r ni ngs
*
*
*
- - - - - - - - - - - -
==>
_
Fi l e
==> *DEFAULT
Thr e s hol ds
Numbe r of hi s t or i c a l
r e c or ds t o ke e p pe r f i l e .
==> 99999
ARETRI ES ==>
1
90
80
BFULLP
CFULLP
==>
==>
Mi ni mum numbe r of da ys
be t we e n s t or e d s a mpl e s .
CRETRI ES ==>
DFULLP ==>
100
90
==>
7
EXTNADD ==>
OVFLADD ==>
EOVFLADD ==>
SPI LLADD ==>
5000
5000
5000
1000
#
of da ys a dva nc e wa r ni ng
on t hr e s hol d e xc e e de d.
==>
7
Col l e c t CFULLP onl y on s pe c i f i e d f i l e s ( Y/ N) ?
==>
N
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1/ He l p 3/ Qui t
9/ Re pe a t
12/ Sa ve - Re f r e s h
System Default thresholds screen
This screen is also presented by pressing PF11 from either the Main File menu or from
the File Tables screen, if the cursor is not on a file name or file statistics line,
respectively. The System Default thresholds screen is initially populated with a set of
defaults that are adequate for most file monitoring needs. The thresholds are:
ARETRIES
Table A Retries indicate a failure of the Table A hashing algorithm to find a
slot on a Table A page to store field information. Table A is usually the
smallest table in a Model 204 database file, but it is accessed every time a
field name is referred to in User Language or IFAM code, so it is important
that Table A operate as efficiently as possible. In most cases, any
ARETRIES are too many, and for this reason, the ARETRIES default is very
small.
BFULLP Percentage of Table B full. This is the percentage of record slots currently
used, calculated as BHIGHPG/BSIZE. Table B holds the actual data in a
Model 204 file and is usually the largest table.
CRETRIES
Table C hashing algorithm retries. This statistic indicates that Table C, a
hashed data structure, is becoming full, so the algorithm which determines
——————————————————————————————————————————
SirFile User's Guide
7
——————————————————————————————————————————
Overview and Setup for SirFile
——————————————————————————————————————————
placement of new pointers in the table must run repeatedly in order to find an
empty slot. There is no fixed measure of how many retries indicate a critical
condition for Table C.
CFULLP Percentage of Table C full. Like Table A, Table C begins to exhibit hash
retries when the data in it reaches a certain density. There is no strict
formula for the maximum fullness of Table C for a given file, but a rule of
thumb is that retries will begin to appear when Table C is 70 to 80% full.
CFULLP is a more accurate measure of Table C full status than CRETRIES,
but it is very expensive to calculate. For this reason, unless you determine
CFULLP calculation file-by-file, it is only calculated by the SIRFILE BATCH
command.
DFULLP Table D percentage full. Table D can fill either as a result of index
information or User Language procedures. Percentage full in Table D is
calculated as the number of D pages used (DPGUSED) divided by DSIZE.
EXTNADD
Number of Extension Records. Extension records occur when the
information added to an existing record exceeds the usable space left on a
Table B page. Extension records are not a sign of a file full condition
pending, and in some record structures they may be unavoidable. For this
reason the EXTNADD threshold may be set very high. However, extension
records cause inefficiencies in storage and retrieval, and for some file
designs should be taken as a sign that Table B parameters are out of
balance.
OVFLADD
Addition of records to overflow areas. Overflow records may occur in either
sorted or hash files.
EOVFLADD
Addition of records to extra overflow areas. Records may be added to Extra
Overflow areas in sorted files when the Overflow area is full.
SPILLADD
Number of records that have “spilled” from the preferred overflow area into
secondary overflow areas or the overflow area prior to the appropriate sort
group. Spilled records are stored and retrieved less efficiently than other
records.
Number of historical records to keep
Number of sample records to keep for each file. SirFile requires at least 1
sample to be stored for any given file in order to make predictions about file-
full conditions. The default value of 99999 records means that SirFile will
never throw away old data, as long as the file CREATE date does not
change.
——————————————————————————————————————————
8
SirFile User's Guide
——————————————————————————————————————————
Getting Started
——————————————————————————————————————————
Minimum number of days between stored samples
Minimum number of days that must pass between samples being stored for
any particular file. This setting allows users to run the refresh as often as
they like without SirFile storing excessive amounts of data. The default of 7
ensures that no more than one record a week is maintained for any file
unless that file breaks a threshold.
# Days Warning
Number of days prior to a predicted “threshold exceeded” condition SirFile
should post a warning. During a Refresh, SirFile uses the current file table
values and the historical file information to calculate when the file will exceed
each threshold (if positive growth is detected in a threshold value). If the
number of days predicted falls within this value, a prediction and message
are posted to the file, and the file appears highlighted on the Main File menu.
Collect CFULLP only on specified files?
Specifying “Y” to this prompt allows SirFile to collect the CFULLP statistic
only on files specified by the user. Collecting CFULLP requires a TABLEC
command, which can be very I/O intensive.
●
When “Y” is specified at this prompt, the user must specifically request
each file the TABLEC command is to be run against, entering Y at the
following prompt in the File thresholds screen:
Col l e c t CFULLP f or t hi s f i l e
●
When “N” is specified at this prompt, CFULLP calculations are
performed only by the SIRFIELD BATCH command.
The user may accept the defaults or change any of the supplied settings. Pressing
PF12 saves the settings and initiates the SirFile database Refresh process.
SirFile records are fairly small and you shouldn't be too concerned about minimizing the
amount of stored data: A year's worth of data for a single file will occupy only about 1
Model 204 page if a record is kept per week.
The following commands are allowed:
OPEN xxxxxxxx
Opens a file. As data can only be collected for files that SirFile
already knows about, or files that are currently open by any user, a
SirFile user may wish to manually open a file before running a
refresh to guarantee the file is included in the sample.
CLOSE xxxxxxxx Closes a file. Any file that the SirFile user has open can be closed,
except SIRFILE, SIRLOCAL and CCASYS (the required application
subsystem files for SirFile).
——————————————————————————————————————————
SirFile User's Guide
9
——————————————————————————————————————————
Overview and Setup for SirFile
——————————————————————————————————————————
PF keys:
PF1
PF3
PF9
Accesses full-screen help.
Return to command level or previous screen.
Repeats the last command-line command.
PF12 Saves the file specific thresholds and invokes the SirFile database refresh
operation.
——————————————————————————————————————————
10
SirFile User's Guide
——————————————————————————————————————————
The Refresh Process
——————————————————————————————————————————
——————
CHAPTER 3
The Refresh Process
The Refresh process checks file tables and updates the SirFile database. You can
request a refresh operation to run once or periodically.
1. Running a refresh once always runs in the Model 204 thread of the user requesting
the refresh, and can be specified either for a single file or for all files that SirFile can
access. This can be invoked via:
●
●
●
the Main File menu, using either the ADD or REFRESH command or using
PF12
any of the File Tables, System Default thresholds, or File thresholds screens,
using PF12
the SIRFILE BATCH command. The SIRFILE BATCH command is usually
invoked only in a BATCH204 jobstream, to be run when files are not open for
2. A periodic refresh, which repeats at a specified time interval, is also called the
Background Monitor. This can be invoked via:
●
●
the Background Monitor specification screen, using PF5 . This runs the refresh
on an sdaemon thread, that is, a different thread from the requesting user.
the SIRFILE BACKGROUND interval command. This runs the refresh on an
sdaemon thread, that is, a different thread from the requesting user, and it may
be useful in the online's User 0 stream.
●
the SIRFILE SDAEMON interval command. This runs the refresh on the
thread of the requesting user, and it is most often invoked by a BATCH2 or
IODEV=3 thread.
refreshes.
Whenever the refresh operation is performed, it can consume considerable resources if
it calculates the CFULLP (Table C percentage full) value. One of the values specified on
the System Default thresholds screen is whether to allow file-by-file determination of
CFULLP calculation. If file-by-file CFULLP determination is allowed, then CFULLP is
calculated during any type of refresh, for exactly those files which are specified as
having CFULLP calculation performed. If CFULLP calculation is not determined on a
file-by-file basis, then CFULLP calculation is performed for all files by the SIRFILE
BATCH command, and is not performed by any other type of refresh.
——————————————————————————————————————————
SirFile User's Guide 11
——————————————————————————————————————————
The Refresh Process
——————————————————————————————————————————
Messages to users and the audit trail are only sent during a periodic refresh.
The Refresh process makes a list of all files already in its database, then adds to the list
any files that are currently open in the online. Then it runs through the following process
for each file on the list:
1. It checks to see if a file-specific threshold exists. If not, it compares the file to the
system default thresholds.
2. If any value in the file exceeds a threshold value, a record is stored for the file, and a
warning is posted which causes the file to be highlighted on the Main File menu.
3. If the file has not exceeded any thresholds and at least 1 sample record has been
stored for the file, SirFile performs a simple linear regression to predict when the file
will fill. If the file-full date falls within the number of days of advance warning (as
shown on the File threshold screen), a prediction and a message is posted to the
file. The file will now appear highlighted on the Main File menu and the File Tables
screen.
4. If no prediction or warning is posted to the file, SirFile performs a cleanup of any old
warnings, predictions, or messages for the file.
5. If the refresh process is running online, and SirFile encounters a file in its database
that it cannot open — either because it did not get added to its APSY definition, or
because the file is not allocated to the region — the user is prompted for a
password.
——————————————————————————————————————————
12
SirFile User's Guide
——————————————————————————————————————————
Main File Menu
——————————————————————————————————————————
——————
CHAPTER 4
Main File Menu
The Main File menu is presented on entering SirFile any time but the first; it is also
presented when PF3 is pressed from most SirFile screens. The first time entering
SirFile, the System Default thresholds screen is presented, an initial database load is
performed, then the Main File menu is presented. If any file has a warning or prediction
posted against it, it appears highlighted on the Main File menu. Because certain
terminal devices will not support extended display attributes, a pointer is also placed to
the left of any highlighted file name.
- - - - - - - - - - - - - - - - - - - - - - - - -
==>
*
*
*
Si r i us Fi l e Moni t or
*
*
*
- - - - - - - - - - - - - - - - - - - -
_
Fi l e s : 38
1
2
3
4
5
6
7
8
9
ALANPROC => 17 MOVE875
33 SI RSCAN
34 SI RULSPF
35 SI RXREF
36 TOMPROC
37 TOMWEB
38 TOOLS
ALANWEB
ALEXPROC
CCASYS
CHARPROC
DATALI NK
DEVFI LE
DMEDTC
18 M204DCTL
19 M204PROC
20 M204TEMP
21 PUBS2
22 SI RDBA
23 SI RDBAD
24 SI RFI LE
25 SI RFI LED
26 SI RFI XES
27 SI RLI B
28 SI RLI BD
29 SI RLI BP
30 SI RLOCAL
31 SI RMON
32 SI RPRO
DMEPROC
10 DMEWORK
11 DMEWORK1
12 DMEWORK2
13 J ANCAT
14 J ANSSL
15 J ANUS
16 METADATA
- - - - - - ULSPF. 016: Hi ghl i ght e d f i l e na me s ha ve
a
wa r ni ng pos t e d a ga i ns t t he m.
6/ Ms gs
11/ Thr e s hol ds 12/ Re f r e s h
1/ He l p
7/ Up
2/ Ba c kgr ound
8/ Down
3/ Qui t
9/ Re pe a t
4/ V TABLES
10/ De t a i l
Main File menu
As many as 64 files are shown at once on the Main File menu. The following commands
are allowed:
n
Where n is any number. Scrolls the display forward the
specified number of files.
-n
Where n is any number. Scrolls the display backward the
specified number of files.
F xxxxxxxx or /xxxxxxxx Searches forward in the file list for the requested file name
“xxxxxxx”.
-F xxxxxxxx or -/xxxxxxxx Searches backward in the file list for the requested file
name “xxxxxxx”.
——————————————————————————————————————————
SirFile User's Guide 13
——————————————————————————————————————————
Main File Menu
——————————————————————————————————————————
Top
Moves the display to the top of the file list.
Moves the display to the bottom of the file list.
Bottom
M
When using PF7 or PF8 , scroll up or down to the top or
bottom of the list of files.
ADD xxxxxxxx
Add the specified file to the database. SirFile attempts to
open the file. If the file cannot be opened the user is
prompted for a password on the separate password
screen. Once the file is open SirFile analyzes the file
tables, stores a file record and returns to the Main File
menu, where the new file will appear.
REFRESH xxxxxxxx
OPEN xxxxxxxx
REFRESH performs the same function as the ADD
command if the specified file is not already in the
database. If the file is in the database its tables are
checked, and a record is stored for the file if the specified
number of days has passed since the last sample, or if a
threshold has been exceeded.
Opens a file. As data can only be collected for files that
SirFile already knows about, or files that are currently open
by any user, a SirFile user may wish to manually open a
file before running a refresh to guarantee the file is
included in the sample.
CLOSE xxxxxxxx
DELETE xxxxxxxx
Closes a file. Any file that the SirFile user has open can be
closed, except SIRFILE, SIRLOCAL and CCASYS (the
required application subsystem files for SirFile).
Removes the file from the SirFile database. It is never
necessary to delete a file from SirFile, but if a file is
obsolete, or is never allocated to the online region, the
SirFile administrator may find it inconvenient to always be
prompted for passwords when the file cannot be opened
during a refresh. DELETE removes all records associated
with the file: warnings, history and thresholds.
TIME xxxx yy
Puts the screen into auto-refresh mode. The screen will
refresh xxxx times every yy seconds. This command does
not invoke the refresh process each time it wakes up, so it
is only useful if a background task (or some other user) is
running occasional refreshes, and this screen is used to
view the changed information.
——————————————————————————————————————————
14 SirFile User's Guide
——————————————————————————————————————————
Main File Menu
——————————————————————————————————————————
PF keys:
PF1
PF2
Accesses full-screen help.
Accesses the Background Monitor specification screen. This screen controls
background monitoring, and specifies actions taken when the monitor notices
file-full-pending conditions.
PF3
PF4
Return to command level or the UL/SPF main menu.
Accesses a scrollable list that displays the table-full status of files currently
open by any user or subsystem.
PF6
Accesses a screen of messages posted to the file. The only messages posted
——————————————————————————————————————————
Main File Menu
——————————————————————————————————————————
——————————————————————————————————————————
16
SirFile User's Guide
——————————————————————————————————————————
File Thresholds Screen
——————————————————————————————————————————
——————
CHAPTER 5
File Thresholds Screen
The user may specify a set of thresholds that apply to only a single file, by placing the
cursor on the filename and pressing PF11 , from either the Main File menu or from the
File Tables screen. The File thresholds screen shows the same options as on the
System Default thresholds screen, and it also displays some file-specific information.
- - - - - - - - - - - - - -
*
*
*
Se t t hr e s hol d va l ue s f or f i l e wa r ni ngs
*
*
*
- - - - - - - - - - - -
==>
_
Fi l e
==> DATALI NK
CREATE/ Re or g Da t e ==> 01/ 11/ 91 07: 59
La s t s a mpl e t a ke n ==> 02/ 24/ 99 23: 10
#
da ys unt i l
t hr e s hol d
e xc e e de d
>9999
Thr e s hol ds
Cur r e nt
Numbe r of hi s t or i c a l
r e c or ds t o ke e p pe r f i l e .
==> 99999
ARETRI ES ==>
1
90
80
0
BFULLP
CFULLP
==>
==>
23. 0
N/ A
>9999
N/ A
>9999
>9999
Mi ni mum numbe r of da ys
be t we e n s t or e d s a mpl e s .
CRETRI ES ==>
DFULLP ==>
100
90
0
26. 6
==>
7
EXTNADD ==>
OVFLADD ==>
EOVFLADD ==>
SPI LLADD ==>
5000
5000
5000
1000
0
0
0
0
>9999
>9999
>9999
>9999
#
of da ys a dva nc e wa r ni ng
on t hr e s hol d e xc e e de d.
==>
7
Col l e c t CFULLP f or t hi s f i l e ( Y/ N) ?
==>
N
- - - - - - - - - - - - ULSPF. 063: Thr e s hol d va l ue s t a ke n f r om s ys t e m de f a ul t s e t t i ngs .
1/ He l p 3/ Qui t 5/ De l e t e
9/ Re pe a t
12/ Sa ve - Re f r e s h
File thresholds screen
See the System Default thresholds screen (in “Overview and Setup for SirFile” on page
File Name
File Name
File Creation/Reorganization Date
Date of the last CREATE run against the file. This date is taken from page
trailers in the file. SirFile automatically discards its own history records for a
file if it detects that a CREATE has been run subsequent to the date of the
history records.
Last Sample Kept
The data and time of the last record stored for the file in the SirFile database.
——————————————————————————————————————————
SirFile User's Guide 17
——————————————————————————————————————————
File Thresholds Screen
——————————————————————————————————————————
Current Table Settings
The column to the right of the threshold settings contains the current file
status for ARETRIES, BFULLP, CRETRIES, DFULLP, EXTNADD,
OVFLADD, EOVFLADD, and SPILLADD.
CFULLP is not calculated in this column because of resource considerations.
If however CFULLP was collected on any sample after the first, the latest
CFULLP is presented and is used in the calculation of the value in the next
column.
# days until threshold exceeded
If SirFile has captured at least one previous sample for the target file, a third
column of values is displayed, which shows the number of days until each of
the table parameters exceeds its matching threshold. If a parameter is
showing little or no growth, or the table is empty, SirFile displays >9999“. If
the value cannot be calculated, an ”N/A“ is displayed (such as for CFULLP, if
it has not been collected).
Collect CFULLP for this file?
Selecting “Y” at this prompt allows SirFile to run the TABLEC command for
the file. This prompt is not presented if the user has specified “N” for the
following prompt on the System Default thresholds screen:
Col l e c t CFULLP onl y on s pe c i f i e d f i l e s
The following commands are allowed:
OPEN xxxxxxxx
Opens a file. As data can only be collected for files that SirFile
already knows about, or files that are currently open by any user, a
SirFile user may want to manually open a file before running a
refresh to guarantee the file is included in the sample.
CLOSE xxxxxxxx Closes a file. Any file that the SirFile user has open can be closed,
except SIRFILE, SIRLOCAL, and CCASYS (the required
application subsystem files for SirFile).
PF keys:
PF1
PF3
PF5
Accesses full-screen help.
Return to command level or previous screen.
Delete this file-specific threshold. Deleting a file-specific threshold allows the
file to be evaluated against the system default thresholds on all subsequent
refresh operations.
PF5
Delete the file-specific threshold being viewed. This operation returns the user
to the previous screen once the threshold is deleted.
——————————————————————————————————————————
18 SirFile User's Guide
——————————————————————————————————————————
File Thresholds Screen
——————————————————————————————————————————
PF9
Repeats the last command-line command.
PF12 Saves the file specific thresholds and, for this file only, invokes the SirFile
database refresh operation.
——————————————————————————————————————————
SirFile User's Guide
19
——————————————————————————————————————————
File Thresholds Screen
——————————————————————————————————————————
——————————————————————————————————————————
20
SirFile User's Guide
——————————————————————————————————————————
File Open Screen
——————————————————————————————————————————
——————
CHAPTER 6
File Open Screen
When SirFile needs to open a file, it first tries to do it without a password. If that fails the
user is prompted for a password with the following screen:
- - - - - - - - - - - - - - - - - - - - - - - - -
*
*
*
Ent e r Pa s s wor d
*
*
*
- - - - - - - - - - - - - - - - - - - - - - - - -
Fi l e
==> ADSF
Pa s s wor d ==>
_
A pa s s wor d i s r e qui r e d f or SI RFI LE t o a c c e s s t a bl e us a ge
i nf or ma t i on f or t he r e que s t e d f i l e .
wi l l be a de qua t e .
Any pr i vi l e ge l e ve l
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
3/ Qui t
6/ Ski p t hi s f i l e
9/ Ski p a l l c l os e d f i l e s
File open screen
SirFile requires only read privileges in files being monitored.
If the user is being prompted for passwords in the middle of a refresh operation, the PF
key choices are as shown in the figure, and have the following actions:
PF3
PF6
PF9
Cancel the refresh and return to the previous screen.
Skip the current file in the refresh.
Skip the this and the rest of the files in the refresh that require manual entry of
passwords.
Otherwise, for example if the user is prompted for a password due to an OPEN
command, the only PF key choice is:
PF3
Cancel the open and return to the previous screen.
——————————————————————————————————————————
SirFile User's Guide 21
——————————————————————————————————————————
File Open Screen
——————————————————————————————————————————
——————————————————————————————————————————
22
SirFile User's Guide
——————————————————————————————————————————
File Detail Screen
——————————————————————————————————————————
——————
CHAPTER 7
File Detail Screen
The File Detail screen may be accessed from the Main File menu or the File Tables
screen, by placing the cursor on a file name and pressing PF10 .
- - - - - - - - - - - - - - - - - - - ULSPF500
===>
FI LENAME ENQSHR ENQEXC
/
4. 1. 1E / CMS - - - - - - - - - - - - - - - - I NTERVAL:
*
SEC- - - -
_
NREQ
NUPD BUFPAGE CFRQUEU FI STAT FRCVOPT
ALANPROC
ASI ZE
3
0
BSI ZE
10
1
CSI ZE
10
0
0
1
0
0
4
DSI ZE FREESI Z NRECMAS NRECEXT FI LEORG
1350
FOPT
219
13
0
0
0
RETRYA BFULLP RETRYC DFULLP
0
0. 00
0
44. 74
DKRD
0. 00
2
DKWR DI RRCD DUPDTS
REQ CFRCONF
SEC
TOT
0. 00
2
0. 00
0
0. 00
0
0. 00
0. 00
0
0
RECADD RECDEL
I XADD
0. 00
0
I XDEL
0. 00
0
BADD
0. 00
0
BCHG
0. 00
0
BDEL
0. 00
0
SEC
TOT
0. 00
0
0. 00
0
BXCHNG BXDELE BXNEXT BXFI ND BXI NSE BXSPLI BXRFND BXFREE
SEC
TOT
0. 00
0
0. 00
0
0. 00
0
0. 00
0
0. 00
0
0. 00
0
0. 00
0
0. 00
0
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1/ He l p 3/ Qui t 6/ Ms gs
File Detail screen
The File Detail screen may be placed into auto-refresh mode via the TIME command:
TIME xx yy This command takes a snapshot of the file every yy seconds until xx
snapshots have been taken. The rate and total information displayed is
updated with each snapshot. The snapshots are not stored, but they
allow the user to view precise per-second changes in the state of the file.
The automatic refresh may be interrupted via PA1 .
This screen is especially useful when a warning is posted against a file,as it allows the
user to view all relevant file table information.
PF keys:
PF1
PF3
PF6
Accesses full-screen help.
Return to command level or previous screen.
Accesses the messages screen if any messages are posted against this file.
——————————————————————————————————————————
SirFile User's Guide 23
——————————————————————————————————————————
File Detail Screen
——————————————————————————————————————————
——————————————————————————————————————————
24
SirFile User's Guide
——————————————————————————————————————————
File Tables Screen
——————————————————————————————————————————
——————
CHAPTER 8
File Tables Screen
PF4 from the Main File menu presents a scrollable list of the table-full status of files
currently open by any user or subsystem.
- - - - - - - - - - - - - - - - - - FI LE 1/ 22 - - - - - ULSPF500/ 4. 1. 1E/ CMS - - - - - - - - - - - - - - - - - - - - - - - - -
===>
_
FI LENAME NRECMAS NRECEXT BFULLP DFULLP RETRYA RETRYC
DATALI NK
METADATA
SI RLI BD
CCASYS
2376
1966
1683
1432
567
423
230
29
16
15
3
0
0
6
220
23. 000 26. 666
33. 500 22. 000
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
4. 000
7. 666
96 22. 941 24. 375
M204DCTL
SI RFI LED
SI RLOCAL
M204TEMP
SI RULSPF
MOVE875
M204PROC
SI RLI BP
SI RFI XES
SI RLI B
6
0
2
0
0
0
0
0
0
0
0
0
0
35. 555 10. 000
1. 333
5. 000
3. 428
5. 000
0. 000 20. 000
0. 000 70. 843
75. 000 86. 363
0. 000 60. 031
>
0. 000
1. 400
0
0
0
0
0. 000 54. 300
0. 000 30. 344
0. 000 54. 187
0. 000 49. 600
0. 000 48. 400
SI RXREF
SI RMON
SI RFI LE
0
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1/ He l p
7/ Up
3/ Qui t
9/ Re pe a t
5/ Sor t Fi l e
11/ Thr e s h
6/ Ms gs
12/ Re f r e s h
8/ Down
10/ De t a i l
File Tables screen
Like the File Detail screen, the File Tables screen displays information about open files
in the region using statistics taken directly from the files' tables. If a file has a warning or
prediction stored against it, it is highlighted on this display.
The following commands work on this screen:
USER xxxx
restricts the view to files held open by the specified user
NUMBER (userid will not work).
SUBSYS xxxxx
restricts the view to files held open by the specified
application subsystem. An asterisk (*) can be used as a
wildcard character, so “SUBSYS SIR*” will display files that
have an enqueue on them by any subsystem beginning
with the letters “SIR”.
FILE xxxxxxx
restricts the display to the named file. An asterisk (*) can
be used as a wildcard character, so “FILE *ADAC*” will
display any files whose names contain the string “ADAC”.
——————————————————————————————————————————
SirFile User's Guide 25
——————————————————————————————————————————
File Tables Screen
——————————————————————————————————————————
n
Where n is any number. Scrolls the display forward the
specified number of files.
-n
Where n is any number. Scrolls the display backward the
specified number of files.
F xxxxxxxx or /xxxxxxxx Searches forward in the file list for the requested file name
“xxxxxxx”, and makes it the first line on the display.
-F xxxxxxxx or -/xxxxxxxx Searches backward in the file list for the requested file
name “xxxxxxx”, and makes it the first line on the display.
Top
Moves the display to the top of the file list.
Moves the display to the bottom of the file list.
Bottom
M
When using PF7 or PF8 , scroll up or down to the top or
bottom of the list of files.
SORT stat x
Where stat is the screen name of any of the displayed
statistics, and x is A or D, for ascending or descending.
Multiple sort criteria may be specified, as in the following
example:
SORT RETRYC A, NRECMAS D
OPEN xxxxxxxx
Opens a file. This is useful if you want to guarantee that a
file is included in a refresh operation you are about to
initiate.
CLOSE xxxxxxxx
Closes a file. Any file that the SirFile user has open can be
closed, except SIRFILE, SIRLOCAL and CCASYS (the
required application subsystem files for SirFile).
PF keys for this screen are:
PF1
PF3
PF6
PF7
PF8
PF9
Accesses full screen help.
Return to previous screen.
Accesses table-full prediction messages for files that have them posted.
Scrolls the display up.
Scrolls the display down.
Repeats the previous command-line command.
——————————————————————————————————————————
26 SirFile User's Guide
——————————————————————————————————————————
File Tables Screen
——————————————————————————————————————————
PF10 Accesses the File Detail screen, if the cursor is positioned over a file statistic
line when the PF key is pressed.
PF11 Accesses the threshold screen for a selected file.
PF12 Performs the Refresh process, either for all files, or for a single file if the cursor
is placed over a file statistic line when the PF key is pressed.
——————————————————————————————————————————
SirFile User's Guide
27
——————————————————————————————————————————
File Tables Screen
——————————————————————————————————————————
——————————————————————————————————————————
28
SirFile User's Guide
——————————————————————————————————————————
Messages Screen
——————————————————————————————————————————
——————
CHAPTER 9
Messages Screen
Placing the cursor on a file name in the Main File menu or the File Tables screen, and
pressing PF6 , allows the user to view messages posted to the file.
- - - - - - - - - - - - - - -
===>
*
*
*
Me s s a ge s a nd wa r ni ngs pos t e d t o f i l e
*
*
*
- - - - - - - - - - - - -
ALANPROC
_
Fi l e :
03/ 01/ 99: Ta bl e B i s l i ke l y t o e xc e e d t he t hr e s hol d on MAR 17, 1999
03/ 01/ 99: EXTNADD t hr e s hol d i s l i ke l y t o be e xc e e de d MAR 25, 1999
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1/ He l p
7/ Up
3/ Qui t
9/ Re pe a t
6/ Ma i n
8/ Down
10/ De t a i l
SIRFILE.TRC # 2
This screen can only be accessed for files that have messages posted. Messages are
only posted when a file is predicted to fill. If the file has already exceeded a threshold,
the user should view the file tables and parameters via the File Detail screen or the File
thresholds screen.
PF keys:
PF1
PF3
PF5
Accesses full-screen help.
Return to previous screen.
Delete the file-specific threshold being viewed. This operation returns the user
to the previous screen once the threshold is deleted.
——————————————————————————————————————————
SirFile User's Guide 29
——————————————————————————————————————————
Messages Screen
——————————————————————————————————————————
——————————————————————————————————————————
30
SirFile User's Guide
——————————————————————————————————————————
Background Monitor Specification Screen
——————————————————————————————————————————
——————
CHAPTER 10
Background Monitor Specification Screen
PF2 from the Main File menu presents the Background Monitor specification screen.
- - - - - - - - - - - - - - - - - - - - -
==>
*
*
*
Ba c kgr ound Fi l e Moni t or
*
*
*
- - - - - - - - - - - - - - - - - - - -
_
De f a ul t moni t or i ng i nc r e me nt ( mi nut e s )
==>
9
- - - - - - - - - - - - - - - - - - - - - - - - Wa r ni ngs - - - - - - - - - - - - - - - - - - - - - - - - - - -
Se nd wa r ni ngs t o t he j our na l ? ( Y/ N)
Wa r n: Ne ve r , Fi r s t t i me onl y,
==>
==>
N
1
0
=
1
=
2
=
Eve r y t i me
Ot he r us e r s t o r e c e i ve wa r ni ng me s s a ge s ( s e pa r a t e by bl a nks ) :
==> OPR
- - - - - - - - - - - - - - - - - - - - - - - Pr e di c t i onm 2
1
Tf 52. 461
0
TD0 Tw( ==>) Tj/ TT4
1
Tf 1. 8003
0
TD- 0. 0001 Tw(
1
) Tj- 5
——————————————————————————————————————————
Background Monitor Specification Screen
——————————————————————————————————————————
Predictions to Journal
Y or N. Specifying Y causes SirFile to send a user audit line
(record type US) to the journal each time a prediction condition
is noticed by the background task. (Prediction conditions mean
the file is predicted to fill within the number of days of advance
warning as shown on the File threshold screen.)
Predict frequency
Predict List
0, 1 or 2. “0” causes SirFile to disregard predictions. “1” causes
SirFile to warn users on the predict list the first time a prediction
condition is noticed. “2” causes SirFile to send a warning to
each user ID on the predict list each time the background task
notices the condition.
Specify a list of user IDs and/or thread numbers to receive
prediction messages by the background task. User IDs and
numbers must be separated by blanks or commas.
The following commands work on this screen:
OPEN xxxxxxxx Opens a file. As data can only be collected for files that SirFile
already knows about, or files that are currently open by any user, a
SirFile user may wish to manually open a file before running a
refresh to guarantee the file is included in the sample.
CLOSE xxxxxxxx Closes a file. Any file that the SirFile user has open can be closed,
except SIRFILE, SIRLOCAL and CCASYS (the required application
subsystem files for SirFile).
PF keys:
PF1
PF3
PF5
Accesses full-screen help.
Return to previous screen.
Save the new background task specifications, and initialize the background
task. If the background task is already running, the user is notified. To make
the background task accept the new settings, the sdaemon background user
should be bumped and restarted.
PF9
Repeats the previous command-line command.
PF12 Save the new background task specifications.
——————————————————————————————————————————
32
SirFile User's Guide
——————————————————————————————————————————
Invocation Techniques for Background Monitoring
——————————————————————————————————————————
——————
CHAPTER 11
Invocation Techniques for Background
Monitoring
SirFile's background monitor runs as a special user in the SIRFILE APSY; this performs
the periodic refresh operation. Messages to users and the audit trail are only sent
during a periodic refresh (that is, by the background task).
Any user ID can be the background monitor, and any SirFile user can initiate the
background task. The most useful way to run the background monitor is in one of the
sdaemon IODEVs set up in the online. If you are going to run the background file
monitor in an sdaemon, you should allocate an extra one explicitly for this task. Failing
to allocate an extra sdaemon can slow down other jobs initiated from Sirius products
which require sdaemon servicing.
When the background monitoring task is sent to an sdaemon, the task appears as the
sdaemon thread number and the user ID of the submitting user. The sdaemon sits in a
WAIT state until the specified number of minutes has passed, then it wakes up and runs
a SirFile database refresh, sends warnings as appropriate, then returns to a “sleep”
state. The background task may be BUMPed the same as any user. To change the
time parameter for the background task, it should be bumped and resubmitted.
be initiated via one of the following commands:
SIRFILE BACKGROUND interval
This command, typed at command level or inserted in the USER0 stream,
initiates the background task under an sdaemon. Interval specifies the
number of minutes the background task should sleep between refresh
operations; it is a required value and must be between 1 and 1440 (24
hours).
If no sdaemon is available or if the background task is already running, the
submitting user is warned, and the request is ignored.
SIRFILE SDAEMON interval
This command, typed at command level, causes the session to become the
background task. Interval specifies the number of minutes the background
task should sleep between refresh operations; it is a required value and must
be between 1 and 1440 (24 hours).
The command may be placed in a BATCH2 or IODEV3 input stream, or it
may be typed at command level from any terminal. Typing this command on
——————————————————————————————————————————
SirFile User's Guide 33
——————————————————————————————————————————
Invocation Techniques for Background Monitoring
——————————————————————————————————————————
a terminal will cause that session to become the background SirFile task:
that is, it will enter a “sleep” state that is not interruptable unless it is
bumped.
You can also use the SIRFILE BATCH command to invoke a refresh once; see
do this.
——————————————————————————————————————————
34
SirFile User's Guide
——————————————————————————————————————————
Running SirFile under BATCH204
——————————————————————————————————————————
——————
CHAPTER 12
Running SirFile under BATCH204
Running SirFile's database refresh in batch has two advantages over running it in the
online:
1. It allows the database refresh to be scheduled on a regular basis by a job
scheduling system.
2. It allows the most expensive processing in SirFile to be run in off hours.
In addition, if you have specified “N” for the following prompt on the System Default
thresholds screen, the CFULLP statistic is only calculated if the refresh is run via the
SIRFIELD BATCH command:
Col l e c t CFULLP onl y on s pe c i f i e d f i l e s
CFULLP is a more accurate measure of the full status of Table C, but it requires that a
TABLEC command be executed, which can be a very resource-intensive operation.
Following is a sample job fragment and CCAIN stream showing the SirFile refresh being
run in BATCH204.
/ / SI RFI LE J OB ( 0) ' Ba t c h Re f r e s h' , CLASS=X
/ / REFRESH EXEC PGM=BATCH204, SYSOPT=187
/ / . . .
/ / CCASYS
/ / CCAGRP
DD DSN=M204. CCASYS, DI SP=SHR
DD DSN=M204. CCAGRP, DI SP=SHR
/ / SI RFI LE DD DSN=M204. SI RFI LE, DI SP=SHR
/ / SI RLOCAL DD DSN=M204. SI RLOCAL, DI SP=SHR
/ / PROCFI LE DD DSN=M204. PROCFI LE, DI SP=SHR
/ / PROCFI L2 DD DSN=M204. PROCFI L2, DI SP=SHR
/ / . . .
/ / CCAI N *
NFI LES=99, NDI RS=99, NDCBS=99, NUSERS=2, NSERVS=2, . . .
I ODEV=15, POLLNO=1, NOTERM=1
LOGON f i l e ma na gr
pa s s wor d
OPEN FI LE PROCFI LE1
pa s s wor d
OPEN FI LE PROCFI L2
pa s s wor d
. . .
SI RFI LE BATCH
EOJ
/ *
/ /
——————————————————————————————————————————
SirFile User's Guide 35
——————————————————————————————————————————
Running SirFile under BATCH204
——————————————————————————————————————————
The job is simply a BATCH204 job that contains CCASYS and CCAGRP, and it has a
DD card for any file SirFile is going to monitor. The IODEV=15 statement is required;
change it to IODEV=nn if you reset the SDAEMDEV parameter to nn. SYSOPT for the
job must allow for use of Groups and Application Subsystems. If any file is not yet in the
SirFile database or requires a password to open, it should be opened explicitly in the
CCAIN stream.
The command SIRFILE BATCH tells the SIRFILE APSY to run through the Refresh
process, including TABLEC calculations for CFULLP (Table C percentage full) if
CFULLP allocation is not determined file-by-file.
Note: A file must be open with File Manager privileges (PRIVDEF must contain the
x'8000' bit) in order for the TABLEC command to operate. When SirFile adds files to its
APSY definition, it adds them with privileges x'0221' to SCLASS “USER” and x'8221' to
SCLASS “ADMIN”. If a site wants to run the batch job with TABLEC commands for each
file, the logged-on user in the batch job must be in the ADMIN SCLASS.
Users may customize their run by manually changing privileges for specific files in the
USER SCLASS to x'8221'. Then, running SIRFILE BATCH with a user ID from the
USER SCLASS will only calculate TABLEC for the files with high privileges. (Note that
the output will show a failure of the TABLEC command for all files with too low of
privileges).
——————————————————————————————————————————
36
SirFile User's Guide
——————————————————————————————————————————
File statistics definitions
——————————————————————————————————————————
——————
APPENDIX A
File statistics definitions
File statistics provide information about each file open in the Online system. Each file
has a specific value for each statistic based on the file's current activity and state within
the Online region. Many of these statistics are viewable on the File Tables screen and
the File Detail screen in SirFile. Others may be viewable only at command level or
through SirMon.
ASIZE
Size of table A in number of pages.
Table A strings per page.
ASTRPPG
ATRPG
Number of attribute pages in Table A.
BACKOUTS
Number of backed out update units since the file was opened. The stat
begins incrementing when the file is first opened, and is reset to 0 when
the last user closes it. If the file is reopened the incrementing begins
again from 0 (rate or total).
BADD
BCHG
BDEL
Fields added to Table B (rate or total).
Fields changed in place in Table B (rate or total).
Fields deleted from table B (rate or total).
BFULLP
Estimate of the percentage of table B that is full. This statistic is equal to
the table B highest active page (BHIGHPG) divided by the total number
of table B pages (BSIZE).
BHIGHPG
BLOWPG
BQLEN
The current table B high water mark. Same as the Model204 BHIGHPG
parameter.
The lowest active table B page. Same as the Model204 BLOWPG
parameter.
The number of pages in the table B reuse queue. Same as the
Model204 BQLEN parameter.
BRECPPG
Maximum number of records per Table B page.
BRESERVE
The amount of space in bytes on a Table B page on which new records
cannot be started. The space is reserved for the expansion of existing
records on the Table B page.
——————————————————————————————————————————
SirFile User's Guide 37
——————————————————————————————————————————
File statistics definitions
——————————————————————————————————————————
BREUSED
The number of records added to the file that reused the record number
of a previously deleted record. Same as the Model204 BREUSED
parameter.
BSIZE
Size of table B in number of pages.
BUFPAGA
Total number of pages in the disk buffer pool currently occupied by table
A pages from the database file.
BUFPAGB
BUFPAGC
BUFPAGD
BUFPAGE
Total number of pages in the disk buffer pool currently occupied by table
B pages from the database file.
Total number of pages in the disk buffer pool currently occupied by table
C pages from the database file.
Total number of pages in the disk buffer pool currently occupied by table
D pages from the database file.
Total number of pages in the disk buffer pool currently occupied by
pages from all tables in the database file. Equal to BUFPAGA +
BUFPAGB + BUFPAGC + BUFPAGD + BUFPAGF + BUFPAGL.
BUFPAGF
BUFPAGL
BXCHNG
Total number of pages in the disk buffer pool currently occupied by FCT
pages from the database file.
Total number of pages in the disk buffer pool currently occupied by
Table E pages from the database file.
New segments of records starting or local lists deleted in the ordered
index (rate or total).
BXDELE
BXFIND
Removals from tree structure in the ordered index. (rate or total).
Searches to locate FIELD NAME = VALUE pairs in the ordered index
(rate or total).
BXFREE
BXINSE
Nodes emptied in the ordered index (rate or total).
New records inserted with an unused FIELD NAME = VALUE pair in the
ordered index (rate or total).
BXNEXT
FIELD NAME = VALUE pairs touched in the ordered index during range
retrievals (rate or total).
BXRFND
BXSPLI
Calls for range retrieval from the ordered index (rate or total).
Node splits in the ordered index (rate or total).
——————————————————————————————————————————
38 SirFile User's Guide
——————————————————————————————————————————
File statistics definitions
——————————————————————————————————————————
CFRCDEX
CFRCDIR
CFRCEXS
CFRCIND
Conflicts on the "DIRECT" and "EXISTS" critical file resources (rate or
total). Equal to CFRCDIR+CFRCEXS.
Conflicts on the "DIRECT" critical file resource (rate or total). This
resource protects the integrity of Table B.
Conflicts on the "EXISTS" critical file resource (rate or total). This
resource protects the integrity of the existence bit map.
Conflicts on the "INDEX" critical file resource (rate or total). This
resource protects the integrity of the database indexes.
CFRCONF
CFRCREC
Conflicts on all critical file resources (rate or total).
Conflicts on the "RECENQ" critical file resource (rate or total). This
resource protects the integrity of the record enqueuing tables.
CFRQDEX
CFRQDIR
CFRQEXS
CFRQIND
CFRQREC
Number of users waiting for either the "DIRECT" or "EXISTS" critical file
resource. Equal to CFRQDIR+CFRQEXS.
Number of users waiting for the "DIRECT" critical file resource. This
resource protects the integrity of table B.
Number of users waiting for the "EXISTS" critical file resource. This
resource protects the integrity of the existence bit map.
Number of users waiting for the "INDEX" critical file resource. This
resource protects the integrity of the database indexes.
Number of users waiting for the "RECENQ" critical file resource. This
resource protects the integrity of the record enqueuing tables.
CFRQUEU
COMMITS
Number of users waiting for any critical file resource.
Number of committed update units since the file was opened. The stat
begins incrementing when the file is first opened, and is reset to 0 when
the last user closes it. If the file is reopened the incrementing begins
again from 0. (rate or total.)
CSIZE
Size of table C in number of pages.
DFULLP
Percentage of table D that is full. This statistic is equal to the number of
table D pages currently in use (DPGSUSED) divided by the total number
of table D pages (DSIZE).
DHIGHPG
DIRRCD
The current table D high water mark. Same as the Model204 DHIGHPG
parameter.
Number of records scanned in direct searches (rate or total).
——————————————————————————————————————————
SirFile User's Guide 39
——————————————————————————————————————————
File statistics definitions
——————————————————————————————————————————
DKIO
Physical page reads/writes to/from the Model204 database file (rate or
total). This value is equal to DKRD + DKWR.
DKRD
Physical pages reads from the Model204 database file (rate or total).
DKUPTIME
Number of milliseconds spent writing a file's pages to disk, and marking
it "physically consistent". It includes time writing pages even if the disk
update was interrupted. This stat is presented by SirMon in seconds.
DKWR
Physical page writes to Model204 database file (rate or total).
DPGSUSE
The current number of table D pages in use. Same as the Model204
DPGSUSED parameter.
DSIZE
Size of table D in number of pages.
DUPDTS
Records written to the deferred update data set for the Model204
database file (rate or total).
EFULLP
Percentage of table E that is full. This statistic is equal to the number of
table E pages currently in use (EPGSUSED) divided by the total number
of table E pages (ESIZE).
EHIGHPG
ENQEXC
ENQSHR
EOVFADD
EOVFDEL
EPGSUSE
The current table E high water mark. Same as the Model204 EHIGHPG
parameter.
Total number of users and subsystems that have the database file
opened in update mode.
Total number of users and subsystems that have the database file
opened in read/only mode.
Number of records added to the extra overflow areas. Same as the
Model204 EOVFLADD parameter (rate or total).
Number of deleted from to the extra overflow areas. Same as the
Model204 EOVFLDEL parameter (rate or total).
The current number of table E pages in use. Same as the Model204
EPGSUSED parameter.
ESIZE
Size of table E in number of pages.
EXTNADD
Number of extension records added to table B. Same as the Model204
EXTNADD parameter (rate or total).
EXTNDEL
Number of extension records deleted from table B. Same as the
Model204 EXTNDEL parameter (rate or total).
——————————————————————————————————————————
40 SirFile User's Guide
——————————————————————————————————————————
File statistics definitions
——————————————————————————————————————————
FCTB
FCTM
Total number of pages in the disk buffer pool currently occupied by FCT
pages from the database file.
Total number of pages in the disk buffer pool currently occupied by
modified FCT pages from the database file. These pages must be
written to disk before they can be flushed from the buffer pool.
FIFLAGS
Summed hex value representing file status detail. Valid settings are
sums of the following values:
X' 80' - Gr oup i nde x e nt r y r e qui r e d ( s or t e d f i l e s ) .
X' 40' - Ta bl e B a ppe nds pa ge f ul l .
X' 20' - Cur r e nt l y a c t i ve Ta bl e D i nve r s i on pa ge
f ul l .
X' 10' - Fi e l d l e ve l c ons t r a i nt s ( f i l e ha s a t l e a s t
one f i e l d wi t h a UNI QUE a t t r i but e ) .
X' 08' - Ne w Ta bl e C l ogi c f or i ni t i a l pr ope r t y
e nt r y.
X' 04' - Or de r e d I nde x l i s t pa ge f ul l .
X' 01' - Fi l e i s pos t r e l e a s e 3. 16.
FILEORG
Summed hex value representing the organization of Table B. Valid
settings are sums of the following values:
X' 40' - Fi l e s ke wi ng i s e na bl e d.
X' 20' - Unor de r e d f i l e .
X' 08' - Ha s h ke y f i l e .
X' 04' - Re us e Re c or d Numbe r f i l e ( RRN) .
X' 02' - Sor t or ha s h ke y r e qui r e d i n e ve r y r e c or d.
X' 01' - Sor t e d f i l e .
X' 00' - Ent r y or de r f i l e .
FISTAT
The current value of the database file's status byte. Same as the
Model204 FISTAT parameter. Values can be summed:
X' 40' - Fi l e mi ght be l ogi c a l l y i nc ons i s t e nt .
X' 20' - Fi l e i s i n de f e r r e d upda t e mode .
X' 10' - Fi l e ha s be e n r e c ove r e d.
X' 08' - Fi l e i s f ul l .
X' 02' - Fi l e i s phys i c a l l y i nc ons i s t e nt .
X' 01' - Fi l e i s not i ni t i a l i z e d.
Model204 FISTAT parameter.
FOPT
Summed hex value representing file options, as follows:
X' 80' - Pr ohi bi t s t a t e me nt numbe r s i n pr oc e dur e s .
X' 40' - Pr ohi bi t s t a t e me nt l a be l s i n pr oc e dur e s .
X' 08' - Appe nd- f i r s t mode i n RDFS f i l e .
X' 02' - Di s a bl e l oc k pe ndi ng upda t e s .
X' 01' - Di s a l l ow ne w f i e l d na me de f i ni t i ons .
X' 00' - Al l ow l a be l s a nd s t a t e me nt numbe r s i n
pr oc e dur e s .
——————————————————————————————————————————
SirFile User's Guide 41
——————————————————————————————————————————
File statistics definitions
——————————————————————————————————————————
FRCVOPT
Summed hex value indicating file recovery options, as follows:
X' 80' - Upda t e s not a l l owe d wi t hout r ol l f or wa r d
a c t i ve .
X' 40' - Upda t e s not a l l owe d unl e s s c he c kpoi nt i ng
a c t i ve .
X' 20' - Fi l e doe s not pa r t i c i pa t e i n
c he c kpoi nt i ng.
X' 10' - Di s c ont i nui t i e s not a l l owe d.
X' 08' - Tr a ns a c t i on ba c kout di s a bl e d.
X' 04' - Fi l e doe s not t a ke pa r t i n r ol l f or wa r d
l oggi ng.
X' 02' - Fi l e doe s not pa r t i c i pa t e i n r ol l f or wa r d.
X' 01' - Tr a ns a c t i on bounda r i e s a r e i gnor e d whe n
a ppl yi ng r ol l f or wa r d upda t e s .
FREESIZ
FVFPG
Number of unassigned pages in the database file. Same as the
Model204 FREESIZE parameter.
Number of Table A pages used for storing the values from "few valued"
coded fields.
HIGHSRT
IXADD
Record number containing the highest sort key. Same as the Model204
HIGHSORT parameter.
Index entries added to tables C and D, including attempts to add
duplicates (rate or total).
IXDEL
Index entries deleted from tables C and D (rate or total).
MODPAGA
Total number of pages in the disk buffer pool currently occupied by
modified table A pages from the database file. These pages must be
written to disk before they can be flushed from the buffer pool.
MODPAGB
MODPAGC
MODPAGD
MODPAGE
Total number of pages in the disk buffer pool currently occupied by
modified table B pages from the database file. These pages must be
written to disk before they can be flushed from the buffer pool.
Total number of pages in the disk buffer pool currently occupied by
modified table C pages from the database file. These pages must be
written to disk before they can be flushed from the buffer pool.
Total number of pages in the disk buffer pool currently occupied by
modified table D pages from the database file. These pages must be
written to disk before they can be flushed from the buffer pool.
Total number of pages in the disk buffer pool currently occupied by
modified pages from all tables in the database file. These pages must
be written to disk before they can be flushed from the buffer pool. Equal
to MODPAGA + MODPAGB + MODPAGC + MODPAGD + MODPAGF
+ MODPAGL.
——————————————————————————————————————————
42 SirFile User's Guide
——————————————————————————————————————————
File statistics definitions
——————————————————————————————————————————
MODPAGF
Total number of pages in the disk buffer pool currently occupied by
modified FCT pages from the database file. These pages must be
written to disk before they can be flushed from the buffer pool.
MODPAGL
Total number of pages in the disk buffer pool currently occupied by
modified table E pages from the database file. These pages must be
written to disk before they can be flushed from the buffer pool.
MSTRADD
MSTRDEL
MVFPG
Number of records added to table B. Same as the Model204 MSTRADD
parameter (rate or total).
Number of records physically deleted from table B. Same as the
Model204 MSTRDEL parameter (rate or total).
Number of Table A pages used for storing the values from "many
valued" coded fields.
NDPU
The current number of table D pages in use. Same as the Model204
DPGSUSED parameter.
NPTA
Size of table A in pages. Same as ASIZE.
NPTB
Size of table B in pages. Same as BSIZE.
NPTC
Size of table C in pages. Same as CSIZE
NPTD
Size of table D in pages. Same as DSIZE.
NPTE
Size of table E in pages. Same as ESIZE.
NPTF
Size of FCT in pages.
NRECEXT
NRECMAS
NRECOVF
NRECSPL
NREQ
Number of extension records currently in table B.
Number of master records currently in table B.
Number of records currently in overflow areas in table B.
Number of records currently in spill areas in table B.
Current number of active transactions which reference the file.
Current number of active transactions which update the file.
Number of Ordered Index B-tree levels (depth of the B-tree).
NUPD
OIDEPTH
OILEAFP
Percentage of ordered index leaf pages that contain data. OILEAFP =
100 * (OINBYTS / OILEAVS) / PAGESZ. In general, the higher this
——————————————————————————————————————————
SirFile User's Guide 43
——————————————————————————————————————————
File statistics definitions
——————————————————————————————————————————
value, the better. After a reorg, this value will generally be close to 100 -
LRESERV. A value close to 50 or lower is a sign of relatively low
ordered index density and suggests a reorg.
OILEAVS
The number of Ordered Index B-tree leaf-level nodes. The number of
Table D pages used for the B-tree leaves.
OILPACT
OINBYTS
OINENTR
Page number of the Order Index B-tree page which is active.
Number of Ordered Index B-tree entry bytes. .
The number of distinct field name = value pairs stored in the Ordered
Index B-tree.
OINODEP
Percentage of ordered index node pages that contain data. OINODEP
= 100 * (OINBYTS / OINODES) / PAGESZ. In general, the higher this
value, the better. After a reorg, this value will generally be close to 100 -
LRESERV. A value close to 50 or lower is a sign of relatively low
ordered index density and suggests a reorg. This value will usually be
close to OILEAFP except in the case where there are few leaf nodes per
higher level nodes. This situation would suggest a reorg.
OINODES
The number of Ordered Index B-tree nodes. The total number of Table
D pages used for the Ordered Index B-tree.
OPENCTL
OVFLADD
PUBLIC, PRIVATE or SEMIPUBLIC status of file.
Number of records added to overflow areas in table B. Same as the
Model204 OVFLADD parameter (rate or total).
OVFLDEL
PDCHUNK
Number of records deleted from overflow areas in table B. Same as the
Model204 OVFLDEL parameter (rate or total).
Number of "chunks" allocated for the procedure dictionary. The
procedure dictionary is allocated in chunks of PDSIZE pages. When an
attempt to store a name in the dictionary fails because all chunks are
full, a new chunk is allocated.
PDPAGES
Total number of pages allocated for the procedure dictionary. Equal to
PDCHUNK * PDSIZE.
PDSIZE
Procedure Dictionary size.
PDSTRPG
PNDGTIME
Procedure Dictionary Strings per page.
Number of milliseconds since the last update unit completed that a file's
pages have been waiting to be written. The stat is only accumulated
when DKUPDTWT is non-zero.
——————————————————————————————————————————
44 SirFile User's Guide
——————————————————————————————————————————
File statistics definitions
——————————————————————————————————————————
PRIVDEF
Default privileges for the file (summed hex value).
RCVYTIME
Date/time recovery was last performed or REGENERATE used.
RCVYTIME is formatted "YYYYJJJHHMMSSTH", for year, Julian date,
hours, minutes, seconds and tenths of seconds. This value is the same
as that returned by DTSLRCVY.
RECADD
RECDEL
Records started in table B not including extension records (rate or total).
Records deleted from table B not including extension records or records
deleted by DELETE RECORDS or IFDSET (rate or total).
REQ
Number of requests and DISPLAY PROCEDURE commands run on the
file (rate or total).
RETRYA
Number of table A rehashes required to add an item to table A. This
statistics returns the total for the file since it was initialized. A high value
for RETRYA could indicate that table A is getting close to being full.
RETRYC
SECTY
Number of table C rehashes required to add an item to table C. This
statistics returns the total for the file since it was initialized. A high value
for RETRYC could indicate that table C is getting close to being full.
Summed hex value indicating type of security in effect for file:
X' 01' - Pr oc e dur e s e c ur i t y.
X' 04' - Pr oc e dur e s s e c ur e d a f t e r Re l e a s e 4.
SPILADD
SPILDEL
UPDTDUR
Number of records added to spill areas in table B. Same as the
Model204 SPILLADD parameter (rate or total).
Number of records deleted from spill areas in table B. Same as the
Model204 SPILLDEL parameter (rate or total).
Number of milliseconds the file has been part of at least on update unit.
This includes the time for Model 204 to mark the file physically
consistent (the action that completes the update unit). Presented by
SirMon in seconds.
UPDTIME
Date and time file was last updated. UPDTTIME is formatted
"YYYYJJJHHMMSSTH", for year, Julian date, hours, minutes, seconds
and tenths of seconds. This stat is the same as Model 204's file statistic
DTSLUPDT.
——————————————————————————————————————————
SirFile User's Guide 45
——————————————————————————————————————————
File statistics definitions
——————————————————————————————————————————
——————————————————————————————————————————
46
SirFile User's Guide
——————————————————————————————————————————
Date Processing
——————————————————————————————————————————
——————
APPENDIX B
Date Processing
SirFile uses dates in the following ways:
●
To examine the CPU clock (as returned by the STCK hardware instruction) to
determine the current date, in case SirFile is under a rental or trial agreement
●
To display the current date, as returned by the TIME SVC, modified by the
SYSDATE parameter or the the Sir2000 User Language Tools APPDATE clock, as
page headers in various end-user displays
●
To keep track of the date and time of various changes to a file, to enable predictions
about file conditions, using the TIME SVC, modified by the SYSDATE parameter or
the the Sir2000 User Language Tools APPDATE clock
For headers on pages or rows that occur on printed pages or displayed screens, Sirius
Software products generally use a full four-digit year format, although they may display
dates with two-digit years in circumstances where the proper century can be inferred
from the context.
——————————————————————————————————————————
SirFile User's Guide 47
——————————————————————————————————————————
Date Processing
——————————————————————————————————————————
——————————————————————————————————————————
48
SirFile User's Guide
——————————————————————————————————————————
Index
——————————————————————————————————————————
——————————————————————————————————————————
50
SirFile User's Guide
|