CA TPX Session Management Batch Administration

CA TPX™ Session Management
Batch Administration Guide
Release 5.3
This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to
as the “Documentation”) is for your informational purposes only and is subject to change or withdrawal by CA at any time. This
Documentation is proprietary information of CA and may not be copied, transferred, reproduced, disclosed, modified or
duplicated, in whole or in part, without the prior written consent of CA.
If you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make
available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with
that software, provided that all CA copyright notices and legends are affixed to each reproduced copy.
The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable
license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to
certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.
TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION “AS IS” WITHOUT WARRANTY OF ANY
KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE,
DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST
INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE
POSSIBILITY OF SUCH LOSS OR DAMAGE.
The use of any software product referenced in the Documentation is governed by the applicable license agreement and such
license agreement is not modified in any way by the terms of this notice.
The manufacturer of this Documentation is CA.
Provided with “Restricted Rights.” Use, duplication or disclosure by the United States Government is subject to the restrictions
set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or
their successors.
Copyright © 2013 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to
their respective companies.
CA Technologies Product References
This document references the following CA Technologies products:
■
CA TPX™ Session Management (CA TPX)
■
CA STX™ (CA STX)
Contact CA Technologies
Contact CA Support
For your convenience, CA Technologies provides one site where you can access the
information that you need for your Home Office, Small Business, and Enterprise CA
Technologies products. At http://ca.com/support, you can access the following
resources:
■
Online and telephone contact information for technical assistance and customer
services
■
Information about user communities and forums
■
Product and documentation downloads
■
CA Support policies and guidelines
■
Other helpful resources appropriate for your product
Providing Feedback About Product Documentation
If you have comments or questions about CA Technologies product documentation, you
can send a message to techpubs@ca.com.
To provide feedback about CA Technologies product documentation, complete our
short customer survey which is available on the CA Support website at
http://ca.com/docs.
Contents
Chapter 1: Introduction
13
What You Can Do With Batch Processing .................................................................................................................. 13
Administration of CA STX .................................................................................................................................... 13
Compatibility with Earlier Releases ..................................................................................................................... 14
Update Administration Data ............................................................................................................................... 14
Add, Modify, and Delete Records ....................................................................................................................... 14
Update with Extracted Records .......................................................................................................................... 14
Create Reports .................................................................................................................................................... 15
Variables.............................................................................................................................................................. 15
Examples in CB0VSRC Dataset .................................................................................................................................... 16
Use Batch Control Statements ................................................................................................................................... 16
Elements of Batch Control Statements ............................................................................................................... 16
Syntax Diagram ................................................................................................................................................... 17
Blank Spaces and Lines ........................................................................................................................................ 19
Use Single Quotes ............................................................................................................................................... 19
Use Abbreviations and Aliases for Control Words .............................................................................................. 20
Set Up Your JCL Control File ....................................................................................................................................... 20
Items to Remember ............................................................................................................................................ 21
VSAM Data Sets .......................................................................................................................................................... 22
Reset Control Record 0 ....................................................................................................................................... 22
Examples of Batch Jobs .............................................................................................................................................. 23
Chapter 2: Updating User Administration Data
25
Introduction to Updating ........................................................................................................................................... 25
Add a User in Online Administration .................................................................................................................. 25
Add Multiple Users in Batch Administration .............................................................................................................. 26
Example ............................................................................................................................................................... 26
Add Users and Profiles ............................................................................................................................................... 26
Format ................................................................................................................................................................. 27
Operand Explanations ......................................................................................................................................... 27
UIDXGRP and PIDXGRP Variables ........................................................................................................................ 27
Override Profile Values ....................................................................................................................................... 28
Add Sessions to Users and Profiles ............................................................................................................................ 29
Format ................................................................................................................................................................. 29
Operand Explanations ......................................................................................................................................... 29
When You Add a Session to CA TPX .................................................................................................................... 30
Contents 5
Override Profile Value ......................................................................................................................................... 30
Add Profiles to Users .................................................................................................................................................. 30
Format ................................................................................................................................................................. 31
Operand Explanations ......................................................................................................................................... 31
Authorize a User to Administer a Group .................................................................................................................... 31
Format ................................................................................................................................................................. 31
Operand Explanations ......................................................................................................................................... 32
Assign a User View Authority ..................................................................................................................................... 33
Format ................................................................................................................................................................. 33
Operand Explanations ......................................................................................................................................... 33
Copy Users and Profiles .............................................................................................................................................. 33
Format ................................................................................................................................................................. 34
Operand Explanations ......................................................................................................................................... 34
Example 1: Copying a User .................................................................................................................................. 35
Example 2: Copying a Profile ............................................................................................................................... 35
Copy User and Profile Sessions .................................................................................................................................. 35
Format ................................................................................................................................................................. 36
Operand Explanations ......................................................................................................................................... 36
RECORD NOT FOUND Error ................................................................................................................................. 37
Delete Users and Profiles ........................................................................................................................................... 37
Format ................................................................................................................................................................. 37
Operand Explanations ......................................................................................................................................... 38
Example 1: Deleting a User ................................................................................................................................. 38
Example 2: Deleting a Profile .............................................................................................................................. 38
Delete Sessions from Users and Profile ..................................................................................................................... 39
Format ................................................................................................................................................................. 39
Operand Explanations ......................................................................................................................................... 39
RECORD NOT FOUND Error ................................................................................................................................. 39
Notes on Deleting Sessions from User ................................................................................................................ 40
Delete Profiles from a User ........................................................................................................................................ 41
Format ................................................................................................................................................................. 41
Operand Explanations ......................................................................................................................................... 41
Remove Group or View Administration Authority ..................................................................................................... 42
Format ................................................................................................................................................................. 42
Operand Explanations ......................................................................................................................................... 42
Modify User and Profile Values .................................................................................................................................. 43
Format ................................................................................................................................................................. 43
Operand Explanations ......................................................................................................................................... 43
Override Profile Values ....................................................................................................................................... 44
Modify User and Profile Session Values ..................................................................................................................... 45
Format ................................................................................................................................................................. 45
Operand Explanations ......................................................................................................................................... 45
6 Batch Administration Guide
RECORD NOT FOUND Error ................................................................................................................................. 46
Override Profile Values ....................................................................................................................................... 46
Chapter 3: Extracting Data
47
Contents of Extract Files............................................................................................................................................. 47
How User Definitions Are Merged ...................................................................................................................... 47
Profile Definitions ............................................................................................................................................... 48
How Session Definitions Are Merged .................................................................................................................. 48
Mail Locators ....................................................................................................................................................... 49
Application Definitions ........................................................................................................................................ 49
EXTRACT Statement Syntax ........................................................................................................................................ 49
Format ................................................................................................................................................................. 49
Operands ............................................................................................................................................................. 50
Specify Extraction Criteria .......................................................................................................................................... 51
Specify Masking Criteria Values .......................................................................................................................... 52
Manage Errors ..................................................................................................................................................... 52
Specify Multiple Variables ................................................................................................................................... 53
Specify Multiple Values ....................................................................................................................................... 53
Specify Variables Without Assigned Values ............................................................................................................... 53
Profile Variables .................................................................................................................................................. 53
User Variables ..................................................................................................................................................... 53
Example 1: Extracting a List of Users and Their Sessions .................................................................................... 54
Example 2: Extracting a List of Users Using a Particular Session ........................................................................ 54
Example 3: Extracting a List of Profiles and Their Associated Sessions............................................................... 54
Example 4: Extracting a List of Profiles with a Particular Session ....................................................................... 55
Example 5: Extracting a List of Mail Locators ...................................................................................................... 55
Chapter 4: Using Extract Files for Updating
57
Update Records with Extract Files.............................................................................................................................. 57
Add Profiles and Authority to Users ........................................................................................................................... 57
Format ................................................................................................................................................................. 58
Operand Explanations ......................................................................................................................................... 58
Delete Users, Profiles, and Sessions ........................................................................................................................... 59
Format ................................................................................................................................................................. 60
Operand Explanations ......................................................................................................................................... 60
Delete Profiles and Authorization from Users ........................................................................................................... 62
Format ................................................................................................................................................................. 62
Operand Explanations ......................................................................................................................................... 62
Add User Lists ............................................................................................................................................................. 63
Format ................................................................................................................................................................. 63
Operand Explanations ......................................................................................................................................... 63
Contents 7
Delete Mail Locators .................................................................................................................................................. 64
Format ................................................................................................................................................................. 65
Operand Explanations ......................................................................................................................................... 65
Modify Records .......................................................................................................................................................... 65
Format ................................................................................................................................................................. 65
Operand Explanations ......................................................................................................................................... 66
Overriding Profile Values .................................................................................................................................... 66
Delete User Lists ......................................................................................................................................................... 67
Format ................................................................................................................................................................. 68
Operand Explanations ......................................................................................................................................... 68
Chapter 5: Updating Mail Messages and User Lists
69
Add Mail Messages .................................................................................................................................................... 69
Format ................................................................................................................................................................. 69
Operand Explanations ......................................................................................................................................... 70
Sending Application News ................................................................................................................................... 70
Delete Mail Messages ................................................................................................................................................ 71
Format ................................................................................................................................................................. 71
Operand Explanations ......................................................................................................................................... 72
Add User Lists ............................................................................................................................................................. 72
Format ................................................................................................................................................................. 73
Operand Explanations ......................................................................................................................................... 73
Chapter 6: Updating Application Definitions
75
Add Applications ........................................................................................................................................................ 75
Format ................................................................................................................................................................. 75
Operand Explanations ......................................................................................................................................... 75
Copy Applications ....................................................................................................................................................... 76
Format ................................................................................................................................................................. 76
Operand Explanations ......................................................................................................................................... 76
Delete Applications .................................................................................................................................................... 77
Format ................................................................................................................................................................. 77
Operand Explanations ......................................................................................................................................... 77
Modify Application Values ......................................................................................................................................... 78
Format ................................................................................................................................................................. 78
Operand Explanations ......................................................................................................................................... 78
Chapter 7: Using Extract Files for Reporting
81
How Reports Are Processed ....................................................................................................................................... 81
Formatting Options ............................................................................................................................................. 81
8 Batch Administration Guide
REPORT Statement Syntax ......................................................................................................................................... 81
Format ................................................................................................................................................................. 82
Operand Explanations ......................................................................................................................................... 82
Line Definition Syntax................................................................................................................................................. 82
Format ................................................................................................................................................................. 82
Operand Explanations ......................................................................................................................................... 83
ASA Printer Control Characters ........................................................................................................................... 83
Define Multiple Lines .......................................................................................................................................... 84
Specify Variables from Different Types of Records ............................................................................................. 85
Create a Simple Report .............................................................................................................................................. 85
Determine What Information You Want in the Report ...................................................................................... 86
Extract the Data .................................................................................................................................................. 86
An Example of a Simple Report ........................................................................................................................... 86
Format Your Reports .................................................................................................................................................. 86
Use Spacing to Format Your Reports .................................................................................................................. 87
Format a Field Longer than 78 Characters .......................................................................................................... 88
Variables with a Length Greater than Nine ......................................................................................................... 88
Label Your Reports .............................................................................................................................................. 90
Use ASA Printer Control Characters .................................................................................................................... 91
Define Headings in Your Report .......................................................................................................................... 92
Predefined Variables Available for Batch Processing .......................................................................................... 93
Use the Default Report Heading ......................................................................................................................... 93
Set the Page Length ............................................................................................................................................ 94
Define and Set Variables ............................................................................................................................................ 95
Format ................................................................................................................................................................. 95
Operand Explanations ......................................................................................................................................... 95
Reserved Variables .............................................................................................................................................. 96
Set Values for Variables.............................................................................................................................................. 96
Format ................................................................................................................................................................. 96
Operand Explanations ......................................................................................................................................... 97
Chapter 8: Using VTAM Modeling Statements
99
Set Up the Batch Job for VTAM Modeling Statement Support .................................................................................. 99
Format ................................................................................................................................................................. 99
Use the *TPX,MDL Statement ........................................................................................................................... 101
Run the Batch Process....................................................................................................................................... 101
Model Job Example ........................................................................................................................................... 101
SYSIN Example ................................................................................................................................................... 102
SYSUT2 Example ................................................................................................................................................ 102
OS symbols in the VTAM model ............................................................................................................................... 107
Example with OS Symbols ................................................................................................................................. 107
Contents 9
Appendix A: Control Word Abbreviations
109
Control Word Abbreviations and Aliases ................................................................................................................. 109
Appendix B: Variables
111
Special Batch Variables ............................................................................................................................................ 111
Special Administration Variables .............................................................................................................................. 113
CA TPX User Variables (by Variable Name) .............................................................................................................. 113
CA TPX User Variables (by Field Name) .................................................................................................................... 116
CA TPX Profile Variables (by Variable Name) ........................................................................................................... 118
CA TPX Profile Variables (by Field Name) ................................................................................................................. 120
CA TPX User Session Variables (by Variable Name) ................................................................................................. 123
CA TPX User Session Variables (by Field Name) ....................................................................................................... 124
CA TPX Profile Session Variables (by Variable Name) .............................................................................................. 126
CA TPX Profile Session Variables (by Field Name) .................................................................................................... 127
CA TPX Mail Locator Variables ................................................................................................................................. 129
CA TPX Mail Message Variables ............................................................................................................................... 130
CA TPX User List Variables ........................................................................................................................................ 132
CA TPX Application Variables (by Variable Name) ................................................................................................... 132
CA TPX Application Variables (by Field Name) ......................................................................................................... 135
CA STX User Variables (by Variable Name) .............................................................................................................. 142
CA STX User Variables (by Field Name) .................................................................................................................... 145
CA STX Profile Variables (by Variable Name) ........................................................................................................... 147
CA STX Profile Variables (by Field Name) ................................................................................................................. 150
CA STX User Session Variables (by Variable Name).................................................................................................. 153
CA STX Profile Session Variables (by Variable Name) .............................................................................................. 153
Appendix C: Batch Command Summary
155
Special Command Statements ................................................................................................................................. 155
RESET INTEGRITY ............................................................................................................................................... 155
SET ..................................................................................................................................................................... 155
VDEFINE ............................................................................................................................................................ 155
ADD Statements ....................................................................................................................................................... 156
Add Users and Profiles ...................................................................................................................................... 156
Add Sessions to Users and Profiles ................................................................................................................... 156
Add Profile Sessions .......................................................................................................................................... 156
Add Administrative Authority ........................................................................................................................... 156
Add View Facility Authority ............................................................................................................................... 156
Add Mail Messages ........................................................................................................................................... 156
Add User Lists .................................................................................................................................................... 157
Add Applications ............................................................................................................................................... 157
10 Batch Administration Guide
CONVERT Statements ............................................................................................................................................... 157
Convert STXTs ................................................................................................................................................... 157
Convert NPTs ..................................................................................................................................................... 157
Convert MSGFILEs ............................................................................................................................................. 157
Convert MAIL Files ............................................................................................................................................ 158
COPY Statements ..................................................................................................................................................... 158
Copy Users and Profiles .................................................................................................................................... 158
Copy User and Profile Sessions ......................................................................................................................... 158
Copy Applications.............................................................................................................................................. 158
DELETE Statements .................................................................................................................................................. 158
Delete Users and Profiles .................................................................................................................................. 158
Delete Sessions from Users and Profiles ........................................................................................................... 159
Delete Profiles from a User ............................................................................................................................... 159
Delete Administrative Authority from a User ................................................................................................... 159
Delete Mail Messages ....................................................................................................................................... 159
Delete User Lists................................................................................................................................................ 159
UPDATE Statements ................................................................................................................................................. 159
Update Users and Profiles ................................................................................................................................. 159
Update User and Profile Sessions ..................................................................................................................... 160
EXTRACT Statement ................................................................................................................................................. 160
REPORT Statement ................................................................................................................................................... 160
Line Definition in the Report Statement ........................................................................................................... 160
ADD Statement (Using an Extract File) ..................................................................................................................... 160
Add Profiles or Authority .................................................................................................................................. 161
Add User Lists .................................................................................................................................................... 161
DELETE Statement (Using an Extract File) ................................................................................................................ 161
Delete Users, Profiles, and Sessions.................................................................................................................. 161
Delete User Profiles and Authorization............................................................................................................. 161
Delete Applications ........................................................................................................................................... 161
Delete Mail Locators ......................................................................................................................................... 161
UPDATE Statement (Using an Extract File) ............................................................................................................... 162
Appendix D: Converting MSGFILE to MAIL File
163
Convert MSGFILEs and MAIL Files ............................................................................................................................ 163
Convert Information from a MSGFILE ............................................................................................................... 163
Convert Information from a MAIL File .............................................................................................................. 164
Appendix E: Extract File Layout
165
Overview .................................................................................................................................................................. 165
Extract File Layout .................................................................................................................................................... 165
Contents 11
Index
12 Batch Administration Guide
187
Chapter 1: Introduction
This chapter contains a general discussion of CA TPX batch administration.
This section contains the following topics:
What You Can Do With Batch Processing (see page 13)
Examples in CB0VSRC Dataset (see page 16)
Use Batch Control Statements (see page 16)
Set Up Your JCL Control File (see page 20)
VSAM Data Sets (see page 22)
Examples of Batch Jobs (see page 23)
What You Can Do With Batch Processing
The Batch component allows you to report on and update information in the
administration database. Using the control statements described in this guide, you can:
■
Add, modify, and delete users, profiles, sessions, mail messages, user lists, and
application definitions
■
Create administrators
■
Assign View authority to users
■
Create reports from information in the administration database
■
Convert existing CA STX administration data so it can be used in the administration
database
■
Reset the integrity of the VSAM databases
These tasks involve extracting records from the administration database, updating
information, and creating reports.
Administration of CA STX
You can also use the Batch component to report on and update information in the CA
STX r4 administration database. CA TPX and CA STX share a common administration
structure.
Chapter 1: Introduction 13
What You Can Do With Batch Processing
Compatibility with Earlier Releases
The batch facility described in this guide is compatible with the batch facility in earlier
releases of CA TPX. All batch files and commands for earlier releases will work with this
release of the batch facility.
Update Administration Data
Batch processing allows you to perform many of the administration tasks usually
accomplished online with the administration facility. Updating with batch processing
can save you a great deal of time since you do not have to redisplay panels for each
user, profile, or session.
Add, Modify, and Delete Records
You can use the ADD, COPY, DELETE, and UPDATE control statements to modify specific
user or profile records, or to delete table records. For example, you can change the
stage one time out for a user, add a new user, delete a profile, or add an application
session to a profile. For information about how to add, delete, and modify records, see
the chapter Updating Administration Data (see page 25).
Update with Extracted Records
Batch processing allows you to select records from the administration database and
write them to a sequential file called an extract file. You determine what user, profile, or
session records are extracted by specifying extraction criteria. Extract files are used for
creating reports and can also be used when updating large amounts of information. For
information about how to extract user, profile, and session records, see the chapter
Extracting Data (see page 47).
After you have extracted the records, you can use the extract file to select the user,
profile, or session records that you want to update. For example, you may want to
update all users who use the CUA panels so that they use the English language panels.
You could:
■
Use an EXTRACT statement to extract all of the users who have their language
option set to CU.
■
Then use an UPDATE statement to change the language option to EN for all the user
records in the extract file.
For information about how to use an extract file to add, delete, and modify records, see
the chapter Using Extract Files for Updating (see page 57).
14 Batch Administration Guide
What You Can Do With Batch Processing
Create Reports
Batch processing allows you to generate and format reports that contain information
about specific users or profiles. For example, you can generate a report that lists all of
the users in a specified user group, and also list what profiles and sessions are assigned
to them. This might be useful if you are creating a new profile to better suit the needs of
the users.
Reporting is a two-step process involving extracting the data and then printing the
report.
Step 1: Extract the Data
In the first step, you extract the information that you want to report on from the
administration database. You use the EXTRACT statement (see the chapter Extracting
Data (see page 47)) to specify the information to be extracted. Records that meet the
criteria are written to an extract file, which is then used as input to the REPORT
statement.
Step 2: Print the Report
In the second step, the extract file is used by a REPORT statement that generates the
report. The REPORT statement specifies the information to be printed in the report.
Batch processing also allows you to format your report with headings, ASA printer
control characters, and labels. If you like, you can use the extract file with another
report generator such as SAS to generate the report.
For a complete description of the REPORT statement and how to format reports, see the
chapter Using Extract Files for Reporting (see page 81).
Variables
In many of the batch facility statements you specify variables:
■
When extracting data, you specify variables with specific values as extraction
criteria. If the data matches the criteria, the user, profile, or session information will
be extracted.
■
When creating reports, you specify the variables that you want listed in the report.
■
When updating data, you specify values to be assigned to for variables.
For a complete list of variables, see the appendix Variables (see page 111). Most of the
variables correspond to fields that can be modified in online administration.
Chapter 1: Introduction 15
Examples in CB0VSRC Dataset
There are also special batch variables and administration variables that do not
correspond to online fields. These variables can be used only for extraction and
reporting (they cannot be updated). They provide information about:
■
The last update of the record
■
The user's administration authority
■
The profiles assigned to the user
■
The user's View facility authority
For example, by using these variables, you could extract all users who have a specific
profile, and then create a report listing these users, their profiles, and which user groups
they can administer.
Examples in CB0VSRC Dataset
Examples of jobs that perform batch processing as discussed in this guide are in the
TPX.CB0VSRC dataset. CB0VSRC member $BATADMN lists and briefly describes each
sample. Member $BATMAIL lists and describes sample batch functions related to the CA
TPX Mail facility.
Use Batch Control Statements
This section shows you how control statement syntax is illustrated in this guide and
some general rules concerning control statement syntax.
Elements of Batch Control Statements
To run Batch, you use control statements that tell Batch what to do. A control statement
includes the following elements:
■
A control word (such as EXTRACT, REPORT, ADD, DELETE, or UPDATE) that indicates
what function you want to perform.
■
Parameters (such as USER, ALL SESSIONS, USERSESSION, or PROFILE) that indicate
what type of information you want to process.
■
Variables that indicate specific information such as user IDs, profile names, and user
definition values.
Control statements also contain delimiters such as spaces, parentheses, and single
quotes.
16 Batch Administration Guide
Use Batch Control Statements
Examples
Some examples of control statements are:
DELETE PROFILESESSION USING(CICSPROF)
ADD TPX USERSESSION (USER03 TSO02)
EXTRACT GIVING (HRUSERS) USER AND NO SESSIONS (UIDXNAME (HR---))
Syntax Diagram
In this guide, the syntax for a control statement is shown using a syntax diagram. Syntax
diagrams show you what parts of a statement are required, where you have a choice of
parameters, where you must enter variables, and what parts of the control statement
can be repeated.
Example of Simple Batch Control Statement
Here is a syntax diagram of a simple control statement:
ADD (for user profiles)
|------------------------+
V
|
->>-- ADD --- USERPROFILES ---(--- userID -- profileID -----)----><
The syntax diagram always begins with the double right arrowhead on the left end of
the control path. The ADD control word is required since it is directly on the control
path. Next, you must type USERPROFILE.
As you follow the control path, you see that the open parenthesis is also required. The
next item on the path is a variable. Variables indicate specific items that you replace
with information like user IDs, profile names, variable names, or other values. In this
case, the variable is a user ID. After the user ID is another variable, a profile name. The
arrow starting after the variables and pointing back to the area before the variables
indicates that you can enter more than one variable. In this case, you can specify as
many user IDs and profile names as you like. Note that you have to enter a user ID and
profile name together each time you make a loop.
After you have entered a value for the variable, you must type the close parenthesis to
end the list. The right and left arrowheads at the end of the control path indicate the
end of the syntax diagram. Here is an example of an ADD statement following this
syntax diagram:
ADD USERPROFILE (USER1 PROF1 USER2 PROF1)
Chapter 1: Introduction 17
Use Batch Control Statements
Optional Items
Some statements have optional items. In the following example, you can enter
OPTION1, OPTION2, or nothing between the word COMMAND and the variable.
COMMAND example
->>--- COMMAND ------------------------- (variable) ------------><
|-- OPTION1 ---|
+-- OPTION2 ---+
Example of a Complex Batch Control Statement
The following is a syntax diagram that contains some more complex instructions:
UPDATE (for users and profiles)
->>--- UPDATE ------ TPX ----------- USER --------------(---->
+-- STX --+
+-- PROFILES --+
+-----------------------------------------+
|
+---------------------+
|
V
V
|
|
->---- object --(------ variable(value) -----)-----)----------><
Although this syntax diagram has two lines, you do not have to enter your control
statement on two lines. The syntax diagram simply does not fit on one line. The single
right arrowhead at the end of the first line indicates that the control path continues on
the next line.
The two repeat arrows in this diagram indicate the following:
■
The longer arrow indicates that you can repeat the items object (variable(value)) as
many times as you like.
■
The shorter arrow shows that, within the previous repetition, you can also repeat
variable(value) as many times as you like.
Here is an example of an UPDATE statement following the syntax diagram:
UPDATE USER (USER1 (UIDXJKEY(PA2) UIDXMKEY(PA3))
USER2 (UIDXJKEY(PA2)))
18 Batch Administration Guide
Use Batch Control Statements
Blank Spaces and Lines
The examples in this guide show you where to enter spaces in your control statements
to separate the various pieces of information. The following rules apply to the use of
blank spaces and lines:
■
You might want to add spaces in a control statement so that you can read it more
easily. You can use any number of spaces where one space is appropriate. You can
also enter as many spaces as you like before and after an open or closed
parenthesis.
■
You can put a line break or blank line anywhere that a space is appropriate. For
example, you may want a report that prints three lines of information for each
record in an extract file. You could put the definition for each line of the report on a
separate line in the control file. You may find it useful to break control statements
into multiple lines because of your terminal screen width and for clarity.
For example, the following four lines in a control file are read as one control
statement:
REPORT GIVING(PF3REPRT) USING(PF3USERS)
((' &UIDXNAME ' '&UIDXGRP')
(' &UIDXMKEY ' '&UIDXJKEY ' '&UIDXPKEY')
(' &UIDXESCK ' '&UIDXACCS ' '&UIDXPRSV'))
■
You can put more than one control statement on one line of the control file. For
example, consider the following two ADD statements:
ADD USER (USER18)
ADD USER (USER52)
■
You could put the two statements on one line as follows:
ADD USER (USER18) ADD USER (USER52)
Use Single Quotes
Single quotes are most often used in REPORT statements. The text and variables to be
printed in a report must be enclosed within single quotes in a report statement. The
other control statements only require single quotes when you are specifying a value
that has spaces within it. For example:
UPDATE USER (USER1(VUSRLOC('PGH BLDG FLOOR-7')))
Batch resolves text enclosed within single quotes literally. The only exception is if a
string of characters is preceded by an ampersand (&), in which case it is considered a
variable name and replaced by the value of that variable.
To include a single quote within text enclosed by single quotes, type two single quotes
with no space between them (''). Ampersands without text immediately following them
are resolved as ampersands, but to include an ampersand with text following it, type
two ampersands with no space between them (&&text).
Chapter 1: Introduction 19
Set Up Your JCL Control File
Any text not enclosed within single quotes is automatically converted to uppercase. Text
enclosed in single quotes (such as report labels) is not converted to uppercase. So, if you
define a report label with uppercase and lowercase characters, the label will be printed
in uppercase and lowercase.
A string within single quotes cannot be longer than one line of the REPORT statement.
For example, the following REPORT statement prints the menu key, jump key, and print
key for each user record in the extract file named KEYREPT. The report labels "Menu
Key," "Jump Key," and "Print Key" are printed on the report in uppercase and lowercase
characters. Note that the user is adding spaces within the single quotes to indent these
labels. An ampersand (&) is added in front of UIDXNAME, UIDXMKEY, UIDXJKEY, and
UIDXPKEY to tell CA TPX that they are variables.
REPORT GIVING(KEYREPT)
((' &UIDXNAME')
(' Menu Key (' Jump Key (' Print Key -
USING(KEYUSERS)
' '&UIDXMKEY')
' '&UIDXJKEY')
' '&UIDXPKEY'))
Note: Hexadecimal quoted strings can appear in REPORT statements with the same
constraints as other quoted strings.
Use Abbreviations and Aliases for Control Words
When you are specifying control words and parameters in control statements, you can
use shortened forms of the control word to conserve space on the line. Batch also
allows aliases or alternate names for some of these control words.
For a list of the abbreviations and the aliases for control words, see the appendix
Control Word Abbreviations (see page 109).
Set Up Your JCL Control File
You execute Batch control statements such as EXTRACT, REPORT, ADD, DELETE, and
UPDATE from a JCL control file. You can execute any number of control statements in a
single JCL file. If you use the REPORT statement, make sure the EXTRACT statement that
produces the extract file for the report appears before the REPORT statement.
You must include some statements at the beginning of the control file to activate Batch.
See the Sample JCL in this chapter that activates Batch and generates a report. The
VNODE='*BATCH*' parameter on the second line indicates that Batch is to be activated.
20 Batch Administration Guide
Set Up Your JCL Control File
Items to Remember
Keep the following points in mind:
■
The procname is the name of your TPX procedure that contains the VSAM files you
want to process.
■
You must allow a region size of at least four megabytes to start the batch facility.
■
If you have changed the symbolic parameters for the startup procedure, change
VNODE in your VNODE='*BATCH*' parameter to the value specified in the VNODE
parameter of your startup procedure. See the Installation Guide.
■
Do not use sequence numbers in Batch input statements. Batch statements will not
execute if you use sequence numbers. If you are using TSO to create your JCL, enter
UNNUM in the command line to turn off sequence numbers.
■
You can use the COMMENTS statement to put comments in your control file. You
may find it helpful to document the control statements so that other users can
easily see what the statements do. COMMENTS statements are not executed when
the job is run. For an example containing some COMMENTS statements, see Sample
JCL (see page 21).
■
Do not intersperse comments in a command. This can cause parsing errors when
batch executes the command. If you want to separate the parameters in a
command, use blank lines.
Sample JCL
This sample JCL will produce an extract file and a report.
//USER54 JOB (0,A300),BATCHJCL,CLASS=V,MSGCLASS=H,NOTIFY=USER54
// EXEC procname,VNODE='*BATCH*'
//*Define file names for extract files
//PA3USRS DD UNIT=SYSDA,SPACE=(CYL,(1,1))
//*Define file names for report files
//PA3RPRT DD SYSOUT=E
//XTRACE DD DUMMY
//SYSIN DD *
COMMENTS
The following statement produces the extract file named
COMMENTS
PA3USRS which contains the merged user definition for
COMMENTS
each user who has PA3 as the menu key.
COMMENTS
EXTRACT GIVING(PA3USRS) USER NO SESSIONS (UIDXMKEY(PA3))
COMMENTS
COMMENTS
COMMENTS
COMMENTS
COMMENTS
COMMENTS
The following REPORT statements produce the report files
PA3RPRT and PA2RPRT which list the user ID, menu key,
jump key, and print key for the users who have PA3 and
PA2 assigned for the menu key.
Chapter 1: Introduction 21
VSAM Data Sets
COMMENTS
COMMENTS
REPORT GIVING(PA3RPRT) USING(PA3USRS)
((' &UIDXNAME' '&UIDXMKEY' '&UIDXJKEY' '&UIDXPKEY'))
VSAM Data Sets
If you want to run multiple copies or versions of CA TPX in batch mode or online, you
must follow the instructions for sharing data sets in the Installation Guide. It allows the
different versions to share the VSAM administration data sets.
Important! Running Batch concurrently with an online version of CA TPX may cause
VSAM file corruption if the VSAM sharing parameters are not set correctly.
Reset Control Record 0
When you share VSAM files without using CA-L-Serv, and need to restore or move your
VSAM data sets, you need to delete control record zero (0). Use the batch RESET
INTEGRITY control statement to do this.
Note: Prior to a Reset Integrity command being processed, the TPX Batch job will issue
an exclusive ENQ for the file to be processed. If the ENQ fails, the Reset Integrity job is
rejected.
RESET INTEGRITY
|------------------+
->>--- RESET INTEGRITY ----(--V----- ADMIN1 -----|-----)---><
|-- ADMIN2 ----|
|-- NOTES -----|
|-- MAIL ------|
+-- VIEW ------+
In this statement you specify a VSAM data set (ADMIN1, ADMIN2, MAIL, or VIEW) or the
NOTES data set. For example, the following RESET INTEGRITY statement deletes control
record zero from ADMIN1 and ADMIN2:
RESET INTEGRITY (ADMIN1 ADMIN2)
Note: When the RESET INTEGRITY statement is executed, the following messages may
appear in the batch log:
TPBL1010 VSAM ERA CTLREC 0 RETURN CODE IS 8
TPBL1051 MEANS RECORD ACCESSED NOT ON FILE
These messages indicate that the file did not need to be reset because control record
zero has already been deleted. No error has occurred, and your batch file will continue
to execute.
22 Batch Administration Guide
Examples of Batch Jobs
Examples of Batch Jobs
The CB0VSRC library contains examples of batch processes, which are indexed in the
$BATxxxx members.
Chapter 1: Introduction 23
Chapter 2: Updating User Administration
Data
This chapter shows you how to update users, profiles, and sessions in batch
administration.
This section contains the following topics:
Introduction to Updating (see page 25)
Add Multiple Users in Batch Administration (see page 26)
Add Users and Profiles (see page 26)
Add Sessions to Users and Profiles (see page 29)
Add Profiles to Users (see page 30)
Authorize a User to Administer a Group (see page 31)
Assign a User View Authority (see page 33)
Copy Users and Profiles (see page 33)
Copy User and Profile Sessions (see page 35)
Delete Users and Profiles (see page 37)
Delete Sessions from Users and Profile (see page 39)
Delete Profiles from a User (see page 41)
Remove Group or View Administration Authority (see page 42)
Modify User and Profile Values (see page 43)
Modify User and Profile Session Values (see page 45)
Introduction to Updating
Batch processing in CA TPX is designed so you can add, modify, and delete data for the
three main elements of user administration: users, profiles, and sessions. In online
administration, you use panels to identify which of these elements you want to update
and specify the necessary information in panel fields. In Batch, you use control
statements to specify what you want to add, delete, or modify.
Add a User in Online Administration
To add a user in online administration
1.
Select User Maintenance and add the new user ID.
2.
Select User Options in User Maintenance and assign the user to an administration
group named ADMINGRP.
3.
Change the user overrides for the stage 1 time out and the stage 1 option.
Chapter 2: Updating User Administration Data 25
Add Multiple Users in Batch Administration
4.
Select Maintain List of Profiles in User Maintenance and assign profiles PROF1 and
PROF2 to the user.
5.
Select Session Options in User Maintenance and assign sessions TSO-20 and CICS-1
to the user.
6.
Select each application session and specify an application ID for the session.
7.
Change the session overrides for Startup ACL and Term ACL and Label.
8.
Select Session Options in User Maintenance and assign the session NETWRK to the
user.
9.
Change the session override for ACIPGM.
Add Multiple Users in Batch Administration
Adding one user in online administration does not take a great deal of time, but if you
have 20 users to add, Batch provides a more efficient solution. The following example
lists a series of control statements to add a user. If you have 20 users to add, you can
copy the control statements and change the appropriate values for each new user. You
could also modify the statements to make the appropriate changes for all users. The
statements in the example are documented in this chapter.
Example
This example adds USER1 and adds two CA TPX sessions.
SET MASKCHAR '!'
ADD TPX USER
(USER1 (UIDXGRP (ADMINGRP)
UIDXTOU1 (60)
UIDXTOP1 (K)))
ADD TPX USERSESSION (USER1 TSO-20 (UENTAPPL
UENTSCRP
UENTSCRT
VSESLABL
USER1 CICS-1 (UENTAPPL
UENTSCRP
UENTSCRT
VSESLABL
(TSO-20)
(TSOSTRT)
(TSOTERM)
('TSO for Reports'))
(CICS-1)
(CICSSTRT)
(CICSTERM)
('Test CICS')))
Add Users and Profiles
You use the ADD statement when you want to add user or profile records to the
administration database. This is the syntax of an ADD statement when you are not using
an extract file.
26 Batch Administration Guide
Add Users and Profiles
The ADD statement can be used to add signon authority to an existing user if the user
does not already have that authority. In this case a message will be sent to the log
indicating that the user was updated instead of added.
Format
The ADD statement for users and profiles has the following syntax:
->>--- ADD ------------------------ USER -------------------(-->
|-- TPX --|
+-- PROFILES --+
+-- STX --+
|--------------------------------------------------+
V
|
->---- object ----------------------------------------------)--><
|
|------------------- -+
|
|
V
|
|
+--(----- variable(value) -----)--+
Operand Explanations
The ADD statement for users and profiles has the following operands:
Operand
Explanation
TPX
Indicates that you are adding a user or profile authorized for
CA TPX. This is the default if you have an LMP code for CA TPX
only.
STX
Indicates that you want to add a CA STX session. This is the
default if you have an authorization code for CA STX only.
USER
Indicates that you want to add a user.
PROFILE
Indicates that you want to add a profile.
object
Specifies the user ID if you are adding a user, or the profile
name, if you are adding a profile.
variable
Specifies a variable. For a description of the variables, see the
appendix Variables (see page 111).
Value
Specifies a valid value for the variable specified in variable.
UIDXGRP and PIDXGRP Variables
The UIDXGRP and PIDXGRP variables are common to CA TPX.
When you add a user, you should assign the user to a user group by specifying a value
for the UIDXGRP variable. If you do not assign the user to a group, the user is assigned
to the default group defined in the system options table.
Chapter 2: Updating User Administration Data 27
Add Users and Profiles
When you add a profile, you should assign the profile to a profile user group by
specifying a value for the PIDXGRP variable.
Override Profile Values
To nullify a profile parameter value at the user level without specifying a particular
value, specify a string of eight underscores. For example:
ADD USER (USER45 (UIDXGRP(HR) UIDXACBN('________')))
This statement adds the user USER45 in the user group HR and overrides any ACB mask
set at the profile level. For information about how this product incorporates profile
values when defining a user, see How User Definitions Are Merged (see page 47).
Example 1: Adding a User
An administrator wants to add three new user IDs that are authorized for CA TPX.
Instead of adding the users through online administration, the administrator decides to
execute command statements in a batch job. The administrator wants to assign two of
the IDs to the HR user group and one ID to the SALES user group. The following
statements accomplish this task:
ADD TPX USER (USER45 (UIDXGRP(HR))
USER67 (UIDXGRP(HR))
USER78 (UIDXGRP(SALES)))
When the ADD statements are executed, the user IDs USER45, USER67, and USER78 are
added to the administration database and assigned to the specified groups. The users
have authority for CA TPX. At this point, there are no profiles or sessions associated with
the user IDs, and the user definition variables contain no values. For information about
how to add sessions to a user, see Add Sessions to Users and Profiles (see page 29). For
information about how to add profiles to a user, see Add Profiles to Users (see page 31).
For information about how to assign values to the user definition variables, see Modify
User and Profile Values (see page 43).
Example 2: Adding a Profile
An administrator wants to add a new profile named SALEPROF for the company's sales
department employees. Instead of adding the profile through online administration, the
administrator decides to execute a command statement in a batch job. The
administrator wants all users of this profile to have an update class of B and panel
language of CUA. The profile is to belong to the SALES maintenance authorization group.
The appropriate variables are specified.
ADD PROFILE (SALEPROF ( PIDXUPDC(B) PIDXLANG(CUA) PIDXGRP(SALES) ))
28 Batch Administration Guide
Add Sessions to Users and Profiles
When the ADD statement is executed, the profile named SALEPROF is added to the
administration database. At this point, there are no sessions associated with the profile,
and the profile contains values for the update class, panel language, and group. For
information about how to add sessions to a profile, see Add Sessions to Users and
Profiles (see page 29). For information about how you can assign values to the profile
definition variables, see Modify User and Profile Values (see page 43).
Note: When you add a profile, you should immediately assign the profile to an
authorization group with the ADD statement or a subsequent UPDATE statement. For
information about how to use the UPDATE statement to assign a profile to a group, see
Modify User and Profile Values (see page 43). If you do not assign the profile to a group,
the profile is assigned to the default group defined in the System Options Table.
Add Sessions to Users and Profiles
You use the ADD statement when you want to add sessions to users and profiles.
Format
The ADD statement for users and profile sessions has the following syntax:
->>--- ADD -------------------------- USERSESSION -----------------(------------>
|-- TPX --|
+-- PROFILESESSION ---+
+-- STX --+
|-----------------------------------------------------------------+
V
|
->---- objectID ---- sessionID --------------------------------------------)---><
|
|------------------- -+
|
|
V
|
|
+--(----- variable(value) -----)--+
Operand Explanations
The ADD statement for users and profile sessions has the following operands:
Operand
Explanation
TPX
Indicates that you want to add a CA TPX session. This is the
default if you have an LMP code for CA TPX only. Otherwise, you
must specify TPX.
STX
Indicates that you want to add a CA STX session. This is the
default if you have an authorization code for CA STX only.
PROFILESESSION
Indicates that you want to add a session to a profile.
USERSESSION
Indicates that you want to add a session to a user.
objectID
Specifies the profile or user ID to which the session is added.
Chapter 2: Updating User Administration Data 29
Add Profiles to Users
Operand
Explanation
sessionID
Specifies the session that is to be added to the specified profile
or user.
variable
Specifies a valid variable that you want to specify for the user or
profile that you are adding. For descriptions of the variables, see
the appendix Variables (see page 111).
value
Specifies a valid value assigned to the selected variable.
When You Add a Session to CA TPX
When you add a session to a user or profile, you should specify the application ID for the
session by specifying a value in the UENTAPPL or PENTAPPL variable.
Override Profile Value
To nullify a profile parameter value at the user level without specifying a particular
value, specify a string of eight underscores.
For information about how CA TPX incorporates profile values when defining a user, see
How User Definitions Are Merged (see page 47).
Example: Adding a Session to a Profile
An administrator wants to add a session with a session ID of SALESREP to three profiles.
Instead of using online administration, the administrator executes the following
command statement:
ADD TPX PROFILESESSION (PROF05 SALESREP
PROF08 SALESREP
PROF14 SALESREP)
When the ADD statement is executed, the session SALESREP is added to the profile
records for PROF05, PROF08, and PROF14.
Add Profiles to Users
You use the ADD statement when you want to add profiles to a user.
30 Batch Administration Guide
Authorize a User to Administer a Group
Format
The ADD statement for profile sessions has the following syntax:
|------------------------+
V
|
->>-- ADD -- USERPROFILE ---(--- userID -- profileID -----)---><
Operand Explanations
The ADD statement for profile sessions has the following operands:
userID
Specifies the user ID of the user to which the profile is added.
profileID
Specifies the name of the profile to be added to the user.
Example: Adding a Profile to a User
An administrator wants to add a profile named SALEPROF to the user USER45. Instead of
adding the profile with online administration, the administrator executes the following
command statements in a batch job:
ADD USERPROFILE (USER45 SALEPROF)
The ADD statement adds the profile named SALEPROF to the user USER45.
Authorize a User to Administer a Group
You use the ADD statement when you want to give a user authorization to administer
the users in a user group.
Format
The ADD statement for adding a user to administer a group has the following syntax:
|--------------------------+
V
|
->>--- ADD ------------------ USERMAGN ----(--- userID --- group-name -----)---><
|-- STX --|
+-- TPX --+
Chapter 2: Updating User Administration Data 31
Authorize a User to Administer a Group
Operand Explanations
The ADD statement for authorizing a user to administer a group has the following
operands:
TPX
Indicates that you want to create a user administrator. If the user already has user
administration authority, no additional authority is assigned.
STX
Indicates that you want to create a CA STX administrator. If the user already has STX
user administration authority, no additional authority is assigned.
userID
Specifies the user ID group administration authorization is to be added.
group-name
Specifies the name of the user group that you want the user to have authorization
for.
If You Omit TPX
If you do not specify TPX, authority is assigned to the administrator according to the
values set in your CA LMP codes:
■
If your site has both CA TPX and CA STX, the administrator will have both
authorities.
■
If your site has CA TPX only, the administrator will have CA TPX authority.
The batch log will contain messages indicating what authority was assigned to the
administrator.
Example: Authorizing a User to Administer a Group
An administrator wants to authorize a user to administer two authorization groups.
Instead of using the online administration, the administrator executes the following
command statements in a batch job:
ADD USERMAGN (USER45 SALEGRP1
USER45 SALEGRP2)
When the ADD statements are executed, the user with a user ID of USER45 is authorized
to administer the groups named SALEGRP1 and SALEGRP2.
32 Batch Administration Guide
Assign a User View Authority
Assign a User View Authority
You use the ADD statement when you want to give a user authority to view a group with
the View facility.
Format
The ADD statement for authorizing a user to view a group has the following syntax:
|-----------------------------------------+
V
|
->>--- ADD ---- USERVAGN ----(---- userID --- group-name --- authority -------)---><
Operand Explanations
The ADD statement for authorizing a user to view a group has the following operands:
userID
Specifies the user ID to which View authority is to be assigned.
group-name
Specifies the name of the user group that you want the user to have authority to
view.
authority
Specifies a number that is the user's View authority for the specified user group.
The user will be able to view sessions of users in the group with security levels
lower than the number specified here.
Example: Authorizing a User to View a Group
An administrator wants to authorize a user to view two authorization groups and have a
View authority of 50 for each group. Instead of using online administration, the
administrator executes the following command statements in a batch job:
ADD USERVAGN (USER45 SALEGRP1 50
USER45 SALEGRP2 50)
When the ADD statements are executed, USER45 can view sessions of users in the
groups SALEGRP1 and SALEGRP2 with a View security level less than 50.
Copy Users and Profiles
You use the COPY statement to copy the characteristics of an existing user or profile
record to create a new record.
Chapter 2: Updating User Administration Data 33
Copy Users and Profiles
Format
The COPY statement can be used to add signon authority to an existing user if the user
does not already have that authority. In this case a message will be sent to the log
indicating that the user was updated instead of copied.
The COPY statement for users and profiles has the following syntax:
->>--- COPY ---------------------- USER -------------- templates ------------ ( -->
|-- TPX --|
+-- PROFILES --+
+- TO -+
+-- STX --+
|------------------------------------------------------+
V
|
->---- object -------------------------------------------------- ) -------------><
|
|------------------ -+
|
|
V
|
|
+-- ( ------ variable(value) ----- )--+
Operand Explanations
The COPY statement for users and profiles has the following operands:
TPX
Indicates that you want to copy the parameter values and authority. If the template
user or profile does not have signon authority, the COPY statement is not executed.
STX
Indicates that you want to copy the CA STX parameter values and authority. If the
template user or profile does not have STX signon authority, the COPY statement is
not executed.
Note: If you don't specify TPX or STX, the COPY statement is executed and whatever
signon authority the template user or profile has is copied.
USER
Indicates that you want to copy a user.
PROFILE
Indicates that you want to copy a profile.
template
Specifies the user or profile that is to be used as a template for the new user or
profile.
object
Specifies the user ID or profile ID assigned to the new user or profile.
34 Batch Administration Guide
Copy User and Profile Sessions
variable
Specifies a variable. For descriptions of the variables, see the appendix Variables
(see page 111).
value
Specifies a valid value to be assigned to the variable selected in variable.
Example 1: Copying a User
An administrator is adding user IDs for two new employees. The administrator wants
the new user IDs (USER80 and USER81) to have the same profiles, sessions, and user
definition values as an existing user (USER32). The administrator executes the following
statement in a batch job:
COPY USER USER32 TO (USER80 USER81)
When the COPY statement is executed, USER80 and USER81 are added to the
administration database. Their user definitions, sessions, and profiles are the same as
those for USER32.
Example 2: Copying a Profile
An administrator is creating a new profile named USRPROF5 and wants it to have the
same profile definition and sessions as a profile named USRPROF2. The administrator
executes the following statement in a batch job:
COPY TPX PROFILE USRPROF2 TO (USRPROF5)
When the COPY statement is executed, USERPROF5 is added to the administration
database. It has the values from profile USRPROF2.
If the Profile Exists
If the profile already exists, delete the existing records and then copy the new ones. The
COPY statement only works for new profiles.
Copy User and Profile Sessions
The COPY statement can be used to copy the characteristics of an existing user or profile
session record to create a new record.
Chapter 2: Updating User Administration Data 35
Copy User and Profile Sessions
This command is useful after you assign a session to a user or profile. For a description
of adding a session to a user or profile, see the section Add Sessions to Users and
Profiles (see page 29). You can copy the characteristics of the existing record to create
the new record.
Format
The COPY statement for user and profile sessions has the following syntax:
->>--- COPY --------------------- USERSESSION -------- template --sessionID---(-->
|-- TPX --|
+-- PROFILESESSION --+
+-- STX --+
|---------------------------------------------------------------+
V
|
->---- objectID ---- new-sessionID -------------------------------------)-----><
|
|-------------------+
|
|
V
|
|
+--(--- variable(value) ----)--+
Operand Explanations
The COPY statement for user and profile sessions has the following operands:
TPX
Indicates that you want to copy a session. If the template session is not a CA TPX
session, the COPY statement is not executed.
STX
Indicates that you want to copy a CA STX session. If the template session is not an
STX session, the COPY statement is not executed.
Note: If you do not specify TPX or STX, the COPY statement is executed regardless
of what type of session the template is.
USERSESSION
Indicates that you want to copy a user session.
PROFILESESSION
Indicates that you want to copy a profile session.
template
Specifies the user or profile containing the session that is to be used as a template
for the new user or profile session.
sessionID
Specifies the session ID of the session that is to be copied.
object
Specifies the user ID or profile ID of the user or profile to contain the new session.
36 Batch Administration Guide
Delete Users and Profiles
new-sessionID
Specifies the session ID of the session that is to be created.
variable
Specifies a variable. For descriptions of the variables, see the appendix Variables
(see page 111).
value
Specifies a valid value assigned to the variable selected in variable.
RECORD NOT FOUND Error
If you get a RECORD NOT FOUND error while copying a user session, the session you are
trying to copy may be assigned to the user by an assigned profile. Although the profile
session appears on the user's menu, there is no record of it at the user level.
Example: Copying a User Session
An administrator wants to add sessions named TSO-3 and TSO-4 to a user with a user ID
of USER2. The administrator wants the new sessions to have the same user session
values as an existing session named TSO-1 that is assigned to a user named USER5. The
administrator executes the following statement in a batch job:
COPY TPX USERSESSION USER5 TSO-1 (USER2 TSO-3 USER2 TSO-4)
When the COPY statement is executed, USER2 has two new sessions with session IDs of
TSO-3 and TSO-4. The new sessions have the same user session values as the session
named TSO-1 assigned to USER5.
Delete Users and Profiles
You can use the DELETE statement to delete user and profile records from the
administration database.
Format
The DELETE statement for users and profiles has the following syntax:
|-------------+
V
|
->>--- DELETE --------------------- USER --------------- (----- object ------)-----><
|-- TPX --|
+-- PROFILES --+
+-- STX --+
Chapter 2: Updating User Administration Data 37
Delete Users and Profiles
Operand Explanations
The DELETE statement for users and profiles has the following operands:
Operand
Explanation
TPX
Indicates that you are deleting values and signon authority.
STX
Indicates that you are deleting CA STX values and signon
authority. If the user or profile does not have TPX signon
authority, the user is deleted.
If you do not specify TPX or STX, the user or profile is deleted
regardless of signon authority.
USER
Specify USER to delete a user.
PROFILE
Specify PROFILE to delete a profile.
object
If you are deleting a user, this parameter specifies the user ID
to be deleted. If you are deleting a profile, this parameter
specifies the name of the profile to be deleted.
Example 1: Deleting a User
An administrator wants to delete two user IDs from CA TPX. Instead of using online
administration, the administrator uses the following DELETE statement:
DELETE TPX USER (USER35 USER46)
When the DELETE statement is executed, USER35 and USER46 and their associated CA
TPX profile and session records are deleted from the administration database.
Example 2: Deleting a Profile
An administrator wants to delete a profile. Instead of using online administration, the
administrator uses the following DELETE statement:
DELETE PROFILE (USRPROF3)
When the DELETE statement is executed, the profile named USRPROF3 and the
associated session records for both CA TPX and CA STX are deleted from the
administration database.
38 Batch Administration Guide
Delete Sessions from Users and Profile
Delete Sessions from Users and Profile
You use the DELETE statement when you want to delete sessions from a user or a
profile.
Format
The DELETE statement for user and profile sessions has the following syntax:
|--------------------+
V
|
->>--- DELETE ------------------ USERSESSION ---------(--- object -- sessID --- ) --><
|-- TPX --| +-- PROFILESESSION --+
+-- STX --+
Operand Explanations
The DELETE statement for user and profile sessions has the following operands:
Operand
Explanation
TPX
Indicates that you want to delete a session. If the session is not a
CA TPX session, the DELETE statement is not executed.
STX
Indicates that you want to delete a CA STX session. If the session
is not an STX session, the DELETE statement is not executed.
Note: If you do not specify TPX or STX, the DELETE statement is
executed regardless of what type of session the template is.
USERSESSION
Indicates that you want to delete a session from a user.
PROFILESESSION
Indicates that you want to delete a session from a profile.
object
Specifies the profile or user ID from which the session is to be
deleted.
sessID
Specifies the session ID that you want to delete.
RECORD NOT FOUND Error
If you get a RECORD NOT FOUND error while deleting a user session, the session you are
trying to delete may be assigned to the user via an assigned profile. Although the
session would appear on the user's menu, it is actually a profile session.
Chapter 2: Updating User Administration Data 39
Delete Sessions from Users and Profile
Notes on Deleting Sessions from User
When you delete a session from a user, the action that CA TPX takes depends on a
number of factors as described in this section.
Session Does not Exist
If the user does not have the specified session, Batch creates an override record and
marks it with the *DELETED* flag on the user's list of sessions in user maintenance.
Since there is no session associated with the override record, the override record is
deleted the next time the user signs on.
Session Exists
If the user does have the specified session record, CA TPX determines whether the
record is a session record or an override record.
Session Record
If the record is a session record, this product deletes the record.
Override Record
An "override" record is a session record that is added to the user record when the
user changes session values for a session that is really a profile session.
For example, PROFILE1 is a user's assigned profile and has a session named TSO32.
There is no TSO32 session record for the user, but the TSO32 session appears on the
user's Menu.
The user decides to change some of the session values for the TSO32 session, such as
the startup ACL/E program or the session time out. The user's changes are not recorded
in the profile session. Instead, CA TPX creates an "override" record containing the values
the user specified. When the user initiates the session, the override values are used.
When you are using the DELETE statement to delete an override session record from a
user, CA TPX must first determine whether the override record is already marked with
the *DELETED* flag.
Already *DELETED*
If the override record is already marked with the *DELETED* flag, the override
record is deleted. As a result, the session appears on the Menu the next time the
user signs on. From the user's point of view, the session has been added.
Not *DELETED*
If the override record is not marked with the *DELETED* flag, CA TPX marks the
session as *DELETED*. The session does not appear the next time the user signs on.
40 Batch Administration Guide
Delete Profiles from a User
Example: Deleting a Session from a User
An administrator wants to delete two sessions from a user with a user ID of USER45.
Instead of using online administration, the administrator executes the following
command statements:
DELETE TPX USERSESSION (USER45 SALESREP USER45 ACCTINFO)
When the DELETE statement is executed, the sessions SALESREP and ACCTINFO are no
longer assigned to USER45.
Delete Profiles from a User
You use the DELETE statement when you want to delete profiles from a user.
Format
The DELETE statement for user profiles has the following syntax:
|-------------------------+
V
|
->>--- DELETE ---- USERPROFILE --(----- userID -- profileID -----)---><
Operand Explanations
The DELETE statement for user profiles has the following operands:
Operand
Explanation
userID
Specifies the user from which the profile is to be deleted.
profileID
Specifies the profile to be deleted from the user.
To delete all profiles assigned to the user, specify eight masking
characters for this variable. For example, if the current masking
character is the dash (-), enter --------. See Specify Masking Criteria
Values (see page 52).
Example: Deleting a Session from a Profile
An administrator wants to delete two different profiles from two different users.
Instead of using online administration, the administrator executes the following
command statement:
DELETE USERPROFILE (USER45 PROF1 USER54 PROF3)
Chapter 2: Updating User Administration Data 41
Remove Group or View Administration Authority
When the DELETE statement is executed, profile PROF1 is deleted from USER45 and
profile PROF3 is deleted from USER54.
Remove Group or View Administration Authority
You use the DELETE statement when you want to remove a user's authority to
administration authority or View authority.
Format
The DELETE statement for removing group authorization authority has the following
syntax:
|----------------------------+
V
|
->>--- DELETE ----- USERMAGN -------(------ userID --- group-name ------)---><
+-- USERVAGN --+
Operand Explanations
The DELETE statement for removing group authorization authority has the following
operands:
Operand
Explanation
USERMAGN
Indicates that user administration authority is to be deleted.
USERVAGN
Indicates that View facility authority is to be deleted.
userID
Specifies the user ID from which administration authority is to be
removed.
group-name
Specifies the user group to be deleted from the user's list of
administration or View authority groups.
To delete all groups assigned to the user, specify eight masking
characters for this variable. For example, if the current masking
character is the dash (-), enter --------. See Specify Masking Criteria
Values (see page 52).
Example: Removing Group Administration Authority from a User
An administrator wants to remove a user's authority to administer a maintenance
authorization group named SALESGRP. Instead of using online administration, the
administrator executes the following command statement in a batch job:
DELETE USERMAGN (USER45 SALESGRP)
42 Batch Administration Guide
Modify User and Profile Values
When the DELETE statement is executed, USER45 is no longer authorized to administer
the users in the group named SALESGRP.
Modify User and Profile Values
You use the UPDATE statement to modify any user or profile values in the
administration database.
Format
The UPDATE statement for users and profiles has the following syntax:
->>--- UPDATE --------------------- USER -----------------(---->
|-- TPX --|
+-- PROFILE --+
+-- STX --+
|-----------------------------------------------+
|
|--------------------+
|
V
V
|
|
->---- object -------(----- variable(value) -----)--------)----><
Operand Explanations
The UPDATE statement for users and profiles has the following operands:
Operand
Explanation
TPX
Indicates that you want to modify the parameter values. If the
user or profile does not have signon authority, the UPDATE
statement is not executed.
STX
Indicates that you want to modify the CA STX parameter values.
If the user or profile does not have STX signon authority, the
UPDATE statement is not executed.
If you do not specify TPX or STX, the UPDATE statement is
executed and whatever signon authority the user or profile has.
USER
Specify USER to modify user values.
PROFILE
Specify PROFILE to modify profile values.
object
Specifies the user ID if you are modifying user values, or the
profile name if you are modifying profile values.
variable
Specifies the user or profile variable that you want to modify.
For descriptions of the valid variable names, see the
appendix Variables (see page 111).
value
Specifies the new value that you want to assign to the variable.
Chapter 2: Updating User Administration Data 43
Modify User and Profile Values
Override Profile Values
To nullify a profile parameter value at the user level without specifying a particular
value, specify a string of eight underscores. For example:
UPDATE USER (USER45 (UIDXGRP(HR) UIDXACBN('________')))
This statement updates the user USER45 in the user group HR and overrides any ACB
mask set at the profile level. For information about how CA TPX incorporates profile
values when defining a user, see How User Definitions Are Merged (see page 47).
Example 1: Modifying a User Value
An administrator wants to change the values for a user's menu key and stage 1 time out.
The administrator includes the following control statement in a batch job:
UPDATE USER (USER50(UIDXMKEY(PA3) UIDXTOU1(60)))
This statement assigns the following values:
■
PA3 for the menu key
■
60 for the stage 1 time out
Example 2: Assigning a User to a Group
An administrator wants to change the user authorization group of user USER62 to
USRGRP5. Instead of using online administration, the administrator executes the
following control statement in a batch job:
UPDATE USER (USER62(UIDXGRP(USRGRP5)))
This statement assigns USER62 to the user authorization group named USRGRP5.
Example 3: Modifying a Profile Value
An administrator wants to modify the definition values of two profiles so that the users'
sessions will be inactivated when they issue a /F command. The administrator executes
the following statement in a batch job:
UPDATE PROFILE (USRPROF1(PIDXKOPT(F)) USRPROF4(PIDXKOPT(F)))
The UPDATE statement changes the values of the "Inactivate on" field in each profile
description so that it has a value of F.
44 Batch Administration Guide
Modify User and Profile Session Values
Modify User and Profile Session Values
You use the UPDATE statement to modify any user or profile session values in the
administration database.
Format
The UPDATE statement for user and profile sessions has the following syntax:
->>--- UPDATE --------------------- USERSESSION ---------------(-------->
|-- TPX --|
+-- PROFILESESSION ---+
+-- STX --+
|-----------------------------------------------------------+
|
|-------------------+
|
V
V
|
|
->---- object-ID --- session-ID --- ( --- variable(value) -----)-----)--><
Operand Explanations
The UPDATE statement for user and profile sessions has the following operands:
Operand
Explanation
TPX
Indicates that you are updating a user or profile session
authorized for CA TPX. If the session is not a CA TPX session, the
UPDATE statement is not executed.
STX
Indicates that you are updating a user or profile session
authorized for CA STX. If the session is not a CA TPX session, the
UPDATE statement is not executed.
Note: If you do not specify TPX or STX, the UPDATE statement is
executed regardless of the type of session being updated.
USERSESSION
Specify USERSESSION to modify user session values.
PROFILESESSION
Specify PROFILESESSION to modify profile session values.
object-ID
This is the user ID if you are modifying user session values, or
the name of the profile if you are modifying profile session
values.
session-ID
This is the session ID of the session you want to modify.
variable
Specifies a variable. For descriptions of the variables, see the
appendix Variables (see page 111). The variable must be
appropriate for the session. Except for the user group variable,
which is common to sessions, you must specify variables for CA
TPX sessions.
Chapter 2: Updating User Administration Data 45
Modify User and Profile Session Values
Operand
Explanation
value
Specifies a valid value to be assigned to the variable selected in
variable.
RECORD NOT FOUND Error
If you get a RECORD NOT FOUND error while updating a user session, the session you
are trying to update may be assigned to the user via an assigned profile. Although the
session would appear on the user's menu, it is actually a profile session.
Override Profile Values
To nullify a profile parameter value at the user level without specifying a particular
value, specify a string of eight underscores. For example:
UPDATE USERSESSION ( USER45 TSO05 (UENTPJMP('________')))
This statement updates USER45's session TSO05 and overrides any jump key definition
set at the profile level. For information about how CA TPX incorporates profile values
when defining a user, see How User Definitions Are Merged (see page 47).
Example: Modifying User and Profile Session Values
An administrator has developed a new ACL/E program named TSOSTRT, a startup
program for a session with a session ID of TSO32. The administrator wants to assign the
new startup program to one user and two profiles that have the session. Other users
and profiles have the TSO32 session, but the administrator does not want them to use
the new startup program. The administrator uses the following control statements:
UPDATE TPX USERSESSION (USER56 TSO32(UENTSCRP(TSOSTRT)))
UPDATE TPX PROFILESESSION (USRPROF1 TSO32(UENTSCRP(TSOSTRT))
USRPROF2 TSO32(UENTSCRP(TSOSTRT)))
The UPDATE statements modify the administration database so that the TSO32 sessions
for USER56, USRPROF1, and USRPROF2 execute the ACL/E startup program named
TSOSTRT when the sessions are initiated.
46 Batch Administration Guide
Chapter 3: Extracting Data
This chapter shows you how to extract data from the CA TPX administration files for
reporting and updating.
This section contains the following topics:
Contents of Extract Files (see page 47)
EXTRACT Statement Syntax (see page 49)
Specify Extraction Criteria (see page 51)
Specify Variables Without Assigned Values (see page 53)
Contents of Extract Files
When you use the EXTRACT statement, information is extracted and written to an
extract file. The extract file contains information about the users, profiles, or mail
locators that match the criteria specified in the EXTRACT statement. Certain parameters
in the EXTRACT statement also allow you to extract the sessions that are associated with
users or profiles.
Extract files can be used for updating and reporting. For more information, see the
chapter Using Extract Files for Updating (see page 57) and the chapter Using Extract
Files for Reporting (see page 81).
You can also use extract files with report generators such as SAS. For information about
the format of extract files, see the appendix Extract File Layout (see page 165).
How User Definitions Are Merged
When you extract user records, Batch uses the same process to determine the values of
the user options fields as when the user signs on to CA TPX. When a user signs on, the
values for fields such as the menu key, jump key, and other user option fields are
determined by merging the values for these fields from the system, profile, and user
levels.
Chapter 3: Extracting Data 47
Contents of Extract Files
CA TPX merges the values for the user parameters in the following order:
1.
At the system level, the product gets the system default values from the SMRT and
STXT tables. These values apply to all users.
2.
At the profile level, the product gets the profile default values from the profiles
assigned to the user. If more than one profile is assigned to the user, values from
the first appropriate profile are used. Some values are defined at both the system
level and profile level. If a profile value is different than the system value, the
profile value overrides the system value.
3.
At the user level, the product gets the user values assigned to the user by a user
administrator or by the user during self-maintenance. If a user value is different
than a value set at the profile or system level, the user value overrides the other
values.
Batch uses this same process to construct a user definition. Therefore, any user option
values in an extract file or report are the result of merging the system defaults, profile
overrides, and user overrides for each field.
Profile Definitions
Profile definitions are not merged definitions. The profile definition values that you see
in an extract file are the actual options assigned for that profile.
How Session Definitions Are Merged
Batch constructs session records in a similar way. CA TPX gathers the values for
application session characteristics in the following order:
1.
At the system level, the product gets the system default values from the system
option table (the SMRT for CA TPX). These values apply to all users.
2.
At the application level, the product gets the application default values defined for
the particular application in the application characteristics table (the ACT for CA
TPX). These values apply to all users using this application.
3.
At the profile level, the product gets the profile session default values from
whatever profiles are assigned to the user. If more than one profile session with the
same ID is assigned to the user, values from the first profile are used, but can be
overridden by values from subsequent profiles. Some values are defined at both the
system level and profile level. If a profile value is different than the system value,
the profile value overrides the system value.
4.
At the user level, the product gets the user session values assigned to the user by a
user administrator or by the user during self-maintenance. If a user value is
different than a value set at the profile or system level, the user value overrides the
other values.
48 Batch Administration Guide
EXTRACT Statement Syntax
Mail Locators
Mail locators create an association between a mail message text and the users who
have that message in their mailbox. The message text exists once, but has a mail locator
for each user's mailbox that contains the message.
You can extract the mail locators, and then use the DELETE MAILMESSAGE command to
delete the locators. When a mail locator is deleted, the message is removed from that
user's mailbox.
Application Definitions
You can extract the application definition records and use them for reports, updating or
deleting.
EXTRACT Statement Syntax
The EXTRACT statement allows you to specify the name of the extract file and the
criteria used to extract data from the administration database.
If your batch job contains more than one EXTRACT statement, the extract file must
specify the DISP=MOD parameter to prevent each EXTRACT statement from overwriting
the previous one.
Format
The EXTRACT statement has the following syntax:
->>-- EXTRACT -- GIVING(ddname) ---- USER -------------- AND ALL SESSIONS -------->
|-- PROFILE -----+
|- AND MATCHING SESSIONS -|
|
+- AND NO SESSIONS -------|
|-- MAILMESSAGE ------------------------------|
|-- USERLIST ---------------------------------|
+-- ACT -------------------------------------+
|----------------------------------------------------+
|
|-------------+
|
V
V
|
|
->---------------(--- variable( ---- value ----------)--------------------)------><
Chapter 3: Extracting Data 49
EXTRACT Statement Syntax
Operands
The EXTRACT statement has the following operands:
ddname
Specifies the data definition name (DD name) of the output extract file. The data
extracted from the administration database is written to this file.
The DCB information is controlled by the program and should not be specified. The
maximum record size that can be extracted is equal to that of the ADMIN2 file; use
this value in conjunction with the expected record count to be extracted and your
media type to determine space requirements. The final disposition of the data set is
under JCL control.
USER
Specify USER to extract user records.
PROFILE
Specify PROFILE to extract profile records.
MAILMESSAGE
Specify MAILMESSAGE to extract mail locators.
USERLIST
Specify USERLIST to extract user lists.
ACT
Specify ACT to extract application definition records.
AND ALL SESSIONS
Indictes that all of the session records associated with each user or profile record
are extracted, regardless of the extraction criteria that you specify. Sessions
associated with a profile are extracted even if previously deleted from the user.
(Use the UENTDEL variable to determine if the session has been deleted.)
AND MATCHING SESSIONS
Indicates that only sessions which match extraction criteria containing a session
value are extracted. If you specify AND MATCHING SESSIONS and the extraction
criteria does not contain a session variable, no sessions are extracted.
AND NO SESSIONS
None of the session records associated with each user or profile record is extracted,
even if the extraction criteria contain a session variable.
50 Batch Administration Guide
Specify Extraction Criteria
variable
The name of any valid user, profile, or session variable. These variables represent
the fields on the online administration panels. You can specify as many variables as
you like, but a record will be extracted only if it matches all of the criteria variables.
For a list of the variables that you can use and the corresponding online
administration fields, see the appendix Variables (see page 111).
The variable can also be one of the variables listed in the following table. These
variables allow you to extract users, sessions, or profiles according to what
component they are associated with. These variables can have a value of Y or N.
VUSR$TPX(value)
Selects the user if user has signon authority.
WUSR$TPX(value)
Selects the profiles.
VSES$TPX(value)
Selects the user sessions.
WSES$TPX(value)
Selects the profile sessions.
value
This is the value of the variable that is used as a criterion for extracting records. You
can specify as many values as you like. Records are extracted if the specified
variable contains one of the specified values. For a detailed discussion of specifying
variables and values, see Specify Extraction Criteria (see page 51).
Specify Extraction Criteria
BATCH uses the variable and value you specify in the EXTRACT statement as criteria to
select the records that are written to the extract file. Using extraction criteria, you can
extract users with a particular user ID, menu key, or another characteristic. You can
selectively extract profiles in the same way.
For example, the following EXTRACT statement produces the output file named
PA2USERS, containing the user records for all users whose menu key is PA2:
EXTRACT GIVING(PA2USERS) USER AND NO SESSIONS (UIDXMKEY(PA2))
You can then use the resulting extract file (PA2USERS) to update the user records or to
generate a report on those users.
Chapter 3: Extracting Data 51
Specify Extraction Criteria
Specify Masking Criteria Values
If you want your extraction criteria to be non-specific, you can use a masking character
to mask the criteria value. The default masking character is a hyphen (-). You can mask
any number of characters of the value (from one to the number of characters in the
value). For example, the following EXTRACT statement produces the output file named
SALEDEPT, containing the user records for all users whose user IDs begin with SALES,
regardless of the last three characters:
EXTRACT GIVING(SALEDEPT) USER AND NO SESSIONS (UIDXNAME(SALES---))
Changing the Masking Character
The value of the masking character is stored in a variable named MASKCHAR. You
can use a SET statement to change the value of MASKCHAR so that your masking
character does not conflict with actual values in the records. For example, if you
want to make the masking character an exclamation point (!), use the following SET
statement:
SET MASKCHAR '!'
Manage Errors
The variable named MASKERLV contains a code that tells CA TPX Batch what to do when
it finds a value in an input control record that contains the masking character. You can
use a SET statement to set the value of MASKERLV to one of the values shown below. A
number 1 (one) is the default value.
0
Error message TPBL1050 is issued. Batch continues to process as if the error had not
occurred.
1
Error message TPBL1050 is issued. Batch only processes records that do not contain
the masking character. The return code for the job is set to 12 if is not already set to
a higher number.
2
The return code for the job is set to 16 if is not already set to a higher number.
Batch terminates processing. All data before the error was encountered is saved.
3
User abend 930 is issued and no data is written to the extract file.
52 Batch Administration Guide
Specify Variables Without Assigned Values
Example
The following SET statement causes Batch to terminate processing, keeping the data
processed before the error occurred:
SET MASKERLV '2'
Specify Multiple Variables
If you specify more than one variable in the extraction criteria, all records that match all
of the criteria are extracted. For example, the following statement extracts a user record
and puts it in an extract file named PRIVUSRS if the user has a command class of A and
an update class of A:
EXTRACT GIVING(PRIVUSRS) USER AND NO SESSIONS (UIDXPRSV(A) UIDXUPDC(A))
Specify Multiple Values
You can also specify more than one value in the extraction criteria for a particular
variable. For example, the following EXTRACT statement produces an output file named
KEYUSERS that contains the user records for each user who has a menu key of PA1, PA2,
or PA3:
EXTRACT GIVING(KEYUSERS) USER AND NO SESSIONS (UIDXMKEY(PA1 PA2 PA3))
Note: A record needs to match only one of the specified criteria to be extracted.
Specify Variables Without Assigned Values
Profile Variables
You can also specify a blank value in order to specify profile variables that have not been
assigned a value. To do this, always specify a value of eight underscores, regardless of
the length of the variable.
Note: This method can only be used to select profiles and profile sessions.
User Variables
You can specify a blank value in order to specify user variables that have not been
assigned a value. To do this, always specify a single space (' '), regardless of the length of
the variable.
Chapter 3: Extracting Data 53
Specify Variables Without Assigned Values
Using a variable with a blank value as extraction criteria will only select user records if
the variable has not been assigned a value at the system, application, profile, or user
level.
Example 1: Extracting a List of Users and Their Sessions
An administrator wants a report that lists the sessions that the company's service
department employees use. The administrator also wants to know what startup and
termination ACL programs the users have assigned for their sessions. The user IDs for
service department personnel begin with SERV, followed by a four-character code
unique to the user. The administrator issues the following statement in a batch job:
EXTRACT GIVING(SERVSESS) USER AND ALL SESSIONS (UIDXNAME(SERV----))
The EXTRACT statement produces an extract file named SERVSESS that contains the
merged user definitions and the associated session records for each user whose user ID
begins with SERV.
Example 2: Extracting a List of Users Using a Particular Session
An administrator has written an ACL/E startup program for a session named SALESREP,
and wants a report listing all users who have the SALESREP session. The administrator
executes the following statement in a batch job:
EXTRACT GIVING(SRUSERS) USER AND MATCHING SESSIONS (UENTUSER(SALESREP))
The statement produces an extract file named SRUSERS that contains the user definition
and the SALESREP session record for each user who has the SALESREP session.
Example 3: Extracting a List of Profiles and Their Associated Sessions
An administrator wants a report listing the profiles that are set up to give the user PASS
access to the sessions. The administrator also wants to know what sessions are
associated with the profiles. The administrator executes the following statement in a
batch job:
EXTRACT GIVING(PASSPROF) PROFILE AND ALL SESSIONS (PIDXACCS(PASS))
The EXTRACT statement produces an extract file named PASSPROF that contains the
profile definition and associated session records for each profile that has a value of PASS
in the ACCESS field.
54 Batch Administration Guide
Specify Variables Without Assigned Values
Example 4: Extracting a List of Profiles with a Particular Session
An administrator wants to know what profiles have a session with a session ID of TSO2.
The administrator also wants the report to list the startup and termination ACL/E
programs that are assigned for the session by each profile. The administrator executes
the following statement in a batch job:
EXTRACT GIVING(TSO2PROF) PROFILE AND MATCHING SESSIONS (PENTUSER(TSO2))
The statement produces an extract file named TSO2PROF that contains the profile
definition and TSO2 session records for each profile that has a session with a session ID
of TSO2.
Note: The records for sessions other than TSO2 are not included in the extract file.
Example 5: Extracting a List of Mail Locators
An administrator wants to extract all mail locators for a user ID TUSR05, which has been
deleted. The administrator executes the following statement in a batch job:
EXTRACT GIVING(OLDLOC) MAILMESSAGE (MLOCTO(TUSR05))
This creates the extract file OLDLOC, which contains all mail locators for the recipient
TUSR05. The variable MLOCTO specifies the recipient of a mail message.
Chapter 3: Extracting Data 55
Chapter 4: Using Extract Files for Updating
This chapter shows you how to use extract files to update the CA TPX ADMIN and MAIL
files.
This section contains the following topics:
Update Records with Extract Files (see page 57)
Add Profiles and Authority to Users (see page 57)
Delete Users, Profiles, and Sessions (see page 59)
Delete Profiles and Authorization from Users (see page 62)
Add User Lists (see page 63)
Delete Mail Locators (see page 64)
Modify Records (see page 65)
Delete User Lists (see page 67)
Update Records with Extract Files
When you use the EXTRACT statement, information is extracted and written to an
extract file. The extract file can contain user, profile, session, user list, or mail data.
Using the ADD, DELETE, and UPDATE statements, you can modify all of the records that
appear in the extract file. You can also use the records in the extract file to delete mail
messages or create user lists.
Note: When you use an extract file to update records, the records in the administration
database are updated and not the records in the extract file.
You do not have to use extract files to update the administration or mail files:
■
For information on how to update user and profile records directly, without using
extract files, see the chapter Updating Administration Data (see page 25).
■
For information on how to update mail messages and user lists directly, see the
chapter Updating Mail Messages and User Lists (see page 69).
Add Profiles and Authority to Users
You can specify an extract file in an ADD statement when you want to add a profile or
user maintenance authorization group to a set of user records.
Chapter 4: Using Extract Files for Updating 57
Add Profiles and Authority to Users
Format
The ADD statement for user profiles and group authorization has the following syntax:
->>-- ADD ------------------- USERPROFILE ------ USING(ddname)-->
|-- TPX --|
|-- USERMAGN ----|
+-- STX --+
+-- USERVAGN ----+
----------- (object) -------------------------------------------><
|
|
+---(-- group-name --- authority ---)---+
Operand Explanations
The ADD statement for user profiles and group authorization has the following
operands:
TPX
Indicates that you want to assign authority. This is the default if you have an LMP
code for CA TPX only. Otherwise, you must specify TPX or STX. If the user already
has user administration authority, no additional authority is assigned.
This parameter applies only when using the USERMAGN parameter.
STX
Indicates that you want to assign CA STX authority. This is the default if you have an
authorization code for CA STX only. Otherwise, you must specify TPX or STX. If the
user already has STX user administration authority, no additional authority is
assigned.
This parameter applies only when using the USERMAGN parameter.
USERPROFILE
Indicates that you want to add a profile to a user.
USERMAGN
Indicates that you want to authorize a user to administer a group.
USERVAGN
Indicates that you want to assign a user View authority for a group.
ddname
Specifies the data definition name (DD name) of the input extract file that is used to
update the administration database.
object
Specifies the name of a profile if you are adding a profile to a user, the name of an
authorization group if you are authorizing a user to administer a group, or a View
authority if you are assigning View authority to a user.
58 Batch Administration Guide
Delete Users, Profiles, and Sessions
group-name
Specifies the group for which the user is assigned View authority.
authority
Specifies the user's View authority for the group.
Example 1: Adding a Group Profile to a User
An administrator wants to add a profile named GRP1PROF to all the users who are in a
maintenance authorization group named USERGRP1. The administrator uses the
following control statements:
EXTRACT GIVING(GRP1USRS) USER AND NO SESSIONS (UIDXGRP(USERGRP1))
ADD USERPROFILE USING(GRP1USRS) (GRP1PROF)
The EXTRACT statement produces the extract file named GRP1USRS, which contains the
merged user definition for each user who is in the maintenance authorization group
named USERGRP1. The ADD statement adds the profile named GRP1PROF to each user
record in the extract file.
Example 2: Authorizing Users to Administer a Group
An administrator wants to authorize all of the user administrators in the company's
sales department to administer a user group named SALESGRP. All of the sales
department administrators have user IDs that begin with SALESAD, so the administrator
uses the following control statements:
EXTRACT GIVING(SALESEMP) USER AND NO SESSIONS (UIDXNAME(SALESAD-))
ADD USERMAGN USING(SALESEMP) (SALESGRP)
The EXTRACT statement produces the extract file named SALESADS, which contains the
merged user definition for each user whose user ID begins with SALESAD. The ADD
statement authorizes these users to administer the users in the group named SALESGRP.
Delete Users, Profiles, and Sessions
Important! When deleting users and profiles using an extract file, always use the extract
file to print a report first to make sure that you are not deleting records that you do not
want to delete. You should also back up the administration data sets before running
Batch.
You can specify an extract file in a DELETE statement when you want to delete user
records, user session records, user profile records, profile records, and profile session
records.
Chapter 4: Using Extract Files for Updating 59
Delete Users, Profiles, and Sessions
Format
The DELETE statement for users, profiles, and sessions has the following syntax:
->>-- DELETE ----------------- USER -------------USING(ddname)--><
|-- TPX --| |-- PROFILE ---------|
+-- STX --+ |-- USERSESSION -----|
+-- PROFILESESSION --+
Operand Explanations
The DELETE statement for users, profiles, and sessions has the following operands:
Operand
Explanation
TPX
Indicates that you want to delete the parameters. If you do not
specify TPX or STX, Batch will delete regardless of type.
STX
Indicates that you want to delete the CA STX parameters. If you
do not specify TPX or STX, Batch will delete regardless of type.
USER
Specifies that you want to delete a user.
PROFILE
Specifies that you want to delete a profile.
USERSESSION
Specifies that you want to delete a session from a user.
PROFILESESSION
Specifies that you want to delete a session from a profile.
ddname
Specifies the data definition name (DD name) of the input
extract file that is used to indicate which users, profiles, user
sessions, or profile sessions are to be deleted.
Example 1: Deleting User IDs
An administrator has discovered some user IDs that have not been used for a long time.
The user IDs were named using an old naming convention and all begin with HSP. The
administrator executes the following statements in a batch job:
EXTRACT GIVING(DELUSRS) USER AND NO SESSIONS (UIDXNAME(HSP-----))
DELETE USER USING(DELUSRS)
The EXTRACT statement produces the extract file named DELUSRS, which contains the
merged user definition for each user ID in the list of extraction criteria. The DELETE
statement deletes the user records, user session records, user profile records and
maintenance authorization group names for each user.
60 Batch Administration Guide
Delete Users, Profiles, and Sessions
Example 2: Deleting User Sessions
You can use the DELETE statement with an extract file to delete one or more sessions
from a set of user records. For example, an administrator wants to delete a session with
a session ID of TSO24 from all of the user records that have the session. The
administrator uses the following control statements:
EXTRACT GIVING(TSOUSRS) USER AND MATCHING SESSIONS (UENTUSER(TSO24))
DELETE USERSESSION USING(TSOUSRS)
The EXTRACT statement produces the extract file named TSOUSRS, which contains the
merged user definition and the TSO24 session record for each user who has a TSO24
session defined. Records for the users' other sessions are not included in the extract file.
The DELETE statement deletes the user session records that appear in the extract file
named TSOUSRS (all TSO24 sessions).
Example 3: Deleting Profiles
You can use the DELETE statement with an extract file to delete a set of profile records.
For example, an administrator wants to delete three profiles that have been replaced by
other profiles. The administrator uses the following command statements to delete the
profiles.
EXTRACT GIVING(DELPROF) PROFILE AND NO SESSIONS
(PIDXNAME(ACCTPROF SERVPROF TSPROF))
DELETE PROFILE USING(DELPROF)
The EXTRACT statement produces the extract file named DELPROF, which contains the
profile records for each profile in the list of extraction criteria. The DELETE statement
deletes the profile records and profile session records for each profile.
Example 4: Deleting Profile Sessions
An administrator is going to delete a session with a session ID of CICSTST. But first, the
administrator wants to make sure that the session is deleted from the profile records
that have session records for CICSTST. The administrator uses the following control
statements:
EXTRACT GIVING(CICSPROF) PROFILE AND MATCHING SESSIONS (PENTUSER(CICSTST))
DELETE PROFILESESSION USING(CICSPROF)
The EXTRACT statement produces the extract file named CICSPROF, which contains the
profile definition and the CICSTST session record for each profile that has a CICSTST
session defined. Records for the other sessions in the profile are not included in the
extract file. The DELETE statement deletes the profile session records that appear in the
extract file named CICSPROF (all CICSTST sessions).
Chapter 4: Using Extract Files for Updating 61
Delete Profiles and Authorization from Users
Delete Profiles and Authorization from Users
Format
The DELETE statement for user profiles and group authorization has the following
syntax:
->>-- DELETE ----- USERPROFILE ----USING(ddname) -- (object) --><
|-- USERMAGN ----|
|-- USERVAGN ----+
Operand Explanations
The DELETE statement for user profiles and group authorization has the following
operands:
Operand
Explanation
USERPROFILE
Specify USERPROFILE to delete a profile from a user.
USERMAGN
Specify USERMAGN to remove group authorization from a user.
USERVAGN
Specify USERVAGN to remove View facility authority from a user.
ddname
This is the data definition name (DD name) of the input extract file
that is used to indicate which users are to have profiles or group
authorization deleted.
object
This parameter specifies the object that is to be deleted from each
user record. This is a profile name if you are deleting a profile from a
user, or a group name if you are removing group authorization from
a user.
Example 1: Deleting a Profile from a User Group
An administrator wants to delete a profile named GRP1PROF from all the users who are
in a maintenance authorization group named USERGRP1. The administrator uses the
following control statements:
EXTRACT GIVING(GRP1USRS) USER AND NO SESSIONS (UIDXGRP(USERGRP1))
DELETE USERPROFILE USING(GRP1USRS) (GRP1PROF)
The EXTRACT statement produces the extract file named GRP1USRS, which contains the
merged user definition for each user who is in the maintenance authorization group
named USERGRP1. The DELETE statement deletes the profile named GRP1PROF from
each user record in the extract file.
62 Batch Administration Guide
Add User Lists
Example 2: Removing Group Authorization from Users
An administrator wants to delete a group named SERVGRP from the user records for the
company's sales department employees. All of the sales department employees have
user IDs that begin with SALES, so the administrator uses the following control
statements:
EXTRACT GIVING(SALESEMP) USER AND NO SESSIONS (UIDXNAME(SALES---))
DELETE USERMAGN USING(SALESEMP) (SERVGRP)
The EXTRACT statement produces the extract file named SALESEMP, which contains the
merged user definition for each user whose user ID begins with SALES. The DELETE
statement deletes the user maintenance authorization group named SERVGRP from
each user record in the extract file.
Add User Lists
You can specify an extract file in an ADD USERLIST statement. The statement will add
user lists to specified users, getting entries for the list from the extract file.
Format
The ADD statement for userlists has the following syntax.
->>-- ADD -- USERLIST -- userlist ---- owner ------------------------------------>
+- *GENERAL* -+ +- PRIVATE -+ +- INVISIBLE -+
->------------------------------ USING (ddname) --------------------------------><
+-- title - (title) -+
Operand Explanations
The DELETE statement for mail messages has the following operands:
Operand
Explanation
userlist
Specifies the name to be assigned to the user list that is being added.
owner
Specifies the user ID or user group name of the owner of the list that
is being added.
*GENERAL*
Indicates that the list being added is a general list, which can be used
by all users.
PRIVATE
Indicates that only the owner of the list can use it.
This parameter does not apply to general user lists.
Chapter 4: Using Extract Files for Updating 63
Delete Mail Locators
Operand
Explanation
INVISIBLE
Indicates that only the owner of the list can browse or copy its
contents.
TITLE(title)
Specifies a title to be assigned to the new list. The title must be a
quoted string.
ddname
This is the data definition name (DD name) of the input extract file
that is used to indicate which entries will appear in the user list that
is being added.
All entries of a user list must be of a single type. Possible types are
user IDs, user names, terminal IDs, user lists, user group names,
active application IDs, application IDs, active session IDs, and session
IDs.
Example
An administrator wants to add a list to all users in the accounting department. All users
in the accounting department have user IDs that begin with ACCT. The list is to include
the user IDs of all users who work on the ABC Corporation account. The administrator
knows that all of these users have been assigned the profile ABC so the special batch
variable VUSRPROF can be used to extract these users. The administrator doesn't want
other users to be able to use this list. To perform these tasks, the following control
statements can be executed in a batch job:
EXTRACT GIVING(ABCUSRS) USER AND NO SESSIONS (VUSRPROF(ABC))
ADD USERLIST ABCLIST ACCT---- PRIVATE TITLE('ABC Accountants') USING (ABCUSRS)
The EXTRACT statement produces the extract file named ABCUSRS, which contains the
user ID of all users who have the profile ABC in their profile list. The ADD USERLIST
command adds a list named ABCLIST to each user whose ID begins with ABC. The list
contains all user IDs that are in the extract file ABCUSRS.
Delete Mail Locators
Mail locators are associated with mail messages. A locator exists for every user that has
the message stored in his or her mailbox. When the locator is deleted for that user, the
message no longer appears in the user's mailbox.
You can specify an extract file in the DELETE MAILMESSAGE statement. The extract file
can specify actual mail locators, which will be deleted, or user IDs, in which case all mail
locators for that user are deleted.
64 Batch Administration Guide
Modify Records
Format
The DELETE statement for mail messages has the following syntax.
->>--- DELETE --- MAILMESSAGE ---- USING --- (ddname) ----><
Operand Explanations
The DELETE statement for mail messages has the following operands:
ddname
Specifies the data definition name (DD name) of the input extract file that is used to
indicate which mail locators are to be deleted. The file can consist of mail locators
or user IDs.
Example
An administrator wants to delete mail messages in the mailboxes of users whose IDs are
no longer valid. The user IDs were named using an old naming convention and all begin
with HSP. The administrator uses the following control statements:
EXTRACT GIVING (OLDMAIL) MAILMESSAGE (MLOCTO (HSP-----))
DELETE MAILMESSAGE USING (OLDMAIL)
The EXTRACT statement produces the extract file named OLDMAIL, which contains all of
the mail locators for all users whose IDs begin with HSP. The DELETE MAILMESSAGE
statement deletes all of these mail locators.
Modify Records
Any of the user or profile values that can be modified on an online administration panel
can be modified using an UPDATE statement with an extract file.
Format
The UPDATE statement has the following syntax:
|------------------+
V
|
->>--- UPDATE -- USING(ddname) ---(----variable(value) ---)---><
Chapter 4: Using Extract Files for Updating 65
Modify Records
Operand Explanations
The UPDATE statement has the following operands:
Operand
Explanation
ddname
Specifies the data definition name (DD name) of the input extract file
that is used to update the administration database.
variable
Specifies the name of the user or profile variable that you want to
modify. You can specify as many variables as you want, but you can
specify only one value for each variable. For descriptions of the valid
variables and the corresponding online administration fields, see the
appendix Variables (see page 111).
value
Specifies the new value that you want to assign to the variable.
Overriding Profile Values
To nullify a profile parameter value at the user level without specifying a particular
value, specify a string of eight underscores (_). For example:
UPDATE USING (USERS) ( UIDXACBN('________'))
This statement updates the users listed in the extract file USERS. The blank value will
override any value for the ACB mask set at the profile level. For information on how CA
TPX uses profile values when creating a user definition, see How User Definitions Are
Merged (see page 47).
Example 1: Modifying User Variables
An administrator wants to make sure that all users have a stage 1 time out of 60
minutes. The administrator uses the following control statements:
EXTRACT GIVING(ALLUSERS) USER AND NO SESSIONS (UIDXNAME(--------))
UPDATE USING(ALLUSERS) (UIDXTOU1(60) UIDXTOP1(L))
The EXTRACT statement uses a masked value to produce an extract file that contains the
merged user definitions for all users. For each record in the extract file, the UPDATE
statement modifies the administration database so that the value of the time out and
option fields have the specified values for all users.
66 Batch Administration Guide
Delete User Lists
Example 2: Modifying Profile Variables
An administrator notices that some of the profiles have PA3 assigned as the command
key. The administrator uses the following control statements to change these profiles so
that they have PF12 assigned as the command key.
EXTRACT GIVING(PA3PROFS) PROFILE AND NO SESSIONS (PIDXESCK(PA3))
UPDATE USING(PA3PROFS) (PIDXESCK(PF12))
The EXTRACT statement produces the extract file named PA3PROFS, which contains the
profile definition for each profile that has a command key of PA3. The UPDATE
statement changes the value of the command key to PF12 for each of the profile
records.
Example 3: Modifying User and Profile Session Variables
An administrator has developed a new ACL/E program named TSOSTRT, a startup
program for a session with a session ID of TSO32. The administrator wants to make sure
that all users and profiles that have the session TSO32 use the correct startup ACL
program. The administrator uses the following control statements:
EXTRACT GIVING(ACLUSERS) USER AND MATCHING SESSIONS (UENTUSER(TSO32))
EXTRACT GIVING(ACLPROFS) PROFILE AND MATCHING SESSIONS (PENTUSER(TSO32))
UPDATE USING(ACLUSERS) (UENTSCRP(TSOSTRT))
UPDATE USING(ACLPROFS) (PENTSCRP(TSOSTRT))
The first EXTRACT statement produces an extract file named ACLUSERS, which contains
the merged user definition and the TSO32 session record for each user with the TSO32
session. The second EXTRACT file produces the extract file named ACLPROFS, which
contains the profile definition and the TSO32 session record for each profile with the
TSO32 session.
The UPDATE statements use the extract files to update the administration database so
that all users and profiles that have the TSO32 session have TSOSTRT specified as the
startup ACL program for that session. The other user and profile sessions will not be
affected because their records were not extracted.
Delete User Lists
You can delete user lists with the DELETE USERLIST statement. The DELETE USERLIST
statement can specify a specific user list belonging to a specific user or group.
Chapter 4: Using Extract Files for Updating 67
Delete User Lists
Format
The DELETE USERLIST statement has the following syntax:
->>-- DELETE -- USERLIST --- userlist ----- owner -----------><
+-- *GENERAL* --+
Operand Explanations
The DELETE statement for user lists has the following operands:
userlist
Specifies the name of the user list that is to be deleted.
owner
Specifies the user ID or user group name of the owner of the list that is to be
deleted.
*GENERAL*
Indicates that the list to be deleted is a general list.
Example
An administrator wants to delete the user list HRLIST from all users in the human
resources department. All of these users have user IDs that begin with HR. The
administrator could use the following statement in a batch job:
DELETE USERLIST HRLIST HR------
The list is deleted from all users with user IDs beginning with HR.
68 Batch Administration Guide
Chapter 5: Updating Mail Messages and
User Lists
This chapter shows you how to store and delete mail messages, and how to add and
delete user lists in batch administration.
This section contains the following topics:
Add Mail Messages (see page 69)
Delete Mail Messages (see page 71)
Add User Lists (see page 72)
Add Mail Messages
You can use the ADD MAILMESSAGE statement when you want to store mail messages
in users' mailboxes in the MAIL file. When using the ADD MAILMESSAGE statement, you
can specify:
■
The expiration date of the message
■
The subject of the message
■
The recipients of the message, either with user IDs or user lists
■
The text of the message
When a user receives a message that was sent with the batch facility, the sender will be
listed as the batch jobname.
Format
The ADD MAILMESSAGE statement has the following syntax:
->>-- ADD -- MAILMESSAGE ------------------------------------------------>
+-- EXPIRING ---(-------------------------------)--+
| +--MM(mm)--+ +--DD(dd)--+ +--YY----yy----+---|
|
+- yyyy -+
|
+------------------ nn -----------------------+
->-- SUBJECT ---- (-- subject --)---TO----------------------------------->
|-- USERS ------|
+-- USERLISTS --+
|--------------------+
V
|
->-------------------- recipient ------------------------- text ---------><
|
|
|
|
|
|
|
|
|
|
+- ( -+
+------*BULLETIN* -----+
+- ) -+
+- ( -+
+- ) -+
Chapter 5: Updating Mail Messages and User Lists 69
Add Mail Messages
Operand Explanations
The ADD statement for user lists has the following operands:
Operand
Explanation
EXPIRING
Indicates that the following syntax is going to specify an expiration
date.
MM(mm)
Numerically specifies the month of the expiration date.
DD(dd)
Numerically specifies the day of the expiration date.
YY(yy/yyyy)
Numerically specifies the year of the expiration date. The year can
appear as two or four digits (for example, 03 or 2003).
nn
Specifies the number of days that must pass after the message is
sent before it expires.
USERS
Indicates that the message recipients will be specified by user ID.
USERLISTS
Indicates that the message recipients will be specified by a user list.
recipients
Specifies either a user ID or a user list.
*BULLETIN*
Indicates that this message is a bulletin, which will be stored in the
mailbox of all users.
A bulletin can also be application news, as described in the
following section.
subject
Specifies the subject of the message. It must be enclosed in quotes.
If the subject begins with the string APPL=applID, the message will
be sent as application news for the application specified in applID.
Application news is described in the following section.
text
Specifies the text of the message. It must consist of one or more
quoted strings. Each quoted string can contain up to 79 characters
and will appear as a separate line in the message.
There is no limit on the amount of text, but it must fit in one VSAM
record.
Sending Application News
To send application news, the subject of the message must begin with APPL=applID,
where applID specifies the application. The recipient must be *BULLETIN*.
Application news replaces an application's description on the Menu.
70 Batch Administration Guide
Delete Mail Messages
Example 1
An administrator wants to send a message to user lists DEVLST01 and DEVLST02. The
message is to expire after seven days. The following statement accomplishes this task:
ADD MAILMESSAGE EXPIRING 7 SUBJECT('Meeting on Friday')
TO USERLISTS(DEVLST01 DEVLST02)
('There is a department meeting on Friday afternoon.'
'Be sure to bring your thinking caps.')
When this statement is executed, the message will be put in the mailbox of each user
who is included in the DEVLST01 or DEVLST02 user list. The subject of the message will
be "Meeting on Friday" and the text of the message is:
There is a department meeting on Friday afternoon.
Be sure to bring your thinking caps.
Example 2
An administrator wants to put out application news for the CA TPX application TSO01.
The application news will consist of a single line, saying that the application is going to
be brought down. The message is to expire on 3 February 2003. The following statement
accomplishes this task:
ADD MAILMESSAGE EXPIRING (MM(02) DD(3) YY(03)) SUBJECT
( 'APPLID=TSO01 going down midnight Friday') TO (*BULLETIN*)
When this statement is executed, the message will appear on the Menu for each user
who has TSO01 on the menu.
If the message included text as well as a subject, a bulletin containing the text would
appear in the mailbox of each user who has TSO01 on the menu.
Delete Mail Messages
You can delete messages from users' mailboxes with the DELETE MAILMESSAGE
statement. The DELETE MAILMESSAGE statement can specify a specific date or a
number of days. All messages that were created before the specified date, or that have
existed longer than the specified number of days, will be deleted from users' mailboxes.
The statement will also delete all messages that have expired.
Format
The DELETE MAILMESSAGE statement has the following syntax:
->>-- DELETE -- MAILMESSAGE --- BEFORE ---(------------------------------)--+---><
| +-MM(mm)-+ +-DD(dd)-+ +-YY--yy--+--|
|
+- yyyy -+ |
+-------- nn ------- DAYS ------------+
Chapter 5: Updating Mail Messages and User Lists 71
Add User Lists
Operand Explanations
The DELETE statement for mail messages has the following operands:
MM(mm)
Specifies the month of the date numerically.
DD(dd)
Specifies the day of the date numerically.
YY(yy/yyyy)
Specifies the year of the date numerically. The year can appear as two or four digits
(for example, 03 or 2003).
nn
Specifies a number of days.
Example
An administrator wants to delete all messages that where created more than 90 days
previously. The following statement will accomplish this:
DELETE MAILMESSAGES BEFORE 90 DAYS
All messages that were created more than 90 days previous to the day that the
command is executed are deleted. All messages that have expired are also deleted.
Add User Lists
You can use the ADD statement when you want to add user lists to specific users. In the
ADD USERLIST statement you can specify the properties of the user list and what type of
contents it will contain.
72 Batch Administration Guide
Add User Lists
Format
The ADD USERLIST statement has the following syntax.
->>-- ADD -- USERLIST --- userlist ---- owner ---------------------------------->
+- *GENERAL* -+ +- PRIVATE -+ +- INVISIBLE -+
|--------+
V
|
->------------------------------------------------------------(--- entry ---)--->
<
|--- USERS ---------------------|
+-- TITLE -- (title) --+
|--- USERIDS -------------------|
|--- USERLISTS -----------------|
|--- TERMINALS -----------------|
|---------------APPLICATIONS ---|
| +- ACTIVE -+
|
|
|
|----------------SESSIONS-------|
| +- ACTIVE -+
|
|
|
+--- GROUPS --------------------+
Operand Explanations
The ADD statement for mail messages has the following operands:
Operand
Explanation
userlist
Specifies the name assigned to the user list you are adding.
owner
Specifies the user ID or user group name of the owner of the user
list.
If you are specifying a multi-signon user ID on a specific terminal,
specify the user ID and the terminal ID. For example, to specify
user MLTUSR02 on terminal TERMAA21, specify this the
command as:
ADD USERLIST LIST01 MLTUSR02 TERMAA21 PRIVATE...
*GENERAL*
Indicates that this is a general user list, which can be used by all
users.
PRIVATE
Indicates that users other than the owner cannot use the list. This
operand does not apply to general user lists.
INVISIBLE
Indicates that users other than the owner cannot browse or copy
the list's contents.
USERS
Indicates that the list is made up exclusively of user names. This is
the default type of list contents.
USERIDS
Indicates that the list is made up exclusively of user IDs.
USERLISTS
Indicates that the list is made up exclusively of other user lists.
TERMINALS
Indicates that the list is made up exclusively of terminal IDs.
Chapter 5: Updating Mail Messages and User Lists 73
Add User Lists
Operand
Explanation
ACTIVE
Indicates that the list is made up exclusively of active applications
or sessions.
This parameter can be used only with the APPLICATIONS or
SESSIONS parameters.
APPLICATIONS
Indicates that the list is made up exclusively of applications.
SESSIONS
Indicates that the list is made up exclusively of sessions.
GROUP
Indicates that the list is made up exclusively of user groups.
TITLE(title)
Specifies the name of the user list.
entry
Specifies an entry in the user list. The entry must be of the
specified type (user name, user ID, etc.)
Example
An administrator wants to add a user list to all users in the human resources
department. The list will consist of a number of users in human resources. All user IDs of
employees in human resources begin with HR. The user list will include all human
resource managers, whose IDs begin with HRM, and the user IDs HRDV0023, HRSC0214,
and HREX0001. The administrator would run the following statement in a batch job:
ADD USERLIST HRLIST HR------ USERIDS TITLE('HR Memo List')
( HRM----- HRDV0023 HRSC0214 HREX0001 )
The user list will be added to all users whose IDs begin with HR.
74 Batch Administration Guide
Chapter 6: Updating Application Definitions
This chapter shows you how to update application definitions in batch administration.
This section contains the following topics:
Add Applications (see page 75)
Copy Applications (see page 76)
Delete Applications (see page 77)
Modify Application Values (see page 78)
Add Applications
You use the ADD statement when you want to add application definition records to the
administration database. This is the syntax of an ADD statement when you are not using
an extract file.
Format
The ADD statement for applications has the following syntax:
->>--- ADD ------------------ ACTAPPL----(objectID applID)--><
Operand Explanations
The ADD statement for application definitions has the following operands:
ACTAPPL
Indicates that you want to add an application.
objectID
Specifies the application characteristics table (ACT) being added or being added to.
applID
Specifies the application being added.
Chapter 6: Updating Application Definitions 75
Copy Applications
Example 1: Adding an Application
A system administrator wants to add three new applications in the application
characteristics table named ACT45 to CA TPX. Instead of adding the applications through
online administration, the administrator decides to execute command statements in a
batch job. The following statements accomplish this task:
ADD ACTAPPL (ACT45 TSO01)
ADD ACTAPPL (ACT45 CICS32)
ADD ACTAPPL (ACT45 IMS03)
When the ADD statements are executed, applications TSO01, CICS32, and IMS03 are
added to the ACT named ACT45.
Copy Applications
You use the COPY statement to copy the characteristics of an existing application
definition record to create a new record.
Format
The COPY statement for application definitions has the following syntax:
->>--- COPY --------- ACTAPPL templateact templateappl------ ( -->
|---------------------------------------------------------+
V
|
->---- objectact --------------------objectappl-------------- ) -----------><
Operand Explanations
The COPY statement for application definitions has the following operands:
Operand
Explanation
ACTAPPL
Indicates that you want to copy an application definition.
templateact
Specifies the application characteristics table name from
where the template is to be taken.
templateappl
Specifies the application definition that is to be used as the
template for the new application definition(s).
objectact
Specifies the application characteristics table name into
which the new application definition is to be created.
objectappl
Specifies the application definition that is to be created with
the template characteristics.
76 Batch Administration Guide
Delete Applications
Example 1: Copying an Application Definition
A systems administrator is adding two new applications to the applications
characteristics table named ACT01. The administrator wants the new APPLIDs (CICS07
and CICS08) to have the same values as an existing APPLID (CICS01). The administrator
executes the following statement in a batch job:
COPY ACTAPPL ACT01 CICS01 TO (ACT01 CICS07 ACT01 CICS08)
When the COPY statement is executed, CICS07 and CICS08 are added to the ACT01
applications characteristics table. Their characteristics are the same as those for CICS01.
Delete Applications
You can use the DELETE statement to delete application definition records from the
administration database.
Format
The DELETE statement for applications has the following syntax:
|-------------+
V
|
->>--- DELETE --------- ACTAPPL ------- (----- objectid applid------)-----><
Operand Explanations
The DELETE statement for application definitions has the following operands:
ACTAPPL
Specify ACTAPPL to delete an application definition.
objectid
Specifies the application characteristics table from which the application definition
is to be deleted.
applid
Specifies the application definition to be deleted.
Chapter 6: Updating Application Definitions 77
Modify Application Values
Example 1: Deleting an Application Definition
A system administrator wants to delete application CICS07 from three application
characteristics tables (ACT01, ACT02, and ACT03) in CA TPX. Instead of using online
administration, the administrator uses the following DELETE statement:
DELETE ACTAPPL (ACT01 CICS07
ACT02 CICS07
ACT03 CICS07)
When the DELETE statement is executed, CICS07 is deleted from the three application
characteristics tables on the administration database.
Modify Application Values
You use the UPDATE statement to modify any application definition values in the
administration database.
Format
The UPDATE statement for application definitions has the following syntax:
->>--- UPDATE --------------------- ACTAPPL -----------------(---->
|------------------------------------------------+
|
|---------------------+ |
V
V
| |
->---- objectid applid -------(----- variable(value) -----)--------)----><
Operand Explanations
The UPDATE statement for application definitions has the following operands:
ACTAPPL
Specify ACTAPPL to modify application definition values.
objectid
Specifies the application characteristics table in which the application resides which
is to be modified.
applid
Specifies the application definition which is to be modified.
78 Batch Administration Guide
Modify Application Values
variable
Specifies the application variable that you want to modify. For descriptions of the
valid variables names, see the appendix Variables (see page 111).
value
Specifies the new value that you want to assign to the variable.
Example 1: Modifying an Application Definition Value
A system administrator wants to change the value for the virtual terminal type to group
for application CICS07 in application characteristics table ACT01. The administrator
includes the following control statement in a batch job:
UPDATE ACTAPPL (ACT01 CICS07 (ACTTYPE (GRP)))
This statement assigns the virtual terminal type of GRP to application CICS07 in
application characteristics table ACT01.
Chapter 6: Updating Application Definitions 79
Chapter 7: Using Extract Files for Reporting
This chapter shows you how to use an extract file to create a report.
This section contains the following topics:
How Reports Are Processed (see page 81)
REPORT Statement Syntax (see page 81)
Line Definition Syntax (see page 82)
Create a Simple Report (see page 85)
Format Your Reports (see page 86)
Define and Set Variables (see page 95)
Set Values for Variables (see page 96)
How Reports Are Processed
Batch processing allows you to produce reports on user, profile, session, and mail data
by using the REPORT statement. When you use the EXTRACT statement, information is
extracted and written to an extract file. The information in the extract file contains
merged user and session definitions. For more information, see the chapter Extracting
Data (see page 47).
You must create an extract file for reporting. You use the REPORT statement to select
the data you want from the extract file and put it in a form suitable for viewing.
Formatting Options
The reporting process also allows you to control the format of your reports. Some of the
formatting options are spacing, headings, page numbering, and page length. The
remainder of this chapter shows you how to specify the data you want to report on and
how to format the data into an attractive report.
REPORT Statement Syntax
You use the REPORT statement to specify the extract file used to generate the report
and what data you want to report on.
Chapter 7: Using Extract Files for Reporting 81
Line Definition Syntax
Format
The REPORT statement has the following syntax:
->>--- REPORT --- GIVING(ddname)--- USING(extract-ddname) ---(--->
|-------------------------+
V
|
->---- (line-definition) ------------)----------------------><
Operand Explanations
The REPORT statement has the following operands:
ddname
Specifies the data definition name (DD name) of the output report file. The
formatted report information is written to this file.
extract-ddname
Specifies the data definition name (DD name) of the extract file to be used for the
report. This is the same data definition name that you specified in the EXTRACT
statement that produced the extract file (see EXTRACT Statement Syntax in the
chapter Extracting Data (see page 47)).
line-definition
Specifies what information is printed on each line of the report. For more
information on the syntax of a line definition, see Line Definition Syntax (see
page 82).
Line Definition Syntax
In the REPORT statement, you specify what information is to be printed on each line of
the report through line definitions.
Format
A line definition has the following syntax:
|------------------+
V
|
->>-- ' -- * ------ &variable -------' --------------------------------------><
+-- string ---+
| |----------------------+ |
| V
| |
+----' -- &variable --- ' ---+
+-- string ---+
82 Batch Administration Guide
Line Definition Syntax
Operand Explanations
A line definition has the following operands:
*
Specifies the first character after the first single quote in each line definition is
reserved for an ASA control character. The following table lists the ASA printer
control characters that you can enter in this space. For information on how to use
printer control characters to format your reports, see Use ASA Printer Control
Characters (see page 91).
&variable
Specifies the name of any valid user, profile, or session variable. These variables
represent the fields on the online administration panels. For a list of the variables
that you can use and the corresponding online administration fields, see the
appendix Variables (see page 111). Each variable name must be preceded by an
ampersand (&amp.). You can specify as many variables as will fit on a printed line of
the report. When the report is created, the value of the specified variable for each
user or profile record is placed on the report line.
string
Specifies a text string that you want to include in the report. Single quotation marks
(') and ampersands (&) must be indicated by two quotation marks or ampersands (''
or &&) to appear in the text of the report.
ASA Printer Control Characters
The following table shows the functions of ASA printer control characters:
Control Character
Function
1 (one)
Prints the line at the top of a new page.
blank space
Prints the line on the next line of the current page (line
feed).
0 (zero)
Prints the line two lines down on the current page (two line
feeds).
- (hyphen)
Prints the line three lines down on the current page (three
line feeds).
+ (plus)
Prints the line on the current line on the page (no line feed).
This is useful for making bold text on a line printer, but has
no effect on a laser printer.
Chapter 7: Using Extract Files for Reporting 83
Line Definition Syntax
For example, the following REPORT produces the report file USERREP. When USERREP is
printed, each line of the report lists the user ID, menu key, and jump key for each user
record in the extract file KEYUSERS:
REPORT GIVING(USERREP) USING(KEYUSERS)
((' &UIDXNAME' '&UIDXMKEY' '&UIDXJKEY'))
Define Multiple Lines
If all of the information you want to print for each user or profile record will not fit on
one line, you can define multiple lines, using parentheses to separate each line of the
report. When the REPORT statement is executed, CA TPX Batch prints all of the defined
lines for each record in the extract file.
Example
The following REPORT statement produces the report file USERREP. When USERREP is
printed, there are two lines of data for each user record. The first line lists the user ID,
menu key, and jump key, while the second line lists the print key, command class, and
update class.
REPORT GIVING(USERREP) USING(KEYUSERS)
((' &UIDXNAME' '&UIDXMKEY' '&UIDXJKEY')
(' &UIDXPKEY' '&UIDXPRSV' '&UIDXUPDC'))
Note: The entire REPORT statement does not have to be specified on one line of the
control record. It can be helpful to separate the REPORT statement into multiple lines
because of your terminal screen width and for clarity.
Sample Report
Printing the report file USERREP produces the following output:
USER1
PA1
.
.
.
USER24
PA1
84 Batch Administration Guide
PF12/24
P
PA3
D
PF12/24
F
PA2
B
Create a Simple Report
Specify Variables from Different Types of Records
When you extract the session records associated with a user or profile record, you can
define report lines that print values from both types of records in the same report.
Batch prints all of the defined lines for each record. If you specify user and session
variables in the same line, user values are ignored for session records and session values
are ignored for user records.
Example
An administrator wants a report listing the user IDs for the user records in an extract file
named SESSACLS. The administrator also wants to see what sessions each user has and
the startup ACL/E program for each session. The administrator executes the following
REPORT statement:
REPORT GIVING(USERREP) USING(SESSACLS) ((' &UIDXNAME' '&UENTUSER' '&UENTSCRP'))
Sample Report
Printing the report file USERREP produces the following output:
USER1
TSO-1
CICS
STRTTSO
STRTCICS
CICS
TSO-4
STRTTSO4
.
.
.
USER3
.
.
.
The first record that Batch encounters in the extract file is the user record for USER1, so
the user ID in that record is printed. The other variables in the line definition (UENTUSER
and UENTSCRP) are session variables, so they are ignored. The second record in the
extract file is the TSO-1 session record for USER1, so the user variable (UIDXNAME) is
ignored, and the session ID and startup ACL are printed.
Create a Simple Report
The example in this section shows you how to use the EXTRACT and REPORT statements
to generate a simple report. You may want to use similar control statements with your
own ADMIN files to see how they work.
Chapter 7: Using Extract Files for Reporting 85
Format Your Reports
Determine What Information You Want in the Report
Before you extract the data for the report, you must determine what kind of
information you want in the report. In the example below, an administrator wants a list
of all users who are in a group named USRGRP1. The administrator also wants to know
the stage 1 time out, stage 1 option, stage 2 time out, and stage 2 option for each user.
Extract the Data
The administrator decides to use the group name to select the user records that are
extracted. The following EXTRACT statement produces the extract file GRP1EXT, which
contains the merged user definition for each user who is in USRGRP1.
EXTRACT GIVING(GRP1EXT) USER AND NO SESSIONS (UIDXGRP(USRGRP1))
An Example of a Simple Report
Printing the report file GRP1REP produces the following output:
USER1
USER3
USER4
USER5
USER8
USER10
USER12
USER23
120
120
120
240
120
120
240
0
L
L
L
L
L
FI
L
L
60
60
60
240
60
K
K
K
KI
K
240
0
KI
F
Format Your Reports
You can format your reports and make them easier to read by using spacing, labels,
headings, and ASA Printer Control Characters. You can also assign variables to control
the number of positions reserved for a value. This section shows you how to format a
report.
86 Batch Administration Guide
Format Your Reports
Use Spacing to Format Your Reports
When you place single quotes around the names of the variables to be printed on each
line, the number of characters in the variable name (including the ampersand) is set
aside for the printed value of the variable. For more information, see An Example of a
Simple Report (see page 86). All of the variable names specified in this example are nine
characters long, so nine positions are reserved for the value on the printed report,
regardless of the actual length of the value. For example, nine positions are reserved for
the stage 1 option, even though the value will never be more than two characters long.
Some variables contain values that are more than nine characters long. At most, the
variable name is only nine characters long, so only nine positions are reserved for the
printed value. As a result, only the first nine characters of the value are printed and the
remaining characters are truncated. For a description of the variables with more than
nine characters, see Variables with a Length Greater than Nine (see page 88).
You can reserve any number of positions for a value by adding spaces between the
single quotes where the variable is specified. The number of character positions
between the quotes is set aside for the value of the variable. You can also use the
spaces to indent lines in the report to make them stand out.
Example
An administrator wants a report listing the user ID, user name, group name, location
and phone number for each user record in an extract file named GRP1EXT. The
administrator uses the following REPORT statement to generate the report file
GRP1REP:
REPORT GIVING(GRP1REP) USING(GRP1EXT)
((' &UIDXNAME' '&VUSRRNME' '&UIDXGRP') (' &VUSRLOC' '&VUSRPHN#'))
Sample Report
Printing the report file produces the following output:
USER1
BILL JOHN SALEDEPT
PGH BLDG 412-555-1
USER2
FRANK JON SERVDEPT
PGH BLD 412-555-1
.
.
.
USER24
JANE PHIL SERVDEPT
NY BLDG 212-555-1
Chapter 7: Using Extract Files for Reporting 87
Format Your Reports
Format a Field Longer than 78 Characters
You must use a SYSIN control file with an LRECL greater than 80.
Example
The administrator realizes nine characters is not enough to display the value of these
variables, and that it is not easy to locate a specific user ID quickly. The administrator
modifies the REPORT statement:
REPORT GIVING(GRP1REP2) USING(GRP1EXT)
((' &UIDXNAME
' '&VUSRRNME
('
' '&VUSRLOC
' '&UIDXGRP')
' '&VUSRPHN# '))
Sample Report
Printing this report file produces the following output:
USER1
USER2
.
.
.
USER24
BILL JOHNSON
PGH BLDG FLOOR-7
FRANK JONES
PGH BLDG FLOOR-5
SALEDEPT
412-555-1234
SERVDEPT
412-555-5678
JANE PHILLIPS
NY BLDG FLOOR-4
SERVDEPT
212-555-9012
Variables with a Length Greater than Nine
The following table lists the variables that are more than nine characters long:
Variable Name
Length
Description
PENTDATA
60
The session data to be passed to the session
(profile level).
PENTUPB1 through
PENTUPB8
27
The ACL program parameters for a session (profile
level).
UENTDATA
60
The session data to be passed to the session (user
level).
UENTUPB1 through
UENTUPB8
27
The ACL program parameters for a session (user
level).
VSESLABL
32
The session description that appears on the user's
Menu (user level).
88 Batch Administration Guide
Format Your Reports
Variable Name
Length
Description
VUSRLOC
20
The user's location.
VUSRRNME
22
The actual name of the user.
VUSR$MAG
variable
A list of all the administration groups that the user
is authorized to administer. The length of the value
depends upon the number of groups in the list.
The maximum length of this variable is 255 bytes.
VUSR$PRF
variable
A list of all the profiles assigned to the user. The
length of the value depends upon the number of
profiles assigned to the user.
The maximum length of this variable is 255 bytes.
VUSR$VAG
variable
A list of all the administration groups that the user
is authorized to view. The length of the value
depends upon the number of groups in the list.
The maximum length of this variable is 255 bytes.
VUSRPHN#
12
The user's phone number.
WSESLABL
32
The session description that appears on the user's
Menu (profile level).
XUACIDSN
44
The default data set name used by all ACI INCLUDE
commands that only specify a member.
XUDSN
44
The name of data set allocated when output is
spooled to a data set.
XUHEAD1 through
XUHEAD3
50
The three lines of data to be used as a header for
the data set allocated when output is spooled to a
data set.
XUPRINTR
17
The name of the printer used when spooling
output to a printer. This value corresponds to the
value given in a JCL DEST parameter.
XAPXP01 through
XAPXP16
64
The ACI program parameters for this session. ACI
programs refer to these parameters with variables
&&P1 through &&P16.
XPACIDSN
44
The default data set name used by all ACI INCLUDE
commands that only specify a member (profile
level).
XPDSN
44
The name of data set allocated when output is
spooled to a data set (profile level).
XPHEAD1 through
XPHEAD3
50
The three lines of data to be used as a header for
the data set allocated when output is spooled to a
data set (profile level).
Chapter 7: Using Extract Files for Reporting 89
Format Your Reports
Variable Name
Length
Description
XPPRINTR
17
The name of the printer used when spooling
output to a printer. This value corresponds to the
value given in a JCL DEST parameter (profile level).
XPPXP01 through
XPPXP16
64
The ACI program parameters for this session. ACI
programs refer to these parameters with variables
&&P1 through &&P16 (profile level).
Label Your Reports
You can also label the printed values so that the person reading the report knows what
each value is. You specify labels in the line definition. When you specify a label within
single quotes, the text of the label will be printed as it appears in the line definition.
Example
An administrator wants to generate a report which lists the user ID, menu key, jump
key, and print key for each user record in an extract file named KEYUSERS and label each
value. The administrator uses the following REPORT statement to produce the report
file named KEYREPT:
REPORT GIVING(KEYREPT) USING(KEYUSERS)
((' &UIDXNAME')
(' MENU KEY - ' '&UIDXMKEY')
(' JUMP KEY - ' '&UIDXJKEY')
(' PRNT KEY - ' '&UIDXPKEY'))
Sample Report
Printing the report file produces the following output:
USER1
MENU
JUMP
PRNT
USER2
MENU
JUMP
PRNT
.
.
.
90 Batch Administration Guide
KEY - PA2
KEY - PA3
KEY - PA1
KEY - PA3
KEY - PA2
KEY - NONE
Format Your Reports
Use ASA Printer Control Characters
You can use ASA printer control characters to control line spacing and page breaks in
your reports. You insert the control characters in the first space after the first single
quote in a line definition to tell the printer what to do before printing that line. For the
list of the ASA printer control characters that you can use in your reports, see ASA
Printer Control Characters (see page 83).
Example
Look at the example report again in Putting Labels in Your Reports in this chapter. There
are no blank lines between the information for each user record. To make the report
easier to read, the administrator can use the following REPORT statement to tell the
printer to print a blank line between the information for each user record:
REPORT GIVING(KEYREPT) USING(KEYUSERS)
(('0&UIDXNAME')
(' MENU KEY - ' '&UIDXMKEY')
(' JUMP KEY - ' '&UIDXJKEY')
(' PRNT KEY - ' '&UIDXPKEY'))
Sample Report
Printing the report file produces the following output:
USER1
MENU KEY - PA2
JUMP KEY - PA3
PRNT KEY - PA1
USER2
MENU KEY - PA3
JUMP KEY - PA2
PRNT KEY - NONE
USER4
MENU KEY - PA2
JUMP KEY - PA3
PRNT KEY - PA1
.
.
.
Chapter 7: Using Extract Files for Reporting 91
Format Your Reports
Define Headings in Your Report
CA TPX has predefined variables that you can use to define headings for your reports.
You can define up to nine heading lines to be printed at the top of each page of the
report. The heading variables are named RTITLE1 through RTITLE9. RTITLE1 is printed at
the top of the page, RTITLE2 on the next line, and so on. You use the SET statement to
define these variables. For a description of the SET command, see Set Values for
Variables (see page 96). The character following the first single quote must be an ASA
printer control character. For example, the following SET statement assigns a value to
the heading variable RTITLE1:
SET RTITLE1 '1 SAMPLE REPORT
&ZDATE Page - &RPAGE#'
The RTITLE variables can contain strings and/or variables. When the value of the RTITLE
variable is resolved, the variable name is replaced with the value of that variable. For a
list of the variables that you can use in your report headings, see the appendix Variables
(see page 111).
Note: If you do not define a heading, CA TPX uses the default heading. The default
heading prints the date, time, and page number at the top of each page.
You set the report title variables in the control record before the REPORT statement.
When you set the report title variables, the values remain in effect until you redefine
them or restart the batch job.
Example
An administrator wants to print a report listing the user ID, stage 1 time out and option
for each user record in an extract file named TIMEOUTS. The administrator uses the
following control statements:
SET RTITLE1 '1 TIMEOUT OPTIONS REPORT
&ZDATE
Page - &RPAGE#'
SET RTITLE2 'CA-TPX STAGE 1
'
SET RTITLE3 '
----------------- '
SET RTITLE4 ' USER ID
TIMEOUT
OPTION '
SET RTITLE5 ' =============================== '
REPORT GIVING(GRP1REP) USING(GRP1EXT)
(('0&UIDXNAME
' '&UIDXTOU1 ' '&UIDXTOP1'))
92 Batch Administration Guide
Format Your Reports
Sample Report
Printing the report file GRP1REP produces the following output:
TIMEOUT OPTIONS REPORT 12/04/02 Page – 1
CA-TPX
STAGE 1
----------------USER ID
TIMEOUT
OPTION
=============================
USER1
120
L
USER3
120
L
USER4
.
.
.
120
L
Eliminate Heading
To eliminate a report heading specify the following statement:
SET RLINEMAX '0'
Predefined Variables Available for Batch Processing
There are some predefined variables that you can use in your report headings. For a
description of these variables, along with other variables that can be used in batch
statements, see the appendix Variables (see page 111).
Use the Default Report Heading
If you do not set the value of RTITLE1, the default value is used. This is the default value
of RTITLE1:
'1&RTITLE1C
-predefined-space-
date time Page &RPAGE#'
Operand
Explanation
1
This is the ASA printer control character that tells the printer
to start a new page before printing the heading.
Chapter 7: Using Extract Files for Reporting 93
Format Your Reports
RTITLE1C
This is a predefined variable which initially has no value
assigned to it. You can use a set statement to assign a value
to this variable. You cannot include other variable names in
the value of this variable. If the value that you assign to
RTITLE1C is more than 40 characters long, you must define
RTITLE1 with your own SET statement.
predefined-space
A predefined space of 40 characters will always be printed
between the value of RTITLEC and the date.
date
This is the date on which Batch started processing.
time
This is the time at which Batch started processing. The time
that appears in the default heading is constant throughout
the report.
Page &RPAGE#
The word "Page" followed by the current page number of the
report.
The SET statement for RTITLE1 in the example (see Putting Headings in Your Report (see
page 92)) could be replaced with the following SET statement:
SET RTITLE1C '1 TIMEOUT OPTIONS REPORT'
Example
The first line of the report heading would look something like the following:
TIMEOUT OPTIONS REPORT
07/04/95 23:42:03 Page 1
Note: The printed heading would actually have 40 blank spaces between the last
character of the title and the first character of the date. The blank spaces are excluded
in this example because of the page width.
Set the Page Length
You can use the variable RLINEMAX to control the number of lines (including headings)
printed on each page of the report. You assign the value to this variable with a SET
statement preceding the REPORT statement. For a description of the SET command, see
Set Values for Variables (see page 96). The default value of RLINEMAX is 60 lines.
For example, the following control records produce a report file named KEYSREPT that
has a maximum number of 50 lines on each page:
SET RLINEMAX '50'
REPORT GIVING(KEYSREPT) USING(KEYSEXTR)
((' &UIDXNAME' '&UIDXMKEY' '&UIDXJKEY'))
94 Batch Administration Guide
Define and Set Variables
Define and Set Variables
You can define and set variables using the VDEFINE and SET statements. For example,
you can define variables to set a constant date and time in all report headers in reports
that are printed in the same job.
Format
The VDEFINE statement has the following syntax:
->>--- VDEFINE ----- variable ----- (LENGTH(length)) -------><
Operand Explanations
The VDEFINE statement has the following operands:
Operand
Explanation
variable
This is the name that you want to assign to the variable. Variable names
can be a minimum of two characters long up to eight characters long.
Some variable names and variable prefixes are reserved for CA TPX. For a
list of the variable names and prefixes that you cannot use for your
variables, see Reserved Variables (see page 96).
length
This is length of the variable (measured in character positions). The value
of a user-defined variable is resolved literally, without substituting values
for variable names. For example, if &ZDATE appears in the value of a
user-defined variable, it will not be recognized as a variable name, and
the characters "&ZDATE" will actually be printed.
Chapter 7: Using Extract Files for Reporting 95
Set Values for Variables
Reserved Variables
The following variable names and prefixes are reserved, and cannot be used for user
variables:
■
AB
■
R
■
UENT
■
WUSR
■
ACT
■
SMRT
■
UIDX
■
XAPX
■
AMAP
■
SMRV
■
VSAM
■
XP
■
CMD
■
SOTOP
■
VSES
■
XPPX
■
NPT
■
STG$
■
VSMTB
■
XU
■
OCM
■
STXT
■
VUPD
■
Z
■
PENT
■
TB
■
VUPE
■
PIDX
■
TMSK
■
VUSR
■
PSK
■
TRAC
■
WSES
Example
The following VDEFINE statement defines a variable named TIME with a length of 8:
VDEFINE TIME (LENGTH(8))
Set Values for Variables
You can use the SET statement to assign values to the variables that you have defined
with the VDEFINE statement.
Format
The SET statement has the following syntax:
->>--- SET ---- variable --------- variable2 ----------------><
+-- 'value' -----+
96 Batch Administration Guide
Set Values for Variables
Operand Explanations
The SET statement has the following operands:
Operand
Explanation
variable
This is the name of the variable to which you want to assign a value.
If the variable name has not been defined with a VDEFINE statement,
the variable is defined with a length equal to the length of the
specified value.
variable2
This is the name of an existing variable. If you specify the name of an
existing variable, the variable that you are setting is given the same
value of the existing variable.
value
This is the value that you want to assign to the variable. The value
can contain any combination of strings and/or variables up to the
length specified in the VDEFINE statement.
Examples
The following statement sets the value of a variable named TIME to the current time:
SET TIME ZTIME
The variable TIME could be used in the heading of a report as follows:
SET RTITLE1 '1 THIS IS A SAMPLE REPORT &ZDATE &TIME'
When the report is printed, the time at the top of each page will be constant throughout
the report if you use the &ZTIME variable. Instead each page of the report will show a
different time of day.
Chapter 7: Using Extract Files for Reporting 97
Chapter 8: Using VTAM Modeling
Statements
This chapter describes the batch step that allows CA TPX to support VTAM modeling
statements.
The batch job converts your VTAM model statements as defined in a VTAMLST member
to the form used by the TPXAPPL member. This feature makes it easy to define your
APPL statements to CA TPX.
This section contains the following topics:
Set Up the Batch Job for VTAM Modeling Statement Support (see page 99)
OS symbols in the VTAM model (see page 107)
Set Up the Batch Job for VTAM Modeling Statement Support
The SYSIN DD for this feature points to VTAMLST member that contains the TPX models.
The Batch component analyzes the statements contained in the SYSIN file and produces
the SYSUT2 output DD containing all the APPL statements generated by the combination
of CA TPX control statements and VTAM models. The SYSUT2 output is read from the
file pointed to by the VTAMLST DD during TPX initialization.
The data set read in as the SYSIN DD must have all of the normal *TPX type control
statements (see the section Customizing the APTPX Member of the chapter "Special
Features and Customization Tasks" in the Programming Guide) in addition to the
*TPX,MDL statements used for modeling expansion.
Important! This feature requires the VNODE parameter be set to *MODEL* rather than
*BATCH*.
Format
The format of the *TPX,MDL statement is:
*TPX,MDL, initial value,type,count,order; initial value,type,count,order;… initial
value,type,count,order
Each grouping of initial value through order is a control set. Each control set is matched
positionally to a wildcard (* or ?) in the VTAM model statement. Each wildcard requires
a control set.
Chapter 8: Using VTAM Modeling Statements 99
Set Up the Batch Job for VTAM Modeling Statement Support
There can be up to seven control sets on a *TPX,MDL statement.
Parameters on the statement are as follows:
Parameter
Description
initial value
The character string that will be concatenated with the LU name
mask on the VTAM Model APPL statement. The total length of the
LU name generated is the sum of the length of this string and the
other initial values for this model statement plus the length of LU
name mask less the length of the variable placeholders contained
within LU name mask. The maximum length of the resultant LU
name cannot exceed eight characters.
type
The incrementing method used to generate the VTAM APPL
statements. When alphabetic characters are called for when
forming the substitution string in any of the incrementing methods,
only uppercase characters are used. Valid values are:
A—Alpha. Only alphabetic characters A through Z are used.
N—Numeric. Only numeric values 0 through 9 are used.
B—Alphanumeric. Values A though Z are used and then 0 through
9.
H—Hexadecimal. Values 0 through 9 are used and then A through
F.
count
The number of VTAM APPL statements to be generated from the
model (in decimal). The maximum value is 9999. Additional
statements can be generated by specifying another *TPX,MDL and
VTAM Model statements specifying the next initial value and
increment.
order
The order in which the initial values are incremented during VTAM
APPL statement generation. This parameter is only required if there
is more than one control set specified on the *TPX,MDL statement.
All values are set to their initial values and the control set marked
1, in the order parameter, is incremented. After this value is
incremented to the count limit, it is reset to its initial value and the
control set with an order parameter of 2 is incremented. This
continues until the control set with the highest increment order
value is exhausted or a maximum of 9999 statements have been
generated. The highest value allowed for order is 7.
100 Batch Administration Guide
Set Up the Batch Job for VTAM Modeling Statement Support
Use the *TPX,MDL Statement
The *TPX,MDL statement causes the following flow of events:
■
A *TPX,MDL statement is read and validated. This becomes the active model until
another *TPX,MDL statement is encountered.
■
Each VTAM APPL statement is checked to see if the LU name (label) field contains
any wildcards (* or ?). If there is an ACBNAME parameter on the APPL statement, it
is also checked for wildcards.
■
The Batch process generates the appropriate number of APPL statements
substituting the values from the control sets on the *TPX,MDL statement, for the
wildcards in the LU name and ACBNAME fields.
■
The generated APPL statements, and comment statements showing the LU name
and ACBNAME model formats are inserted where the VTAM model was
encountered, in the SYSUT2 data set.
■
All records read from the SYSIN data set as well as generated APPL statements and
errors are also written to the SYSOUT data set allocated as LOG.
Run the Batch Process
The Batch process model step can be run as:
■
An independent job.
Note: If the Batch process model step is run as an independent job, and you only
want to audit the input, set SYSUT2 to DUMMY to avoid building an output file.
■
The first step in the CA TPX startup procedure, using the SYSUT2 output as the
VTAMLST input to the TPX step. If used this way, a "COND=(8,EQ)" should be coded
on the EXEC for the TPX step.
Model Job Example
A sample model job is shown here:
//USER54 JOB (0,A300),MODELJCL,CLASS=V,MSGCLASS=H,NOTIFY=USER54
//
EXEC procname,VNODE='*MODEL*'
//LOG
DD
SYSOUT=*
//SYSIN DD
input file containing models
//SYSUT2 DD
output file that will contain the expanded statements
(or DUMMY)
Chapter 8: Using VTAM Modeling Statements 101
Set Up the Batch Job for VTAM Modeling Statement Support
SYSIN Example
A sample member used as SYSIN data is shown here:
APTPX
VBUILD TYPE=APPL
*TPX,PRINT=ON LIST THIS MEMBER IN THE TPX LOG
*
*TPX,PRIMARY
DO NOT REMOVE - THIS COMMENT IDENTIFIES TPX APPLID
*
TPX
APPL AUTH=(ACQ,PASS),MODETAB=TPXLGMOD,DLOGMOD=T3278M2,
SRBEXIT=NO,
EAS=404
*
*TPX,SHARE DO NOT REMOVE - THIS COMMENT IDENTIFIES SHARED VIRT TERM
*
TPXSHARE APPL MODETAB=TPXLGMOD,DLOGMOD=T3278M2,PARSESS=YES,
SRBEXIT=NO,
EAS=404
X
X
X
X
*
*TPX,GROUP DO NOT REMOVE - THIS COMMENT IDENTIFIES GROUP VIRT TERM
*
*TPX,MDL,A,A,3,2;01,N,20,1
TPXGR?* APPL MODETAB=TPXLGMD2,DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
*
*
END OF GROUP ACB DEFINITIONS
*
*TPX,UNIQUE DO NOT REMOVE - THIS COMMENT IDENTIFIES UNIQUE VIRT TERM
*
*TPX,MDL,001,N,20
TPXUN* APPL MODETAB=TPXLGMD2,DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
*
SYSUT2 Example
Sample output is shown here:
APTPX
VBUILD TYPE=APPL
*TPX,PRINT=ON LIST THIS MEMBER IN THE TPX LOG
*
*TPX,PRIMARY
DO NOT REMOVE - THIS COMMENT IDENTIFIES TPX APPLID
*
TPX
APPL AUTH=(ACQ,PASS),MODETAB=TPXLGMOD,DLOGMOD=T3278M2,
SRBEXIT=NO,
EAS=404
102 Batch Administration Guide
X
X
Set Up the Batch Job for VTAM Modeling Statement Support
*
*TPX,SHARE DO NOT REMOVE - THIS COMMENT IDENTIFIES SHARED VIRT TERM
*
TPXSHARE APPL MODETAB=TPXLGMOD,DLOGMOD=T3278M2,PARSESS=YES,
SRBEXIT=NO,
EAS=404
*
*TPX,GROUP DO NOT REMOVE - THIS COMMENT IDENTIFIES GROUP VIRT TERM
*
*TPX,MDL,A,A,3,2;01,N,20,1
* LUNAME = TPXGR?*
TPXGRA01 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA02 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA03 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA04 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
X
X
X
X
X
TPXGRA05 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA06 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA07 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA08 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXGRA09 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA10 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA11 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA12 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXGRA13 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA14 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA15 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA16 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
X
X
X
X
X
X
X
X
X
Chapter 8: Using VTAM Modeling Statements 103
Set Up the Batch Job for VTAM Modeling Statement Support
TPXGRA17 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA18 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA19 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRA20 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXGRB01 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB02 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB03 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB04 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXGRB05 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB06 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB07 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB08 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXGRB09 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB10 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB11 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB12 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXGRB13 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB14 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB15 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB16 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
104 Batch Administration Guide
X
X
X
X
X
X
X
X
X
X
X
X
X
X
X
Set Up the Batch Job for VTAM Modeling Statement Support
TPXGRB17 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB18 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB19 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRB20 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXGRC01 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC02 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC03 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC04 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
X
X
X
X
X
X
TPXGRC05 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC06 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC07 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC08 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXGRC09 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC10 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC11 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC12 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXGRC13 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC14 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC15 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC16 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
X
X
X
X
X
X
X
X
X
Chapter 8: Using VTAM Modeling Statements 105
Set Up the Batch Job for VTAM Modeling Statement Support
TPXGRC17 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC18 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC19 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXGRC20 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
X
X
X
*
*
END OF GROUP ACB DEFINITIONS
*
*TPX,UNIQUE DO NOT REMOVE - THIS COMMENT IDENTIFIES UNIQUE VIRT TERM
*
*TPX,MDL,001,N,20
* LUNAME = TPXUN*
TPXUN001 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN002 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN003 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN004 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXUN005 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN006 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN007 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN008 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXUN009 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN010 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN011 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN012 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
106 Batch Administration Guide
X
X
X
X
X
X
X
X
X
OS symbols in the VTAM model
TPXUN013 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN014 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN015 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN016 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
TPXUN017 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN018 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN019 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
TPXUN020 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
*
X
X
X
X
X
X
X
OS symbols in the VTAM model
OS symbols may be used in the VTAM modeled APPL statements.
Important! If OS symbols are used in the APPL statements, a batch *MODEL* job must
be run on each system for which the OS symbols are to be resolved. The resulting
output of the batch *MODEL* job on each system must be used as the VTAMLST DD
data set in each respective TPX region.
Example with OS Symbols
The following example shows portions of the SYSIN and the SYSUT2 data sets that would
be used to produce APPL statements for an LPAR named "PR01".
SYSIN Example
*TPX,MDL,01,N,20
&SYSNAME.GR* APPL MODETAB=TPXLGMD2,DLOGMOD=T3278M2,SRBEXIT=YES,EAS=1
SYSUT2 Example
*TPX,MDL,01,N,20
* LUNAME = PR01GR*
PR01GR01 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR02 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
X
Chapter 8: Using VTAM Modeling Statements 107
OS symbols in the VTAM model
PR01GR03 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR04 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR05 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
PR01GR06 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR07 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR08 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
X
X
X
X
PR01GR09 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR10 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR11 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
PR01GR12 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR13 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR14 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
X
X
X
X
PR01GR15 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR16 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR17 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
PR01GR18 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR19 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
PR01GR20 APPL MODETAB=TPXLGMD2,
DLOGMOD=T3278M2,SRBEXIT=NO,EAS=1
X
108 Batch Administration Guide
X
X
X
X
Appendix A: Control Word Abbreviations
This section contains the following topics:
Control Word Abbreviations and Aliases (see page 109)
Control Word Abbreviations and Aliases
The following table lists the abbreviations and the aliases for control words used in
Batch control statements. If a control word does not appear in the table, there is no
alias for the word and you must enter the word as described in the other chapters of
this book.
Control Word
Abbreviation
Aliases
ACTAPPL
ACTA
ACTIVE
A
ACTSESS
ACTS
APPLICATION
APPL
BEFORE
BEFO
COMMENTS
C
COPY
COP
DELETE
DEL
EXPIRING
EXP
GROUPS
GR
GIVING
GIVING
OUTDD, OFILE, OUDD, OUTFILE
INDD
I
IFILE, INFILE, USING
INVISIBLE
INV
LENGTH
L
MAILMESSAGE
MAILM
OUTDD
O
PRIVATE
PRI
PROFILE
PROF
PROFILES
PROFILESESSION
PROFILESES
PROFSESS
OFILE, OUDD, OUTFILE
Appendix A: Control Word Abbreviations 109
Control Word Abbreviations and Aliases
Control Word
Abbreviation
Aliases
PROFSESS
PROFSES
PROFILESESSION
SESSION
SES
SUBJECT
SUBJ
TERMINAL
T
TITLE
TI
USER
U
USERLIST
USERL
USERMAGN
USERM
USERPROFILE
USERP
USERSESSION
USERSES
USERVAGN
USERV
USERVIEWAUTHGROUPNAME
USING
USING
INDD, IFILE, INFILE
VDEFINE
VDEF
110 Batch Administration Guide
USERID
USERMAINTAUTHGROUPNAME
Appendix B: Variables
This appendix presents a summary of the CA TPX variables that can be modified with the
batch facility, used as extraction criteria, or presented in a report.
This section contains the following topics:
Special Batch Variables (see page 111)
Special Administration Variables (see page 113)
CA TPX User Variables (by Variable Name) (see page 113)
CA TPX User Variables (by Field Name) (see page 116)
CA TPX Profile Variables (by Variable Name) (see page 118)
CA TPX Profile Variables (by Field Name) (see page 120)
CA TPX User Session Variables (by Variable Name) (see page 123)
CA TPX User Session Variables (by Field Name) (see page 124)
CA TPX Profile Session Variables (by Variable Name) (see page 126)
CA TPX Profile Session Variables (by Field Name) (see page 127)
CA TPX Mail Locator Variables (see page 129)
CA TPX Mail Message Variables (see page 130)
CA TPX User List Variables (see page 132)
CA TPX Application Variables (by Variable Name) (see page 132)
CA TPX Application Variables (by Field Name) (see page 135)
CA STX User Variables (by Variable Name) (see page 142)
CA STX User Variables (by Field Name) (see page 145)
CA STX Profile Variables (by Variable Name) (see page 147)
CA STX Profile Variables (by Field Name) (see page 150)
CA STX User Session Variables (by Variable Name) (see page 153)
CA STX Profile Session Variables (by Variable Name) (see page 153)
Special Batch Variables
The following table lists special variables that you can use for extracting or reporting.
These variables do not correspond to any fields in CA TPX online administration.
Variable Name
Description
RPAGE#
The current page number. This variable is updated each time the
variable is printed. Use only for reporting.
SMRTCACT
The name of the startup ACT. Use only for reporting.
SMRTCMSK
The name of the startup mask table. Use only for reporting.
SMRTCSRT
The name of the startup SMRT. Use only for reporting.
Appendix B: Variables 111
Special Batch Variables
Variable Name
Description
UIDX$ACS
A value of MULTIPLE in this field indicates that the user is
authorized to have more than one session active at one time.
UIDXACCS can only have values of PASS or SINGLE, so you must
use UIDX$ACS if you want to print a value of MULTIPLE in a
report. Use only for reporting.
VACTTBL
The name of an Application Characteristics Table (ACT).
VUSRDACC
The date on which the user last signed on to CA TPX.
VUSRMAGN
You use this variable to extract users by the maintenance
authorization group that they are authorized to administer. Use
only for extraction.
VUSRPROF
You use this variable to extract users by the profiles that are
assigned to the user record. Use only for extraction.
VUSRVAGN
You use this variable to extract users by the CA TPX View user
groups that are assigned to the user record. Use only for
extraction.
VUSR$MAG
A list of all the user maintenance authorization groups that the
user can administer. Use only for reporting.
VUSR$PRF
A list of all the profiles that are assigned to the user record.
When using this variable in a report, you must include enough
space for all profiles in the list. Use only for reporting.
VUSR$VAG
A list of all CA TPX View user groups that are assigned to the
user record. Use only for reporting.
ZDATE
The current system date in U.S. format (mm/dd/yy). Use only for
reporting.
ZEDATE
The current system date in European format (dd/mm/yy). Use
only for reporting.
ZJDATE
The current system date in Julian format (yy.ddd). Use only for
reporting.
ZJOBNAME
The name of the job card or the TSO user ID. Use only for
reporting.
ZLDATE
The current system date in long U.S. format (mm/dd/yyyy). Use
only for reporting.
ZLEDATE
The current system date in long European format (dd/mm/yyyy).
Use only for reporting.
ZLJDATE
The current system date in long Julian format (yyyy.ddd). Use
only for reporting.
ZNEWS1
The first line (79 characters) of the system LOGO news. Use only
for reporting.
112 Batch Administration Guide
Special Administration Variables
Variable Name
Description
ZNEWS2
The second line (79 characters) of the system LOGO news. Use
only for reporting.
ZSYSID
The name of the startup SMRT. Use only for reporting.
ZUSERID
The name of the job card or the TSO user ID. Use only for
reporting.
Special Administration Variables
The following table lists variables that appear on the user ID selection panel (TEN0129)
in user ID maintenance or the Profile Table List (TEN0110) in profile maintenance. You
can use these variables for extracting and reporting.
Variable Name
Description
VUSRLUPD
The user ID of the person who last updated the user record.
VUSRDUPD
The date on which the user record was last updated.
VUSRTUPD
The time at which the user record was last updated.
WUSRLUPD
The user ID of the person who last updated the profile record.
WUSRDUPD
The date on which the profile record was last updated.
WUSRTUPD
The time at which the profile record was last updated.
CA TPX User Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
UIDXACBN
ACB Mask Default
The virtual terminal (full name or masked value) that is used for the
user's sessions.
UIDXACCS
ACCESS
The type of access the user has to sessions. This variable can only
have a value of PASS or SINGLE in a report. If the user can access
multiple sessions at one time, this field will be blank. Use UIDX$ACS
to print a value of MULTIPLE in a report.
UIDXCHAR
Command character
The character that the user types to indicate that the next character
is a command.
UIDXDND1
Do not disturb
Indicates whether the user will receive mail messages. If set to Y, all
messages will be stored in the user's mailbox.
Appendix B: Variables 113
CA TPX User Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
UIDXESCK
Command key
The key that the user presses to execute a command.
UIDXGRP
Group name
The maintenance authorization group to which the user belongs.
UIDXHBRB
Background Horizontal
Border
The character used for the horizontal border around background
sessions in Windows.
UIDXHBRF
Foreground Horizontal
Border
The character used for the horizontal border around the current
session in Windows.
UIDXJKEY
Jump key
The key that the user presses to switch to the next active application.
UIDXKOPT
Inactivate on
Indicates whether a /K or /F command will inactivate the user's
sessions.
UIDXLANG
Language
The language used to display the panels and messages for the user.
UIDXMAIL
Get Mail first
Indicates whether CA TPX automatically takes the user to MAIL when
the user signs on.
UIDXMENU
Display menu
Indicates whether CA TPX displays the Menu or the user's first "start
at signon" session when the user signs on.
UIDXMKEY
Menu key
The key that the user presses to display the Menu.
UIDXNAME
Userid
The user's user ID.
UIDXOCLS
OPER Cmd class
The user's TPXOPER command class, which indicates what TPXOPER
commands the user can issue.
UIDXOWN
Affinity applid
The VTAM application ID of the component that will manage a user's
sessions.
UIDXPKEY
Print key
The key that the user presses to print the current screen image on
the default printer.
UIDXPROP
Propagate ACB
Indicates if the virtual terminal selected for the user's first activated
session is to be used for all the user's sessions.
UIDXPRSV
Command Class
The user's command authorization class, which indicates what user
commands the user can issue.
UIDXPRT
Default printer
The printer to which the user's print requests are sent.
UIDXSCTY
Security system
The security system used when the user signs on to CA TPX.
UIDXSMAX
Maximum sessions
The maximum number of sessions the user can have active at one
time.
UIDXSTIC
Static user
Tells whether the user is a dynamic or static user (Y=static,
N=dynamic). For implications of static versus dynamic, see the
Programming Guide.
114 Batch Administration Guide
CA TPX User Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
UIDXSUSP
Suspend user
Indicates whether the user is suspended after executing the
maximum number of password retries (valid only if security is used).
UIDXTOP1
Stage 1 option
The action CA TPX takes when an idle user has reached the stage 1
time out limit.
UIDXTOU1
Stage 1 time out
The number of minutes the user can be idle before CA TPX executes
the stage 1 option.
UIDXTOP2
Stage 2 option
The action CA TPX takes when an idle user has reached the stage 2
time out limit.
UIDXTOU2
Stage 2 time out
The number of minutes the user can be idle before CA TPX executes
the stage 2 option.
UIDXTPXP
Force new pswd
Indicates whether the user is required to enter a new password at
the next signon (valid only if security is used).
UIDXUPDC
Update class
The user's update class, which determines what the user can change.
UIDXVBRB
Background Vertical
Border
The character used for the vertical border around background
sessions in Windows.
UIDXVBRF
Foreground Vertical
Border
The character used for the vertical border around the current session
in Windows.
UIDXVLVL
View Security Level
The View security level for the user. This level determines if other
users can view this user.
UIDXWCHR
Window Command
Character
The character that the user types in a Windows session to indicate
that the next character is a command.
UIDXWMOD
Window Mode Key
The key that the user presses to toggle between window modes in a
Windows session.
UIDXWRKB
Lock Keyboard
(Windows)
Indicates whether the user is able to use a session in one window
while waiting for output on another window.
UIDX$DYN
None
Indicates whether the user is STATIC or DYNAMIC. Use only for
reporting.
UIDX$XFR
Transfer option
Indicates what action CA TPX takes when a user transfers sessions
from one physical terminal to another without signing off.
VUSRLOC
Location
The user's office number, city, or other physical location. Use single
quotes if the value contains spaces.
VUSRPHN#
Phone
The user's phone number. Use single quotes if the value contains
spaces.
VUSRRNME
User Name
The user's full name. Use single quotes if the value contains spaces.
VUSR$TPX
None
Indicates whether the user is authorized to use the component.
Appendix B: Variables 115
CA TPX User Variables (by Field Name)
CA TPX User Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
ACB Mask Default
UIDXACBN
The virtual terminal (full name or masked value) that is used for
the user's sessions.
ACCESS
UIDXACCS
The type of access the user has to sessions. This variable can
only have a value of PASS or SINGLE in a report. If the user can
access multiple sessions at one time, this field will be blank. Use
UIDX$ACS to print a value of MULTIPLE in a report.
Affinity applid
UIDXOWN
The VTAM application ID of the system that will manage a user's
sessions.
Background Horizontal
Border
UIDXHBRB
The character used for the horizontal border around background
sessions in Windows.
Background Vertical Border
UIDXVBRB
The character used for the vertical border around background
sessions in Windows.
Command character
UIDXCHAR
The character that the user types to indicate that the next
character is a command.
Command key
UIDXESCK
The key that the user presses to execute a command.
Command Class
UIDXPRSV
The user's command authorization class, which indicates what
user commands the user can issue.
Default printer
UIDXPRT
The printer to which the user's print requests are sent.
Display menu
UIDXMENU
Indicates whether CA TPX displays the Menu or the user's first
"start at signon" session when the user signs on.
Do not disturb
UIDXDND1
Indicates whether the user will receive mail messages. If set to Y,
all messages will be stored in the user's mailbox.
Force new pswd
UIDXTPXP
Indicates whether the user is required to enter a new password
at the next signon (valid only if security is used).
Foreground Horizontal
Border
UIDXHBRF
The character used for the horizontal border around the current
session in Windows.
Foreground Vertical Border
UIDXVBRF
The character used for the vertical border around the current
session in Windows.
Get Mail first
UIDXMAIL
Indicates whether CA TPX automatically takes the user to MAIL
when the user signs on.
Group name
UIDXGRP
The maintenance authorization group to which the user belongs.
Inactivate on
UIDXKOPT
Indicates whether a /K or /F command will inactivate the user's
sessions.
116 Batch Administration Guide
CA TPX User Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Jump key
UIDXJKEY
The key that the user presses to switch to the next active
application.
Language
UIDXLANG
The language used to display the panels and messages for the
user.
Location
VUSRLOC
The user's office number, city, or other physical location. Use
single quotes if the value contains spaces.
Lock Keyboard (Windows)
UIDXWRKB
Indicates whether the user is able to use a session in one
window while waiting for output on another window.
Maximum sessions
UIDXSMAX
The maximum number of sessions the user can have active at
one time.
Menu key
UIDXMKEY
The key that the user presses to display the Menu.
OPER Cmd class
UIDXOCLS
The user's TPXOPER command class, which indicates what
TPXOPER commands the user can issue.
Phone
VUSRPHN#
The user's phone number or extension. Use single quotes if the
value contains spaces.
Print key
UIDXPKEY
The key that the user presses to print the current screen image
on the default printer.
Propagate ACB
UIDXPROP
Indicates if the virtual terminal selected for the user's first
activated session is to be used for all the user's sessions.
Security system
UIDXSCTY
The security system used when the user signs on to CA TPX
Stage 1 option
UIDXTOP1
The action CA TPX takes when an idle user has reached the stage
1 time out limit.
Stage 1 time out
UIDXTOU1
The number of minutes the user can be idle before CA TPX
executes the stage 1 option.
Stage 2 option
UIDXTOP2
The action CA TPX takes when an idle user has reached the stage
2 time out limit.
Stage 2 time out
UIDXTOU2
The number of minutes the user can be idle before CA TPX
executes the stage 2 option.
Static user
UIDXSTIC
Tells whether the user is a dynamic or static user (Y=static,
N=dynamic). For implications of static versus dynamic, see the
Installation Guide or Programming Guide.
Suspend user
UIDXSUSP
Indicates whether the user is suspended after executing the
maximum number of password retries (valid only if security is
used).
Appendix B: Variables 117
CA TPX Profile Variables (by Variable Name)
Field Name in Online
Administration
Variable Name
Field Description
Transfer option
UIDX$XFR
Indicates what action CA TPX takes when a user transfers
sessions from one physical terminal to another without signing
off.
Update class
UIDXUPDC
The user's update class, which indicates what parameters the
user can modify.
User Name
VUSRRNME
The user's full name. Use single quotes if the value contains
spaces.
Userid
UIDXNAME
The user's user ID.
View Security Level
UIDXVLVL
The View security level for the user. This level determines if
other users can view this user.
Window Command
Character
UIDXWCHR
The character that the user types in a Windows session to
indicate that the next character is a command.
Window Mode Key
UIDXWMOD
The key that the user presses to toggle between window modes
in a Windows session.
CA TPX Profile Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
PIDXACBN
ACB Mask Default
The virtual terminal (full name or masked value) that is used for
the user's sessions.
PIDXACCS
ACCESS
The type of access the user has to sessions. This variable can
only have a value of PASS, SINGLE, or spaces in a report. If the
profile allows access to multiple sessions at one time, this field
will be blank.
PIDXAMSK
ACF2 Authorization Mask
Specifies the bit value that is to be checked at the byte located
by PIDXAOFS.
PIDXAOFS
ACF2 Authorization Offset
Specifies the offset into the ACF2 LIDREC (logon ID record) of the
attribute bit that is used to authorize a user's access to this
profile.
PIDXCHAR
Command character
The character that the user types to indicate that the next
character is a command.
PIDXDND1
Do not disturb
Indicates whether the user will receive mail messages. If set to Y,
all messages will be stored in the user's mailbox.
PIDXESCK
Command key
The key that the user presses to execute a command.
118 Batch Administration Guide
CA TPX Profile Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
PIDXFRST
Profile should be first
Specifies that this profile should be first in the user's profile list.
PIDXGRP
Group name
The maintenance authorization group to which the profile is
assigned.
PIDXHBRB
Background Horizontal
Border
The character used for the horizontal border around background
sessions in Windows.
PIDXHBRF
Foreground Horizontal
Border
The character used for the horizontal border around the current
session in Windows.
PIDXJKEY
Jump key
The key that the user presses to switch to the next active
application.
PIDXKOPT
Inactivate on
Indicates whether a /K or /F command will inactivate the user's
sessions.
PIDXLANG
Language
The language used to display the panels and messages for the
user.
PIDXMAIL
Get Mail first
Indicates whether CA TPX automatically takes the user to MAIL
when the user signs on.
PIDXMENU
Display menu
Indicates whether CA TPX displays the Menu or the user's first
"start at sign on" session when the user signs on.
PIDXMKEY
Menu key
The key that the user presses to display the Menu.
PIDXNAME
Profile name
The name of the profile.
PIDXOCLS
OPER Cmd class
The user's TPXOPER command class, which indicates what
TPXOPER commands the user can issue.
PIDXOWN
Affinity applid
The VTAM application ID of the system that will manage a user's
sessions.
PIDXPKEY
Print key
The key that the user presses to print the current screen image
on the default printer.
PIDXPROP
Propagate ACB
Indicates if the virtual terminal selected for the user's first
activated session is to be used for all the user's sessions.
PIDXPRSV
Command Class
The user's command authorization class, which indicates what
user commands the user can issue.
PIDXPRT
Default printer
The printer to which the user's print requests are sent.
PIDXSALS
Security Alias
Specifies the name by which this profile is identified to the
security system.
PIDXSCTY
Security system
The security system used when the user signs on to CA TPX.
PIDXSMAX
Maximum sessions
The maximum number of sessions the user can have active at
one time.
Appendix B: Variables 119
CA TPX Profile Variables (by Field Name)
Variable Name
Field Name in Online
Administration
Field Description
PIDXTOP1
Stage 1 option
The action CA TPX takes when an idle user has reached the stage
1 time out limit.
PIDXTOU1
Stage 1 time out
The number of minutes the user can be idle before CA TPX
executes the stage 1 option.
PIDXTOP2
Stage 2 option
The action CA TPX takes when an idle user has reached the stage
2 time out limit.
PIDXTOU2
Stage 2 time out
The number of minutes the user can be idle before CA TPX
executes the stage 2 option.
PIDXUPDC
Update class
The user's update class, which indicates what parameters the
user can modify.
PIDXVBRB
Background Vertical Border
The character used for the vertical border around background
sessions in Windows.
PIDXVBRF
Foreground Vertical Border
The character used for the vertical border around the current
session in Windows.
PIDXVLVL
View Security Level
The View security level for the user. This level determines if
other users can view this user.
PIDXWCHR
Window Command
Character
The character that the user types in a Windows session to
indicate that the next character is a command.
PIDXWMOD
Window Mode Key
The key that the user presses to toggle between window modes
in a Windows session.
PIDXWRKB
Lock Keyboard (Windows)
Indicates whether the user is able to use a session in one
window while waiting for output on another window.
PIDX$XFR
Transfer option
Indicates what action CA TPX takes when a user transfers
sessions from one physical terminal to another without signing
off.
WUSR$TPX
None
Indicates whether the user is authorized to use the CA TPX
component.
CA TPX Profile Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
ACB Mask Default
PIDXACBN
The virtual terminal (full name or masked value) that is used for
the user's sessions.
120 Batch Administration Guide
CA TPX Profile Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
ACCESS
PIDXACCS
The type of access the user has to sessions. This variable can
only have a value of PASS, SINGLE, or spaces in a report. If the
profile allows access to multiple sessions at one time, this field
will be blank.
ACF2 Authorization Mask
PIDXAMSK
Specifies the bit that value that is to be checked at the byte
located by the ACF2 Authorization Offset field.
ACF2 Authorization Offset
PIDXAOFS
Specifies the offset into the ACF2 LIDREC (logon ID record) of the
attribute bit that is used to authorize a user's access to this
profile.
Affinity applid
PIDXOWN
The VTAM application ID of the system that will manage a user's
sessions.
Background Horizontal
Border
PIDXHBRB
The character used for the horizontal border around background
sessions in Windows.
Background Vertical Border
PIDXVBRB
The character used for the vertical border around background
sessions in Windows.
Command character
PIDXCHAR
The character that the user types to indicate that the next
character is a command.
Command key
PIDXESCK
The key that the user presses to execute a command.
Command Class
PIDXPRSV
The user's command authorization class, which indicates what
user commands the user can issue.
Default printer
PIDXPRT
The printer to which the user's print requests are sent.
Display menu
PIDXMENU
Indicates whether CA TPX displays the Menu or the user's first
"start at signon" session when the user signs on.
Do Not Disturb
PIDXDND1
Indicates whether the user will receive mail messages. If set to Y,
all messages will be stored in the user's mailbox.
Foreground Horizontal
Border
PIDXHBRF
The character used for the horizontal border around the current
session in Windows.
Foreground Vertical Border
PIDXVBRF
The character used for the vertical border around the current
session in Windows.
Get Mail first
PIDXMAIL
Indicates whether CA TPX automatically takes the user to MAIL
when the user signs on.
Group name
PIDXGRP
The maintenance authorization group to which the profile
belongs.
Inactivate on
PIDXKOPT
Indicates whether a /K or /F command will inactivate the user's
sessions.
Appendix B: Variables 121
CA TPX Profile Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Jump key
PIDXJKEY
The key that the user presses to switch to the next active
application.
Language
PIDXLANG
The language used to display the panels and messages for the
user.
Lock Keyboard (Windows)
PIDXWRKB
Indicates whether the user is able to use a session in one
window while waiting for output on another window.
Maximum sessions
PIDXSMAX
The maximum number of sessions the user can have active at
one time.
Menu key
PIDXMKEY
The key that the user presses to display the Menu.
OPER Cmd class
PIDXOCLS
The user's TPXOPER command class, which indicates what
TPXOPER commands the user can issue.
Print key
PIDXPKEY
The key that the user presses to print the current screen image
on the default printer.
Profile name
PIDXNAME
The name of the profile.
Profile Should be First
PIDXFRST
Specifies that this profile should be first in the user's profile list.
Propagate ACB
PIDXPROP
Indicates if the virtual terminal selected for the user's first
activated session is to be used for all the user's sessions.
Security system
PIDXSCTY
The security system used when the user signs on to CA TPX.
Security Alias
PIDXSALS
Specifies the name by which this profile is identified to the
security system.
Stage 1 option
PIDXTOP1
The action CA TPX takes when an idle user has reached the stage
1 time out limit.
Stage 1 time out
PIDXTOU1
The number of minutes the user can be idle before CA TPX
executes the stage 1 option.
Stage 2 option
PIDXTOP2
The action CA TPX takes when an idle user has reached the stage
2 time out limit.
Stage 2 time out
PIDXTOU2
The number of minutes the user can be idle before CA TPX
executes the stage 2 option.
Transfer option
PIDX$XFR
Indicates what action CA TPX takes when a user transfers
sessions from one physical terminal to another without signing
off.
Update class
PIDXUPDC
The user's update class, which indicates what parameters the
user can modify.
View Security Level
PIDXVLVL
The View security level for the user. This level determines if
other users can view this user.
122 Batch Administration Guide
CA TPX User Session Variables (by Variable Name)
Field Name in Online
Administration
Variable Name
Field Description
Window Command
Character
PIDXWCHR
The character that the user types in a Windows session to
indicate that the next character is a command.
Window Mode Key
PIDXWMOD
The key that the user presses to toggle between window modes
in a Windows session.
CA TPX User Session Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
UENTACB
ACB Mask
The virtual terminal name (full name or masked value) used for
this session.
UENTDEL
None
Indicates whether the session has been deleted. Possible values
are Y or N. Use only for reporting.
UENTTNA
ACCESS=PASS
Indicates whether the user has PASS access to this session.
Possible values are Y or N.
UENTAPPL
Applid or Tier level
The VTAM APPLID (or network name) of the application or the
TPXTIERn Tier level identifier for sub-menuing.
UENTDATA
SessionData
Up to 60 characters of data that is passed to the application
when the session is initiated.
UENTHLID
Tier Member Key
The value of the Owner Key in the sub-menu that owns this
session. This session is a member of that owner.
UENTHLNM
Tier Owner Key
A unique value assigned to this sub-menu owning session.
UENTMODE
Modent name
The name of the logon mode table entry that CA TPX uses for
this session.
UENTOPND
Output Option
Indicates what CA TPX does to inform the user that output has
arrived on this session when the user is in another session.
UENTOPTI
Invisible
Indicates whether the application is not displayed on the Main
Menu until the user initiates the session.
UENTOPTK
KeepACB
Indicates whether the virtual terminal allocated for this session
is reserved for the session after the session has ended.
UENTOVAC
OV/OS/390 ACI
Indicates whether this is an OfficeVision/OS/390 session.
UENTPASS
ACL Password
The user password used in the startup ACL program.
Appendix B: Variables 123
CA TPX User Session Variables (by Field Name)
Variable Name
Field Name in Online
Administration
Field Description
UENTPJMP
Sesskey
The number of the PF key that the user can press to directly
switch to this session. (The value does not contain the
characters PF).
UENTROW
Menu Order
The position of the session on the Menu.
UENTSCRP
Startup ACL
The name of the ACL program that is automatically executed
when the user initiates this session.
UENTSCRT
Termination ACL
The name of the ACL program that is automatically executed
when the user inactivates this session.
UENTSTRT
Start at signon
Indicates whether this session is initiated when the user signs
on.
UENTTOUT
Timeout minutes
The number of minutes the session can be idle before CA TPX
inactivates the session.
UENTUID
ACL Userid
The user ID used in the startup ACL program.
UENTUPB1
through
UENTUPB8
Parm 1 through Parm 8
The ACL program parameters for this session. ACL programs
refer to these parameters with variables P1 through P8. Use
single quotes if the value contains spaces.
UENTUSER
SessionID
The session ID assigned to the application.
UENT$DEL
None
Specifies the string *DELETED*.
VSESLABL
Label
The description of the session that appears on the user's Main
Menu. Use single quotes if the value contains spaces.
VSES$TPX
None
Indicates whether or not the session is a session.
CA TPX User Session Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
ACB Mask
UENTACB
The virtual terminal name (full name or masked value) used for
this session.
ACCESS=PASS
UENTTNA
Indicates whether the user has PASS access to this session.
ACL Password
UENTPASS
The user password used in the startup ACL program.
ACL Userid
UENTUID
The user ID used in the startup ACL program.
124 Batch Administration Guide
CA TPX User Session Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Applid or Tier level
UENTAPPL
The VTAM APPLID (or network name) of the application or the
TPXTIERn Tier level identifier for sub-menuing..
Invisible
UENTOPTI
Indicates whether the application is not displayed on the Main
Menu until the user initiates the session.
KeepACB
UENTOPTK
Indicates whether the virtual terminal allocated for this session
is reserved for the session after the session has ended.
Label
VSESLABL
The description of the session that appears on the user's Main
Menu. Use single quotes if the value contains spaces.
Menu Order
UENTROW
The position of the session in the Menu.
Modent name
UENTMODE
The name of the logon mode table entry that CA TPX uses for
this session.
Output Option
UENTOPND
Indicates what CA TPX does to inform the user that output has
arrived on this session when the user is in another session.
OV/OS/390 ACI
UENTOVAC
Indicates whether this is an OfficeVision/OS/390 session.
Parm 1 through Parm 8
UENTUPB1 through
UENTUPB8
The ACL program parameters for this session. ACL programs
refer to these parameters with variables P1 through P8. Use
single quotes if the value contains spaces.
SessionData
UENTDATA
Up to 60 characters of data that is passed to the application
when the session is initiated.
SessionID
UENTUSER
The session ID assigned to the application.
Sesskey
UENTPJMP
The number of the PF key that the user can press to directly
switch to this session. (The value does not contain the
characters PF).
Start at signon
UENTSTRT
Indicates whether this session is initiated when the user signs
on to CA TPX.
Startup ACL
UENTSCRP
The name of the ACL program that is automatically executed
when the user initiates this session.
Termination ACL
UENTSCRT
The name of the ACL program that is automatically executed
when the user inactivates this session.
Tier Member Key
UENTHLID
The value of the Owner Key in the sub-menu that owns this
session. This session is a member of that owner.
Tier Owner Key
UENTHLNM
A unique value assigned to this sub-menu owning session.
Appendix B: Variables 125
CA TPX Profile Session Variables (by Variable Name)
Field Name in Online
Administration
Variable Name
Field Description
Timeout minutes
UENTTOUT
The number of minutes the session can be idle before CA TPX
inactivates the session.
CA TPX Profile Session Variables (by Variable Name)
Variable Name
Field Name in Online Field Description
Administration
PENTACB
ACB Mask
The virtual terminal name (full name or masked value) used for
this session.
PENTTNA
ACCESS=PASS
Indicates whether the user has PASS access to this session.
PENTAPPL
Applid or Tier level
The VTAM APPLID (or network name) of the application or the
TPXTIERn Tier level identifier for sub-menuing..
PENTDATA
SessionData
Up to 60 characters of data that is passed to the application when
the session is initiated.
PENTHLID
Tier Member Key
The value of the Owner Key in the sub-menu that owns this
session. This session is a member of that owner.
PENTHLNM
Tier Owner Key
A unique value assigned to this sub-menu owning session.
PENTMODE
Modent name
The name of the logon mode table entry that CA TPX uses for this
session.
PENTOPND
Output Option
Indicates what CA TPX does to inform the user that output has
arrived on this session when the user is in another session.
PENTOPTI
Invisible
Indicates whether the application is not displayed on the Main
Menu until the user initiates the session.
PENTOPTK
KeepACB
Indicates whether the virtual terminal allocated for this session is
reserved for the session after the session has ended.
PENTOVAC
OV/OS/390 ACI
Indicates whether this is an OfficeVision/OS/390 session.
PENTPASS
ACL Password
The user password used in the startup ACL program.
PENTPJMP
Sesskey
The number of the PF key that the user can press to directly switch
to this session. (The value does not contain the characters PF).
PENTROW
Profile Menu Order
The position of the session on the menu.
PENTSCRP
Startup ACL
The name of the ACL program that is automatically executed when
the user initiates this session.
126 Batch Administration Guide
CA TPX Profile Session Variables (by Field Name)
Variable Name
Field Name in Online Field Description
Administration
PENTSCRT
Termination ACL
The name of the ACL program that is automatically executed when
the user inactivates this session.
PENTSTRT
Start at signon
Indicates whether this session is initiated when the user signs on
to CA TPX.
PENTTOUT
Timeout minutes
The number of minutes the session can be idle before CA TPX
inactivates the session.
PENTUID
ACL Userid
The user ID used in the startup ACL program.
PENTUPB1 through
PENTUPB8
Parm 1 through
Parm 8
The ACL program parameters for this session. ACL programs refer
to these parameters with variables P1 through P8. Use single
quotes if the value contains spaces.
PENTUSER
SessionID
The session ID assigned to the application.
WSESLABL
Label
The description of the session that appears on the user's Main
Menu. Use single quotes if the value contains spaces.
WSES$TPX
None
Indicates whether or not the session is a CA TPX session.
CA TPX Profile Session Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
ACB Mask
PENTACB
The virtual terminal name (full name or masked value) used
for this session.
ACCESS=PASS
PENTTNA
Indicates whether the user has PASS access to this session.
ACL Password
PENTPASS
The user password used in the startup ACL program.
ACL Userid
PENTUID
The user ID used in the startup ACL program.
Applid or Tier level
PENTAPPL
The VTAM APPLID (or network name) of the application or
the
TPXTIERn Tier level identifier for sub-menuing.
Invisible
PENTOPTI
Indicates whether the application is not displayed on the
Main Menu until the user initiates the session.
KeepACB
PENTOPTK
Indicates whether the virtual terminal allocated for this
session is reserved for the session after the session has
ended.
Label
WSESLABL
The description of the session that appears on the user's
Main Menu. Use single quotes if the value contains spaces.
Appendix B: Variables 127
CA TPX Profile Session Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Modent Name
PENTMODE
The name of the logon mode table entry that CA TPX uses for
this session.
Output Option
PENTOPND
Indicates what CA TPX does to inform the user that output
has arrived on this session when the user is in another
session.
OV/OS/390 ACI
PENTOVAC
Indicates whether this is an OfficeVision/OS/390 session.
Parm 1 through Parm 8
PENTUPB1 through
PENTUPB8
The ACL program parameters for this session. ACL programs
refer to these parameters with variables P1 through P8. Use
single quotes if the value contains spaces.
Profile Menu Order
PENTROW
The position of the session in the Menu.
SessionData
PENTDATA
Up to 60 characters of data that is passed to the application
when the session is initiated.
SessionID
PENTUSER
The session ID assigned to the application.
Sesskey
PENTPJMP
The number of the PF key that the user can press to directly
switch to this session. (The value does not contain the
characters PF).
Start at signon
PENTSTRT
Indicates whether this session is initiated when the user signs
on.
Startup ACL
PENTSCRP
The name of the ACL program that is automatically executed
when the user initiates this session.
Termination ACL
PENTSCRT
The name of the ACL program that is automatically executed
when the user inactivates this session.
Tier Member Key
PENTHLID
The value of the Owner Key in the sub-menu that owns this
session. This session is a member of that owner.
Tier Owner Key
PENTHLNM
A unique value assigned to this sub-menu owning session.
Timeout minutes
PENTTOUT
The number of minutes the session can be idle before CA TPX
inactivates the session.
128 Batch Administration Guide
CA TPX Mail Locator Variables
CA TPX Mail Locator Variables
The following variables can be used for extracting and reporting. These variables specify
information about mail locators.
Mail locators create an association between a mail message text and the users who
have that message in their mailbox. The mail locator contains information about the
message and indicates the location of the message text. The message text exists once,
but has a mail locator for each user's mailbox that contains the message.
See the User Guide and the online help within the Mail facility for information on the
mail facility fields and their use.
Variable Name
Field Description
MLOCTO
The user ID of the recipient of the message.
MLOCFROM
The user ID of the sender of the message
MLOCDATE
The date that the message was sent, in the format mm/dd/yy.
MLOCDATF
The date that the message was sent, in the format dd/mm/yy.
MLOCDATL
The date that the message was sent, in the format mm/dd/yyyy.
MLOCDATQ
The date that the message was sent, in the format dd/mm/yyyy.
MLOCTIME
The time that the message was sent.
MLOCEXPD
The date and time that the message expires. The date is in the
format mm/dd/yy.
MLOCEXPF
The date and time that the message expires. The date is in the
format dd/mm/yy.
MLOCEXPL
The date and time that the message expires. The date is in the
format mm/dd/yyyy.
MLOCEXPQ
The date and time that the message expires. The date is in the
format dd/mm/yyyy.
MLOCRETP
The number of days until the message expires (from the day it was
sent).
MLOCACK
Indicates that an acknowledgment message will be send to the
sender when the message is opened.
MLOCHBAK
Indicates that an acknowledgment message for the message has
been sent, indicating that it has been opened.
MLOCISAK
Indicates that this message is an acknowledgment message. If this
variable is set to Y, the variable MLOCTO for this message indicates
the sender of the original message.
Appendix B: Variables 129
CA TPX Mail Message Variables
Variable Name
Field Description
MLOCTARG
Specifies the user name and ID (if user ID suppression is not active)
of the sender of the message. This variable is valid only if
MLOCISAK is set to Y.
MLOCREAD
Indicates that the message has been opened by the recipient.
MLOCSEND
Indicates that the message has been sent to the recipient.
MLOCBRKN
Indicates that the message was sent with the breakin option
activated.
MLOCSTOR
Indicates that the message has been stored in the recipient's
mailbox.
MLOCOSCD
Indicates that only the sender of this message can delete it.
Note: Date variables that are in U.S. format (mm/dd/yy) will appear in European format
(dd/mm/yy) if the European Dates field is set in the System Options Table (SMRT).
CA TPX Mail Message Variables
The following variables can be used for extracting and reporting. These variables
correspond to information specified in the Mail facility.
See the User Guide and the online help within the Mail facility for information on the
mail facility fields and their use.
Variable Name
Description
MMSGID
The unique ID of the message.
MMSGFROM
The user ID of the message sender.
MMSG$FRM
The user name of the message sender.
MMSGDATE
The date that the message was sent, in the format mm/dd/yy.
MMSGDATF
The date that the message was sent, in the format dd/mm/yy.
MMSGDATL
The date that the message was sent, in the format mm/dd/yyyy.
MMSGDATQ
The date that the message was sent, in the format dd/mm/yyyy.
MMSGTIME
The time that the message was sent.
MMSGEXPD
The date and time that the message expires. The date is in the
format mm/dd/yy.
MMSGEXPF
The date and time that the message expires. The date is in the
format dd/mm/yy.
130 Batch Administration Guide
CA TPX Mail Message Variables
Variable Name
Description
MMSGEXPL
The date and time that the message expires. The date is in the
format mm/dd/yyyy.
MMSGEXPQ
The date and time that the message expires. The date is in the
format dd/mm/yyyy.
MMSGRETP
The number of days until the message expires (from the day it was
sent).
MMSG#USE
The usage count of the message. This corresponds to the number
of mail locators that currently exist for the message.
MMSGSYID
The system ID of the message sender.
MMSGTARG
The ID of the message target. It can be a user ID, userlist, terminal
ID, application ID, session ID, active application ID, or an active
session ID.
MMSGT$TAR
The type of target formatted as a string: "user," "userlist,"
"terminal," "appl," "actappl," "sess," "actsess," or "group."
MMSGACK
Indicates that an acknowledgment message will be sent to the
sender when the recipient opens this message.
MMSGSEND
Indicates that the sender specified that the message be send to the
recipient.
MMSGBRKN
Indicates that the message was sent with the breakin option
activated.
MMSGSTOR
Indicates that the sender specified that the message be stored in
the recipient's mailbox.
MMSGOSCD
Indicates that only the sender can delete this message.
MMSGO2M
Indicates that this message can be send through the OPR2MBX
interface.
MMSGSUBJ
The subject of the message.
MMSGNEXT
The next record of the message.
MMSGTEXT
The text of the message.
Note: Date variables that are in U.S. format (mm/dd/yy) will appear in European format
(dd/mm/yy) if the European Dates field is set in the System Options Table (SMRT).
Appendix B: Variables 131
CA TPX User List Variables
CA TPX User List Variables
The following variables can be used for extracting and reporting. These variables
correspond to information specified in the Mail facility. They provide information about
user lists.
See the User Guide and the online help within the Mail facility for information on the
mail facility fields and their use.
Variable Name
Description
MLSTOWN
The owner of the list.
MLSTID
The ID of the list.
MLSTITLE
The title of the list (a string).
MLSTPUBL
Indicates that this is a public list.
MLSTVISI
Indicates that other users can browse the contents of the list.
MLSTTTAR
The type of entries in the list, formatted as a string: "user,"
"userlist," "terminal," "appl," "actappl," "sess," "actsess," or
"group."
MLSTLIST
The contents of the list, including the optional comments for each
entry in the list. rrule 2 3%
CA TPX Application Variables (by Variable Name)
Variable Name
Field Name in Online Field Description
Administration
ACTACL
Start ACLPGM
The default session activation ACL program used to activate sessions
to this application.
ACTAUT
Auto restart
Tells CA TPX whether to automatically reconnect to the application
when the user's virtual terminal session with the application ends.
ACTBCPS
Start ACL prior to
CLSDST PASS
If you specify Y and have specified that the application issues CLSDST
PASS, the ACLPGM will be allowed to communicate with the
application before the PASS.
ACTBMSG
Inform user of CD
protocol error
Indicates whether CA TPX notifies a user sending protocol violating
data from a non-SNA terminal that the data has been ignored.
Specify Y if you've specified Y for Enforce CD protocol and want the
user to know when data is ignored.
132 Batch Administration Guide
CA TPX Application Variables (by Variable Name)
Variable Name
Field Name in Online Field Description
Administration
ACTBRKT
Enforce CD protocol
Specify Y to ignore data received from non-SNA terminals that
violates protocol. Specify N if you don't want this data ignored.
ACTCLEAR
Sends first screen
Indicates whether the terminal user should wait for the application
to send the first screen at session start time. Specifying Y indicates
that the application is going to send the first screen.
ACTCOMP
Outbound
compression
Indicates whether outbound compression is performed on this
application. If you specify Y, CA TPX will do 3270 data stream
compression on all data this application sends to the terminal.
ACTCPS
Issues CLSDST PASS
Indicates whether the application may issue a CLSDST PASS to
another VTAM applid after the initial session to this application is
established. Specifying Y allows CA TPX to recognize that the aspects
of CLSDST PASS processing are normal and not error situations.
ACTCUSER
OPENGATE Control
User
Specifies the user ID of the user who controls this application for
OPENGATE processing.
ACTETEC
End-to-End option
Tells CA TPX when it should return the SNA response to the
application when the application sends data. Options are:
ALL—wait for response from the terminal on every RU.
NONE—don't wait for the response from the physical terminal.
BB—wait for response from the terminal on any RU with Begin
Bracket.
DR—wait for response from the terminal on any RU carrying the
request for Definite Response.
ACTEXT
Extended data stream Specifies whether the application has a terminal table indicating
extended data stream support.
ACTGR
Generic Resource
ACTINQ
Inquire on application Tells CA TPX whether to issue the VTAM INQUIRE APPLSTAT macro
status
for this application.
ACTKEY
Session Key
Identifies a single PFkey that lets the user go directly to the
application session.
ACTLABEL
Label
The up to 32 characters of description that appears on the
CA TPX menu for this application.
ACTLMOD
Pass Ticket prof name Specifies the name to be supplied to the external security system
during Pass Ticket generation for TSO and VM systems.
Specifies whether the application is actually a generic resource name
for a pool of applications. Setting this will cause CA TPX to take the
APPLID from the network name control vector rather than the plu
name field of the bind.
Appendix B: Variables 133
CA TPX Application Variables (by Variable Name)
Variable Name
Field Name in Online Field Description
Administration
ACTMASKX
Masking done for
security
Indicates whether masking has been established for security reasons.
Specify Y to prevent session transfers if masking was specified in the
application definition. Specify N to allow session transfers.
ACTMDL
Model sensitive
Specifies whether the application has a terminal table with specific
terminal and model definitions. These applications require that the
virtual terminal model types match the physical terminal model.
ACTMDT
Inbound compression Indicates whether inbound compression is performed on this
application. Specify Y to have CA TPX optimize inbound data.
ACTMODET
Mode entry override
Specifies the name of a particular logon mode table entry that CA
TPX must use for this application. Include this value only for
applications that require the use of a specific logon mode table entry
name.
ACTMSK1
Mask entry name
Specifies the name of the virtual terminal mask that controls which
virtual terminal CA TPX selects for the application session. You
specify these masks on the Masking Rules Table.
ACTNAME
Application-ID
This is the APPLID name of the application that is being
defined to CA TPX.
ACTNVIEW
Disallow VIEWing on
this appl
Specifies whether CA TPX prevents users from using any of the View
facility features.
ACTOPT8
Ignore appl output
for timeout
Indicates whether application output is disregarded when updating
fields used for timeout checking.
ACTPTIX
Generate Pass Ticket
Indicates that a pass ticket is to be generated for this application
during session initiation.
ACTQTIX
Gen Qualified Pass
Ticket
Indicates that a Pass Ticket will be generated based on ACF2 or TOP
SECRET qualified profiles
ACTRDBUF
Readbuf Technique
Indicates whether CA TPX reads the terminal controller buffer
contents when the user switches out of the application session.
ACTSAVE
Keep virtual terminal
Specifies whether the virtual terminal should be maintained when
the application session ends. Certain applications require the virtual
terminal to be maintained and reserved for that session for security
reasons
ACTSCRN
Screen even if
readbuf technique
Indicates that a virtual screen image is maintained even though Y
was specified in the Readbuf Technique field.
ACTSESS
Sessionid
The name identifying the session on the CA TPX menu unless it's
overridden at the profile or user level.
134 Batch Administration Guide
CA TPX Application Variables (by Field Name)
Variable Name
Field Name in Online Field Description
Administration
ACTSGNL
Signal session switch
Used to inform network management and measurement products
such as Net Alert when the user switches from one virtual terminal
session to another. Specify a one- to eight-character identifier that
will be used as the signal.
ACTSTRIP
Outbound stripping
Indicates whether outbound stripping is performed on this
application. If you specify Y, CA TPX strips extended attribute bytes
that are not supported by a physical terminal.
ACTSTUB
Substring
Used with applications that use CLSDST PASS. Specify a substring of
characters from the application's minor APPL statements if those
statements do not begin with the same characters as the major APPL
statement. This substring must uniquely identify the application.
ACTSWOUT
Suspend background
application
Used for applications that automatically update the application
screen. If you specify Y and the user switches out of the session, CA
TPX will inform the application that automatic updating of the screen
should be suspended until the user returns to the application
session.
ACTTACL
Termination ACLPGM Specifies the default session termination ACL program used when
sessions to this application are terminated.
ACTTOUT
Timeout Minutes
The number of minutes of inactivity that can pass before
CA TPX automatically terminates a session with this application.
ACTTYPE
Type (SHR,GRP,UNQ,
TPX)
Describes the application's virtual terminal requirements.
ACTUMAX
Maximum sessions
Specifies the maximum number of virtual terminal sessions that can
be active in CA TPX at one time for this application.
ACTUVAR
USERVAR application
Indicates whether the application uses a VTAM USERVAR definition
in lieu of the Extended Recovery Facility.
ACTXRF
XRF application
Specifies whether the application uses the Extended Recovery
Facility.
CA TPX Application Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Application-ID
ACTNAME
This is the APPLID name of the application that is being
defined to CA TPX.
Appendix B: Variables 135
CA TPX Application Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Auto restart
ACTAUT
Tells CA TPX whether to automatically reconnect to the
application when the user's virtual terminal session with the
application ends.
Disallow VIEWing on this ACTNVIEW
appl
Specifies whether CA TPX prevents users from using any of
the View facility features.
End-to-End option
Tells CA TPX when it should return the SNA response to the
application when the application sends data. Options are:
ACTETEC
ALL—wait for response from the terminal on every RU.
NONE—don't wait for the response from the physical
terminal.
BB—wait for response from the terminal on any RU with
Begin Bracket.
DR—wait for response from the terminal on any RU carrying
the request for Definite Response.
Enforce CD protocol
ACTBRKT
Specify Y to ignore data received from non-SNA terminals
that violates protocol. Specify N if you don't want this data
ignored.
Extended data stream
ACTEXT
Specifies whether the application has a terminal table
indicating extended data stream support.
Gen Qualified Pass
Ticket
ACTQTIX
Indicates that a Pass Ticket will be generated based on ACF2
or TOP SECRET qualified profiles
Generate Pass Ticket
ACTPTIX
Indicates that a pass ticket is to be generated for this
application during session initiation.
Generic Resource
ACTGR
Specifies whether the application is actually a generic
resource name for a pool of applications. Setting this will
cause CA TPX to take the APPLID from the network name
control vector rather than the plu name field of the bind.
Ignore appl output for
timeout
ACTOPT8
Indicates whether application output is disregarded when
updating fields used for timeout checking.
Inbound compression
ACTMDT
Indicates whether inbound compression is performed on this
application. Specify Y to have CA TPX optimize inbound data.
Inform user of CD
protocol error
ACTBMSG
Indicates whether CA TPX notifies a user sending protocol
violating data from a non-SNA terminal that the data has
been ignored. Specify Y if you've specified Y for Enforce CD
protocol and want the user to know when data is ignored.
Inquire on application
status
ACTINQ
Tells CA TPX whether to issue the VTAM INQUIRE APPLSTAT
macro for this application.
136 Batch Administration Guide
CA TPX Application Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Issues CLSDST PASS
ACTCPS
Indicates whether the application may issue a CLSDST PASS
to another VTAM applid after the initial session to this
application is established. Specifying Y allows CA TPX to
recognize that the aspects of CLSDST PASS processing are
normal and not error situations.
Keep virtual terminal
ACTSAVE
Specifies whether the virtual terminal should be maintained
when the application session ends. Certain applications
require the virtual terminal to be maintained and reserved
for that session for security reasons
Label
ACTLABEL
The up to 32 characters of description that appears on the
CA TPX menu for this application.
Mask entry name
ACTMSK1
Specifies the name of the virtual terminal mask that controls
which virtual terminal CA TPX selects for the application
session. You specify these masks on the Masking Rules Table.
Masking done for
security
ACTMASKX
Indicates whether masking has been established for security
reasons. Specify Y to prevent session transfers if masking was
specified in the application definition. Specify N to allow
session transfers.
Maximum sessions
ACTUMAX
Specifies the maximum number of virtual terminal sessions
that can be active in CA TPX at one time for this application.
Mode entry override
ACTMODET
Specifies the name of a particular logon mode table entry
that CA TPX must use for this application. Include this value
only for applications that require the use of a specific logon
mode table entry name.
Model sensitive
ACTMDL
Specifies whether the application has a terminal table with
specific terminal and model definitions. These applications
require that the virtual terminal model types match the
physical terminal model.
Outbound compression
ACTCOMP
Indicates whether outbound compression is performed on
this application. If you specify Y, CA TPX will do 3270 data
stream compression on all data this application sends to the
terminal.
Outbound stripping
ACTSTRIP
Indicates whether outbound stripping is performed on this
application. If you specify Y, CA TPX strips extended attribute
bytes that are not supported by a physical terminal.
OPENGATE Control User ACTCUSER
Specifies the user ID of the user who controls this application
for OPENGATE processing.
Appendix B: Variables 137
CA TPX Application Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Pass Ticket prof name
ACTLMOD
Specifies the name to be supplied to the external security
system during Pass Ticket generation for TSO and VM
systems.
Readbuf Technique
ACTRDBUF
Indicates whether CA TPX reads the terminal controller
buffer contents when the user switches out of the
application session.
Screen even if readbuf
technique
ACTSCRN
Indicates that a virtual screen image is maintained even
though Y was specified in the Readbuf Technique field.
Sends first screen
ACTCLEAR
Indicates whether the terminal user should wait for the
application to send the first screen at session start time.
Specifying Y indicates that the application is going to send
the first screen.
Session Key
ACTKEY
Identifies a single PFkey that lets the user go directly to the
application session.
Sessionid
ACTSESS
The name identifying the session on the CA TPX menu unless
it's overridden at the profile or user level.
Signal session switch
ACTSGNL
Used to inform network management and measurement
products such as Net Alert when the user switches from one
virtual terminal session to another. Specify a one- to
eight-character identifier that will be used as the signal.
Start ACL prior to
CLSDST PASS
ACTBCPS
If you specify Y and have specified that the application issues
CLSDST PASS, the ACLPGM will be allowed to communicate
with the application before the PASS.
Start ACLPGM
ACTACL
The default session activation ACL program used to activate
sessions to this application
Substring
ACTSTUB
Used with applications that use CLSDST PASS. Specify a
substring of characters from the application's minor APPL
statements if those statements do not begin with the same
characters as the major APPL statement. This substring must
uniquely identify the application.
Suspend background
application
ACTSWOUT
Used for applications that automatically update the
application screen. If you specify Y and the user switches out
of the session, CA TPX will inform the application that
automatic updating of the screen should be suspended until
the user returns to the application session.
Termination ACLPGM
ACTTACL
Specifies the default session termination ACL program used
when sessions to this application are terminated.
Timeout Minutes
ACTTOUT
The number of minutes of inactivity that can pass before CA
TPX automatically terminates a session with this application.
138 Batch Administration Guide
CA TPX Application Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Type
(SHR,GRP,UNQ,TPX)
ACTTYPE
Describes the application's virtual terminal requirements.
USERVAR application
ACTUVAR
Indicates whether the application uses a VTAM USERVAR
definition in lieu of the Extended Recovery Facility.
XRF application
ACTXRF
Specifies whether the application uses the Extended
Recovery Facility.
Auto restart
ACTAUT
Tells CA TPX whether to automatically reconnect to the
application when the user's virtual terminal session with the
application ends.
Disallow VIEWing on this ACTNVIEW
appl
Specifies whether CA TPX prevents users from using any of
the View facility features.
End-to-End option
Tells CA TPX when it should return the SNA response to the
application when the application sends data. Options are:
ACTETEC
ALL—wait for response from the terminal on every RU.
NONE—don't wait for the response from the physical
terminal.
BB—wait for response from the terminal on any RU with
Begin Bracket.
DR—wait for response from the terminal on any RU carrying
the request for Definite Response.
Enforce CD protocol
ACTBRKT
Specify Y to ignore data received from non-SNA terminals
that violates protocol. Specify N if you don't want this data
ignored.
Extended datastream
ACTEXT
Specifies whether the application has a terminal table
indicating extended data stream support.
Gen Qualified Pass
Ticket
ACTQTIX
Indicates that a Pass Ticket will be generated based on ACF2
or TOP SECRET qualified profiles
Generate Pass Ticket
ACTPTIX
Indicates that a pass ticket is to be generated for this
application during session initiation.
Generic Resource
ACTGR
Specifies whether the application is actually a generic
resource name for a pool of applications. Setting this will
cause CA TPX to take the APPLID from the network name
control vector rather than the plu name field of the bind.
Ignore appl output for
timeout
ACTOPT8
Indicates whether application output is disregarded when
updating fields used for timeout checking.
Inbound compression
ACTMDT
Indicates whether inbound compression is performed on this
application. Specify Y to have CA TPX optimize inbound data.
Appendix B: Variables 139
CA TPX Application Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Inform user of CD
protocol error
ACTBMSG
Indicates whether CA TPX notifies a user sending protocol
violating data from a non-SNA terminal that the data has
been ignored. Specify Y if you've specified Y for Enforce CD
protocol and want the user to know when data is ignored.
Inquire on application
status
ACTINQ
Tells CA TPX whether to issue the VTAM INQUIRE APPLSTAT
macro for this application.
Issues CLSDST PASS
ACTCPS
Indicates whether the application may issue a CLSDST PASS
to another VTAM applid after the initial session to this
application is established. Specifying Y allows CA TPX to
recognize that the aspects of CLSDST PASS processing are
normal and not error situations.
Keep virtual terminal
ACTSAVE
Specifies whether the virtual terminal should be maintained
when the application session ends. Certain applications
require the virtual terminal to be maintained and reserved
for that session for security reasons
Label
ACTLABEL
The up to 32 characters of description that appears on the CA
TPX menu for this application.
Mask entry name
ACTMSK1
Specifies the name of the virtual terminal mask that controls
which virtual terminal CA TPX selects for the application
session. You specify these masks on the Masking Rules Table.
Masking done for
security
ACTMASKX
Indicates whether masking has been established for security
reasons. Specify Y to prevent session transfers if masking was
specified in the application definition. Specify N to allow
session transfers.
Maximum sessions
ACTUMAX
Specifies the maximum number of virtual terminal sessions
that can be active in CA TPX at one time for this application.
Mode entry override
ACTMODET
Specifies the name of a particular logon mode table entry
that CA TPX must use for this application. Include this value
only for applications that require the use of a specific logon
mode table entry name.
Model sensitive
ACTMDL
Specifies whether the application has a terminal table with
specific terminal and model definitions. These applications
require that the virtual terminal model types match the
physical terminal model.
Outbound compression
ACTCOMP
Indicates whether outbound compression is performed on
this application. If you specify Y CA TPX will do 3270 data
stream compression on all data this application sends to the
terminal.
140 Batch Administration Guide
CA TPX Application Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Outbound stripping
ACTSTRIP
Indicates whether outbound stripping is performed on this
application. If you specify Y CA TPX strips extended attribute
bytes that are not supported by a physical terminal.
OPENGATE Control User ACTCUSER
Specifies the user ID of the user who controls this application
for OPENGATE processing.
Pass Ticket prof name
ACTLMOD
Specifies the name to be supplied to the external security
system during Pass Ticket generation for TSO and VM
systems.
Readbuf Technique
ACTRDBUF
Indicates whether CA TPX reads the terminal controller
buffer contents when the user switches out of the
application session.
Screen even if readbuf
technique
ACTSCRN
Indicates that a virtual screen image is maintained even
though Y was specified in the Readbuf Technique field.
Sends first screen
ACTCLEAR
Indicates whether the terminal user should wait for the
application to send the first screen at session start time.
Specifying Y indicates that the application is going to send
the first screen.
Session Key
ACTKEY
Identifies a single PFkey that lets the user go directly to the
application session.
Sessionid
ACTSESS
The name identifying the session on the CA TPX menu unless
it's overridden at the profile or user level.
Signal session switch
ACTSGNL
Used to inform network management and measurement
products such as Net Alert when the user switches from one
virtual terminal session to another. Specify a one- to
eight-character identifier that will be used as the signal.
Start ACL prior to
CLSDST PASS
ACTBCPS
If you specify Y and have specified that the application issues
CLSDST PASS, the ACLPGM will be allowed to communicate
with the application before the PASS.
Start ACLPGM
ACTACL
The default session activation ACL program used to activate
sessions to this application
Substring
ACTSTUB
Used with applications that use CLSDST PASS. Specify a
substring of characters from the application's minor APPL
statements if those statements do not begin with the same
characters as the major APPL statement. This substring must
uniquely identify the application.
Appendix B: Variables 141
CA STX User Variables (by Variable Name)
Field Name in Online
Administration
Variable Name
Field Description
Suspend background
application
ACTSWOUT
Used for applications that automatically update the
application screen. If you specify Y and the user switches out
of the session, CA TPX will inform the application that
automatic updating of the screen should be suspended until
the user returns to the application session.
Termination ACLPGM
ACTTACL
Specifies the default session termination ACL program used
when sessions to this application are terminated.
Timeout Minutes
ACTTOUT
The number of minutes of inactivity that can pass before CA
TPX automatically terminates a session with this application.
Type
(SHR,GRP,UNQ,TPX)
ACTTYPE
Describes the application's virtual terminal requirements.
USERVAR application
ACTUVAR
Indicates whether the application uses a VTAM USERVAR
definition in lieu of the Extended Recovery Facility.
XRF application
ACTXRF
Specifies whether the application uses the Extended
Recovery Facility.
CA STX User Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
XUACIDSN
ACIDSN
The default data set name used by all ACI INCLUDE
commands that only specify a member.
XUACIFM
Filemode
The file mode of the default file used by the ACI INCLUDE
command.
XUACIFN
Filename
The file name of the default file used by the ACI INCLUDE
command.
XUACIFT
Filetype
The file type of the default file used by the ACI INCLUDE
command.
XUACIPWD
Link Password
The password for the virtual minidisk containing the default
file used by the ACI INCLUDE command.
XUACIVAD
Link Virtual Address
The virtual minidisk address of the default file used by the ACI
INCLUDE command.
XUAUTH
Authorization
The user's authorization class. The possible values are A, B, C,
or D.
142 Batch Administration Guide
CA STX User Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
XUCASE
Upper Case Conversion
Indicates whether or not input characters are automatically
converted to upper case.
XUCOPY
Spool Copies
The number of copies produced when output is spooled to a
printer.
XUDISP
Disposition
The disposition status for the data set allocated when output
is spooled to a data set. Values can be OLD, NEW, SHR, or
MOD.
XUDSN
Dataset Name
The name of data set allocated when output is spooled to a
data set.
XUEMUDES
Emulation Spool Dest
The destination of output if spooling is used during full-screen
emulation. Values can be either F or P. F specifies an MVS
data set. P specifies a printer using SYSOUT.
XUHEAD1
Header1
The first line of data to be used as a header for the data set
allocated when output is spooled to a data set.
XUHEAD2
Header2
The second line of data to be used as a header for the data
set allocated when output is spooled to a data set.
XUHEAD3
Header3
The third line of data to be used as a header for the data set
allocated when output is spooled to a data set.
XULOGAPL
Startup application name
The X.25 application that is automatically activated when a
user signs on to CA STX. This value must be identical to the
application's name in the Application Definition Table (NPT).
XUMODE
Screen Presentation Mode
The initial setting for the screen mode. The user can change
the mode in an X.25 application session, but this is the value
set when the user signs on to CA STX. Possible values are:
R—indicates continuous roll mode. This is the default option.
W—indicates wrap-around mode.
P—indicates page-at-a-time mode.
A— indicates automatic refresh mode.
XUMUJRNL
Emulation Journalling
Indicates whether or not the user can save screens in the
session journal when using full-screen emulation. Possible
values are Y or N.
XUOAUTO
Autopage mode Allowed
Indicates whether or not the user can use the automatic
refresh screen presentation mode. Possible values are Y or N.
XUOPAGE
Page mode Allowed
Indicates whether or not the user can use the page-at-a-time
screen presentation mode. Possible values are Y or N.
XUOWRAP
Wrap mode Allowed
Indicates whether or not the user can use the wrap-around
screen presentation mode. Possible values are Y or N.
Appendix B: Variables 143
CA STX User Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
XUPCOLS
Screen Presentation Width
The line length of the simulated terminal. Possible values are
80 and 132.
XUPFCB
Printer FCB
The forms control buffer image that JES should set to guide
printing of the sysout data set when spooling output to a
printer.
XUPRINTR
Printer
The name of the printer used when spooling output to a
printer. This value corresponds to the value given in a JCL
DEST parameter.
XUPRNTCL
Spool Class
The output class to which spooled output is routed. Possible
values are a letter from A to Z or a number from 0 to 9.
XUPSWD
Password
The user's password. It can be up to 8 characters long. When
CA STX security is specified in the System Options Table
(STXT), the password the user enters at signon is checked
against this one. Otherwise, it is the responsibility of the
security system or one of the security exits to check the
password the user enters.
XUSOROLL
Roll Mode Allowed
Indicates whether or not the user can specify the
continuous-roll screen presentation mode. Possible values
are Y or N.
XUSPLSZ
Journal Allocation Blocks
The number of 3160-byte blocks to be allocated to a user's
journal spill file. The default is 500. A value of 0 specifies no
spill file, but the user has access to the portion of the journal
that is maintained in memory. The number of line blocks that
are kept in memory is specified with the Performance
Parameters in the System Options Table (STXT).
XUSPOLUN
Unit
The unit for the data set allocated when spooling output to a
data set.
XUSPRNDS
Allow Spool to Dataset
Indicates whether or not the user can spool output to a data
set.
XUTERMT
Emulated Terminal Type
The type of terminal emulated for X.25 applications. Possible
values are TTY for a standard teletype device or AJ for an AJ
model 33 terminal.
XUTMOUT
Timeout Interval
The interval in minutes after which an inactive user is
disconnected from an X.25 session. The default is 15 minutes.
If 0 is specified, CA STX does not disconnect inactive users,
although the remote application may clear the virtual circuit.
XUTTOTT
Timeout Terminal
Indicates whether or not the timeout interval applies to the
terminal session in addition to the application session.
XU$STX
None
Indicates whether or not the session is a CA STX session.
144 Batch Administration Guide
CA STX User Variables (by Field Name)
CA STX User Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
ACIDSN
XUACIDSN
The default data set name used by all ACI INCLUDE commands
that only specify a member.
Allow Spool to Dataset
XUSPRNDS
Indicates whether or not the user can spool output to a data set.
Authorization
XUAUTH
The user's authorization class. The possible values are A, B, C, or
D.
Autopage mode Allowed XUOAUTO
Indicates whether or not the user can use the automatic refresh
screen presentation mode. Possible values are Y or N.
Dataset Name
XUDSN
The name of data set allocated when output is spooled to a data
set.
Disposition
XUDISP
The disposition status for the data set allocated when output is
spooled to a data set. Values can be OLD, NEW, SHR, or MOD.
Emulated Terminal Type XUTERMT
The type of terminal emulated for X.25 applications. Possible
values are TTY for a standard teletype device or AJ for an AJ
model 33 terminal.
Emulation Journalling
XUMUJRNL
Indicates whether or not the user can save screens in the session
journal when using full-screen emulation. Possible values are Y
or N.
Emulation Spool Dest
XUEMUDES
The destination of output if spooling is used during full-screen
emulation. Values can be either F or P. F specifies an MVS data
set. P specifies a printer using SYSOUT.
Filemode
XUACIFM
The file mode of the default file used by the ACI INCLUDE
command.
Filename
XUACIFN
The file name of the default file used by the ACI INCLUDE
command.
Filetype
XUACIFT
The file type of the default file used by the ACI INCLUDE
command.
Header1
XUHEAD1
The first line of data to be used as a header for the data set
allocated when output is spooled to a data set.
Header2
XUHEAD2
The second line of data to be used as a header for the data set
allocated when output is spooled to a data set.
Header3
XUHEAD3
The third line of data to be used as a header for the data set
allocated when output is spooled to a data set.
Appendix B: Variables 145
CA STX User Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Journal Allocation Blocks XUSPLSZ
The number of 3160-byte blocks to be allocated to a user's
journal spill file. The default is 500. A value of 0 specifies no spill
file, but the user has access to the portion of the journal that is
maintained in memory. The number of line blocks that are kept
in memory is specified with the Performance Parameters in the
System Options Table (STXT).
Link Password
XUACIPWD
The password for the virtual minidisk containing the default file
used by the ACI INCLUDE command.
Link Virtual Address
XUACIVAD
The virtual minidisk address of the default file used by the ACI
INCLUDE command.
Page mode Allowed
XUOPAGE
Indicates whether or not the user can use the page-at-a-time
screen presentation mode. Possible values are Y or N.
Password
XUPSWD
The user's password. It can be up to 8 characters long. When CA
STX security is specified in the System Options Table (STXT), the
password the user enters at signon is checked against this one.
Otherwise, it is the responsibility of the security system or one
of the security exits to check the password the user enters.
Printer
XUPRINTR
The name of the printer used when spooling output to a printer.
This value corresponds to the value given in a JCL DEST
parameter.
Printer FCB
XUPFCB
The forms control buffer image that JES should set to guide
printing of the sysout data set when spooling output to a
printer.
Roll Mode Allowed
XUSOROLL
Indicates whether or not the user can specify the continuous-roll
screen presentation mode. Possible values are Y or N.
Screen Presentation
Mode
XUMODE
The initial setting for the screen mode. The user can change the
mode in an X.25 application session, but this is the value set
when the user signs on to CA STX. Possible values are:
R—indicates continuous roll mode. This is the default option.
W—indicates wrap-around mode.
P—indicates page-at-a-time mode.
A—indicates automatic refresh mode.
Screen Presentation
Width
XUPCOLS
The line length of the simulated terminal. Possible values are 80
and 132.
Spool Class
XUPRNTCL
The output class to which spooled output is routed. Possible
values are a letter from A to Z or a number from 0 to 9.
Spool Copies
XUCOPY
The number of copies produced when output is spooled to a
printer.
146 Batch Administration Guide
CA STX Profile Variables (by Variable Name)
Field Name in Online
Administration
Variable Name
Field Description
Startup application
name
XULOGAPL
The X.25 application that is automatically activated when a user
signs on to CA STX. This value must be identical to the
application's name in the Application Definition Table (NPT).
Timeout Interval
XUTMOUT
The interval in minutes after which an inactive user is
disconnected from an X.25 session. The default is 15 minutes. If
0 is specified, CA STX does not disconnect inactive users,
although the remote application may clear the virtual circuit.
Timeout Terminal
XUTTOTT
Indicates whether or not the timeout interval applies to the
terminal session in addition to the application session.
Unit
XUSPOLUN
The unit for the data set allocated when spooling output to a
data set.
Upper Case Conversion
XUCASE
Indicates whether or not input characters are automatically
converted to upper case.
Wrap mode Allowed
XUOWRAP
Indicates whether or not the user can use the wrap-around
screen presentation mode. Possible values are Y or N.
CA STX Profile Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
XPACIDSN
ACIDSN
The default data set name used by all ACI INCLUDE
commands that only specify a member.
XPACIFM
Filemode
The file mode of the default file used by the ACI INCLUDE
command.
XPACIFN
Filename
The file name of the default file used by the ACI INCLUDE
command.
XPACIFT
Filetype
The file type of the default file used by the ACI INCLUDE
command.
XPACIPWD
Link Password
The password for the virtual minidisk containing the default
file used by the ACI INCLUDE command.
XPACIVAD
Link Virtual Address
The virtual minidisk address of the default file used by the
ACI INCLUDE command.
XPAUTH
Authorization
The user's authorization class. The possible values are A, B,
C, or D.
Appendix B: Variables 147
CA STX Profile Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
XPCASE
Upper Case Conversion
Indicates whether or not input characters are automatically
converted to upper case.
XPCOPY
Spool Copies
The number of copies produced when output is spooled to a
printer.
XPDISP
Disposition
The disposition status for the data set allocated when
output is spooled to a data set. Values can be OLD, NEW,
SHR, or MOD.
XPDSN
Dataset Name
The name of data set allocated when output is spooled to a
data set.
XPEMUDES
Emulation Spool Dest
The destination of output if spooling is used during
full-screen emulation. Values can be either F or P. F specifies
an MVS data set. P specifies a printer using SYSOUT.
XPHEAD1
Header1
The first line of data to be used as a header for the data set
allocated when output is spooled to a data set.
XPHEAD2
Header2
The second line of data to be used as a header for the data
set allocated when output is spooled to a data set.
XPHEAD3
Header3
The third line of data to be used as a header for the data set
allocated when output is spooled to a data set.
XPLOGAPL
Startup application name
The X.25 application that is automatically activated when a
user signs on to CA STX. This value must be identical to the
application's name in the Application Definition Table (NPT).
XPMODE
Screen Presentation Mode
The initial setting for the screen mode. The user can change
the mode in an X.25 application session, but this is the value
set when the user signs on to CA STX. Possible values are:
R—indicates continuous roll mode. This is the default
option.
W—indicates wrap-around mode.
P—indicates page-at-a-time mode.
A—indicates automatic refresh mode.
XPMUJRNL
Emulation Journalling
Indicates whether or not the user can save screens in the
session journal when using full-screen emulation. Possible
values are Y or N.
XPOAUTO
Autopage mode Allowed
Indicates whether or not the user can use the automatic
refresh screen presentation mode. Possible values are Y or
N.
XPOPAGE
Page mode Allowed
Indicates whether or not the user can use the
page-at-a-time screen presentation mode. Possible values
are Y or N.
148 Batch Administration Guide
CA STX Profile Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
XPOWRAP
Wrap mode Allowed
Indicates whether or not the user can use the wrap-around
screen presentation mode. Possible values are Y or N.
XPPCOLS
Screen Presentation Width
The line length of the simulated terminal. Possible values
are 80 and 132.
XPPFCB
Printer FCB
The forms control buffer image that JES should set to guide
printing of the sysout data set when spooling output to a
printer.
XPPRINTR
Printer
The name of the printer used when spooling output to a
printer. This value corresponds to the value given in a JCL
DEST parameter.
XPPRNTCL
Spool Class
The output class to which spooled output is routed. Possible
values are a letter from A to Z or a number from 0 to 9.
XPPSWD
Password
The user's password. It can be up to 8 characters long.
When CA STX security is specified in the System Options
Table (STXT), the password the user enters at signon is
checked against this one. Otherwise, it is the responsibility
of the security system or one of the security exits to check
the password the user enters.
XPSOROLL
Roll Mode Allowed
Indicates whether or not the user can specify the
continuous-roll screen presentation mode. Possible values
are Y or N.
XPSPLSZ
Journal Allocation Blocks
The number of 3160-byte blocks to be allocated to a user's
journal spill file. The default is 500. A value of 0 specifies no
spill file, but the user has access to the portion of the
journal that is maintained in memory. The number of line
blocks that are kept in memory is specified with the
Performance Parameters in the System Options Table
(STXT).
XPSPOLUN
Unit
The unit for the data set allocated when spooling output to
a data set.
XPSPRNDS
Allow Spool to Dataset
Indicates whether or not the user can spool output to a data
set.
XPTERMT
Emulated Terminal Type
The type of terminal emulated for X.25 applications.
Possible values are TTY for a standard teletype device or AJ
for an AJ model 33 terminal.
Appendix B: Variables 149
CA STX Profile Variables (by Field Name)
Variable Name
Field Name in Online
Administration
Field Description
XPTMOUT
Timeout Interval
The interval in minutes after which an inactive user is
disconnected from an X.25 session. The default is 15
minutes. If 0 is specified, CA STX does not disconnect
inactive users, although the remote application may clear
the virtual circuit.
XPTTOTT
Timeout Terminal
Indicates whether or not the timeout interval applies to the
terminal session in addition to the application session.
XP$STX
None
Indicates whether or not the session is a CA STX session.
CA STX Profile Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
ACIDSN
XPACIDSN
The default data set name used by all ACI INCLUDE
commands that only specify a member.
Allow Spool to Dataset
XPSPRNDS
Indicates whether or not the user can spool output to a
data set.
Authorization
XPAUTH
The user's authorization class. The possible values are A,
B, C, or D.
Autopage mode Allowed
XPOAUTO
Indicates whether or not the user can use the automatic
refresh screen presentation mode. Possible values are Y
or N.
Dataset Name
XPDSN
The name of data set allocated when output is spooled to
a data set.
Disposition
XPDISP
The disposition status for the data set allocated when
output is spooled to a data set. Values can be OLD, NEW,
SHR, or MOD.
Emulated Terminal Type
XPTERMT
The type of terminal emulated for X.25 applications.
Possible values are TTY for a standard teletype device or
AJ for an AJ model 33 terminal.
Emulation Journalling
XPMUJRNL
Indicates whether or not the user can save screens in the
session journal when using full-screen emulation. Possible
values are Y or N.
150 Batch Administration Guide
CA STX Profile Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Emulation Spool Dest
XPEMUDES
The destination of output if spooling is used during
full-screen emulation. Values can be either F or P. F
specifies an MVS data set. P specifies a printer using
SYSOUT.
Filemode
XPACIFM
The file mode of the default file used by the ACI INCLUDE
command.
Filename
XPACIFN
The file name of the default file used by the ACI INCLUDE
command.
Filetype
XPACIFT
The file type of the default file used by the ACI INCLUDE
command.
Header1
XPHEAD1
The first line of data to be used as a header for the data
set allocated when output is spooled to a data set.
Header2
XPHEAD2
The second line of data to be used as a header for the
data set allocated when output is spooled to a data set.
Header3
XPHEAD3
The third line of data to be used as a header for the data
set allocated when output is spooled to a data set.
Journal Allocation Blocks
XPSPLSZ
The number of 3160-byte blocks to be allocated to a
user's journal spill file. The default is 500. A value of 0
specifies no spill file, but the user has access to the
portion of the journal that is maintained in memory. The
number of line blocks that are kept in memory is specified
with the Performance Parameters in the System Options
Table (STXT).
Link Password
XPACIPWD
The password for the virtual minidisk containing the
default file used by the ACI INCLUDE command.
Link Virtual Address
XPACIVAD
The virtual minidisk address of the default file used by the
ACI INCLUDE command.
Page mode Allowed
XPOPAGE
Indicates whether or not the user can use the
page-at-a-time screen presentation mode. Possible values
are Y or N.
Password
XPPSWD
The user's password. It can be up to 8 characters long.
When CA STX security is specified in the System Options
Table (STXT), the password the user enters at signon is
checked against this one. Otherwise, it is the
responsibility of the security system or one of the security
exits to check the password the user enters.
Printer
XPPRINTR
The name of the printer used when spooling output to a
printer. This value corresponds to the value given in a JCL
DEST parameter.
Appendix B: Variables 151
CA STX Profile Variables (by Field Name)
Field Name in Online
Administration
Variable Name
Field Description
Printer FCB
XPPFCB
The forms control buffer image that JES should set to
guide printing of the sysout data set when spooling
output to a printer.
Roll Mode Allowed
XPSOROLL
Indicates whether or not the user can specify the
continuous-roll screen presentation mode. Possible
values are Y or N.
Screen Presentation
Mode
XPMODE
The initial setting for the screen mode. The user can
change the mode in an X.25 application session, but this is
the value set when the user signs on to CA STX. Possible
values are:
R—indicates continuous roll mode. This is the default
option.
W—indicates wrap-around mode.
P—indicates page-at-a-time mode.
A—indicates automatic refresh mode.
Screen Presentation
Width
XPPCOLS
The line length of the simulated terminal. Possible values
are 80 and 132.
Spool Class
XPPRNTCL
The output class to which spooled output is routed.
Possible values are a letter from A to Z or a number from
0 to 9.
Spool Copies
XPCOPY
The number of copies produced when output is spooled
to a printer.
Startup application name
XPLOGAPL
The X.25 application that is automatically activated when
a user signs on to CA STX. This value must be identical to
the application's name in the Application Definition Table
(NPT).
Timeout Interval
XPTMOUT
The interval in minutes after which an inactive user is
disconnected from an X.25 session. The default is 15
minutes. If 0 is specified, CA STX does not disconnect
inactive users, although the remote application may clear
the virtual circuit.
Timeout Terminal
XPTTOTT
Indicates whether or not the timeout interval applies to
the terminal session in addition to the application session.
Unit
XPSPOLUN
The unit for the data set allocated when spooling output
to a data set.
Upper Case Conversion
XPCASE
Indicates whether or not input characters are
automatically converted to upper case.
152 Batch Administration Guide
CA STX User Session Variables (by Variable Name)
Field Name in Online
Administration
Variable Name
Field Description
Wrap mode Allowed
XPOWRAP
Indicates whether or not the user can use the
wrap-around screen presentation mode. Possible values
are Y or N.
CA STX User Session Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
XAPXACI
ACI Program
The ACI program that is automatically executed upon
connection to the application. This parameter overrides the
ACI program specified in the Emulation Options of the
Application Definition Table (NPT).
XAPXP01 through
XAPXP16
&&P1 through &&P16
The ACI program parameters for this session. ACI programs
refer to these parameters with variables &&P1 through
&&P16. Use single quotes if the value contains spaces or
commas. The strings can contain a maximum of 64
characters.
XAPX$SES
None
The application name.
XAPX$MEN#
None
The position of the session ID in the CA STX Menu.
XAPX$STX
None
Indicates whether or not the session is a CA STX session. This
variable can have a value of Y or N.
CA STX Profile Session Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
XPPXACI
ACI Program
The ACI program that is automatically executed upon
connection to the application. This parameter overrides the
ACI program specified in the Emulation Options of the
Application Definition Table (NPT).
XPPXP01 through
XPPXP16
&&P1 through &&P16
The ACI program parameters for this session. ACI programs
refer to these parameters with variables &&P1 through
&&P16. Use single quotes if the value contains spaces or
commas. The strings can contain a maximum of 64
characters.
Appendix B: Variables 153
CA STX Profile Session Variables (by Variable Name)
Variable Name
Field Name in Online
Administration
Field Description
XPPX$SES
None
The application name.
XPPX$MEN#
None
The position of the session ID in the CA STX Menu.
XPPX$STX
None
Indicates whether or not the session is a CA STX session. This
variable can have a value of Y or N.
154 Batch Administration Guide
Appendix C: Batch Command Summary
This section contains the following topics:
Special Command Statements (see page 155)
ADD Statements (see page 156)
CONVERT Statements (see page 157)
COPY Statements (see page 158)
DELETE Statements (see page 158)
UPDATE Statements (see page 159)
EXTRACT Statement (see page 160)
REPORT Statement (see page 160)
ADD Statement (Using an Extract File) (see page 160)
DELETE Statement (Using an Extract File) (see page 161)
UPDATE Statement (Using an Extract File) (see page 162)
Special Command Statements
The following are the syntax diagrams for special command statements that are not
used explicitly for updating, extracting, or reporting.
RESET INTEGRITY
|-------------------+
V
|
->>--- RESET INTEGRITY -----(-------- ADMIN1 --------------)---><
|-- ADMIN2 ---|
|-- NOTES ----|
|-- MAIL -----|
+-- VIEW ----+
------------------------------------------------------------------
SET
->>--- SET ----- variable ----------- variable2 -------------><
+-- 'value' -----+
VDEFINE
->>--- VDEFINE ----- variable ------ (LENGTH(length)) -------><
Appendix C: Batch Command Summary 155
ADD Statements
ADD Statements
The following are the syntax diagrams for ADD statements that do not use an extract
file.
Add Users and Profiles
->>--- ADD ----------------------- USER --------------------(---->
|-- TPX --|
+-- PROFILES --+
+-- STX --+
|--------------------------------------------------+
V
|
->---- object ----------------------------------------------)---><
|
|------------------ -+
|
|
V
|
|
+--(----- variable(value) -----)---+
Add Sessions to Users and Profiles
->>--- ADD -------------------------- USERSESSION -----------------(----->
|-- TPX --|
+-- PROFILESESSION ---+
+-- STX --+
|--------------------------------------------------------------+
V
|
->---- objectID --- sessionID ---------------------------------------)--><
|
|--------------------+
|
|
V
|
|
+--(----- variable(value) ----)--+
Add Profile Sessions
|-------------------------+
V
|
->>-- ADD -- USERPROFILE --(----- userID -- profileID -----)---><
Add Administrative Authority
|---------------------+
V
|
->>-- ADD------------USERMAGN---(---userID -- group-name----)--><
|- TPX -|
+- STX -+
Add View Facility Authority
|-------------------------------------+
V
|
->>-- ADD -- USERVAGN ---(--- userID -- group-name -- authority ---)---><
Add Mail Messages
->>-- ADD -- MAILMESSAGE ------------------------------------------------>
+-- EXPIRING ---(-------------------------------)--+
156 Batch Administration Guide
CONVERT Statements
| +--MM(mm)--+ +--DD(dd)--+ +--YY----yy----+---|
|
+- yyyy -+
|
+------------------ nn -----------------------+
->-- SUBJECT ---- (-- subject --)---TO----------------------------------->
|-- USERS ------|
+-- USERLISTS --+
|--------------------+
V
|
->-------------------- recipient ------------------------- text ---------><
|
|
|
|
|
|
|
|
|
|
+- ( -+
+------*BULLETIN* -----+
+- ) -+
+- ( -+
+- ) -+
Add User Lists
->>-- ADD -- USERLIST --- userlist ---- owner ----------------------------------->
+- *GENERAL* -+ +- PRIVATE -+ +- INVISIBLE -+
|--------+
V
|
->------------------------------------------------------------(--- entry ---)---><
|--- USERS ---------------------|
+-- TITLE -- (title) --+
|--- USERIDS -------------------|
|--- USERLISTS -----------------|
|--- TERMINALS -----------------|
|---------------APPLICATIONS ---|
| +- ACTIVE -+
|
|
|
|----------------SESSIONS-------|
| +- ACTIVE -+
|
|
|
+--- GROUPS --------------------+
Add Applications
->>--- ADD ------------------ ACTAPPL----(objectID applID)--><
CONVERT Statements
The following are the syntax diagrams for CONVERT statements.
Convert STXTs
->>--- CONVERT ----- USING(ddname) ----- STXT ---- tablename --><
Convert NPTs
->>-- CONVERT -- USING(-- ddname1 - ddname2 --)--NPT-tablename-><
Convert MSGFILEs
->>--- CONVERT ---MSGFILE----- TO ---------------- MAIL -----><
+-- REPLACING --+
Appendix C: Batch Command Summary 157
COPY Statements
Convert MAIL Files
->>--- CONVERT ---MSGFILE------- TO ---------------- MSGFILE --><
+-- REPLACING --+
COPY Statements
The following are the syntax diagrams for COPY statements.
Copy Users and Profiles
->>--- COPY ---------------------- USER -------------- templates ----------- ( -->
|-- TPX --|
+-- PROFILES --+
+- TO -+
+-- STX --+
|-------------------------------------------------------+
V
|
->---- object -------------------------------------------------- ) -------------><
|
|------------------ -+
|
|
V
|
|
+-- ( ------ variable(value) ---- ) ---+
Copy User and Profile Sessions
->>--- COPY --------------------- USERSESSION -------- template -- sessionID--- ( -->
|-- TPX --|
+-- PROFILESESSION --+
+-- STX --+
|-------------------------------------------------------------------+
V
|
->---- objectID ---- new-sessionID ---------------------------------------- ) ---><
|
|------------------+
|
|
V
|
|
+-- ( --- variable(value) --- ) --+
Copy Applications
->>--- COPY --------- ACTAPPL templateact templateappl------ ( -->
|---------------------------------------------------------+
V
|
->---- objectact --------------------objectappl-------------- ) -----------><
DELETE Statements
The following are syntax diagrams for DELETE statements that do not use an extract file.
Delete Users and Profiles
|----------+
V
|
->>-- DELETE ------------------ USER ---------------(--- object ----)--><
|-- TPX --| +-- PROFILES --+
+-- STX --+
158 Batch Administration Guide
UPDATE Statements
Delete Sessions from Users and Profiles
|--------------------+
V
|
->>-- DELETE ------------------- USERSESSION --------(--- object -- sessID -- ) --><
|-- TPX --|
+-- PROFILESESSION --+
+-- STX --+
Delete Profiles from a User
|-----------------------+
V
|
->>--DELETE --- USERPROFILE ---(--- userID -- profileID ---)---><
Delete Administrative Authority from a User
|--------------------------+
V
|
->>--- DELETE ----- USERMAGN ------(--- userID --- group-name -----)---><
+-- USERVAGN --+
Delete Mail Messages
->>-- DELETE -- MAILMESSAGE -- BEFORE --(---------------------------------)--+---><
| +--MM(mm)--+ +--DD(dd)--+ +--YY--yy--+--|
|
+- yyyy -+
|
+--------- nn ------- DAYS --------------+
----------------------------------------------------------------------------------
Delete User Lists
->>-- DELETE -- USERLIST --- userlist ----- owner -------------><
+-- *GENERAL* --+
UPDATE Statements
The following are the syntax diagrams for UPDATE statements that do not use extract
files.
Update Users and Profiles
->>--- UPDATE -------------------- USER -----------(---->
|-- TPX --|
+-- PROFILE --+
+-- STX --+
|-----------------------------------------+
|
|--------------------+ |
V
V
| |
->---- object -----(----- variable(value) -----)------)---><
Appendix C: Batch Command Summary 159
EXTRACT Statement
Update User and Profile Sessions
->>--- UPDATE --------------------- ACTAPPL -----------------(---->
|-----------------------------------------------+
|
|---------------------+ |
V
V
| |
->---- objected applid -------(----- variable(value) -----)--------)----><
EXTRACT Statement
The following is the syntax diagram for an EXTRACT statement that creates an extract
file for reporting or updating.
->>-- EXTRACT -- GIVING(ddname) --->
|-|
|-|--
USER -------------- AND ALL SESSIONS ------PROFILE ---+
|- AND MATCHING SESSIONS -|
+- AND NO SESSIONS -------|
MAILMESSAGE -------------------------------|
USERLIST ----------------------------------|
+-- ACT -------------------------------------+
|----------------------------------------------------+
|
|-------------+
|
V
V
|
|
->---------------(--- variable( ---- value ----------)------------------)------><
REPORT Statement
The following are the syntax diagrams for the REPORT statement and the line definition
that is used in the REPORT statement.
->>--- REPORT ---- GIVING(ddname)--- USING(extract-ddname) --(---->
|------------------------------+
V
|
->---- (line-definition) -------------------)--------------------><
Line Definition in the Report Statement
|------------------+
V
|
->>-- ' -- * ------- &variable ------ ' ------------------------------------><
+-- string ----+
| |-----------------------+ |
| V
| |
+----' --- &variable --- ' ---+
+-- string ---+
ADD Statement (Using an Extract File)
The following are the syntax diagrams for the ADD statement that uses an extract file.
160 Batch Administration Guide
DELETE Statement (Using an Extract File)
Add Profiles or Authority
->>-- ADD --------------- USERPROFILE --------USING(ddname) ---->
|-- USERMAGN ----|
+-- USERVAGN ----+
->---------- (object) -----------------------------------------><
|
|
+---(-- group-name ----- authority -----)---+
Add User Lists
->>-- ADD -- USERLIST --- userlist --- owner ---------------------------------->
+-*GENERAL* -+ +- PRIVATE -+ +- INVISIBLE -+
->------------------------------ USING (ddname) ------------------------------><
+-- title - (title) -+
DELETE Statement (Using an Extract File)
The following are the syntax diagrams for the DELETE statements that use an extract
file.
Delete Users, Profiles, and Sessions
->>-- DELETE------------------|-- TPX --| |-+-- STX --+ |-+--
USER ---------------- USING(ddname) ----><
PROFILE ----------|
USERSESSION ------|
PROFILESESSION ---+
Delete User Profiles and Authorization
|----------+
V
|
->>--- DELETE ----- USERPROFILE --------USING(ddname) ---(--- (object) ---)----><
|-- USERMAGN -----|
|-- USERVAGN -----+
Delete Applications
->>--- DELETE --- ACTAPPL ---- USING --- (ddname) ----><
Delete Mail Locators
->>--- DELETE --- MAILMESSAGE ------ USING ----- (ddname) ---><
Appendix C: Batch Command Summary 161
UPDATE Statement (Using an Extract File)
UPDATE Statement (Using an Extract File)
The following is the syntax diagram for the UPDATE statement that uses an extract file.
|--------------------+
V
|
->>-- UPDATE -- USING(ddname) ---(----- variable(value)----)---><
162 Batch Administration Guide
Appendix D: Converting MSGFILE to MAIL
File
This section contains the following topics:
Convert MSGFILEs and MAIL Files (see page 163)
Convert MSGFILEs and MAIL Files
Batch facility commands can be used to convert MSGFILEs to MAIL files that can be used
by CA TPX. The MAIL file is a VSAM file that is used by the Mail facility.
The batch commands can be used to convert a MSGFILE into a MAIL file and to convert a
MAIL file into a MSGFILE.
Convert Information from a MSGFILE
The CONVERT command will convert information from a MSGFILE into a MAIL file.
->>--- CONVERT ---MSGFILE------- TO -------------- MSGFILE ----><
+-- REPLACING --+
Operand Explanations
The CONVERT statement for MSGFILEs has the following operands:
TO
Indicates that any information already in the MAIL file will not be changed.
REPLACING
Indicates that any information in the MSGFILE that matches information in the MAIL
file will replace that in the MAIL file.
Example
An administrator wants to convert the MSGFILE into a VSAM MAIL file. The MAIL file is
new, so the administrator is unconcerned about information in the MAIL file. The
administrator includes the following statement in a batch job:
CONVERT MSGFILE TO MAIL
The file is converted. The MAIL file now includes the information that was in the
MSGFILE.
Appendix D: Converting MSGFILE to MAIL File 163
Convert MSGFILEs and MAIL Files
Convert Information from a MAIL File
The CONVERT command will convert information from a MAIL into a MSGFILE.
->>--- CONVERT ---MAIL------- TO ---------------- MSGFILE ---><
+-- REPLACING --+
Operand Explanations
The CONVERT statement for MAIL files has the following operands:
TO
Indicates that any information already in the MSGFILE file will not be changed.
REPLACING
Indicates that any information in the MAIL file that matches information in the
MSGFILE will replace that in the MSGFILE.
Example
An administrator wants to convert the contents of a MAIL file so it can be used with an
earlier version of TPX. The administrator wants to make sure that the information in the
MAIL file overwrites matching information in the MSGFILE. The administrator includes
the following statement in a batch job:
CONVERT MAIL REPLACING MSGFILE
The file is converted. The MSGFILE now includes the information that was in the MAIL
file.
164 Batch Administration Guide
Appendix E: Extract File Layout
This section contains the following topics:
Overview (see page 165)
Extract File Layout (see page 165)
Overview
This appendix contains a list of the records that will be written to an extract file. You will
need to refer to this appendix if you plan to use a report generator.
The file layout shown here is for a user record with a session record. In your extract file,
there may be more than one session record for each user record.
If the extract file contains a profile record, the layout is the same as the user record,
except the field names begin with PIDX instead of UIDX. In addition, any user fields that
refer to profiles or groups are not included in a profile record.
Note: The field positions given specify the relative position of the field in the file.
Extract File Layout
Field
offset
in hex
Field
name
XAPXV PREFIX=XAPX,TYPE=CSECT,CODE=U
000000 XAPXX CSECT
*
* VSAM HEADER PORTION
*
*
000000 XAPXVSMH1 DS 0D
000000 XAPXVSMRD DC A(XAPXVSMHL+XAPXXLEN+0)
Appendix E: Extract File Layout 165
Extract File Layout
000005
000006
00000E
000016
00001E
000026
00002E
000031
000035
RDW
CL1'U' SIGNIFICANT TYPE
CL8 ' 1ST PART OF KEY
CL8' ' 2ND PART OF KEY
CL8' ' USERID OF LAST UPDATER
CL8' ' DATE OF LAST UPDATE
CL8' ' TIME OF LAST UPDATE
XL3
A(0)
NEXT RECORD POINTER
AL1(XAPXVSMAD)
UPDATE INDICATOR FOR THE RECORD
EQU X'80
RECORD HAS BEEN UPDATED
EQU X'40
RECORD HAS BEEN ADDED
EQU X'20
RECORD HAS BEEN DELETED
IF THIS FLAG IS ON AT THE TIME THE RECORD IS BEING
READ, THE PRIMARY USE OF THIS SEGMENT IS NOT ACTIVE.
EQU X'04
SEGMENT IS NOT USED FOR PRIMARY USE
IF THIS FLAG IS ON AT THE TIME THE RECORD IS BEING
WRITTEN, THE SEGMENT WILL NOT BE WRITTEN TO THE FILE.
EQU X'02
SEGMENT IS UNUSED
DC AL1(0) THE VERSION ID OF THE FIRST SEGMENT
DC AL2(4+XAPXXLEN)
LENGTH OF FIRST SEGMENT IF MULTI-SEGMENT
DS OF
DATA OF FIRST SEGMENT
XAPXVSMH1
LENGTH OF HEADER
XAPXVSMK0 DC
XAPXVSMK1 DC
XAPXVSMK2 DC
XAPXVSMLU DC
XAPXVSMDU DC
XAPXVSMTU DC
DS
XAPXVSMNR DC
XAPXVSMUT DC
XAPXVSMUP
XAPXVSMAP
XAPXVSMDE
*
*
XAPXVSMS1
*
*
XAPXVSMD1
000036 XAPXVSMV1
000037 XAPXVSM#1
000038 XAPXVSM$1
*
*
*
000038 XAPXXID
00003C XAPXMEN#
000040 XAPXNPT
000048 XAPXACI
000050 XAPX0FCB
000054 XAPXFLAG
XAPXVSYN
XAPXNPRF
XAPXDEL
000055 XAPXDSP
000056 XAPXDES
000066 XAPXFCBA
XAPXFP01
DC
DC
DC
DC
DC
DC
EQU
EQU
EQU
DC
DC
DC
EQU
CL4'APX'
A(0)
CL8' '
CL8' '
F'0'
XL1'00'
X'80'
X'40'
X'20'
XL1'00'
XL32'00'
XL1'00'
X'80'
EYECATCHER
ORDER OF APPL IN APPL MENU
NPT NAME
ACI NAME
FLAGS
ON SAYS WE'RE PART OF A VSAM RECORD
NPRF BIT AS IN TPX
*DELETED* FLAG AS IN TPX
DISPLAY FLAG (NOT USED)
DESCRIPTION (NOT USED)
USER MAY CHANGE ACI PARM &&P1
XAPXFP02
EQU X'40'
XAPXFP03
EQU X'20'
XAPXFP04
EQU X'10'
XAPXFP05
EQU X'08'
USER MAY CHANGE ACI PARM &&P2
USER MAY CHANGE ACI PARM &&P3
USER MAY CHANGE ACI PARM &&P4
USER MAY CHANGE ACI PARM &&P5
166 Batch Administration Guide
Extract File Layout
XAPXFP06
EQU X'04'
XAPXFP07
EQU X'02'
XAPXFP08
EQU X'01'
USER MAY CHANGE ACI PARM &&P6
USER MAY CHANGE ACI PARM &&P7
USER MAY CHANGE ACI PARM &&P8
000067 XAPXFCBB
XAPXFP09
DC XL1'00'
EQU X'80'
USER MAY CHANGE ACI PARM &&P9
XAPXFP10
EQU X'40'
XAPXFP11
EQU X'20'
XAPXFP12
EQU X'10'
XAPXFP13
EQU X'08'
XAPXFP14
EQU X'04'
XAPXFP15
EQU X'02'
XAPXFP16
EQU X'01'
USER MAY CHANGE ACI PARM &&P10
USER MAY CHANGE ACI PARM &&P11
USER MAY CHANGE ACI PARM &&P12
USER MAY CHANGE ACI PARM &&P13
USER MAY CHANGE ACI PARM &&P14
USER MAY CHANGE ACI PARM &&P15
USER MAY CHANGE ACI PARM &&P16
000068 XAPXFCBC
XAPXFACI
DC XL1'00'
EQU X'80'
USER MAY CHANGE LOGON ACI SCRIPT NAME
XAPXFP10
EQU X'40'
XAPXFP11
EQU X'20'
XAPXFP12
EQU X'10'
XAPXFP13
EQU X'08'
USER MAY CHANGE MENU ORDER
USER MAY CHANGE NPT NAME
USER MAY CHANGE DISPLAYABLE FLAG
000069 XAPXFCBD
00006A XAPXFCBE
XAPXFCB#
00006B
00006C
00007C XAPXL01
00007D XAPXL02
00007E XAPXL03
00007F XAPXL04
000080 XAPXL05
000081 XAPXL06
000082 XAPXL07
000083 XAPXL08
000084 XAPXL09
000085 XAPXL10
DC
DC
EQU
DC
DC
DC
DC
DC
DC
DC
DC
DC
DC
DC
DC
USER MAY CHANGE DESCRIPTION
XL1'00' NOT USED AT PRESENT
XL1'00' NOT USED AT PRESENT
*-XAPXFCBA
XL1'00' RESERVED
XL16'00' RESERVED
AL1(0)
AL1(0)
AL1(0)
AL1(0)
AL1(0)
AL1(0)
AL1(0)
AL1(0)
AL1(0)
AL1(0)
Appendix E: Extract File Layout 167
Extract File Layout
000086
000087
000088
000089
00008A
00008B
00008C
00008D
00008E
00008F
000090
000091
000092
000093
000094
000095
000096
000097
000098
000099
00009A
00009B
XAPXL11
XAPXL12
XAPXL13
XAPXL14
XAPXL15
XAPXL16
XAPXP01
XAPXP02
XAPXP03
XAPXP04
XAPXP05
XAPXP06
XAPXP07
XAPXP08
XAPXP09
XAPXP10
XAPXP11
XAPXP12
XAPXP13
XAPXP14
XAPXP15
XAPXP16
000000
000000
000004
000005
00000D
000015
00001D
000025
00002D
000030
VINDEX
VUSRRDW
VUSRRTYP
VUSRKNME
VUSR$BLK
VUSRLUPD
VUSRDUPD
VUSRTUPD
VUSRNXTR
VUSRHDR#
000034 VUSRUPDT
VIDXUPDT
VIDXADD
VIDXDEL
VIDXCOMN
*
*
000035 VUSRVER1
*
*
000036 VUSRLEN1
168 Batch Administration Guide
DC AL1(0)
DC AL1(0)
DC AL1(0)
DC AL1(0)
DC AL1(0)
DC AL1(0)
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
DC AL64'00'
ORG XAPXFLAG
DC AL1(XAPXNPRF)
DSECT
DS F'0'
Length of VSAM record
DS CL1
PROFILE/USER RECORD
DS CL8
USER-NAME & START OF KEY
DS CL8
THE REST OF KEY IS BLANK
DS CL8
USERID OF LAST UPDATER
DS CL8
DATE OF LAST UPDATE
DS CL8
TIME OF LAST UPDATE
DS 3C
UNUSE D
DS A
NO MEANING IN VSAM OR EXTRACT FILES
EQU *-VINDEX INFORMATION.
*
*First segment begins here.
*
DS XL1
UPDATE IND. BYTE
EQU X'80'
RECORD HAS BEEN UPDATED
EQU X'40'
RECORD HAS BEEN ADDED
EQU X'20'
RECORD HAS BEEN DELETED
EQU X'04'
NOT A CA-TPX USER. THE CA-TPX SEGMENT
EXISTS ONLY TO CARRY COMMON INFORMATION.
EQU X'01'
RESERVED FOR VSAMPROF/MERGEPRG
DC X'01'
THE VERSION ID OF THE FIRST SEGMENT
*00 FOR 2.0 AND 3.0
*01 FOR 3.5 (HAS VIEW TABLE AT END)
DS H'0'
LENGTH OF FIRST SEGMENT IF MULTI-SEGMENT
Extract File Layout
000038
VUSRHLEN
000038
00003C
000040
000048
000050
000060
000068
000070
000078
000080
000088
000090
000098
0000A0
0000A1
0000A2
VUSR
UIDXID
UIDXNEXT
UIDXNAME
UIDXPRT
UIDXOWN
UIDXPASS
UIDXPAS1
UIDXPAS2
UIDXPAS3
UIDXACBN
UIDXGRP
UIDXWCHR
UIDXVLVL
*
0000A4 UIDXUCB@
0000A8 UIDXTERM
0000AC UIDXAPPL
*
0000B0 UIDXTOU1
0000B4 UIDXTOU2
*
0000B8 UIDXCMDP
0000BC UIDXOPTB
*
0000C0 UIDXSMAX
0000C4 UIDXSCNT
*
0000C8 UIDXMSGT
0000CC UIDXUSER
0000D0 UIDXSMCB
0000D4 UIDXPTR
*
0000D8 UIDXCTR
0000DA UIDXLANG
0000DC UIDXPATM
0000DE UIDXAINT
0000E0 UIDXLENG
0000E2
0000E4 UIDXLNG2
*
0000E6 UIDXVBRB
0000E7 UIDXHBRB
DS 0F
EQU *-VINDEX
LENGTH OF HEADER AREA
UINDX PREFIX=UIDX,DSECT=NO
DS 0F
DS CL4
CONSTANT 'UIDX' OR 'PROF'
DS A
NO MEANING IN VSAM OR EXTRACT FILES
DS CL8
NAME OF USER
DS CL8
DEFAULT PRINTER FOR SOFTCOPY
DS CL16
NO MEANING IN VSAM OR EXTRACT FILES
DS CL8
OWNER SYSTEM
DS CL8
USER'S PASSWORD (CA-TPX SECURITY ONLY)
DS CL8
NO MEANING IN VSAM OR EXTRACT FILES
DS CL8
NO MEANING IN VSAM OR EXTRACT FILES
DS CL8
NO MEANING IN VSAM OR EXTRACT FILES
DS CL8
NO MEANING IN VSAM OR EXTRACT FILES
DS CL8
ACBNAME RESERVED FOR USER
DS CL8
GROUP NAME USER BELONGS TO
DS X
WINDOW COMMAND CHARACTER
DS X
CA-TPX VIEW SECURITY LEVEL
DS XL2
NO MEANING IN VSAM OR EXTRACT FILES
DS
DS
DS
A
A
A
NO MEANING IN VSAM OR EXTRACT FILES
NO MEANING IN VSAM OR EXTRACT FILES
NO MEANING IN VSAM OR EXTRACT FILES
DS
DS
F
F
USER TIMEOUT VALUE #1
USER TIMEOUT VALUE #2
DS
DS
A
A
NO MEANING IN VSAM OR EXTRACT FILES
NO MEANING IN VSAM OR EXTRACT FILES
DS
DS
F
F
MAX SESSIONS FOR USER
COUNT OF ACTIVE SESSIONS
DS
DS
DS
DS
F
F
A
A
TIME USER LAST CHECKED MESSAGES
NO MEANING IN VSAM OR EXTRACT FILES
NO MEANING IN VSAM OR EXTRACT FILES
NO MEANING IN VSAM OR EXTRACT FILES
DS
DS
DS
DS
DS
DS
DS
H
H
H
H
H
XL2
H
NO MEANING IN VSAM OR EXTRACT FILES
LANGUAGE CODE
COUNT OF ATTEMPTS AT ENTERING CORRECT PSWD
ATTN-ATTN INTER VAL
SIGNIFICANT LENGTH FOR EXTENDED PROFILES
DS
DS
C
C
BACKGROUND VERTICAL BOARDER FOR WINDOWS
BACKGROUND HORIZONTAL BOARDER FOR WINDOWS
LANGUAGE AT KANJI TERMINAL
Appendix E: Extract File Layout 169
Extract File Layout
*
0000E8 UIDXCHAR
*
0000EB UIDXPRSV
0000EC UIDXOCLS
0000ED UIDXUPDC
*
0000EE UIDXSTAT
UIDXDYN
UIDXDEL
UIDXACSS
UIDXNTRF
UIDXATRF
UIDXTNA
UIDXMENU
UIDXHTRF
*
0000EF UIDXSCTY
0000F0 UIDXJKEY
0000F1 UIDXESCK
0000F2 UIDXMKEY
0000F3 UIDXPKEY
*
0000F4 UIDXOPT0
UIDXAMNU
UIDXMAIL
UIDXBRS1
UIDXPROP
UIDXWBRK
UIDXUINF
UIDXDND1
UIDXDND2
*
0000F5 UIDXTOP1
*
0000F6 UIDXTOP2
*
0000F7 UIDXKOPT
UIDXKOK
UIDXKOF
UIDXAFF
UIDXRELR
UIDXNREL
UIDXMSGW
*
0000F8 UIDXTRAC
*
0000F9 UIDXOPT1
UIDXOPTI
170 Batch Administration Guide
DS
CL3' '
ESCAPE CHARACTER STRING
DS
DS
DS
X
X
X
RESERVED BYTE FOR CMD/PRIVILEDGE LEVELS
RESERVED BYTE FOR TPXOPER CMD AUTH CHECKING
RESERVED BYTE FOR USER UPDATE CLASS
DS
EQU
EQU
EQU
EQU
EQU
EQU
EQU
EQU
X
X'01'
X'02'
X'04'
X'08'
X'10'
X'40'
X'20'
X'80'
STATUS OF THIS ENTRY
RESERVED FOR DYNAMIC ALLOCATION
DYNAMICALLY DELETED
ACCESS=SINGLE
USER CAN'T TRANSFER SESSIONS.
USER CAN TRANSFER SESSIONS / INCMP. KILLED
ACCESS=PASS
USER RECONNECTS IN MENU
USER CAN TRANSFER SESSIONS / INCMP. HELD
DS
DS
DS
DS
DS
X
AL1
AL1
AL1
AL1
SECURITY BY USER
JUMP KEY AID
COMMAND KEY AID
MENU KEY AID
PRINT KEY AID
DS
EQU
EQU
EQU
EQU
EQU
EQU
EQU
EQU
X
X'80'
X'40'
X'20'
X'10'
X'08'
X'04'
X'02'
X'01'
USER IS CURRENTLY AT THEIR MENU
GET MAIL FIRST OPTION
AUTOSCROLL - USED BY SCREEN AND EZWINDOWS
PROPAGATE 1ST ACB SELECTED FOR THIS USER
WINDOW BREAKIN OPTION
INDICATES USER INFOR. BUILT IN MERGE PROCESS
DO NOT DISTURB, SET BY USER
RESERVED
DC
AL1(0)
DC
AL1(0)
DS
EQU
EQU
EQU
EQU
EQU
EQU
X
X'01'
X'03'
X'04'
X'10'
X'20'
X'80'
TERM=K/F
TERM=K
TERM=F (IMPLIES K)
USER GOT HERE DUE TO AFFINITY
RELREQ ON
RELREQ OFF
USER HAS MESSAGE WAITING
DS
X
NO MEANING IN VSAM OR EXTRACT FILES
DS X
EQU X'01'
USER SELECTABLE OPTIONS
USER WANTS ONLY ACTIVE SESSIONS IN MENU
Extract File Layout
0000FA
0000FB
0000FC
0000FD
0000FE
0000FF
000100
000100
000108
000114
000128
000144
000148
000149
00014A
00014B
00014C
00014D
00014E
00014F
UIDXOPTV EQU X'02'
USER WANTS TO OVERRIDE OPT=I ON SESSIONS
UIDXCADM EQU X'08'
CLASSIFIED AS A CA-TPX USER ADMINISTRATOR
UIDXCSYS EQU X'10'
CLASSIFIED AS A CA-TPX SYSTEM ADMINISTRATOR
UIDXCOPR EQU X'20'
CLASSIFIED AS A TPXOPER ADMINISTRATOR
UIDXCMST EQU X'40'
CLASSIFIED AS A CA-TPX MASTER ADMINISTRATOR
UIDXSTIC EQU X'80'
UADS BUILT THROUGH ADMINISTRATION
*
UIDXOPT2 DS X
USER SELECTABLE OPTIONS
UIDXPPRP EQU X'01'
PREVIOUSLY PROPAGATED ACB (SIGNON PROCESSING)
UIDXTIMO EQU X'02'
USER HAS BEEN TIMED-OUT
UIDXPTO
EQU X'04'
SCREEN UPDATE PENDING FOR TIMED-OUT USER
UIDXSUSP EQU X'10'
USER SHOULD BE SUSPENDED FROM SIGNON
UIDXTPXP EQU X'20'
USING CA-TPX SECURITY...NEED NEW PASSWORD
UIDXVSAM EQU X'40'
RESERVED
UIDXRMOV EQU X'80'
RESERVED
*
UIDXOPT3 DS X
MISCELLANEOUS FLAGS
UIDXCNVP EQU X'80'
DIALOG IN PROCESS FOR USER
*
*Next three flags must be same as CA-TPX counterparts above
*
UIDXCMSX EQU X'40'
CLASSIFIED AS A CA STX MASTER ADMINISTRATOR
UIDXCSYX EQU X'10'
CLASSIFIED AS A CA STX SYSTEM ADMINISTRATOR
UIDXCADX EQU X'08'
CLASSIFIED AS A CA STX USER ADMINISTRATOR
*
UIDXWMOD DS X'00'
WINDOWS MODE KEY
UIDXVBRF DS C
FOREGROUND VERTICAL BORDER FOR WINDOWS
UIDXHBRF DS C
FOREGROUND HORIZONTAL BORDER FOR WINDOWS
UIDXWOPT DS X'00'
WINDOW OPTIONS
UIDXWRKB EQU X'80'
WINDOW TASK WILL RESTORE KEYBOARD
*
UIDXDNV
EQU X'01'
DO NOT VIEW THIS USER
UIDXALGN DS 0D
REQUIRED FOR ALIGNMENT
UIDXLEN
EQU *-UIDXID
LENGTH OF ONE ENTRY
VUSRDACC DS CL8
DATE RECORD LAST ACCESSED
VUSRPHN# DS CL12
USERS PHONE #
VUSRLOC
DS CL20
USERS LOCATION
VUSRRNME DS CL25
USERS REAL NAME
VUSROFCB DS F
VUSRFCB1 DS XL1
VUSRFCB2 DS XL1
VUSRFCB3 DS XL1
VUSRFCB4 DS XL1
VUSRFCB5 DS XL1
VUSRFCB6 DS XL1
VUSRFCB7 DS XL1
VUSRFCB8 DS XL1
* MAP OF VUSRFCB1:
VUPDSIGN EQU X'80'
RESERVED
Appendix E: Extract File Layout 171
Extract File Layout
VUPDSADD
VUPDPKEY
VUPDACB
VUPDTOU2
VUPDTOP2
VUPDMAIL
VUPDPRT2
* MAP OF
VUPDXFER
VUPDPRT
VUPDSTAT
VUPDJKEY
VUPDESCK
VUPDMKEY
VUPDCHAR
VUPDKOPT
* MAP OF
VUPDTOU1
VUPDTOP1
VUPDSCTY
VUPDSMAX
VUPDPRSV
VUPDLANG
* MAP OF
VUPDPASS
VUPDOWNR
VUPDOCLS
VUPDUCLS
VUPDGRPN
VUPDACC
* MAP OF
VUPDLNG2
VUPDVBRF
VUPDHBRF
VUPDDND1
VUPDPROP
VUPDVBRB
VUPDHBRB
* MAP OF
VUPDWMOD
VUPDWOPT
VUPDWCHR
VUPDVLVL
VUSRNLEN
000150 VUSRPRFL
EQU X'40'
EQU X'20'
EQU X'10'
EQU X'08'
EQU X'04'
EQU X'02'
EQU X'01'
VUSRFCB2:
EQU X'80'
EQU X'40'
EQU X'20'
EQU X'10'
EQU X'08'
EQU X'04'
EQU X'02'
EQU X'01'
VUSRFCB3:
EQU X'80'
EQU X'40'
EQU X'20'
EQU X'10'
EQU X'08'
EQU X'01'
VUSRFCB4:
EQU X'20'
EQU X'10'
EQU X'08'
EQU X'04'
EQU X'02'
EQU X'01'
VUSRFCB5:
EQU X'80'
EQU X'40'
EQU X'20'
EQU X'08'
EQU X'04'
EQU X'02'
EQU X'01'
VUSRFCB6:
EQU X'80'
EQU X'40'
EQU X'20'
EQU X'10'
EQU *-VINDEX
DS XL2
000152 VUSRGRPL
DS
XL2
000154 VUSRVAGL
DS
XL2
172 Batch Administration Guide
USER MAY ADD SESSIONS IN ADMIN
PRINTER KEY
ACB=
TIMEOUT INTERVAL #2
TIMEOUT OPTION #2
GET MAIL FIRST
PRINTER 2 (USER PPS)
TRANSFER =
PRINTER ID
LOGON=
JUMP KEY
COMMAND KEY
MENU KEY
PREFIX CHAR
TERM=
TIMEOUT INTERVAL
TIMEOUT OPTION
SECURITY OPTION
MAX SESSIONS
PRIVILEGED COMMANDS ALLOWED
LANGUAGE
PASSWORD
AFFINITY SYSTEM
TPXOPER AUTH CLASS
USER UPDATE CLASS
GROUP USER BELONGS TO
ACCESS=
DBCS LANGUAGE
FOREGROUND VERTICAL BORDER FOR WINDOWS
FOREGROUND HORIZONTAL BORDER FOR WINDOWS
DO NOT DISTURB
PROPAGATE ACB
BACKGROUND VERTICAL BORDER FOR WINDOWS
BACKGROUND VERTICAL BORDER FOR WINDOWS
WINDOW
WINDOW
WINDOW
CA-TPX
MODE-KEY
MODE-OPTION BYTE
COMMAND CHARACTER
VIEW AUTHORITY LEVEL
LENGTH OF PROFILE LIST FOLLOWED BY THE
LIST OF PROFILE NAMES
LENGTH OF GROUP LIST FOLLOWED BY THE
LIST OF GROUP NAMES
LENGTH OF VIEW AUTHORIZATIONG GROUPS AND LEVELS
Extract File Layout
000156
000000
000001
000003
000007
000007
00000F
00000F
000013
00001B
00001E
00001F
000020
000021
000022
000023
FOLLOWED BY LIST OF GROUP NAMES
EQU *-VUSR
MINIMUM DATA LENGTH OF THE FIRST SEGMENT
EQU *-VINDEX MINIMUM LENGTH OF THE FIRST SEGMENT
DS AL1(0)
THE FLAG BYTE OF THE SECOND SEGMENT
DC X'00'
The Version Id of the second Segment
DC AL2(VUSR#2)
Length of second Segment
DC CL4'STXU'
Eyecatcher of second Segment
XU PREFIX=XU,TYPE=N .
XU
DS 0X
XULOGAPL DS CL8
AUTOLOG APPL NAME
XUCOMMON DS 0X
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* COMMON SB FIELDS FOR IN CORE SB AND VSAM SB RECORD
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
XUTMOUT
DC AL4(0)
TIMEOUT VALUE, MINUTES
XUPSWD
DC CL8' '
PSWD OF USER AT TERMINAL
XUSPLSZ
DC XL3'00' SPILLSZ FROM UADS
*P.CORES1 DC XL1'00' RESERVED FOR FUTURE USE
XUFLAG0
DC XL1'00' SOME MORE FLAGS
XUVSYN
EQU X'80'
ON SAYS WE'RE PART OF VSAM RECORD
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* FLAGS
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
XUMSCFLG DC X'00' MISCELLANEOUS FLAGS
XUSPRNLY EQU X'80' SPOOL TO PRINTER ONLY
XUSPRNDS EQU X'40' SPOOL TO PRINTER AND DATASET ALLOWED
XUTPXSEC EQU X'20' REMEMBER WE ARE USING TPX SECURITY
XUNPVJR
EQU X'10' NEW PSWD VERIFY JUST REQUESTED (CONV01)
XUSPUOK
EQU X'08' AT LOGON, SECURITY PACKAGE SAID USER OK
XUNOPROF EQU X'04' AT LOGON, NO USER PROFILE FOUND
XULU1SDT EQU X'01' SDT HAS BEEN SENT TO LU1 TERMINAL
XUAUTH
DC XL1'00' USER AUTHORIZATION CODE
XUAUPRIV EQU X'80' CLASS A - PRIVILEGED - FULL + ADMINISTRATIVE
XUAUFULL EQU X'40' CLASS B - FULL - ALL BUT ADMISITRATIVE
XUAULIM
EQU X'20' CLASS C - LIMITED - X.25 PLUS SELECTION MENU
XUAUBARE EQU X'10' CLASS D - BARE BONES - X.25 SESSION ONLY
XUAUGEN
EQU X'40' CLASS B - GENERAL CLASS - ALL BUT ADMIN
XUAURES
EQU X'10' CLASS D - RESTRICTED - X.25 SESSION ONLY
XUTERMT
DC CL1' ' TERMINAL TYPE (A = AJ,T = TTY)
XUSOPT
DC XL1'00' SCREEN MODE OPTIONS FOR THIS USER
XUSOALL
EQU X'F0' ALL MODES ALLOWED
XUSOROLL EQU X'80' ROLL MODE ALLOWED
XUSOWRAP EQU X'40' WRAP MODE ALLOWED
XUSOPAGE EQU X'20' PAGE MODE ALLOWED
XUSOAUTO EQU X'10' AUTO MODE ALLOWED
XUMODE
DC CL1' ' PAGE MODE : ROLL/PAGE A TIME
XUMDROLL EQU C'R' ROLL MODE
XUMDPAGE EQU C'P' PAGE MODE
XUMDAUTO EQU C'A' AUTO-PAGE MODE
VUSRDLEN
VUSRVLEN
VUSRUPD2
VUVER2
VULEN2
VUEYE2
Appendix E: Extract File Layout 173
Extract File Layout
XUMDWRAP EQU C'W' WRAP MODE
000024 XUCASE
DC CL1' ' UPPER / LOWER CASE LETTERS
000025 XUTTOTF
DC X'00' TIMEOPT FLAG.
XUTTOTT
EQU X'80' TERM TIMEOUT SPECIFIED ON TIMEOPT
000026 XUMUFLAG DC X'00' EMULATION FLAG
XUMUISON EQU X'80' EMULATION IS ON
XUMUHELP EQU X'40' EMULATION HELP IS IN PROGRESS
XUMUDSN
EQU X'20' ROUTE EMULATION PRINT TO DATASET
XUMUJRNL EQU X'10' JOURNAL ALLOWED FOR EMULATOR SESSIONS
XUMUDBCS EQU X'08' TERMINAL SUPPORTS SO/SI CREATION
XUMUXHLT EQU X'04' TERMINAL SUPPORTS EXTENDED HIGHLIGHTING
XUMUXCLR EQU X'02' TERMINAL SUPPORTS EXTENDED COLOR
XUMUNPT
EQU X'01' USE NPT FOR TERMINAL SETUP
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* COMMON SPOOL INFORMATION
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
000027 XUHEAD1
DC CL50' ' OUTPUT HEADER LINE 1
000059 XUHEAD2
DC CL50' ' OUTPUT HEADER LINE 2
00008B XUHEAD3
DC CL50' ' OUTPUT HEADER LINE 3
0000BD XUEMUDES DC XL1'00' EMULATION OUTPUT DESTINATION
0000BE XUOUTDES DC XL1'00' SPOOL OUTPUT DESTINATION
000OBF XUPRNTCL DC CL1' ' PRINTER CLASS FOR SPOOL REQUESTS
0000C0 XUPCOLS
DC XL3'00' COLS IN PRINTED OUTPUT
0000C4 XUCOPY
DC XL1'00' NUMBER OF COPIES TO BE SENT IN SPOOLING
0000C5 XUCORES2 DC XL1'00' RESERVED FOR FUTURE USE
0000C6 XUCORES3 DC XL1'00' RESERVED FOR FUTURE USE
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* VM SPOOL INFORMATION
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
0000C6 XUSVMHLD DC XL1'00' VM SPOOL HOLD FLAG
0000C7 XUSVMUSR DC CL8' ' VM SPOOL VM USERID
0000CF XUSVMDIS DC CL8' ' VM SPOOL DISTCODE
0000D7 XUSVMDES DC CL8' ' VM SPOOL DESTCODE
0000DF XUSVMFOR DC CL8' ' VM SPOOL FORMS ID
0000E7 XUSVMTAG DC CL24' ' VM SPOOL TAG DATA
0000FF XUSVMSID DC CL24' ' VM SPOOL ID
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* OS/390 SPOOL INFORMATION
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
000107 XUNODEID DC CL8' ' PRINTER DEST FOR SPOOLER REQUESTS
00011F XUPRNTID DC CL8' ' PRINTER DEST FOR SPOOLER REQUESTS
000127 XUPLOTID DC CL8' ' PRINTER DEST FOR PLOTTER REQUESTS
00012F XUSPFCB
DC CL4' ' FORMS CONTROL BUFFER FOR SPOOLING
000133 XUDSN
DC CL44' ' SPOOLER DATASET
00015F XUSPOLUN DC CL8' ' SPOOL FILE UNIT NAME
000167 XUSPOLUL DC XL1'00' SPOOL FILE UNIT NAME LENGTH
000168 XUDISP
DC CL3' ' SPOOLER DSN DISP
00016B XUVOL
DC CL6' ' SPOOLER DSN VOL
000171 XUPLOTCL DC CL1' ' PRINTER CLASS FOR PLOTTER REQUESTS
174 Batch Administration Guide
* * * * *
*
* * * * *
* * * * *
*
* * * * *
Extract File Layout
000172 XUPCOPY
DC XL1'00' NUMBER OF COPIES TO BE SENT IN PLOTTING
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* VM ACI INFORMATION
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
000173 XUACIFN
DC CL8' '
ACIPATH FILENAME
00017B XUACIFT
DC CL8' '
ACIPATH FILETYPE
000183 XUACIFM
DC CL2' '
ACIPATH FILEMODE
000185 XUACIUSR DC CL8' '
ACIPATH USERID
00018D XUACIVAD DC CL4' '
ACIPATH VIRTUAL ADDR
000191 XUACIPWD DC CL8' '
ACIPATH USERID PASSWORD
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* OS/390 ACI INFORMATION
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
000199 XUACIDSL DC AL2(0) LENGTH OF SBACIDSN
00019B XUACIDSN DC CL44' '
USER ACIDSN
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* RESERVED FIELDS
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
0001C7 XUCORES4 DC AL4(0)
0001CB XUCORES5 DC AL4(0)
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* END OF COMMON SB FIELDS FOR IN CORE SB AND VSAM SB RECORD
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
XUCOMLEN EQU *-XUCOMMON
********************************************
* USER SELF-UPDATE-CLASS/SET-BY-ADMIN BITS *
********************************************
0001CF XUSROFCB DS AL4
0001D3 XUSRFCB0 DC XL1'00'
XUPDPSWD EQU X'80'
USER MAY CHANGE HIS PASSWORD (FOR SECURE=STX)
XUPDAUTH EQU X'40'
USER MAY CHANGE HIS AUTH CLASS
XUPDLGAP EQU X'20'
USER MAY CHANGE STARTUP APPLNAME (LOGAPPL)
XUPDTIMO EQU X'10'
USER MAY CHANGE HIS TIMEOUT OPTION
XUPDTIMI EQU X'08'
USER MAY CHANGE HIS TIMEOUT INTERVAL
XUPDUPC
EQU X'04'
USER MAY TURN UPPERCASE CONVERSION ON/OFF
XUPDCOLS EQU X'02'
USER MAY CHANGE PRESENTATION WIDTH (COLS=)
XUPDPMOD EQU X'01'
USER MAY CHANGE TTY PRESENTATION MODE (R,P,A,W)
0001D4 XUSRFCB1 DC XL1'00'
XUPDRV1
EQU X'80' RESERVED
XUPDTERM EQU X'40'
USER MAY CHANGE EMULATED TERMINAL TYPE
* *
*
* *
* *
*
* *
* *
*
* *
* *
*
* *
Appendix E: Extract File Layout 175
Extract File Layout
XUPDSPSZ
EQU X'20'
XUPDACID
EQU X'10'
XUPDSADD
EQU X'08'
USER MAY CHANGE NO OF JOURNAL ALLOCATION BLOCKS
USER MAY CHANGE ACIDSN
USER MAY ADD SESSIONS IN SELF-MAINT
THIS FIELD HAS SAME FUNCTION AS VUPDSADD IN TPX
*
XUPDAPFN
EQU X'04'
XUPDAPFT
EQU X'02'
XUPDAPFM
EQU X'01'
USER MAY CHANGE VM ACI FILENAME
USER MAY CHANGE VM ACI FILETYPE
0001D5 XUSRFCB2
XUPDAPLU
XUPDAPLV
XUPDAPLP
XUPDEMUJ
XUPDESD
XUPDSHD1
XUPDSHD2
XUPDSHD3
0001D6 XUSRFCB3
XUPDMJSD
XUPDMVOL
XUPDMDSN
XUPDMDSP
XUPDMUNT
XUPDSCLS
XUPDSCOP
XUPDMPRT
0001D7 XUSRFCB4
XUPDMFCB
176 Batch Administration Guide
USER
DC XL1'00'
EQU X'80'
USER
EQU X'40'
USER
EQU X'20'
USER
EQU X'10'
USER
EQU X'08' USER
EQU X'04'
USER
EQU X'02'
USER
EQU X'01'
USER
DC XL1'00'
EQU X'80'
USER
EQU X'40'
USER
EQU X'20'
USER
EQU X'10'
USER
EQU X'08'
USER
EQU X'04'
USER
EQU X'02'
USER
EQU X'01'
USER
DC XL1'00'
EQU X'80'
USER
MAY CHANGE VM ACI FILEMODE
MAY CHANGE VM ACIPATH LINK USERID
MAY CHANGE VM ACIPATH LINK VIRTUAL ADDRESS
MAY CHANGE VM ACIPATH LINK PASSWORD
MAY TURN HISEMU JOURNALING CAPABILTIY ON/OFF
MAY CHANGE EMULATION SPOOL DESTINATION
MAY CHANGE HIS HEADER1 FOR SPOOL BANNER
MAY CHANGE HIS HEADER2 FOR SPOOL BANNER
MAY CHANGE HIS HEADER3 FOR SPOOL BANNER
MAY CHANGE HIS JOURNAL SPOOL DEST (OS/390)
MAY CHANGE HIS SPOOL-TO-FILE VOLUME (OS/390)
MAY CHANGE HIS SPOOL-TO-FILE DSN (OS/390)
MAY CHANGE HIS SPOOL-TO-FILE DISP (OS/390)
MAY CHANGE HIS SPOOL-TO-FILE UNITNAME (OS/390)
MAY CHANGE HIS SPOOL-TO-PRINTER CLASS
MAY CHANGE HIS SPOOL-TO-PRINTER NO OF COPIES
MAY CHANGE HIS SPOOL PRINTER ID (OS/390)
MAY CHANGE HIS SPOOL-TO-PRINTER FCB (OS/390)
Extract File Layout
XUPDVUID
EQU X'40'
XUPDVFRM
EQU X'20'
USER MAY CHANGE HIS SPOOL USERID (VM)
XUPDVDC
XUPDVTAG
XUPDVHOL
XUPDVDIS
XUPDVSID
0001D8 XUSRFCB5
XUPDPLC
XUPDPLI
XUPDPL#
XUPDROLL
XUPDPAGE
XUPDAPAG
XUPDWRAP
0001D9
0001DA
0001DB
0001DC
000000
000000
000004
000005
00000D
000015
00001D
000025
000030
000034
XUPDRPAW
XUSRFCB6
XUSRFCB7
XUSRFCB8
XUSRFCB9
XUSRFCB#
XULENGTH
XU#2
VENTRY
VSESRDW
VSESRTYP
VUSESNME
VSESNAME
VSESLUPD
VSESDUPD
VSESTUPD
VSESNXTR
VSESUPDC
VSESUPDT
VSESADD
VSESDELT
000038
VSESHLEN
USER MAY CHANGE HIS SPOOL FORMS (VM)
EQU X'10' USER MAY CHANGE HIS SPOOL DESTCODE (VM)
EQU X'08'
USER MAY CHANGE HIS SPOOL TAG (VM)
EQU X'04'
USER MAY CHANGE HIS SPOOL HOLD OPTION (VM)
EQU X'02'
USER MAY CHANGE HIS SPOOL DISTCODE (VM)
EQU X'01'
USER MAY CHANGE HIS SPOOLID (VM)
DC XL1'00'
EQU X'80' FCB BIT FOR MSPS PLOTTER CLASS
EQU X'40' FCB BIT FOR MSPS PLOTTER ID
EQU X'20' FCB BIT FOR MSPS PLOTTER # OF COPIES
EQU X'10'
FCB BIT FOR ROLL PRESENTATION MODE
EQU X'08'
FCB BIT FOR PAGE PRESENTATION MODE
EQU X'04'
FCB BIT FOR AUTOPAGE PRESENTATION MODE
EQU X'02'
FCB BIT FOR WRAP PRESENTATION MODE
EQU XUPDROLL+XUPDPAGE+XUPDAPAG+XUPDWRAP
DC XL1'00'
NOT USED AT PRESENT
DC XL1'00'
NOT USED AT PRESENT
DC XL1'00'
NOT USED AT PRESENT
DC XL1'00'
NOT USED AT PRESENT
EQU *-XUSRFCB0
EQU *-XU
EQU *-XUUPD2
COPY VENTRY
DSECT
DC F'0'
DS CL1
PROFILE/USER SESSION RECORD
DS CL8
USER-NAME & START OF KEY
DS CL8' '
SESSID IS THE REST OF THE KEY
DS CL8
USERID OF LAST UPDATER
DS CL8
DATE LAST UPDATED
DS CL8
TIME LAST UPDATED
DS A
NO MEANING IN VSAM OR EXTRACT FILES
DS XL1
UPDATE IND. BYTE
EQU X'80'
RECORD HAS BEEN UPDATED
EQU X'40'
RECORD HAS BEEN ADDED
EQU X'20'
RECORD HAS BEEN DELETED
DS 0F
EQU *-VENTRY LENGTH OF HEADER AREA
Appendix E: Extract File Layout 177
Extract File Layout
000038
000038
00003C
000040
000048
000050
000058
000060
000068
000070
000078
000080
000084
000088
00008C
000090
000094
000098
00009A
00009B
00009C
00009D
00009E
00009F
0000A0
0000A1
178 Batch Administration Guide
VSES
VSESID
VSESNEXT
VSESAPPL
UENTUSER
UENTACB
UENTMODE
UENTSCRP
UENTSCRT
UENTUID
UENTPASS
*
UENTDATA
UENTDAT#
UENTLAB
UENTUPB
UENTSB
UENTTOUT
UENTUFLD
*
UENTLENG
*
UENTTOPT
UENTSLCT
*
UENTROW
UENTPJMP
UENTPRIO
*
UENTSTAT
UENTDEL
UENTSTRT
UENTTNA
UENTDYN
UENTNACL
UENTTMEO
UENTPRFU
UENTAUTH
UENTOPT
UENTOPTK
UENTOPTI
UENTSIGN
UENTNPRF
UENTNCMP
UENTVSAM
UENTSTIC
UENTBRS1
*
UENTFLG1
DS
DS
DS
DS
DS
DS
DS
DS
DS
DS
DS
0F
CL4
A
CL8
CL8
CL8
CL8
CL8
CL8
CL8
CL8
CONSTANT '&PRF.'
NO MEANING IN VSAM OR EXTRACT FILES
APPLID OF APPLICATION
USERS NAME FOR SESSION (SESSION-ID)
RESERVED ACBNAME (OR BLANK)
SPECIFIC MODETABLE ENTRY NAME FOR REQSESS
INITIALIZATION SCRIPT NAME
TERMINATION SCRIPT NAME
&USERID OVERRIDE FOR THIS SESSION
&PSWD OVERRIDE FOR THIS SESSION
DS
EQU
DS
DS
DS
DS
DS
A
60
A
A
A
F
F
NO MEANING IN VSAM OR
LENGTH OF SIGNON DATA
NO MEANING IN VSAM OR
NO MEANING IN VSAM OR
NO MEANING IN VSAM OR
SESSION TIMEOUT VALUE
USER FIELD
DS
H
SIGNIFICANT LENGTH AT WRITE TIME
DS
DS
C
C
NO MEANING IN VSAM OR EXTRACT FILES
FUNCTION SELECTION CHARACTER (A,I,V,ETC..)
DS
DS
DS
XL1
XL1
XL1
ROW OF SESSION IN /W SCREEN
JUMP KEY FOR THIS SESSION
PRIORITY OF THE APPLICATION SESSION
DS
EQU
EQU
EQU
EQU
EQU
EQU
EQU
EQU
DS
EQU
EQU
EQU
EQU
EQU
EQU
EQU
EQU
XL1
X'01'
X'02'
X'04'
X'08'
X'10'
X'20'
X'40'
X'80'
X
X'01'
X'02'
X'04'
X'08'
X'10'
X'20'
X'40'
X'80'
STATUS OF THIS ENTRY
DYNAMICALLY DELETED
START=YES SPECIFIED
TERMINAL NETWORK ACCESS - CLSDST,PASS SESSION
&PRF. DYNAMICALLY DEFINED
SKIP ACLPGM THIS TIME
THIS SESSION HAS TIMED-OUT
SKIP ACLPGM THIS TIME
SESSION NOT AUTH. FOR ACTIVATION (DLS)
SESSION OPTIONS
KEEPACB FOR THIS SESSION
INVISIBLE IN THE MENU UNLESS ACTIVE
USER MUST ENTER SIGNATURE TO GET ON
SESSION WAS NOT DEFINED IN A PROFILE
DON'T COMPRESS THIS SESSION
THIS UENTRY IMBEDDED IN A VSAM RECORD
SESSION WAS BUILT THROUGH ADMIN FUNCTION
RESERVED, BUT DEFINED IN CVPC
DS
X
EXTRACT FILES
EXTRACT FILES
EXTRACT FILES
EXTRACT FILES
Extract File Layout
UENTRING
UENTSWCH
UENTSMSG
UENTACTP
UENTAINV
UENTOVAC
UENTBRS7
UENTBRS8
0000A2 UENTUFLG
UENTUFL1
0000A4 UENTCRS1
0000A8
UENTLEN
0000A8 VSESLBLN
0000B0 VSESLABL
0000D0 VSESUDAT
00010C VSESPRM1
00010D VSESPM1D
000128 VSESPRM2
000129 VSESPM2D
000144 VSESPRM3
000145 VSESPM3D
000160 VSESPRM4
000161 VSESPM4D
00017C VSESPRM5
00017D VSESPM5D
000198 VSESPRM6
000199 VSESPM6D
0001B4 VSESPRM7
0001B5 VSESPM7D
0001D0 VSESPRM8
0001D1 VSESPM8D
0001EC VSESOFCB
0001F0 VSESFCB1
0001F1 VSESFCB2
0001F2 VSESFCB3
0001F3 VSESFCB4
0001F4 VSESFCB5
0001F5 VSESFCB6
0001F6 VSESFCB7
0001F7 VSESFCB8
* MAP OF
VUPESIGN
VUPEROW
VUPENCMP
VUPEOPND
VUPEOVAC
* MAP OF
VUPEKACB
EQU X'80'
EQU X'40'
EQU X'20'
EQU X'10'
EQU X'08'
EQU X'04'
EQU X'02'
EQU X'01'
DS X
EQU X'80'
DS F
DS 0D
EQU *-UENTID
DS CL8
DS CL32
DS CL60
DS CL1
DS CL27
DS CL1
DS CL27
DS CL1
DS CL27
DS CL1
DS CL27
DS CL1
DS CL27
DS CL1
DS CL27
DS CL1
DS CL27
DS CL1
DS CL27
DS F
DS XL1
DS XL1
DS XL1
DS XL1
DS XL1
DS XL1
DS XL1
DS XL1
VSESFCB1:
EQU X'80'
EQU X'40'
EQU X'20'
EQU X'10'
EQU X'08'
VSESFCB2:
EQU X'80'
OUTPUT PENDING OPTION - RING ALARM
OUTPUT PENDING OPTION - SWITCH TO THIS SESS
OUTPUT PENDING OPTION - SEND MESSAGE
BUILT FROM ACT/PROF - USED AT SIGNON
SESSION ALWAYS INVISIBLE, EVEN ACTIVE
OV/OS/390 ACI SESSION
USER AVAILABLE FLAG BYTE
PROTECT FIELDS DESIGNATED ON MENU
DOUBLEWORD ROUNDUP
LENGTH OF ONE ENTRY
NOT
NOT
NOT
NOT
USED
USED
USED
USED
AT
AT
AT
AT
PRESENT
PRESENT
PRESENT
PRESENT
Appendix E: Extract File Layout 179
Extract File Layout
000000
000000
000004
000005
000006
000015
00001D
000025
00002D
00002E
000030
000034
180 Batch Administration Guide
VUPESCRP EQU X'40'
VUPESCRT EQU X'20'
VUPEDATA EQU X'10'
VUPEPJMP EQU X'08'
VUPESTRT EQU X'04'
VUPETOUT EQU X'02'
VUPEACB EQU X'01'
* MAP OF VSESFCB3:
VUPEMODE EQU X'80'
VUPEAPPL EQU X'40'
VUPEPRIO EQU X'20'
VUPETUID EQU X'10'
VUPEPASS EQU X'08'
VUPELAB EQU X'04'
VUPEINV EQU X'02'
VUPEACC EQU X'01'
* MAP OF VSESFCB4:
VUPEPRM1 EQU X'80'
VUPEPRM2 EQU X'40'
VUPEPRM3 EQU X'20'
VUPEPRM4 EQU X'10'
VUPEPRM5 EQU X'08'
VUPEPRM6 EQU X'04'
VUPEPRM7 EQU X'02'
VUPEPRM8 EQU X'01'
VSESVLEN EQU *-VENTRY
**********************************************************************
MLST DSECT
**********************************************************************
Maillist record
MLSTVSMH1 DS
0D
MLSTVSMRD DC
A(MLSTVSMHL+MLSTVDLEN+0)
RDW
MLSTVSMK0 DC
CL1'L'
SIGNIFICANT TYPE
MLSTVSMK1 DC
CL8' '
1ST PART OF KEY
MLSTVSMK2 DC
CL8' '
2ND PART OF KEY
MLSTVSMLU DC
CL8' '
USERID OF LAST UPDATER
MLSTVSMDU DC
CL8' '
DATE OF LAST UPDATE
MLSTVSMTU DC
CL8' '
TIME OF LAST UPDATE
MLSTVSM$S DC
C' '
Selector flag
DS
XL2
MLSTVSMNR DC
A(0)
NEXT RECORD POINTER
MLSTVSMUI DC
AL1(MLSTVSMAD) UPDATE INDICATOR FOR THE RECORD
MLSTVSMUP EQU X'80'
RECORD HAS BEEN UPDATED
MLSTVSMAD EQU X'40'
RECORD HAS BEEN ADDED
MLSTVSMDE EQU X'20'
RECORD HAS BEEN DELETED
MLSTVSMNS EQU X'08'
Do not stamp this record
* IF THIS FLAG IS ON AT THE TIME THE RECORD IS BEING READ, THE PRIMARY
USE OF THIS SEGMENT IS NOT ACTIVE. E.G. SEE VINDEX.
LSTVSMS1 EQU X'04'
SEGMENT IS UNUSED FOR PRIMARY USE
Extract File Layout
000035
000036
000038
000038
00003C
00003D
00003F
* IF THIS FLAG IS ON AT THE TIME THE RECORD IS BEING WRITTEN, THE
SEGMENT WILL NOT BE WRITTEN TO THE FILE.
LSTVSMD1 EQU X'02'
SEGMENT IS UNUSED
LSTVSMRR EQU X'01'
REAL USER SESSION RECORD (USED BY MERGE/ADMIN)
LSTVSMV1 DC
AL1(0)
THE VERSION ID OF THE FIRST SEGMENT
LSTVSM#1 DC
AL2(4+MLSTVDLEN)
LENGTH OF FIRST SEGMENT IF MULTI-SEGMENT
LSTVSM$1 DS
0F
Data of first segment
LSTVSMHL EQU *-MLSTVSMH1 LENGTH OF HEADER
LSTOWN EQU
MLSTVSMK1,8,C'C'
LSTID
EQU
MLSTVSMK2,8,C'C'
LST$SEL EQU
MLSTVSM$S,1,C'C'
LSTEYE DC
CL4'MLST'
EYECATCHER
---------------------------------------------------------------------LSTFLAG DC
AL1(MLSTPUBL+MLSTVISI)
LSTPUBL EQU
128
If on, this maillist has public use
LSTVISI EQU
64
If on, this maillist is visible
LSTBRWSE EQU 1
If on, this maillist is being browsed. All
variables are read-only
---------------------------------------------------------------------LSTTTAR DC
AL1(MLSTUSER)
What kind of targets are found in this list?
......................................................................
CA-TPX mail target types
Len Description
......................................................................
LSTUSER EQU
1
8 *Userids
LSTLIST EQU
2
16 *Maillistids
LSTTERM EQU
3
8 *Terminalids
LSTGRP EQU
4
8 *Administrative groupids
LSTAPPL EQU
5
8 *Applids
LSTACTA EQU
6
8 *ActiveApplids
LSTSESS EQU
7
8 *MenuSessionids
LSTACTS EQU
8
8 *ActiveMenuSessionids
LSTNAME EQU
9
25 *UserNames
LSTMSOU EQU
10
16 *Userids
LSTBULL EQU
11
*Bulletin
LSTANB EQU
12
*Application news bulletin
LSTCOMP DC
X'00' What kind of compression used?
---------------------------------------------------------------------The label that follows begins a series of variable length fields.
Each field is delimited by a null (X'00'). The first field is the
title of the maillist. All other fields are the entries of the list
The last entry is followed by an extra null.
---------------------------------------------------------------------LSTITLE DC
X'000000'
LSTVDLEN EQU *-MLSTEYE
LSTVLEN EQU
*-MLSTV
**********************************************************************
LOCV
DSECT
01-VMAIL
Appendix E: Extract File Layout 181
Extract File Layout
000000
000000
000004
000005
00000D
000015
00001D
000025
00002D
00002E
000030
000034
000035
000036
000038
000038
00003C
000040
000051
182 Batch Administration Guide
**********************************************************************
Mail locator record
4.0
---------------------------------------------------------------------LOCVSMH1 DS 0D
02-XVSAM
LOCVSMRD DC A(MLOCVSMHL+MLOCVDLEN+0)
RDW
02-XVSAM
LOCVSMK0 DC CL1'X'
SIGNIFICANT TYPE
02-XVSAM
LOCVSMK1 DC CL8' '
1ST PART OF KEY
02-XVSAM
LOCVSMK2 DC CL8' '
2ND PART OF KEY
02-XVSAM
LOCVSMLU DC CL8' '
USERID OF LAST UPDATER
02-XVSAM
LOCVSMDU DC CL8' '
DATE OF LAST UPDATE
02-XVSAM
LOCVSMTU DC CL8' '
TIME OF LAST UPDATE
02-XVSAM
LOCVSM$S DC C' '
Selector flag
4.0 02-XVSAM
DS
XL2
02-XVSAM
LOCVSMNR DC A(0)
NEXT RECORD POINTER
02-XVSAM
LOCVSMUI DC AL1(MLOCVSMAD+MLOCVSMNS)
X02-XVSAM
UPDATE INDICATOR FOR THE RECORD
4.0
LOCVSMUP EQU X'80'
RECORD HAS BEEN UPDATED
02-XVSAM
LOCVSMAD EQU X'40'
RECORD HAS BEEN ADDED
02-XVSAM
LOCVSMDE EQU X'20'
RECORD HAS BEEN DELETED
02-XVSAM
LOCVSMNS EQU X'08'
Do not stamp this record
4.0 02-XVSAM
IF THIS FLAG IS ON AT THE TIME THE RECORD IS BEING READ, THE PRIMARY
USE OF THIS SEGMENT IS NOT ACTIVE. E.G. SEE VINDEX.
LOCVSMS1 EQU X'04'
SEGMENT IS UNUSED FOR PRIMARY USE
02-XVSAM
IF THIS FLAG IS ON AT THE TIME THE RECORD IS BEING WRITTEN, THE
SEGMENT WILL NOT BE WRITTEN TO THE FILE.
LOCVSMD1 EQU X'02'
SEGMENT IS UNUSED
02-XVSAM
LOCVSMRR EQU X'01' REAL USER SESSION RECORD (USED BY MERGE/ADMIN) 02-XVSAM
LOCVSMV1 DC AL1(0)
THE VERSION ID OF THE FIRST SEGMENT
02-XVSAM
LOCVSM#1 DC AL2(4+MLOCVDLEN)
X02-XVSAM
LENGTH OF FIRST SEGMENT IF MULTI-SEGMENT
LOCVSM$1 DS 0F
Data of first segment
02-XVSAM
LOCVSMHL EQU *-MLOCVSMH1 LENGTH OF HEADER
02-XVSAM
LOCTO EQU MLOCVSMK1,8,C'C'
01-VMAIL
LOCFROM EQU MLOCVSMLU,8,C'C'
01-VMAIL
LOCDATE EQU MLOCVSMDU,8,C'C'
01-VMAIL
LOCTIME EQU MLOCVSMTU,8,C'C'
01-VMAIL
LOC$SEL EQU MLOCVSM$S,1,C'C'
01-VMAIL
LOCEYE DC
CL4'MLOC'
EYECATCHER
01-VMAIL
---------------------------------------------------------------------LOCEXPD DC
XL4'00'
*Expiration date in STCK form
01-VMAIL
but only left word saved. This
field is NOT adjusted for local
time using CVTTZ.
LOCTXID DC
CL17' '
*Key of text record
---------------------------------------------------------------------LOCFLAG DC
AL1(0)
02-VMAIL
LOCACK EQU 128
If on, this message is to be acknowledged.
02-VMAIL
LOCREAD EQU 64
If on, this message has been seen by recipient. 02-VMAIL
LOCWIP EQU 32
If on, this message has been stored as
02-VMAIL
Extract File Layout
"in progress".
LOCOSCD EQU 16
If on, "Only sender can delete".
02-VMAIL
LOCHBAK EQU 8
If on, this message has been acknowledged.
02-VMAIL
LOCBRKN EQU 4
If on, this message was also sent breakin
02-VMAIL
LOCSTOR EQU 2
If on, this message is to be stored
02-VMAIL
LOCSEND EQU 1
If on, this message was also sent
02-VMAIL
000052 LOCFLAG2 DC AL1(0)
02-VMAIL
LOCO2M EQU 128
If on, this message came from OPR2MBX interface 02-VMAIL
LOCISAK EQU 64
If on, this locator is an acknowledgment.
02-VMAIL
LOCOFRM EQU 32
If on, this message came from OPR2MBX interface 02-VMAIL
and OFROM was used.
---------------------------------------------------------------------The label that follows begins a series of variable length fields.
Each field is delimited by a null (X'00'). The first field is
the Id of the target. It is used only in acknowledgements.
---------------------------------------------------------------------000053 LOCTARG DC
X'00'
01-VMAIL
LOCVDLEN EQU *-MLOCEYE
01-VMAIL
LOCVLEN EQU *-MLOCV
01-VMAIL
**********************************************************************
MSGV
DSECT
01-VMAIL
**********************************************************************
Mail message record
4.0
---------------------------------------------------------------------000000 MSGVSMH1 DS 0D
02-XVSAM
000000 MSGVSMRD DC A(MMSGVSMHL+MMSGVDLEN+0)
RDW
02-XVSAM
000004 MSGVSMK0 DC CL1'S'
SIGNIFICANT TYPE
02-XVSAM
000005 MSGVSMK1 DC CL8' '
1ST PART OF KEY
02-XVSAM
00000D MSGVSMK2 DC CL8' '
2ND PART OF KEY
02-XVSAM
000015 MSGVSMLU DC CL8' '
USERID OF LAST UPDATER
02-XVSAM
00001D MSGVSMDU DC CL8' '
DATE OF LAST UPDATE
02-XVSAM
000025 MSGVSMTU DC CL8' '
TIME OF LAST UPDATE
02-XVSAM
00002D MSGVSM$S DC C' '
Selector flag
4.0 02-XVSAM
00002E DS
XL2
02-XVSAM
000030 MSGVSMNR DC A(0)
NEXT RECORD POINTER
02-XVSAM
000034 MSGVSMUI DC AL1(MMSGVSMAD+MMSGVSMNS)
X02-XVSAM
UPDATE INDICATOR FOR THE RECORD
4.0
MSGVSMUP EQU X'80'
RECORD HAS BEEN UPDATED
02-XVSAM
MSGVSMAD EQU X'40'
RECORD HAS BEEN ADDED
02-XVSAM
MSGVSMDE EQU X'20'
RECORD HAS BEEN DELETED
02-XVSAM
MSGVSMNS EQU X'08'
Do not stamp this record
4.0 02-XVSAM
IF THIS FLAG IS ON AT THE TIME THE RECORD IS BEING READ, THE PRIMARY
USE OF THIS SEGMENT IS NOT ACTIVE. E.G. SEE VINDEX.
MSGVSMS1 EQU X'04'
SEGMENT IS UNUSED FOR PRIMARY USE
02-XVSAM
IF THIS FLAG IS ON AT THE TIME THE RECORD IS BEING WRITTEN, THE
SEGMENT WILL NOT BE WRITTEN TO THE FILE.
MSGVSMD1 EQU X'02'
SEGMENT IS UNUSED
02-XVSAM
MSGVSMRR EQU X'01' REAL USER SESSION RECORD (USED BY MERGE/ADMIN) 02-XVSAM
000035 MSGVSMV1 DC AL1(0)
THE VERSION ID OF THE FIRST SEGMENT
02-XVSAM
Appendix E: Extract File Layout 183
Extract File Layout
000036 MSGVSM#1 DC
000038
000038
00003C
000040
000048
00004C
000050
000061
000062
000063
184 Batch Administration Guide
AL2(4+MMSGVDLEN)
X02-XVSAM
LENGTH OF FIRST SEGMENT IF MULTI-SEGMENT
MSGVSM$1 DS 0F
Data of first segment
02-XVSAM
MSGVSMHL EQU *-MMSGVSMH1 LENGTH OF HEADER
02-XVSAM
MSGFROM EQU MMSGVSMLU,8
01-VMAIL
MSGDATE EQU MMSGVSMDU,8
01-VMAIL
MSGTIME EQU MMSGVSMTU,8
01-VMAIL
MSG#LAST EQU MMSGVSM$S+1,2
01-VMAIL
MSGEYE DC
CL4'MMSG'
EYECATCHER
01-VMAIL
---------------------------------------------------------------------MSGEXPD DC
XL4'00'
*Expiration date in STCK form
01-VMAIL
but only left word saved. This
field is NOT adjusted for local
time using CVTTZ.
MSGNODE DC
CL8' '
*Node of sender
01-VMAIL
MSGSYID DC
CL4' '
*Systemid of sender
01-VMAIL
MSG#USE DC
F'0'
*Use count
01-VMAIL
MSGNEXT DC
CL17' '
*Key of next record
01-VMAIL
MSGTTAR DC
AL1(MMSGUSER)
01-VMAIL
What kind of target is MMSGTARG?
......................................................................
CA-TPX mail target types
Len Description
4.0
......................................................................
MSGUSER EQU 1
8 *Userids
02-VMAIL
MSGLIST EQU 2
16 *Maillistids
02-VMAIL
MSGTERM EQU 3
8 *Terminalids
02-VMAIL
MSGGRP EQU 4
8 *Administrative groupids
02-VMAIL
MSGAPPL EQU 5
8 *Applids
02-VMAIL
MSGACTA EQU 6
8 *ActiveApplids
02-VMAIL
MSGSESS EQU 7
8 *MenuSessionids
02-VMAIL
MSGACTS EQU 8
8 *ActiveMenuSessionids
02-VMAIL
MSGNAME EQU 9
25 *UserNames
02-VMAIL
MSGMSOU EQU 10
16 *Userids
02-VMAIL
MSGBULL EQU 11
*Bulletin
02-VMAIL
MSGANB EQU 12
*Application news bulletin
02-VMAIL
---------------------------------------------------------------------MSGFLAG DC
AL1(0)
02-VMAIL
MSGACK EQU 128
If on, this message is to be acknowledged.
02-VMAIL
MSGREAD EQU 64
If on, this message has been seen by recipient. 02-VMAIL
MSGWIP EQU 32
If on, this message has been stored as
02-VMAIL
"in progress".
MSGOSCD EQU 16
If on, "Only sender can delete".
02-VMAIL
MSGHBAK EQU 8
If on, this message has been acknowledged.
02-VMAIL
MSGBRKN EQU 4
If on, this message was also sent breakin
02-VMAIL
MSGSTOR EQU 2
If on, this message is to be stored
02-VMAIL
MSGSEND EQU 1
If on, this message was also sent
02-VMAIL
MSGFLAG2 DC AL1(0)
02-VMAIL
MSGO2M EQU 128
If on, this message came from OPR2MBX interface 02-VMAIL
MSGISAK EQU 64
If on, this locator is an acknowledgment.
02-VMAIL
Extract File Layout
MSGOFRM EQU
32
If on, this message came from OPR2MBX interface 02-VMAIL
and OFROM was used.
---------------------------------------------------------------------000064 MSGCOMP DC
X'00' What kind of compression used?
01-VMAIL
---------------------------------------------------------------------The label that follows begins a series of variable length fields.
Each field is delimited by a null (X'00'). The first field is
the Id of the target. The second field (MMSG$FRM) is the real name
of the sender. The third field (MMSGSUBJ) is subject of
the message. All other fields (MMSGTEXT) are the lines of the
message. The last line is followed by an extra null.
---------------------------------------------------------------------000065 MSGTARG DC
X'0000000000'
01-VMAIL
MSGVDLEN EQU *-MMSGEYE
01-VMAIL
MSGVLEN EQU *-MMSGV
01-VMAIL
Appendix E: Extract File Layout 185
Index
*
*TPX,MDL statement • 101
A
abbreviating batch control statements • 20
ADD MAILMESSAGE statement • 69
ADD statement • 75
ADD USERLIST statement • 72
adding • 26, 29, 33, 44, 57, 58, 75
applications • 75
group authorization • 58
multiple users • 26
profile sessions • 29
profiles • 26, 33
user profiles • 57
user sessions • 29
users • 26, 33
users to a group • 44
View capabilities • 33, 57
APPL statements, defining • 99
application variables • 132
ASA control characters • 83, 91
B
blank spaces in batch control statements • 19
C
CA STX variables • 142
compatibility • 14
control characters for printing reports • 83
control statements for Batch facility • 26, 33, 35, 37,
43, 49, 57, 60, 65, 81, 92, 95, 96, 109, 155, 163
ADD • 26, 57
blank spaces within lines • 19
CONVERT • 163
for MSGFILE and MAIL • 163
COPY • 33, 35
DELETE • 37, 60
EXTRACT • 49
for printing report headings • 92
REPORT • 81
SET • 92, 96
summary of • 155
UPDATE • 43, 65
using aliases in • 109
VDEFINE • 95
control word aliases • 109
CONVERT statement • 163
for MSGFILE and MAIL • 163
converting • 163
MAIL file • 163
MSGFILE file • 163
COPY statement • 34, 35, 76
copying • 76
applications • 76
copying user and profile sessions • 35
D
date in report heading • 93
DELETE MAILMESSAGE statement • 71
DELETE statement • 77
DELETE USERLIST statement • 67
deleting • 77
applications • 77
DISP=MOD parameter • 49
E
extract file • 165
layout • 165
list of records • 165
extract files • 49, 57, 81
creating reports with • 81
creating with EXTRACT statement • 49
DISP=MOD parameter in • 49
updating records with • 57
EXTRACT statement • 49
multiple occurrences of in a single batch job • 49
syntax of • 49
extracting data • 51, 81, 86
specifying criteria for • 51
to produce reports • 81, 86
F
formatting batch reports • 87, 90, 91, 92, 93, 94, 95
default heading • 93
headings • 92
labels • 90
line spacing • 91
Index 187
page breaks • 91
page length • 94
spacing • 87
user-defined variables • 95
G
group authorization • 33, 42, 58
adding • 33, 58
deleting • 42
H
headings in reports • 92, 93
default heading • 93
heading variables for • 92
J
JCL control file • 20
setting up • 20
L
line definitions • 82
M
mail locator variables • 129
mail locators • 49
mail message variables • 130
masking • 52
error options • 52
extract criteria • 52
modifying • 43, 45, 65, 78
application values • 78
profiles • 43, 65
records • 65
sessions • 45
users • 43, 65
O
override record • 40
overriding profile values with batch statements • 28,
30, 44, 46, 66
P
page format, batch reports • 91, 92, 94
headings • 92
page breaks • 91
page length • 94
prefixes, reserved • 95
188 Batch Administration Guide
profiles • 26, 28, 29, 30, 33, 35, 37, 39, 43, 44, 45,
46, 48, 59, 60, 65, 66, 85, 118, 126
adding • 26
adding sessions to • 29
copying • 33
copying sessions from • 35
definitions in extract files • 48
deleting • 37, 60
deleting sessions from • 39, 59
modifying • 43, 65
modifying sessions for • 45, 65
overriding profile values with batch statements •
28, 30, 44, 46, 66
reporting on • 85
session variables for • 126
variables for • 118
Q
quotation marks in REPORT statements • 19
R
RECORD NOT FOUND error • 37, 39
REPORT statement • 81
reports, batch • 82, 83, 84, 85, 86, 87, 90, 91, 92, 93,
95
default heading • 93
defining multiple lines in • 84
example • 85
formatting • 86
headings in • 92
labels in • 90
line definitions • 82
printer control characters • 83, 91
spacing in • 87
specifying variables in • 85
variables in • 95
reserved variable names • 95
RESET INTEGRITY command • 22
S
sessions • 29, 39, 40, 48, 65
adding to a user • 29
deleting from a profile • 39
deleting from a user • 39
merged definitions of • 48
modifying • 65
record • 40
SET statement • 92, 96
Batch • 92, 96
startup procedure • 101
T
time in report heading • 93
U
UPDATE statement • 43, 65, 78
updating • 75
application definitions • 75
updating user administration data • 25
user administration data • 25
updating • 25
user record variables • 113
users • 26, 27, 29, 33, 35, 37, 39, 41, 42, 43, 44, 47,
57, 58, 59, 60, 65, 85, 113, 123
adding • 26, 57
adding profiles to • 29, 58
adding sessions to • 29
adding to a group • 44
assigning CA TPX View authority to • 33
assigning to groups • 27
copying • 33
copying sessions from • 35
deleting • 37, 60
deleting group authority • 42
deleting profiles from • 41
deleting sessions from • 39, 59
merged definitions of • 47
modifying • 43, 65
modifying sessions for • 65
reporting on with batch facility • 85
session variables for • 123
variables for • 113
in UPDATE statement • 43, 65
mail locator • 129
mail message • 130
masking values • 52
page length • 94
profile • 118
profile session • 126
report headings • 92
reserved variable names • 95
user • 113
user profile • 113
user session • 123
user-defined • 95
with a length greater than nine • 88
VDEFINE command • 95
VTAM modeling statements • 99
V
variables • 43, 49, 50, 52, 65, 83, 85, 87, 88, 92, 94,
95, 96, 111, 113, 118, 123, 126, 129, 130, 132, 142
administration • 113
application • 132
assigning values • 96
batch • 111
CA STX • 142
for extracting data • 50, 111, 113
for use in extracting or reporting • 111, 113
in control statements • 19
in EXTRACT statement • 49
in REPORT statement • 83, 85, 87
Index 189
Download PDF
Similar pages