Comma-Separated Value (CSV) Reporting Utility

The Comma Separated Value (CSV) utility lets you extract Master Control File (MCF) and package file information and write it to a CSV-formatted file
ce18
The Comma Separated Value (CSV) utility lets you extract Master Control File (MCF) and package file information and write it to a CSV-formatted file.
2
The CSV file can be downloaded and imported into various software products to create reports. You can extract the following types of information:
  • List approver group
  • List approver group junction (approver relation)
  • List components that are used by element
  • List data set
  • List destination
  • List element
  • List elements using component
  • List environment
  • List package ID
  • List package action summary
  • List package approver group
  • List package SCL
  • List package ship
  • List processor group
  • List SMF data
  • List stage
  • List subsystem
  • List system
  • List type
The CSV utility runs as a stand-alone program under NDVRC1. You build or modify the SCL statements that determine the CSV output. The utility analyzes the contents of the SCL statements that are passed from the CSVIPT01 DD statement. Then it calls API functions to obtain the data. Finally, it reformats the API response block data into the CSV format and returns it to the API where the data is written to the CSV list file.
CSV Input
SCL is used as input to the CSV Utility to request functions. The SCL follows the same conventions as batch requests.
For a complete list of the syntax rules, see SCL Reference.
CSV supports name-masking for some values. For details, see the syntax description for each function. The placeholder character (%) and partial and full wildcarding are supported in many of the FROM parameters. You can use either of the following methods to code full wildcarding in the FROM parameters:
  • Code the keyword followed by an asterisk (*), or
  • Omit the keyword and associated value from the SCL statement
Comments can be added to CSV syntax by placing an asterisk in column one of an SCL statement.
Common TO Clause
The TO clause can be specified in the syntax for each CSV function. The purpose of this clause is to allow you to override the name of the file where the output is returned. If a TO clause is not specified, the default DDNAME used is APIEXTR. If you run a CSV job that contains multiple actions and if you do not specify different list files, only the results of the last action appear in the list file. To write the results of more than one request to the same file, do so by specifying the MOD subparameter on the DISP parameter in the JCL.
If you override the list file name, add the additional DD statements to the JCL.
The syntax of the TO clause is shown next:
├── TO ─┬─┬─ FILe ───┬─
dd-name
───┬───────────────────────────────────────────┤ │ └─ DDName ─┘ │ └─ DSName ─
dataset-name
──┘
Common OPTIONS Keywords
The OPTIONS clause can be specified in the syntax for each CSV function. The OPTIONS clause lets you specify OPTIONS parameters to override default values and to tailor the function specifications.
The syntax of the OPTIONS clause is shown next:
├── OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ──────────────────────────────┤ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ ├─ PATh ─┬─────────────┬───┤ │ ├─ LOGical ◄ ─┤ │ │ └─ PHYsical ──┘ │ ├─┬─ NOSearch ◄ ─┬───────── │ └─ SEArch ─────┘ │ └─ RETurn ─┬───────────┬───┘ ├─ FIRst ◄ ─┤ └─ ALL ─────┘
OPTIONS Parameters Common to All CSV Functions
Four parameters are common to all functions. You can use any of the following parameters in any function statement:
  • DELImiters
    character
    Specifies the one-character value that is used to separate values. The default value is a comma (,).
  • NOCsv
    Formats the CSV utility output in record format, instead of CSV format, that you can read into a program. NOCSV enables you to avoid having to write an API program to extract the output in record format. With NOCSV, the output is formatted the same as the API response structure. No title line appears in the file, no delimiters between values, no quotes surrounding values, and so on. Also the API response header appears at the beginning of each record.
    When the NOCSV option is specified, the BACKOUT field does not appear in the output. When extracting element information using the NOCSV option, ensure that you know whether the element is part of a backed-out package. To determine if the element is part of a backed-out package, examine the program that reads the data to see if the source and target package names, dates, and times are the same. If the source and target are identical, the package is not backed out. If any of the values are different, the element is part of a backed-out package.
    If you upgrade to a new release that changes the output of a CSV function and you have existing CSV jobs that use the NOCSV option, you may need to change your existing programs that read in the CSV output file due to record layout changes.
    For API functions that change with a new release, the output from the functions is upward-compatible. Therefore, if you have existing API programs and you do not recompile them after installing the new release, the response structures that are produced are identical to the output produced by the previous release. Unless you plan to use the new release enhancements for that function, do not reassemble or relink your programs.
    This situation is not the case for CSV functions. CSV output always matches the format of the latest release, because CSV functions call the current
    CA Endevor
    API to produce the output, which is always in sync with the latest release. To accommodate changes in the CSV output, you may need to change your existing programs that read in the CSV file.
  • NOTitle
    By default, a title line is written as the first record in the list file. To suppress the printing of this record, specify the NOTITLE parameter.
  • QUAlifier QUOte
    By default, double quotes are placed around each value in the list file. To change this character to a quote, specify the QUALIFIER keyword followed by the keyword QUOTE.
OPTIONS Parameters Common to Some CSV Functions
You can use the following three parameters for only some of the functions. These parameters are shown in the syntax section for each of the functions for which they are valid.
  • PATh LOGical/PHYsical
    Mapping path. Determines if
    CA Endevor
    should use the physical or logical mapping path as defined in the C1DEFLTS table. The default is logical.
  • NOSearch/SEArch
    Mapping argument. Search across mapping locations or only search at the location specified. The default is nosearch.
  • RETurn FIRst/ALL
    Return only the first or all records that satisfty the request. This parameter is used with an object that exists at more than one location. The default is first.
EOF or EOJ Statement
The EOF or EOJ statement instructs
CA Endevor
to stop parsing the SCL syntax at a particular point. Using this statement eliminates the need to delete manually any statements you do not want
CA Endevor
to process. If no EOF or EOJ statement is coded,
CA Endevor
generates one after the last SCL statement.
CSV Output
Listed next is a sample of how the output appears in the CSV list file. A title record appears first, followed by each detailed data record. In the sample, the "..." that appears at the end of each line represents additional columns.
"SITE ID","ENV NAME","SYS NAME","SBS NAME","STG NAME",... "0","I40","NDVRMVS","BASE","I40STG1",... "0","Q40","NDVRMVS","BASE","Q40STG2",... "0","P40","NDVRB40","BASE","P40STG2",...
The CSV output layouts have the following attributes:
  • The first record that is returned in the output file is a title record, unless the NOTITLE option is present in the request.
  • Values are separated by a delimiter character. The default separation character is a comma. The DELIMITER option can be used to override the default character.
  • Each value is placed in double quotes. The QUOTE option can be used to override this default to change the characters to single quotes.
  • Numeric values are suppressed leading zeros. Character data containing leading zeros is unaffected.
  • The date is always returned in the yyyy:mm:dd format.
  • Time format is always returned in hh:mm:ss:tt format unless otherwise stated. For package functions where only the hour and minutes are available, hh:mm is returned.
CSV Message Reports
CSV-related messages are written to one or two of the following three message files:
  • CSVMSGS1
  • C1MSGSA
  • C1MSGS1
If the CSVMSGS1 file is coded, the
CA Endevor
Syntax Request Report is written to the CSVMSGS1 file. If the CSVMSGS1 file is not present, the
CA Endevor
Syntax Request Report is written to the C1MSGS1 file. The CSV utility uses CSVMSGS1 if both files are present, and fails if neither of the files is present.
If DDNAME C1MSGSA is coded, the API Execution Report is written to this file. If it is not coded, the CSV utility writes the API Execution Report to the same file as the Syntax Request Report.
The
CA Endevor
Syntax Request Report echoes the SCL statements that were coded and lists any syntax errors that were detected.
The
CA Endevor
API Execution Report contains informational, warning, and error messages that are detected while the request was being processed. All field edit and processing messages are written to this report. Return and reason code information, and selection counts are displayed in this report.
Title Line Abbreviations
Standard literal abbreviations are used in the title line that is written as the first record in the CSV output file. The following lists the standard abbreviations and the full word each is associated with:
  • #
    - Number
  • (F)
    - From location
  • (ISO)
    - International Standards Organization
  • (S)
    - Source location
  • (T)
    - To location
  • ACT
    - Action
  • APPR
    - Approver /Approval
  • BYP
    - Bypass
  • CHG
    - Change
  • CMPL
    - Complementary
  • CMPNT
    - Component
  • CNT
    - Count
  • CONSOL
    - Consolidate
  • CORR
    - Correlation
  • CUR
    - Current
  • DEL
    - Delete
  • DEST
    - Package shipment destination
  • DS
    - Data set
  • DSN
    - Data set name
  • ELM
    - Element
  • ENV
    - Environment
  • ERR
    - Error
  • EXEC
    - Execute or Execution
  • EXPND
    - Expand
  • EXT
    - Extension
  • FG
    - Foreground
  • FLG
    - Flag
  • FWD
    - Forward
  • GEN
    - Generate
  • GRP
    - Group
  • HDR
    - Header
  • HIST
    - History
  • IGN
    - Ignore
  • INCL
    - Include
  • (ISO)
    - International Standards Organization
  • LANG
    - Language
  • LIB
    - Library
  • LL
    - Level
  • LL.VV
    - Level.Version
  • LNG
    - Length
  • LOC
    - Location
  • MBR
    - Member
  • MTH
    - Month
  • O/P
    - Output
  • OPT
    - Option
  • OVRD
    - Override
  • PKG
    - Package
  • PREV
    - Previous
  • PROC
    - Processor
  • RC
    - Return Code
  • RCD
    - Record
  • RCV
    - Receive
  • REG
    - Registration
  • REGR
    - Regression
  • REL
    - Release ID
  • REQ
    - Required
  • RETR
    - Retrieve action
  • REV
    - Reverse
  • RMT
    - Remote
  • SBS
    - Subsystem
  • SEV
    - Severity
  • SRC
    - Source
  • STG
    - Stage
  • STMTS
    - Statements
  • SYM
    - Symbol/Symbolic
  • SYS
    - System
  • TBL
    - Table
  • TERM
    - Termination
  • TRANS
    - Transmission
  • TRNSFR
    - Transfer
  • UPDT
    - Update
  • USR
    - User
  • VIO
    - Violation
  • VV
    - Version
List Approver Group Function
The list approver group CSV function lets you extract approver group information from the MCF that satisfies your criteria.
The syntax of the list approver group CSV function is shown next:
►►─ LISt APProver GROup ─
approver-group-name
────────────────────────────────► ►─┬───────────────────────────────────┬──────────────────────────────────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
dataset-name
──┘ ►─┬─────────────────────────────────────────┬────────────────────────────────► └─ FROm ─ ENVironment ─
environment-name
─┘ ►─┬────────────────────────────────────────────────┬─ . ─────────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ └─ QUAlifier QUOte ────────┘
Wildcard, placeholder characters, or both are permitted in the environment and approver group name fields. Approver group information is extracted individually from each environment that meets its selection criteria. Also, the FROm ENVironment clause is optional, and if omitted, the environment name is wild.
Example
LIST APPROVER GROUP * TO FILE CSVFILE.
Result for this example: If two environments (ENVA and ENVB) are defined in the C1DEFLTS table, all approver groups that are defined in ENVA are extracted first, all from the second environment, ENVB, follow.
Extracted Approver Group Data
The output file contains the following types of information:
  • SITE ID
    Site ID
  • ENV NAME
    Environment name
  • STG NAME
    Stage name
  • STG ID
    Stage ID
  • STG #
    Stage number (1/2)
  • APPR GRP NAME
    Approver group name
  • RCD UPDT CNT
    Record update count
  • UPDT DATE
    Last Update date YYYY/MM/DD
  • UPDT TIME
    Last Update time HH:MM:SS:TH
  • UPDT USRID
    User ID associated with last update
  • REL ID
    Record created release ID
  • QUORUM CNT
    Quorum count
  • TITLE
    Approver group title
  • APPR USRID
    Approver user ID. A maximum of 16 approvers can exist for each approver group. The output file contains one APPR USRID field for each approver. An APPR REQ follows each APPR USRID field.
  • APPR REQ
    Required approver flag (Y/N). The output file contains one APPR REQ field for each APPR USRID. The APPR USRID field and APPR REQ field appear in pairs.
  • DISQUALIFICATION
    Setting of the Disqualification option in the approver group definition. Y-- Approver Disqualification processing occurs for inventory areas protected by this approver group. N-- Approver Disqualification processing does not occur for inventory areas protected by this approver group.
List Approver Group Junction Examples
The list approver group junction CSV function lets you extract approver group relation information from the MCF that satisfies your criteria.
The syntax of the list approver group junction CSV function is shown next:
►►─ LISt APProver GROup JUNction ─┬───────────────────────────────────┬────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬──────────────────────────────────────────────┬───────────────────────────► └─ FROm ─┬─ ENVironment ─
environment-name
──┬─┘ ├─ SYStem ─
sys-name
───────────────┤ ├─ SUBsystem ─
subsys-name
─────────┤ ├─ TYPe ─
type-name
────────────────┤ └─┬─ STAge ─
stage-id
────────────┬─┘ └─ STAge NUMber ─
stage-number
─┘ ►─┬────────────────────────────────────────────────┬─ . ─────────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ └─ QUAlifier QUOte ────────┘
  • FROM ENVIRONMENT environment-name SYSTEM system-name SUBSYSTEM subsystem-name TYPE type-name STAGE ID stage-id | STAGE NUMBER stage-no
    Specifies the inventory location for which approver relation information is being extracted.
    • ENVIRONMENT
      Specify an explicit or name-masked value. A name-masked value can include a full (*) or partial (for example, ENV*) wildcard, multiple placeholders (%), or both. You can also fully wildcard the value by leaving the value blank (for example, ENV " "), or by leaving out the ENV keyword and value.
    • SYSTEM, SUBSYSTEM, and TYPE
      Specify these values explicitly (for example, ABC) or specify a wild value by leaving the clause out or leaving the value blank (for example, SYSTEM ‘ ‘). All characters pass the parser check, but wildcard (*) or placeholder (&) characters are not expanded to find matching definitions. You can specify "*" or "&" but these are treated as text values.
    • STAGE ID stage-id | STAGE NUMBER stage-no
      Specify the stage using one of the following stage keywords. If you do not specify either of the keywords and their values, wildcarding is enforced.
      • STAGE ID
        Enter a single alphanumeric stage identifier. Do not use if the Environment is wild. If the Environment is not wild, you can specify STAGE ID "*" but the * is treated as a text value instead of a wildcard.
      • STAGE NUMBER
        Enter *, %, 1, 2, or leave the value blank. However, only a blank is treated as wild. The * and % values are treated as text values.
List Approver Group Examples
The following clauses are equivalent.
LIST APPROVER GROUP JUNCTION * TO FILE CSVFILE FROM ENV ENV*. LIST APPROVER GROUP JUNCTION * TO FILE CSVFILE FROM ENV ENV* SYS ' ' SUB ' ' TYP ' ' STA ' '.
Results for these examples: If two environments (ENVA and ENVB) are defined in the C1DEFLTS table, all approver group junctions that are defined in ENVA are extracted first, all from the second environment, ENVB, follow.
Extracted Approver Group Junction Data
The output file contains the following types of information:
  • SITE ID
    Site ID
  • ENV NAME
    Environment name
  • SYS NAME
    System name
  • SBS NAME
    Subsystem name
  • TYPE NAME
    Type name
  • STG #
    Stage number (1/2 or *)
  • RCD UPDT CNT
    Record update count
  • UPDT DATE
    Update date YYYY/MM/DD
  • UPDT TIME
    Update time HH:MM:SS:TH
  • UPDT USRID
    Update user ID
  • REL ID
    Record created release ID
  • JUNCTION TYPE
    Junction type; ST for standard or EM for Emergency
  • APPR GRP NAME
    Approver group name
List Components Used by Element Function
The list components by element function lets you list the components in use by the element that you specify.
This action has the following format:
►►─ LISt COMPonents USEd by ELEment element ─┬───────────────────┬────────────► └─ FROm ─┤ LOC 1 ├ ─┘ ►─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬──────────────────────────────────────────► │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬─────────────────────────────────────────────────────────────────────┬────► └─ OPTions ─ ¤ ─┬───────────────────────────────────────────────┬─ ¤ ─┘ ├─ FILTer COMPonents WHEre LOCation ─┤ LOC 2 ├ ─┤ ├─ EXClude CIRculars ───────────────────────────┤ ├─ EXClude INDirect ────────────────────────────┤ ├─ EXClude RELated ─────────────────────────────┤ ├─ DELImiters ─ character ──────────────────────┤ ├─ NOCsv ───────────────────────────────────────┤ ├─ NOTitle ─────────────────────────────────────┤ └─ QUAlifier QUOte ─────────────────────────────┘ ►─ . ────────────────────────────────────────────────────────────────────────►◄
Parameters
This action uses the following parameters:
  • LISt USEd COMPonents FOR ELEment element
    LOC
    Extracts a list of components that use the specified element. Optionally, you can limit the search by specifying the element location.
  • OPTions
    • FILTer COMPonents WITh
      LOC
      Filters the ACM data to return only those elements that are found at the specified location. This option eliminates all nonelement output records (member, object, and comment) from the output. It eliminates all related elements also. This point is true even if you wildcard all the location values.
    • EXClude CIRculars
      Filters the ACM data to exclude components that have a circular relationship to the object of your search.
    • EXClude INDirect
      Filters the ACM data to exclude indirectly related components.
    • EXClude RELated
      Filters the ACM data to exclude related components.
  • LOC
    The location fields further qualify the element query object. You can specify the location by the environment, system, subsystem, or type.
    • ENVironment
      environment-name
      Specifies the one- to eight-character name of the environment in which you want to perform your query.
    • SYStem
      system-name
      Specifies the one- to eight-character name of the system in which you want to perform your query.
    • SUBsystem
      subsystem-name
      Specifies the one- to eight-character name of the subsystem in which you want to perform your query.
    • TYPe
      type-name
      Specifies the type of the elements for which you are searching. The type name can be one to eight characters in length.
    • STAge NUMber
      stage-number
      Specifies the number of the stage in which you want to perform your query.
List Data Set Function
The list data set CSV function lets you extract data set information from the MCF that satisfies your criteria.
The syntax of the list data set CSV function is shown next:
►►─ LISt DSName ─┬───────────────────────────────────┬────────────────────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬──────────────────────────────────────────────┬───────────────────────────► └─ FROm ─┬─ ENVironment ─
environment-name
──┬─┘ ├─ SYStem ─
sys-name
───────────────┤ └─┬─ STAge ─
stage-id
────────────┬─┘ └─ STAge NUMber ─
stage-number
─┘ ►─┬────────────────────────────────────────────────┬─ . ─────────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ └─ QUAlifier QUOte ────────┘
Wildcard, placeholder characters, or both are permitted in any of the environment, system, and stage location fields. For each location that meets its selection criteria, data set records are extracted based on the system name criteria. Location is defined as environment and stage.
The FROM clause is optional. All or part of the keyword specification on this clause can be omitted. On an omitted keyword, a wildcard is assumed. Also, when the environment name is wild, the STAge NUMber clause cannot be used. You can either omit the stage clause or specify it through the STAge stage-id clause.
Example
LIST DSN TO FILE CSVFILE FROM ENV * STA * SYS NDVRMVS.
Result for this example: If two environments (ENVA and ENVB) are defined in the C1DEFLTS table, data set records are extracted in the following order:
  1. All records from ENVA, stage 1 under system NDVRMVS
  2. All records from ENVA, stage 2 under system NDVRMVS
  3. All records from ENVB, stage 1 under system NDVRMVS
  4. All records from ENVB, stage 2 under system NDVRMVS
Extracted Dataset Name Data
The output file contains the following types of information:
  • SITE ID
    Site ID
  • ENV NAME
    Environment name
  • SYS NAME
    System name
  • STG NAME
    Stage name
  • STG ID
    Stage ID
  • STG #
    Stage number (1/2 *)
  • DS RCD ID
    Data set record ID
  • DS RCD TYPE
    Data set type; PO, PV, LB, EL, VK, ??. If symbolics appear in the DS NAME field, the RCD TYPE value is ?? for unknown.
  • DS NAME
    Data set name
  • RCD UPDT CNT
    Record update count
  • UPDT DATE
    Update date YYYY/MM/DD
  • UPDT TIME
    Update time HH:MM:SS:TH
  • UPDT USRID
    Update user ID
List Destination Function
The list destination CSV function allows you to produce a list of destinations that packages can be shipped to.
The syntax of the list destination CSV function follows:
►►─ LISt DEStination ─
dest-id
─┬───────────────────────────────────┬─────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬────────────────────────────────────────────────┬─ . ─────────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─
character
─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ └─ QUAlifier QUOte ────────┘
You can specify a wildcard character (*) as the last character in the destination field. You can also use one or more placeholder characters (%) in this field. Do not leave the destination field blank, because that results in a syntax parser error condition.
Extracted Destination Data
The output file contains the following types of information:
  • DEST ID
    Destination id
  • DESCRIPTION
    Destination description
  • TRANS CODE
    Transmission method code Possible values are:
    • B
      Bulk Data Transfer Program, Version 2
    • F
      NetView File Transfer
    • L
      Local (IEBCOPY)
    • M
      Network Data Mover
    • N
      NetView Distribution Manager
    • S
      Bulk Data Transfer Program using NJE/NJI
    • X
      XCOM
  • TRANS DESC
    Transmission method description
  • TRANS NODE
    Transmission node name
  • CMPL FILES
    Complementary files flag (Y/N)
  • HOST DSN PREFIX
    Host data set name prefix
  • HOST DSN DISP
    Host data set disposition. Final disposition of data set. Possible values are DELETE or KEEP
  • HOST DSN UNIT
    Host data set device unit
  • HOST DSN VOLSER
    Host data set volume serial number
  • REMOTE DSN PREFIX
    Remote data set name prefix
  • REMOTE DSN DISP
    Remote data set disposition. Final disposition of data set. Possible values are DELETE or KEEP
  • REMOTE DSN UNIT
    Remote data set device unit
  • REMOTE DSN VOLSER
    Remote data set volume serial number
  • SITE ID
    Site id
  • CREATE DATE
    Record creation date YYYY/MM/DD
  • CREATE TIME
    Record creation time HH:MM
  • CREATE USRID
    User ID that is associated with create
  • UPDT DATE
    Last record update date YYYY/MM/DD
  • UPDT TIME
    Last record update time HH:MM
  • UPDT USRID
    User ID associated with last update
  • IPNAME
    IPNAME specified on the destination definition for an XCOM transmission
  • IPPORT
    IPPORT specified on the destination definition for an XCOM transmission
  • HOST USS PREFIX
    Host path name prefix
  • DISP
    Host path name disposition. Final disposition of the path. Possible values are DELETE or KEEP
  • REMOTE USS PREFIX
    Remote path name prefix
  • DISP
    Remote path name disposition. Final disposition of the path. Possible values are DELETE or KEEP
List Element Function
The list element CSV function allows you to extract element information from the MCF that satisfies the criteria you specify.
The syntax of the list element CSV function follows:
►►─ LISt ELEment ─
element-name
─┬───────────────────────────────────┬──► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬──────────────────────────────────────────────┬─────────────────────► └─ FROm ─┬─ ENVironment ─
environment-name
──┬─┘ ├─ SYStem ─
sys-name
───────────────┤ ├─ SUBsystem ─
subsys-name
─────────┤ ├─ TYPe ─
type-name
────────────────┤ └─┬─ STAge ─
stage-id
────────────┬─┘ └─ STAge NUMber ─
stage-number
─┘ ►─┬──────────────────────────────────────────────────────────┬─────────► └─ DATa ─┬───────────────────────────────────────────────┬─┘ ├─ All ◄ ───────────────────────────────────────┤ ├─ BASic ───────────────────────────────────────┤ └─┬─────────────┬─┬────────────────┬ ─ SUMmary ─┘ ├─ ELEment ◄ ─┤ └─ CHAnge LEVel ─┘ └─ COMPonent ─┘ ►─┬────────────────────────────────────────────────┬───────────────────► └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ ├─ PATh ─┬──────────────┬──┤ │ ├─ LOGical ◄ ──┤ │ │ └─ PHYsical ───┘ │ ├─┬─ NOSearch ◄ ──┬────────┤ │ └─ SEArch ──────┘ │ └─ RETurn ─┬───────────┬───┘ ├─ FIRst ◄ ─┤ └─ ALL ─────┘ ►─┬──────────────────────────────────────────┬─ . ────────────────────►◄ └─ WHEre ─ ¤ ─┬──────────────────────┬─ ¤ ─┘ ├─┤ CCId ├─────────────┤ ├─┤ GENerate ├─────────┤ ├─┤ PROcessor GROup ├──┤ ├─┤ PROcessor TYPe ├───┤ └─┤ PROcessor FAIled ├─┘
Expansion of CCID
├── CCId ─┬────────────────────────┬─┬───────────┬──────────────────────► └─ OF ─┬─ CURrent ◄ ───┬─┘ ├─ EQual ◄ ─┤ ├─ GENerate ────┤ └─ = ───────┘ ├─ LASt ACTion ─┤ ├─ LASt LEVel ──┤ ├─ CHAnge ──────┤ └─ RETrieve ────┘ ►─┬─ ccid ─────────────┬───────────────────────────────────────────────┤ │ ┌─ , ────┐ │ └─ ( ─▼─
ccid
─┴─ ) ─┘ ►►─────────────────────────────────────────────────────────────────────►◄
Expansion of GENERATE
├── GENerate ─ FROm ─ DATE ─
mm
/
dd
/
yy
─┬────────────────┬───────────────┤ └─ TIMe ─
hh
:
mm
─┘ ├── GENerate ─ THRu ─ DATE ─
mm
/
dd
/
yy
─┬────────────────┬───────────────┤ └─ TIMe ─
hh
:
mm
─┘
Expansion of PROCESSOR GROUP
├── PROcessor GROup ─┬───────────┬─┬─
processor-group-name
───┬─────────┤ ├─ EQual ◄ ─┤ │ ┌─ , ──────────┐ │ └─ = ───────┘ └─ ( ─▼─
group name
─┴─ ) ─┘
Expansion of PROCESSOR TYPE
├── PROcessor TYPe ─┬─ GENerate ◄ ─┬────────────────────────────────────┤ ├─ MOVe ───────┤ └─ DELete ─────┘
Wildcard, placeholder characters, or both are permitted in the environment, system, subsystem, type, element, and stage fields. On nonexplicit environment name specifications, elements are extracted based on environment and stage locations, mapping between environment and stage locations is not supported.
Default mapping options on nonexplicit environment name requests are: PATH PHYSICAL, NOSEARCH, and RETURN ALL. The PATH LOGICAL, SEARCH and RETURN FIRST clauses are invalid on nonexplicit environment name requests. Default mapping options on explicit environment name requests are: PATH LOGICAL, NOSEARCH, and RETURN FIRST.
The FROM clause is optional. All or part of the keyword specification on this clause can be omitted. On an omitted keyword, a wildcard is assumed. Also, when the environment name is wild, the STAge NUMber clause cannot be used. You can either omit the stage clause or specify it through the STAge stage-id clause.
The DATA clause is optional. If not specified, the default is DATA ALL. However, DATA ALL does not return change level summary data. To return element change level summary data, specify DATa SUMmary or DATa ELEment CHAnge LEVel SUMmary. To return component change level summary data, specify DATa COMPonent SUMmary or DATa COMPonent CHAnge LEVel SUMmary.
Only one WHERE CCID clause is allowed. If you specify more than one, a syntax error is generated.
If the WHERE CCID statement does not contain an OF parameter, the default OF CURRENT is assumed.
CURRENT CCID compares the CCID values that are specified against the last action, generate, and last level CCIDs associated with an element. If any match is found, the record is selected.
One to eight CCID values can be specified on the WHERE CCID clause. To specify more than one value, place the values in ( ) and separate each value by a comma. For example: CCID OF GEN = (c1,c2,c3,c4,c5,c6,c7,c8).
The WHEre CCId OF CHAnge clause is only valid when the DATa SUMmary or DATa COMPonent SUMmary option is specified. This clause filters the results of the list data summary function that is based on the specified ccids.
Each change level for an element contains a CCID associated with that change. The CCID for each change level is compared against the ccids entered for the WHEre CCId OF CHAnge clause and only those change level summary records that match are returned by the list data summary function.
WHERE GEN clause: To select based on an exact match, code both the GEN FROM and GEN THRU clauses with identical date and time values. If you specify the FROM clause and no THRU clause, records starting at the FROM date and time and later are selected. If you specify the THRU clause and no FROM clause, records starting at the THRU date and time and earlier are selected.
One to eight processor-group-names can be specified on the where processor group parameter. To specify more than one value, place the values in ( ) and separate each value by a comma. For example: PRO GRO = (p1,p2,p3,p4,p5,p6,p7,p8).
Placeholder characters and a wildcard character are allowed in the CCID and PROCESSOR GROUP values.
List Element Example
LIST ELEMENT * TO FILE CSVFILE FROM ENV * STA * SYS * SUB * TYP *.
Result for this example: If two environments (ENVA and ENVB) are defined in the C1DEFLTS table where SYS1/SBS1 and SYS2/SBS2 are defined to both environment, element records are extracted in the following order:
  1. All element records from location ENVA, STAGE 1 under SYS1and SBS1
  2. All element records from location ENVA, STAGE 1 under SYS2 and SBS2
  3. All element records from location ENVA, STAGE 2 under SYS1 and SBS1
  4. All element records from location ENVA, STAGE 2 under SYS2 and SBS2
  5. All element records from location ENVB, STAGE 1 under SYS1 and SBS1
  6. All element records from location ENVB, STAGE 1 under SYS2 and SBS2
  7. All element records from location ENVB, STAGE 2 under SYS1 and SBS 1
  8. All element records from location ENVB, STAGE 2 under SYS2 and SBS2
Extracted Element Data
The following information is contained in the output file. All the information is returned when the ALL option is specified on the DATA clause. Only the basic element information is returned when the BASIC option is specified. ALL is the default, if no DATA clause is specified.
When the option Element Change Level Summary or Component Change Level Summary is specified on the Data clause, only the fields that are specified in the Change Level Summary section are returned.
Basic Element Information
  • RCD TYPE
    Type of response record; M-Master record; B-Basic Master record. The DATA clause parameter determines the value.
  • SITE ID
    Site ID
  • ENV NAME
    Environment name
  • SYS NAME
    System name
  • SBS NAME
    Subsystem name
  • ELM NAME
    Element name
  • FULL ELM NAME
    Full element name
  • TYPE NAME
    Type name
  • STG NAME
    Stage name
  • STG ID
    Stage ID
  • STG #
    Stage number (1/2)
  • STG SEQ #
    Relative stage number (1/2/3,4…..)
  • PROC GRP NAME
    Processor group name
  • UPDT DATE
    Last physical record update date YYYY/MM/DD
  • UPDT TIME
    Last physical record update time HH:MM:SS:TT
  • SIGNOUT ID
    Signout user ID
  • ELM VV
    Current element version number
  • ELM LL
    Current element level number
  • CMPNT VV
    Current component version number
  • CMPNT LL
    Current component level number
  • SIGNOUT DATE
    Signout date
Release ID Information
  • REL ID
    Record created release ID
Last Action Information
  • LAST ACT MOD ELM
    Last element modifying action
  • LAST ACT
    Last action
  • ENDEVOR RC
    CA Endevor
    return code
  • LAST ACT DATE
    Last action date YYYY/MM/DD
  • LAST ACT TIME
    Last action time HH:MM:SS:TT
  • LAST ACT USRID
    Last action userid
  • LAST ACT CCID
    Last action CCID
  • LAST ACT COMMENT
    Last action comment
Element Base Information
  • ELM BASE MBR
    Element base member name
  • ELM BASE DATE
    Element base member date YYYY/MM/DD
  • ELM BASE TIME
    Element base member time HH:MM:SS:TT
  • ELM BASE # STMTS
    Number of statements in base
  • BASE LL
    Base level number
  • BASE COMPRESSED
    Element base compressed flag (Y/N)
  • BASE USRID
    User ID associated with the base level
  • BASE COMMENT
    Comment associated with the base level
Element Delta Information
  • ELM DELTA MBR NAME
    Element delta member name
  • ELM LAST LL DATE
    Element delta member date YYYY/MM/DD
  • ELM LAST LL TIME
    Element delta member time HH:MM:SS:TT
  • ELM LAST LL # STMTS
    Number of statements in delta
  • ELM LAST LL USRID
    User ID associated with the delta level
  • ELM LAST LL CCID
    CCID associated with the delta level
  • ELM LAST LL COMMENT
    Comment associated with the delta level
  • ELM LAST LL # INSERT
    Number of inserts in last level
  • ELM LAST LL # DELETE
    Number of deletes in last level
  • ELM DELTA FORMAT
    Delta format (F/R/I)
Component Base Information
  • CMPNT MBR
    Component base member name
  • CMPNT DATE
    Component base dateYYYY/MM/DD
  • CMPNT TIME
    Component base time HH:MM:SS:TT
  • CMPNT BASE # STMTS
    Number of statements in base component member
  • CMPNT BASE LL
    Component base level number
Component Delta Information
  • CMPNT DELTA MBR NAME
    Component delta member name
  • CMPNT LAST LL DATE
    Component delta date YYYY/MM/DD
  • CMPNT LAST LL TIME
    Component delta time HH:MM:SS:TT
  • CMPNT LAST LL # STMTS
    Number of statements in delta component member
  • CMPNT LAST LL # INSERT
    Number of inserts in last level
  • CMPNT LAST LL # DELETE
    Number of deletes in last level
  • CMPNT DELTA FORMAT
    Delta format (F/R)
  • CMPNT LIST MONITOR
    Component list that is built by monitor flag (M or blank)
  • CMPNT LIST COPIED
    Component list that is copied or restored flag (C or blank)
  • CMPNT LIST LOC
    Component list base that is stored in the delta library flag (D or blank)
Last Element Move Information
  • MOVE DATE
    Element move date YYYY/MM/DD
  • MOVE TIME
    Element move time HH:MM:SS:TT
  • MOVE USRID
    User ID or job name that is associated with the move
Element Processor Information
  • PROC FLG
    Processor flag (0/1/2/3/4)
  • PROC FAILED
    Last processor failed flag (F or blank)
  • LAST PROC DATE
    Last processor date YYYY/MM/DD
  • LAST PROC TIME
    Last processor time HH:MM:SS:TT
  • GENERATE DATE
    Last generate date YYYY/MM/DD
  • GENERATE TIME
    Last generate time HH:MM:SS:TT
  • GENERATE USRID
    User ID associated with last generate action
  • GENERATE CCID
    CCID associated with last generate action
  • GENERATE COMMENT
    Comment associated with last generate action
  • FAILED LIT
    *FAILED*' - if last processor failed execution
  • PROC NAME
    Name of the last processor executed
  • PROC RC
    Processor return code
Last Element Retrieve Information
  • RETR DATE
    Last retrieve date YYYY/MM/DD
  • RETR TIME
    Last retrieve time HH:MM:SS:TT
  • RETR USRID
    User ID associated with last retrieve action
  • RETR CCID
    CCID associated with last retrieve action
  • RETR COMMENT
    Comment associated with last retrieve action
Package Last Executed Against the Element Source Information
  • PKG ID (S)
    Package ID executed against source
  • PKG EXEC DATE (S)
    Date package that is executed against source YYYY/MM/DD
  • PKG EXEC TIME (S)
    Time package that is executed against source HH:MM:SS:TT
Package Last Executed Against the Element Outputs Information
  • BACKED OUT (O)
    The element outputs were created using a package and the outputs are currently backed out (Y or blank)
  • PKG ID (O)
    Package ID executed against outputs
  • PKG EXEC DATE (O)
    Date package that is executed against outputs YYYY/MM/DD
  • PKG EXEC TIME (O)
    Time package that is executed against outputs HH:MM:SS:TT
Package/Element Locking Information
  • PKG ID
    Element that is locked in package ID
  • LOCKED DATE
    Date element locked YYYY/MM/DD
  • LOCKED TIME
    Time element locked HH:MM:SS:TT
Last From
CA Endevor
Location Information
  • SITE ID (F)
    Site ID
  • ENV NAME (F)
    Environment name
  • SYS NAME (F)
    System name
  • SBS NAME (F)
    Subsystem name
  • ELM (F)
    Element name
  • TYPE NAME (F)
    Type name
  • STG # (F)
    Stage number (1/2)
  • ACT THAT UPDT (F)
    Action that updated the from information
  • VV # (F)
    Version number (00-99)
  • LL # (F)
    Level number (001-999)
Retrieve to/Add/Updt from Information
  • ADD/UPDT DSN/PATH (F)
    Add/Update from data set or USS path name
  • ADD/UPDT MBR/FILE (F)
    ADD/Update from member or USS file name
  • RETR DSN/PATH (T)
    Retrieve-to data set or USS path name
  • RETR MBR/FILE (T)
    Retrieve-to member or USS file name
User Data Information
  • USER DATA
    Element user data
Element Source Information
  • NOSOURCE
    Y or N - Whether the element is a sourceless element. If Y, then the element is sourceless, meaning its element source and delta files are not present at this location.
  • BASE VV
    Base version number
  • CMPNT BASE VV
    Component base version number
Alter Action Metadata
  • ALT FIRST DATE
    The date that the first Alter action was performed against this copy of the element. Values are formatted as yyyy:mm:dd or are blank.
  • ALT FIRST TIME
    The time that the first Alter action was performed against this copy of the element. Values are formatted as hh:mm:ss:tt or are blank.
  • ALT LAST DATE
    The date that the last Alter action was performed against this copy of the element. Values are formatted as yyyy:mm:dd or are blank.
  • ALT LAST TIME
    The time that the last Alter action was performed against this copy of the element. Values are formatted as hh:mm:ss:tt or are blank. The value is blank if the Alter action was never run against this instance of the element. If the first date and time matches the last date and time, then the Alter action was only run once.
  • ALT LAST USERID
    The user ID associated with the last Alter action performed against this copy of the element. Values are eight characters or are blank.
  • ALT CUMULATIVE CNT
    The total number of times that Master Control File metadata fields were updated by
    all
    the Alter actions that were performed against this copy of the element. Values are five numerals or are blank.
  • ALT CCG
    Whether the last Alter action updated the Generate CCID for this element. Possible values are Y or N. The value is blank if the Alter action was never run against this instance of the element.
  • ALT CCL
    Whether the last Alter action updated the Last Action CCID for this element. Possible values are Y or N. The value is blank if the Alter action was never run against this instance of the element.
  • ALT CCR
    Whether the last Alter action updated the Retrieve CCID for this element. Possible values are Y or N. The value is blank if the Alter action was never run against this instance of the element.
  • ALT DES
    Whether the last Alter action updated the Description for this element. Possible values are Y or N. The value is blank if the Alter action was never run against this instance of the element.
  • ALT PRG
    Whether the last Alter action updated the Processor Group for this element. Possible values are Y or N. The value is blank if the Alter action was never run against this instance of the element.
  • ALT SGN
    Whether the last Alter action updated the Signout UserID for this element. Possible values are Y or N. The value is blank if the Alter action was never run against this instance of the element.
  • ALT USER DATA
    Whether the last Alter action updated the User Data for this element. Possible values are Y or N. The value is blank if the Alter action was never run against this instance of the element.
Extracted Change Level Summary Data
This data is returned only when the option Element Change Level Summary or Component Change Level Summary is specified on the Data clause.
Element Level Information
  • RCD TYPE
    S - The record type indicating this record is for a Change Level Summar.
  • DATA TYPE
    E or C - The data type indicating this record contains either (E)lement or (C)omponent Change Level Summary data
  • SITE ID
    Site ID
  • ENV NAME
    Environment name
  • SYS NAME
    System name
  • SBS NAME
    Subsystem name
  • ELM NAME
    Element name
  • TYPE
    Type name
  • STG NAME
    Stage name
  • STG ID
    Stage ID
  • STG #
    1 or 2 - Stage number
  • STG SEQ #
    Relative Stage number
  • PROC GRP
    Processor Group
  • UPDT DATE
    Update Date
  • UPDT TIME
    Update Time
  • SIGNOUT ID
    Signout ID
  • ELM VV
    Current Element Version
  • ELM LL
    Current Element Level
  • CMPNT VV
    Current Component Version
  • CMPNT LL
    Current Component Level
  • RCD CNT
    Number of Change Level Summary Records for this Element
Change Level Information
  • RCD #
    0001 through ALELS_RS_RECCNT - Relative summary record number for this instance of an Element
  • CHG VV
    Change Level Version
  • CHG LL
    Change Level
  • CHG USRID
    The user ID associated with this Change Level
  • CHG DATE
    The date that is associated with this Change Level (yyyymmdd)
  • CHG TIME
    The time that is associated with this Change Level (hhmmsstt)
  • # STMTS
    The number of statements that are contained in the Element at this Change Level
  • # INSERT
    The number of inserts that is associated with this Change Level
  • # DELETE
    The number of deletes associated with this Change Level
  • SYNC
    C, S or blank - Indicates whether (blank) this Change Level is a (C)onsolidation Level or a (S)ynchronization Level
  • CCID
    The CCID associated with this Change Level
  • COMMENT
    The comment that is associated with this Change Level
  • FULL ELM NAME
    Element Long Name
List Elements Using Component Function
The list elements using component action lets you list the elements that use the component you specify.
This action has the following format:
►►────────────────────────────────────────────────────────────────────────────► ►─ LISt ELEMENTS USIng COMPonent ─┬─ ELEment ─ element ─┬───────────────────┬──► │ └─ FROm ─┤ LOC 1 ├ ─┘ │ ├─ MEMber ─ member ─┬─────────────────────┬─┤ │ └─ DSName ─ 'dsname' ─┘ │ ├─ OBJect ─ object-text ────────────────────┤ └─ COMMEnt ─ comment-text ──────────────────┘ ►─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬──────────────────────────────────────────► │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬───────────────────────────────────────────────────────────────────┬─ . ──►◄ └─ OPTions ─ ¤ ─┬─────────────────────────────────────────────┬─ ¤ ─┘ ├─ FILTer ELEMENTS WHEre LOCation ─┤ LOC 2 ├ ─┤ ├─ EXClude CIRculars ─────────────────────────┤ ├─ EXClude INDirect ──────────────────────────┤ ├─ EXClude RELated ───────────────────────────┤ ├─ DELImiters ─ character ────────────────────┤ ├─ NOCsv ─────────────────────────────────────┤ ├─ NOTitle ───────────────────────────────────┤ └─ QUAlifier QUOte ───────────────────────────┘
Expansion of LOC 1 and LOC 2
├── ¤ ─┬─ ENVironment ─
environment-name
──┬─ ¤ ───────────────────────────────┤ ├─ SYStem ─
sys-name
───────────────┤ ├─ SUBsystem ─
subsys-name
─────────┤ ├─ TYPe ─
type-name
────────────────┤ └─┬─ STAge ─
stage-id
────────────┬─┘ └─ STAge NUMber ─
stage-number
─┘
Parameters
This action uses the common To clause and some of the common Option clause parameters. For more information, see Common To Clause and Common OPTIONS Keywords. Other parameters used by this action include the following items:
  • LISt ELEMENTS USIng COMPonent
    Extracts a list of elements that use the specified component. Limit the query to a component that is identified by one of the options. You can only code one of the following options:
    • ELEment element
      Specifies a component that matches the specified 1- to 10-character element name. Name masking is allowed.
    • FROm
      LOC 1
      (Optional) Specifies where the element is located.
    • MEMber
      member
      Specifies a component that matches the specified 1- to 10-character member name. Name masking is allowed.
    • DSName '
      dsname'
      (Optional) Specifies the 1- to 44-character data set name for the specified member. Enclose the data set name in single quotes. Name masking is allowed.
    • Object
      object-text
      Specifies a component that matches the related 1- to 70-character object text string. Name masking is not allowed.
    • Comment
      comment-text
      Specifies a component that matches the related 1- to 70-character comment text string. Name masking is not allowed.
  • OPTions
    (Optional) Specifies various options. You can specify one or more of the options; the options are not mutually exclusive.
    • FILTer ELEMENTS WHEre LOCation
      LOC 2
      Filters the ACM data to return only those elements that are found at the specified location.
    • EXClude CIRculars
      Filters the ACM data to exclude elements that have a circular relationship to the object of your search.
    • EXClude INDirect
      Filters the ACM data to exclude elements that are indirectly related to the object of your search.
    • EXClude RELated
      Filters the ACM data to exclude elements that are related components.
  • LOC 1 and LOC 2
    The location fields further qualify the element query object. One or more of the location parameters must be specified. You can specify the location by the environment, system, subsystem, or type. You can also specify stage ID or stage number, but not both.
    • ENVironment
      environment-name
      Specifies the one- to eight-character name of the environment in which you want to perform your query.
    • SYStem
      system-name
      Specifies the one- to eight-character name of the system in which you want to perform your query.
    • SUBsystem
      subsystem-name
      Specifies the one- to eight-character name of the subsystem in which you want to perform your query.
    • TYPe
      type-name
      Specifies the type of the elements for which you are searching. The type name can be one to eight characters in length.
    • STAge
      stage-id
      Specifies the stage ID for the stage in which you want to perform your query.
    • STAge NUMber
      stage-number
Specifies the number of the stage in which you want to perform your query.
List Environment Function
The list environment CSV function allows you to extract environment information from the MCF that satisfies the criteria you specify.
The syntax of the list environment CSV function follows:
►►─ LISt ENVironment ─
environment-name
────────────────────────────────► ►─┬───────────────────────────────────┬────────────────────────────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬────────────────────────────────────────────────┬─ . ──────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ ├─ PATh ─┬─────────────┬───┤ │ ├─ LOGical ◄ ─┤ │ │ └─ PHYsical ──┘ │ ├─┬─ NOSearch ◄ ─┬─────────┤ │ └─ SEArch ─────┘ │ └─ RETurn ─┬───────────┬───┘ ├─ FIRst ◄ ─┤ └─ ALL ─────┘
Wildcard, placeholder characters, or both are permitted in the environment name field. On a nonexplicit environment name, all environments that match its masking criteria are returned in the order in which they appear in the C1DEFLTS table.
Default mapping options on non-explicit environment name requests are: PATH PHYSICAL, SEARCH, and RETURN ALL. The PATH LOGICAL, NOSEARCH, and RETURN FIRST clauses are invalid on nonexplicit environment name requests. Default mapping options on explicit environment name requests are: PATH LOGICAL, RETURN FIRST, and NOSEARCH.
To get a complete list of defined environments, use the wildcard character for the environment name value. To get a mapped environment list, specify the starting environment name and use the SEARCH, PATH LOGICAL and RETURN ALL options. An explicit environment request with PATH PHYSICAL only returns that environment information. The RETURN and SEARCH/NOSEARCH options have no effect.
List Environment Example
LIST ENV * TO FILE CSVFILE.
If two environments (ENVA and ENVB) are defined in the C1DEFLTS table, environment ENVA data appears first, followed by ENVB.
Extracted Environment Data
The output file contains the following types of information:
  • SITE ID
    Site ID
  • ENV NAME
    Environment name
  • TITLE
    Title
  • USR SEC TBL
    User security name table
  • RESRC SEC TBL
    Resource security name table
  • SMF SEC
    SMF security recording (Y/N)
  • SMF ACT
    SMF action recording (Y/N)
  • SMF ENV
    SMF environment recording (Y/N)
  • DB BRIDGE AVAIL
    DB Bridge available (Y/N)
  • DB BRIDGE ACTIVE
    DB Bridge active (Y/N)
  • DB BRIDGE OPT1
    DB Bridge option 1 (Y/N)
  • DB BRIDGE OPT2
    DB Bridge option 2 (Y/N)
  • DB BRIDGE OPT3
    DB Bridge option 3 (Y/N)
  • DB BRIDGE OPT4
    DB Bridge option 4 (Y/N)
List Package ID Function
The list package ID CSV function lets you extract package information from the package file that satisfies your criteria.
The syntax of the list package ID CSV function is shown next:
►►─ LISt PACkage ID ─
package-id
─┬───────────────────────────────────┬─► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬────────────────────────────────────────────────┬───────────────────► └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ └─ PROMotion HIStory ──────┘ ►┬──────────────────────────────────────────────────────────────┬ . ─►◄ └ WHEre ─ ¤ ─┬─────────────────────────────────────────────┬ ¤ ┘ ├─┤ PACkage TYPe ├────────────────────────────┤ ├─┤ ENTerprise ├──────────────────────────────┤ ├─┤ DATE TYPe ├───────────────────────────────┤ ├─┤ STATus ├──────────────────────────────────┤ ├─ APProver
approver-id
──────────────────────┤ ├─ PROMotion ─┬─ A ─┬─────────────────────────┤ │ ├─ P ─┤ │ │ └─ X ─┘ │ ├─ PROMotion TARget ENVironment ─
environment
┤ ├─ PROMotion TARget STAge ─
stage-ID
─────────┤ └─┤ CASt ├────────────────────────────────────┘ ►►─────────────────────────────────────────────────────────────────────►◄
Expansion of PACKAGE TYPE
├── PACkage TYPe ─┬─ S ─┬───────────────────────────────────────────────┤ └─ E ─┘
Expansion of ENTERPRISE
├── ENTerprise ─┬─ A ─┬─────────────────────────────────────────────────┤ ├─ E ─┤ └─ X ─┘
Expansion of DATE TYPE
├── DATE TYPe ─┬─ CR ─┬─ is OLDer THAn ─
ddd
─ DAYs ────────────────────┤ ├─ MO ─┤ ├─ CA ─┤ ├─ AP ─┤ ├─ EX ─┤ ├─ BO ─┤ ├─ BI ─┤ └─ CO ─┘
Expansion of STATUS
├── STATus ─┬───────────┬─┬────────┬─ INEDit ─────┬────────┬────────────┤ ├─ EQual ◄ ─┤ │ ├─ INApproval ─┤ │ └─ = ───────┘ │ ├─ APPROVED ───┤ │ │ ├─ INExecution ┤ │ │ ├─ EXEcuted ───┤ │ │ ├─ COMMitted ──┤ │ │ ├─ DENied ─────┤ │ │ └─ EXECFailed ─┘ │ │ ┌────── , ────────┐ │ └── ( ─▼─┬─ INEDit ─────┬└── ) ──┘ ├─ INApproval ─┤ ├─ APPROVED ───┤ ├─ INExecution ┤ ├─ EXEcuted ───┤ ├─ COMMitted ──┤ ├─ DENied ─────┤ └─ EXECFailed ─┘
Expansion of CAST
├── CASt FROm ─ DATE ─
mm
/
dd
/
yy
─ TIMe ─
hh
:
mm
────────────────────────► ►─ CASt THRU ─ DATE ─
mm
/
dd
/
yy
─ TIMe ─
hh
:
mm
────────────────────────┤
Name masking is permitted for the Package ID, Promotion Target Environment, and the Promotion Target Stage variables.
Parameters
The following parameters can be used with the list package ID function.
  • PROMotion
    Specifies the promotion package type. Valid values are as follows:
    A
    - Return promotion and non-promotion packages.
    P
    - Return only promotion packages.
    X
    - Exclude promotion packages; only return nonpromotion packages.
  • PROMotion TARget ENVironment
    myenvir
    Specifies the promotion package target environment. This field only applies to promotion packages and can only be specified when the promotion package type is A or P. Name masking is supported. You can specify a target environment without specifying a target stage.
  • PROMotion TARget STAge
    stage-ID
    Specifies the promotion package target stage ID. This field only applies to promotion packages and can only be specified when the promotion package type is A or P. Name masking is supported. You can specify a target stage without specifying a target environment.
Extracted Package Data
The output file contains the following types of information.
General Package Information
  • PKG ID
    Package ID
  • SITE ID
    Site ID
  • DESCRIPTION
    Comment or description that is associated with this package
  • PKG TYPE
    Package type. STANDARD or EMERGENCY
  • SHR OPT
    Package shr option (Y/N)
  • BACKOUT FLG
    Package backout enabled flag (Y/N)
  • WINDOW START DATE
    Window start date DDMMMYY
  • WINDOW START TIME
    Window start time HH:MM
  • WINDOW END DATE
    Window end date DDMMMYY
  • WINDOW END TIME
    Window end time HH:MM
  • STATUS
    Package status. IN-EDIT, IN-APPROVAL, DENIED, APPROVED, IN-EXECUTION, EXECUTED, EXEC-FAILED, or COMMITTED.
Package Create/Update Information
  • CREATE DATE
    Date package was created DDMMMYY
  • CREATE TIME
    Time package was created HH:MM
  • CREATE USRID
    User ID associated with the create action
  • UPDT DATE
    Date package header was last updated DDMMMYY
  • UPDT TIME
    Time package header was last updated HH:MM
  • UPDT USRID
    User ID associated with the last package header update
  • SCL DATE
    Date package SCL was last modified DDMMMYY
  • SCL TIME
    Time package SCL was last modified HH:MM
  • SCL USRID
    User ID or jobname that is associated with the last SCL update
Package Correlation Information
  • CORR RCD EXIST
    Correlation records exist flag (Y/N)
  • ENTERPRISE CORR
    Enterprise correlation flag (Y/N) Indicates that the package is an enterprise package
  • # CORR
    Number of correlations that are associated with this package
Package Cast Information
  • CAST RCD EXIST
    Cast records exist flag (Y/N)
  • CAST DATE
    Date package was cast DDMMMYY
  • CAST TIME
    Time package was cast HH:MM
  • CAST USRID
    User ID associated with the cast action
Package Approval Information
  • APPR GRP EXISTS
    Approver group records exist flag (Y/N)
  • APPR DATE
    Date of final approval/denied DDMMMYY
  • APPR TIME
    Time of final approval/denied HH:MM
Package Execution Information
  • EXEC BEGIN DATE
    Package execution begin date DDMMMYY
  • EXEC BEGIN TIME
    Package execution begin time HH:MM
  • EXEC END DATE
    Package execution end date DDMMMYY
  • EXEC END TIME
    Package execution end time HH:MM
  • EXEC USRID
    User ID associated with the execution action
  • EXEC RC
    Execution return code. Field remains blank until the package is executed.
  • ABNORMAL TERM
    Execution of package abnormally terminated flag (Y/N)
Package Backout/Backin Information
  • BACKOUT N/A
    Backout not in effect flag (Y/N)
  • BACKOUT RCD EXIST
    Backout records exist flag (Y/N)
  • PKG BACKED OUT
    Package has been backed out flag (Y/N), or element actions have been backed out (E).
  • PKG BACKOUT/BACKIN BEGUN
    Package backout/backin has begun flag (Y/N)
  • PKG BACKOUT STATUS
    Package backout status. Blank, BACKED-OUT, or ELMBACKOUT.
  • BACKOUT DATE
    Date package was backed out DDMMMYY
  • BACKOUT TIME
    Time package was backed out HH:MM
  • BACKOUT USRID
    User ID associated with the backout action
  • BACKIN DATE
    Date package was backed in DDMMMYY
  • BACKIN TIME
    Time package was backed in HH:MM
  • BACKIN USRID
    User ID associated with the backin action
Package Commit Information
  • COMMIT DATE
    Date package was committed DDMMMYY
  • COMMIT TIME
    Time package was committed HH:MM
  • COMMIT USRID
    User ID associated with the commit action
Promotion Package Information
  • PROM PKG
    Indicates if this is a promotion package. Possible values are Y, N, or blank.
  • PROM RCD EXIST
    Indicates if promotion history records exist.
  • INT PKG ID
    Internal package ID. The PKG ID field contains the external or original package ID. In the case of nonpromotion packages or the current version of a promotion package, these fields contain the same value. For a historic version of a promotion package, this field contains the generated package name that is stored with the package.
  • PKG VERSION
    Package version number. It is zero for nonpromotion packages. For promotion packages, it reflects the sequence of the package headers returned. The current version number is 1, the current-1 is 2, and so on. This field is a calculated one; it is not stored on the package file.
  • PROM PREV PKGID
    Previous promotion package ID. This field is populated in all promotion package headers, except the oldest (first) version.
  • PROM TGT ENV
    Target location environment name that is associated with the move actions within a promotion package at the time of the last successful cast. This field is only populated for promotion packages.
  • PROM TGT STGID
    Target location stage ID associated with the move actions within a promotion package at the time of the last successful cast. This field is only populated for promotion packages.
Miscellaneous Information
  • EXTERNAL SAF
    External SAF flag (Y/N)
Note Information
  • NOTE
    Repeats for each notes line.
ISO Dates and Times
  • UPDT DATE (ISO)
    Date package header was last updated YYYY/MM/DD
  • UPDT TIME (ISO)
    Time package header was last updated HH:MM:SS.TH
  • CREATE DATE (ISO)
    Date package was created YYYY/MM/DD
  • CREATE TIME (ISO)
    Time package was created HH:MM:SS.TH
  • SCL DATE (ISO)
    Date package SCL was last modified YYYY/MM/DD
  • SCL TIME (ISO)
    Time package SCL was last modified HH:MM:SS.TH
  • CAST DATE (ISO)
    Date package was cast YYYY/MM/DD
  • CAST TIME (ISO)
    Time Package was cast HH:MM:SS.TH
  • APPR DATE (ISO)
    Date of final approval/denial YYYY/MM/DD
  • APPR TIME (ISO)
    Time of final approval/denial HH:MM:SS.TH
  • WINDOW START DATE (ISO)
    Execution window start date YYYY/MM/DD
  • WINDOW START TIME (ISO)
    Execution window start time HH:MM:SS.TH
  • WINDOW END DATE (ISO)
    Execution window end date YYYY/MM/DD
  • WINDOW END TIME (ISO)
    Execution window end time HH:MM:SS.TH
  • EXEC BEGIN DATE (ISO)
    Package execution begin date YYYY/MM/DD
  • EXEC BEGIN TIME (ISO)
    Package execution begin time HH:MM:SS.TH
  • BACKOUT DATE (ISO)
    Date package was backed out YYYY/MM/DD
  • BACKOUT TIME (ISO)
    Time package was backed out HH:MM:SS.TH
  • BACKIN DATE (ISO)
    Date package was backed in YYYY/MM/DD
  • BACKIN TIME (ISO)
    Time package was backed in HH:MM:SS.TH
  • COMMIT DATE (ISO)
    Date package was committed YYYY/MM/DD
  • COMMIT TIME (ISO)
    Time package was committed HH:MM:SS.TH
  • EXEC END DATE (ISO)
    Package execution end date YYYY/MM/DD
  • EXEC END TIME (ISO)
    Package execution end time HH:MM:SS.TH
  • CA-7 SCHD DATE (ISO)
    CA-7 schedule date YYYY/MM/DD
  • CA-7 SCHD TIME (ISO)
    CA-7 schedule time HH:MM:SS.TH
User Data Information
  • CVAL
    Component validation flag: Y, N, or W (warn).
List Package Action Summary Function
The list package action summary CSV function let you extract actions that are associated with a package from the package file that satisfies your criteria.
The syntax of the list package action summary CSV function is shown next:
►►─ LISt PACkage ACTion ─┬───────────────────────────────────┬────────────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─ FROm ─ PACkage ─┬──────┬─
package-id
─────────────────────────────────────► └─ ID ─┘ ►─┬────────────────────────────────────────────────┬─ . ─────────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ └─ PROMotion HIStory ──────┘
Name masking is permitted in the package-id field.
Extracted Package Action Summary Data
The output file contains the following types of information:
  • PKG ID
    Package ID
  • SCL STMT#
    SCL statement number
  • SITE ID
    Site ID
  • ELM ACT
    Element action (ADD, GENERATE)
  • ENDEVOR RC
    Highest return code encountered
  • PROC RC
    Highest processor return code encountered
  • BEGIN EXEC DATE
    Package execution begin date YYYY/MM/DD
  • BEGIN EXEC TIME
    Package execution begin time HH:MM
  • END EXEC DATE
    Package execution end date YYYY/MM/DD
  • END EXEC TIME
    Package execution end time HH:MM
  • CCID
    CCID associated with this action
  • COMMENT
    Comment associated with this action
  • UPDT DATE
    Last physical record update date YYYY/MM/DD
  • UPDT TIME
    Last physical record update time HH:MM
  • UPDT USRID
    User ID or jobname that is associated with the last physical record update
  • APPR REQ (S)
    Approval required flag (Y/blank)
  • VALIDATION REQ (S)
    Validation required flag (Y/blank)
  • LOC (S)
    Source location (C-
    CA Endevor
    , F-File or DD name, D-Data set, A-
    CA Endevor
    Archive, P-USS Path)
  • SITE ID (S)
    Site ID
  • ENV NAME (S)
    Environment name
  • SYS NAME (S)
    System name
  • SBS NAME (S)
    Subsystem name
  • TYPE NAME (S)
    Type name
  • STG # (S)
    Stage number (1/2)
  • STG NAME (S)
    Stage name
  • STG ID (S)
    Stage ID
  • VVLL (S)
    Version level (VVLL)
  • DELTA DATE
    Last delta level date YYYY/MM/DD
  • DELTA TIME (S)
    Last delta level time HH:MM
  • GENERATE DATE (S)
    Last generate date YYYY/MM/DD
  • GENERATE TIME (S)
    Last generate time HH:MM
  • PROC DATE (S)
    Last processor date YYYY/MM/DD
  • PROC TIME (S)
    Last processor time HH:MM
  • PREV PKG ID (S)
    Previous package ID associated with source
  • APPR REQ (T)
    Approval required flag (Y/blank)
  • VALIDATION REQ (T)
    Validation required flag (Y/blank)
  • LOC (T)
    Target location (C-
    CA Endevor
    , F-File or DD name, D-Data set, A-
    CA Endevor
    Archive, P-USS Path)
  • SITE ID (T)
    Site ID
  • ENV NAME (T)
    Environment name
  • SYS NAME (T)
    System name
  • SBS NAME (T)
    Subsystem name
  • TYPE NAME (T)
    Type name
  • STG # (T)
    Stage number (1/2)
  • STG NAME (T)
    Stage name
  • STG ID (T)
    Stage ID
  • VVLL (T)
    Version level (VVLL)
  • DELTA DATE
    Last delta level date YYYY/MM/DD
  • DELTA TIME (T)
    Last delta level time HH:MM
  • GENERATE DATE (T)
    Last generate date YYYY/MM/DD
  • GENERATE TIME (T)
    Last generate time HH:MM
  • PROC DATE (T)
    Last processor date YYYY/MM/DD
  • PROC TIME (T)
    Last processor time HH:MM
  • PREV PKG ID (T)
    Previous package ID associated with target
  • ELM (S)
    Source element name
  • DSN/PATH (S)
    Source data set or USS path name
  • MBR/FILE (S)
    Source member or USS file name
  • ELM (T)
    Target element name
  • DSN/PATH (T)
    Target data set or USS path name
  • MBR/FILE (T)
    Target member or USS file name
  • INT PKG ID
    Internal package ID. The PKG ID field contains the external or original package ID. In the case of nonpromotion packages or the current version of a promotion package, these fields contain the same value. For a historic version of a promotion package, this field contains the generated package name that is stored with the package.
  • PKG VERSION
    Package version number. It is zero for nonpromotion packages. For promotion packages, it reflects the sequence of the package headers returned. The current version number is 1, the current-1 is 2, and so on. This field is a calculated one; it is not stored on the package file.
List Package Approver Group Function
The list package approver group CSV function lets you extract package approver group information from the package file that satisfies your criteria.
The syntax of the list package approver group CSV function is shown next:
►►─ LISt PACkage APProver GROup ─┬───────────────────────────────────┬────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─ FROm ─ PACkage ─┬──────┬─
package-id
─────────────────────────────────────► └─ ID ─┘ ►─┬────────────────────────────────────────────────┬─ . ─────────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ └─ PROMotion HIStory ──────┘
Name masking is permitted in the package-id field.
Extracted Package Approver Data
The output file contains the following types of information:
  • PKG ID
    Package ID
  • APPR GRP NAME
    Approver group name
  • ENV NAME
    Approver group Environment
  • SITE ID
    Site ID
  • OVERALL APPR STATUS
    Overall approval status (blank, A or D)
  • APPR GRP TYPE
    Approval group type (S-standard E-external)
  • QUORUM CNT
    Quorum count. Minimum number of approvers that must approve this package.
  • SEQ#
    One record is written for each approver in a group. This field contains an approver sequence number (1 of 16, 2 of 16, etc.).
  • # APPR
    Number of approvers in this group
  • UPDT DATE
    Update date YYYY/MM/DD
  • UPDT TIME
    Update time HH:MM
  • UPDT USRID
    Update user ID
  • INT PKG ID
    Internal package ID. The PKG ID field contains the external or original package ID. In the case of nonpromotion packages or the current version of a promotion package, these fields contain the same value. In the case of a historic version of a promotion package, this field contains the generated package name that is stored with the package.
  • PKG VERSION
    Package version number. It is zero for nonpromotion packages. For promotion packages, it reflects the sequence of the package headers returned. The current version number is 1, the current-1 is 2, and so on. This is a calculated field; it is not stored on the package file.
Approver Information
  • USRID OF APPR
    User ID of approver
  • APPR DATE
    Approve/denial date YYYY/MM/DD
  • APPR TIME
    Approve/denial time HH:MM
  • APPR STATUS
    Approval status. Blank, APPROVED, DENIED, or DISQUAL.
  • APPR REQ LIT
    Approval required literal. Blank or REQUIRED. One output record is written for each approver that is associated with this group. All the data is duplicated in each record, except that the approver sequence number and approver information only appear in the record that is written for that particular approver.
  • DISQUALIFICATION
    Setting of the Disqualification option in the approver group definition. Possible values are: Y-- Approver Disqualification processing occurs for inventory areas protected by this approver group. N-- Approver Disqualification processing does not occur for inventory areas protected by this approver group.
List Package SCL Function
The list package SCL CSV function allows you to extract package SCL statements that are associated from the package file that satisfies the criteria you specify.
The syntax of the list package SCL CSV function is shown next:
►►─ LISt PACkage SCL ─┬───────────────────────────────────┬───────────────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─ FROm ─ PACkage ─┬──────┬─
package-id
─────────────────────────────────────► └─ ID ─┘ ►─┬────────────────────────────────────────────────┬─ . ─────────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ └─ PROMotion HIStory ──────┘
Name masking is permitted in the
package-id
field.
Extracted Package SCL Data
The output file contains the following types of information:
  • PKG ID
    Package ID
  • SITE ID
    Site ID
  • UPDT DATE
    Date package SCL record was last modified YYYY/MM/DD
  • UPDT TIME
    Time package SCL record was last modified HH:MM
  • UPDT USRID
    User ID or jobname that is associated with the last SCL record update
  • # STMTS
    Number of SCL statements in this record. A maximum of 10 statements can exist in one record.
  • INT PKG ID
    Internal package ID. The PKG ID field contains the external or original package ID. In the case of nonpromotion packages or the current version of a promotion package, these fields contain the same value. For a historical version of a promotion package, this field contains the generated package name that is stored with the package.
  • PKG VERSION
    Package version number. It is zero for nonpromotion packages. For promotion packages, it reflects the sequence of the package headers returned. The current version number is 1, the current-1 is 2, and so on. This field is a calculated one; it is not stored on the package file.
SCL Information
  • SCL
    SCL statement (1). Repeats for each line. If any of the text found in the SCL statements contains the qualifier character (single quote or double quote), that character is converted to the qualifier character not in use. For example, if the qualifier character in use is a double quote and text in a
    CA Endevor
    stored SCL statement is enclosed in double quotes, the CSV utility encloses the text in single quotes instead of double quotes.
List Package Ship Function
The list package ship SCL CSV function lets you extract package ship data for specified packages.
The syntax of the list package ship SCL CSV function is shown next:
►►─ LISt PACkage SHIp ─┬───────────────────────────────────────┬────────► └─ TO ─┬─┬─ FILe ───┬─┬─ APIEXTR ◄ ─┬─┬─┘ │ └─ DDName ─┘ └─
dd-name
───┘ │ └─ DSName ─
data set-name
─────┘ ►─ FROm ─ PACkage ─┬──────┬─
package-id
───────────────────────────────► └─ ID ─┘ ►─┬────────────────────────────────────────────────┬──────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ └─ RETurn ─┬─────────┬─────┘ ├─ ALL ◄ ─┤ └─ LAST ──┘
The entire TO clause is optional and defaults to DDName APIEXTR.
The FROm clause must be specified for the package ID of the package for which you want to obtain Package Shipment data. This field can be wildcarded.
The RETurn suboption to the OPTions clause specifies how much data for each package is to be returned and defaults to ALL. The ALL option returns all package ship information associated with the specified package ID. The LASt option returns only the information that is associated with the last shipment of the specified package ID.
Each shipment can contain up to ten destinations, resulting in up to ten output records for each shipment. This reason is why the SELECTED COUNT can be greater than the RETURNED COUNT in the API Execution Report. Multiple output records from the same shipment can be identified by the same PKG ID, SUBMIT DATE, and SUBMIT TIME fields.
Extracted List Package Ship Data
The output file contains the following types of information:
  • PKG ID
    Package ID associated with this Package Shipment information
  • SUBMIT DATE
    Shipment Create Date (ddMMMyy where MMM is the first 3 letters of the month)
  • SUBMIT TIME
    Shipment Create Time (hh:mm)
  • SUBMIT usrid
    The user ID or job name that created this Package Shipment request
  • UPDT DATE
    The date this Shipment record was last updated (ddMMMyy)
  • UPDT TIME
    The time this Shipment record was last updated (hh:mm)
  • RCD UPDT CNT
    The number of times this record was updated
  • Pkg Ship Type
    P or B - Whether the executed package (P) or the backed-out package (B) was shipped
  • CMPL Files
    Y or N - Whether complementary files were shipped
  • CMPL FILES OVRD
    O or blank - Whether complementary files were overridden
  • TRANS CODE
    Transmission Method Code:
    • L
      Local
    • X
      XCOM
    • S
      BDT1
    • B
      BDT2
    • F
      NVFT
    • M
      CONN
  • Dest id
    The Destination ID of the package
  • Host Stg RC
    The return code of the host staging job
  • Host Trans RC
    The return code of the host transmission job
  • Rmt Move RC
    The return code of the remote move job
  • Rmt Job Name
    The remote job name
List Processor Group Function
The list processor group CSV function lets you extract processor group information from the MCF that satisfies your criteria.
The syntax of the list processor group CSV function is shown next:
►►─ LISt PROcessor GROup ─
processor-group-name
────────────────────────► ►─┬───────────────────────────────────┬────────────────────────────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬──────────────────────────────────────────────┬─────────────────────► └─ FROm ─┬─ ENVironment ─
environment-name
──┬─┘ ├─ SYStem ─
sys-name
───────────────┤ ├─ TYPe ─
type-name
────────────────┤ └─┬─ STAge ─
stage-id
────────────┬─┘ └─ STAge NUMber ─
stage-number
─┘ ►─┬────────────────────────────────────────────────┬─ . ───────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ ├─ PATh ─┬─────────────┬───┤ │ ├─ LOGical ◄ ─┤ │ │ └─ PHYsical ──┘ │ ├─┬─ NOSearch ◄ ─┬─────────┤ │ └─ SEArch ─────┘ │ └─ RETurn ─┬───────────┬───┘ ├─ FIRst ◄ ─┤ └─ ALL ─────┘
Mapping is valid only when the environment name is explicitly specified. For explicit environment specification requests, processor group data is returned in map order. On nonexplicit environments, processor group data is extracted based on environment and stage locations. Mapping between environment and stage locations is not supported on nonexplicit environment requests.
The FROM clause is optional. All or part of the keyword specification on this clause can be omitted. On an omitted keyword, a wildcard is assumed. Also, when the environment name is wild, the STAge NUMber keyword cannot be used. You can either omit the stage keyword or specify it through the STAge stage-id keyword.
The PATH, SEARCH, NOSEARCH, and RETURN clauses can be omitted. Default mapping options on nonexplicit environment name requests are: PATH PHYSICAL, NOSEARCH, and RETURN ALL. The PATH LOGICAL, SEARCH, and RETURN FIRST clauses are invalid on nonexplicit environment name requests. Default mapping options on explicit environment name requests are: PATH LOGICAL, RETURN FIRST, and NOSEARCH. Explicit environment name requests for a single stage environment with no types defined to stage 1 require option NOSEARCH.
List Processor Group Examples
For the following two examples, two environments (ENVA and ENVB) are defined in the C1DEFLTS table where SYS1/SBS1/TYP1/TYP2 are defined to both environments. ENVA and ENVB are mapped together. Processor Group record GRP1 exists under SYS1/TYP1 of ENVB/S2. Processor Group record GRP2 exists under SYS1/TYP2 of both ENVA/S2 and ENVB/S2.
LIST PRO GRO * TO FILE 'CSVFILE' FROM ENV'ENVA' SYS'*' TYP '*' STA'*' OPTIONS PATH LOGICAL SEARCH RETURN ALL.
Result for this example:
  1. GRP1 from ENVB/S2/SYS1/TYP1
  2. GRP2 from ENVA/S2/SYS1/TYP2
  3. GRP2 from ENVB/S2/SYS1/TYP2
LIST PRO GRO * TO FILE 'CSVFILE' FROM ENV'*' SYS'*' TYP'*' STA'*' -or- LIST PRO GRO * TO FILE 'CSVFILE'.
Result for this example:
  1. GRP2 from ENVA/S2/SYS1/TYP2
  2. GRP1 from ENVB/S2/SYS1/TYP1
  3. GRP2 from ENVB/S2/SYS1/TYP2
Extracted Processor Group Data
The output file contains the following types of information:
  • SITE ID
    Site ID
  • ENV NAME
    Environment name
  • SYS NAME
    System name
  • TYPE NAME
    Type name
  • STG NAME
    Stage name
  • STG ID
    Stage ID
  • STG #
    Stage number (1/2)
  • PROC GRP NAME
    Processor group name
  • PROC TYPE
    Processor type (DEL/GEN/MOVE)
  • SYM OVRD #
    Symbolic override number
  • UPDT DATE
    Last physical record update date YYYY/MM/DD
  • UPDT TIME
    Last physical record update time HH:MM:SS:TT
  • UPDT USRID
    User ID or job name that is associated with last physical record update
  • DESCRIPTION
    Processor group description
  • NEXT PROC GRP
    Next processor group in map
  • PROC O/P TYPE
    Processor output type
  • MOVE ACT PROC
    Processor to use on MOVE action (G/M)
  • FG FLG
    Foreground processing flag (Y/N)
  • PROC NAME
    Processor name
  • TRNSFR ACT PROC
    Processor to use on TRANSFER action (G/M)
Symbol Override Information
  • SYM OVRD LNG
    Override symbol name length
  • SYM OVRD
    Override symbol name value
  • SYM OVRD VALUE LNG
    Override symbol value length
  • SYM OVRD VALUE
    Override symbol value. One or more output records are written for each processor type (GEN, DEL, or MOV). Also, one output record is written for each symbol found within a processor type. All the data except for the symbol override number (SYM OVRD #) and the symbol override information is duplicated in each subsequent record.
List SMF Data Function
The list SMFdata CSV function lets you extract SMF record data corresponding to activity related to
CA Endevor
actions or to security violations recorded by
CA Endevor
.
The syntax of the list SMF data CSV function is shown next:
►►─ LISt SMFdata ─┬─ SECurity ─────────────────┬──────────────────────────────► │─ ACTIVity ─────────────────│ └─ ADMIN OBJECT
object-name
─┘ ►─┬───────────────────────────────────────┬──────────────────────────────────► └─ TO ─┬─┬─ FILe ───┬─┬─ APIEXTR ◄ ─┬─┬─┘ │ └─ DDName ─┘ └─
dd-name
───┘ │ └─ DSName ─
data set-name
─────┘ ►─┬─────────────────────────────────────┬────────────────────────────────────► └─ FROm ─┬─ FILe ───┬─┬─ SMFDATA ◄ ─┬─┘ └─ DDName ─┘ └─
dd-name
───┘ ►─┬──────────────────────────────────────────────────────┬───────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ───────┬─ ¤ ─┘ ├─ NOCsv ────────────────────────┤ ├─ NOTitle ──────────────────────┤ ├─ QUAlifier QUOte ──────────────┤ └─ RECord ─┬──────┬─ SMF-rec-id ─┘ └─ ID ─┘
The SECurity and ACTIVity keywords are mutually exclusive.
The LIST SMFdata SECurity function provides information about
CA Endevor
security violations.
The LIST SMFdata ACTIVity function provides information about element activity.
The entire FROm clause is optional and defaults to the ddname SMFDATA.
The TO clause is optional and defaults to ddname APIEXTR.
The OPTions clause with RECord ID lets you provide the SMF record ID of the
CA Endevor
SMF records for which you are requesting a list. The SMF record ID must be a number from 0-255. When not coded, it defaults to the SMF record ID (SMFREC#) specified in the defaults table C1DEFLTS.
Extracted SMF Activity Data
The output file contains the following types of information:
Header Information
  • RCD TYPE
    A - SMF activity record.
  • SMF REC ID
    SMF record ID.
  • ACT DATE
    The date that is associated with this activity (yyyymmdd).
  • ACT TIME
    The time that is associated with this activity (hhmmsstt).
  • CPU ID
    The CPU ID associated with this activity.
  • ACT USRID
    The user ID associated with this activity.
  • ACTION
    The
    CA Endevor
    action that is associated with this activity.
Environment Information
  • SITE
    The Site ID associated with this activity.
  • ENV NAME
    The source Environment name that is associated with this activity.
  • STG NAME
    The source Stage name that is associated with this activity.
  • STG ID
    The source Stage ID associated with this activity.
  • STG NUM
    1 or 2 - The source Stage number that is associated with this activity.
  • SYS NAME
    The source System name that is associated with this activity.
  • SBS NAME
    The source Subsystem name that is associated with this activity.
  • TYPE NAME
    The source Element Type associated with this activity.
  • ELM NAME
    The source Element name that is associated with this activity.
  • PRGRP NAME
    The processor group that is associated with this activity.
  • ELM VV
    The source version of the Element that is associated with this activity.
  • ELM LL
    The source level of the Element that is associated with this activity.
  • DATASET NAME
    The data set name that is associated with this activity.
  • MBR NAME
    The data set member name that is associated with this activity.
  • ENV NAME (T)
    The target Environment name that is associated with this activity.
  • STG NAME (T)
    The target Stage name that is associated with this activity.
  • STG ID (T)
    The target Stage ID associated with this activity.
  • STG NUM (T)
    1 or 2 - The target Stage number that is associated with this activity.
  • SYS NAME (T)
    The target System name that is associated with this activity.
  • SBS NAME (T)
    The target Subsystem name that is associated with this activity.
  • TYPE NAME (T)
    The target Element Type associated with this activity.
  • ELM NAME (T)
    The target Element name that is associated with this activity.
  • ELM VV (T)
    The target version of the Element that is associated with this activity.
  • ELM LL (T)
    The target level of the Element that is associated with this activity.
Element Level Last Information
  • ELM LAST LL DATE
    The Element Last Level Date at the time of this activity (yyyymmdd).
  • ELM LAST LL TIME
    The Element Last Level Time at the time of this activity (hhmmssth).
  • ELM LAST LL USR
    The user ID associated with the last level at the time of this activity.
  • ELM LAST LL ACT
    The
    CA Endevor
    Action that is associated with the last level at the time of this activity.
  • ELM LAST LL STMTS
    The number of statements that are contained in the Element as of the last level at the time of this activity.
  • ELM LAST LL COMMENT
    The Element Last Level Comment at the time of this activity.
Last Processor Information
  • LAST PROC NAME
    The Processor name that is associated with the last processor execution at the time of this activity.
  • LAST PROC DATE
    The date that is associated with the last processor execution at the time of this activity (yyyymmdd).
  • LAST PROC TIME
    The time that is associated with the last processor execution at the time of this activity (hhmmssth).
  • LAST PROC USRID
    The user ID associated with the last processor execution at the time of this activity.
  • LAST PROC RC
    The return code that is associated with the last processor execution at the time of this activity.
  • LAST PROC NDVR RC
    The
    CA Endevor
    return code that is associated with the last processor execution at the time of this activity.
Request Parameter Information
  • CCID
    The Change Control ID associated with this activity.
  • COMMENT
    The Comment that is associated with this activity.
  • SIGNOUT OVRD
    Y or N - Whether signout override was requested.
  • RETR COPY ONLY
    Y or N - Whether the Retrieve action specified copy only (Retrieve action only).
  • EXPND INCL
    Y or N - Whether the Retrieve action requested to expand includes (Retrieve action only).
  • REPLACE
    Y or N - Whether the Retrieve action requested to replace an existing member (Retrieve action only).
  • ELM DEL
    Y or N - Whether the element was deleted upon completion of the request.
  • IGN GEN FAILED
    Y or N - Whether ignore generate failed was requested.
  • BYP GEN PROC
    Y or N - Whether bypass generate processor was requested.
  • BYP DEL PROC
    Y or N - Whether bypass delete processor was requested.
  • SYNC
    Y or N - Whether the SYNC option was specified.
  • DEL ONLY CMPNT
    Y or N - Whether to delete only components.
  • WITH HIST
    Y or N - Whether this is a Move or Transfer With History.
  • ADD UPDT
    Y or N - Whether this is an Add With Update.
  • PROC GRP OVRD
    The name of the Processor Group when requested as an override.
  • SIGNOUT TO USR
    The sign-out to user ID if specified.
Miscellaneous Additional Information
  • EXEC RC
    The execution return code that is associated with this activity.
  • SRCHREPL FLAG
    Y or N - Whether an update of either element source or component data by the Search and Replace utility was specified.
  • AUTOGEN
    Y or N - Whether Autogen was specified on the action. If AUTOGEN is Y, then AUTOGENX is N for that element.
  • AUTOGENX
    Y or N - Whether Autogen was specified on the action for the where-used elements. If AUTOGENX is Y, then AUTOGEN is N for that element.
  • NOSOURCE
    Y or N - Whether the NoSource option was specified on the Generate action.
  • AUTOGEN SPAN
    N, A, S, or B - Whether SPAN NONE, SPAN ALL, SPAN SYSTEM, or SPAN SUBSYSTEM was specified for the AUTOGEN request.
  • FULL ELM NAME
    The full element name that is associated with this activity.
Extracted SMF Security Data
The output file contains the following types of information:
  • RCD TYPE
    S - SMF Security record.
  • SMF REC ID
    The SMF record ID.
  • VIO DATE
    The date of the security violation (yyyymmdd).
  • VIO TIME
    The time of the security violation (hhmmsstt).
  • CPU ID
    The CPU ID associated with the security violation.
  • VIO USRID
    The user ID associated with the security violation.
  • ACTION
    The
    CA Endevor
    action that is associated with the security violation.
  • ERR CODE
    The error code that is associated with the security violation.
  • ERR MESSAGE
    The error message that is associated with the security violation.
  • SITE
    The Site ID associated with the security violation.
  • ENV NAME
    The Environment name that is associated with the security violation.
  • STG NAME
    The Stage name that is associated with the security violation.
  • STG ID
    The Stage ID associated with the security violation.
  • STG NUM
    1 or 2 - The relative Stage number that is associated with the security violation.
  • SYS NAME
    The System name that is associated with the security violation.
  • SBS NAME
    The Subsystem name that is associated with the security violation.
  • TYPE NAME
    The Element Type associated with the security violation.
  • ELM NAME
    The Element name that is associated with the security violation.
  • PRGRP NAME
    The processor group that is associated with the security violation.
  • DATASET NAME
    The data set name that is associated with the security violation.
  • MBR NAME
    The data set member name that is associated with the security violation.
  • FULL ELM NAME
    The full element name that is associated with the security violation.
List Stage Function
The list stage CSV function allows you to extract stage information from the MCF that satisfies the criteria you specify.
The syntax of the list stage CSV function is shown next:
►►─┬─ List STAge ─
stage-id
────────────┬─────────────────────────────────────► └─ List STAge NUMber ─
stage-number
─┘ ►─┬───────────────────────────────────┬──────────────────────────────────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬─────────────────────────────────────────┬────────────────────────────────► └─ FROm ─ ENVironment ─
environment-name
─┘ ►─┬──────────────────────────────────────────────┬─ . ────────────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬ ¤ ┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ ├─ PATh ─┬─────────────┬───┤ │ ├─ LOGical ◄ ─┤ │ │ └─ PHYsical ──┘ │ ├─┬─ NOSearch ◄ ─┬─────────┤ │ └─ SEArch ─────┘ │ ├─ RETurn ─┬───────────┬───┤ │ ├─ FIRst ◄ ─┤ │ │ └─ ALL ─────┘ │ └──────────────────────────┘
The wildcard character is permitted in the environment and stage number fields. On nonexplicit environment name specifications, stage data information is extracted individually from each environment that meets its selection criteria. The FROM clause is optional. On an omitted environment name, a wildcard is assumed. Also, when the environment name is wild, the List STAge NUMber request cannot be used. Use the LIST STAge request.
The PATH, SEARCH, NOSEARCH, and RETURN clauses can be omitted. Default mapping options on nonexplicit environment name requests are: PATH PHYSICAL, NOSEARCH, and RETURN ALL. The PATH LOGICAL, SEARCH, and RETURN FIRST clauses are invalid on nonexplicit environment name requests. Default mapping options on explicit environment name requests are: PATH LOGICAL, RETURN FIRST, and NOSEARCH.
List Stage Examples
For these examples, three environments (ENVA, ENVB, and ENVC) are defined in the C1DEFLTS table. ENVA Stage 2 is mapped to ENVB at stage 2.
LIST STA * TO FILE CSVFILE FROM ENV '*'.
Result for this example:
  1. Stage 1 data from ENVA
  2. Stage 2 data from ENVA
  3. Stage 1 data from ENVB
  4. Stage 2 data from ENVB
  5. Stage 1 data from ENVC
  6. Stage 2 data from ENVC
LIST STA * TO FILE CSVFILE FROM ENV 'ENVA' OPTIONS PATH LOGICAL SEARCH RETURN ALL.
Result for this example:
  1. Stage 1 data from ENVA
  2. Stage 2 data from ENVA
  3. Stage 2 data from ENVB
Extracted Stage Data
The output file contains the following types of information:
  • SITE ID
    Site ID
  • ENV NAME
    Environment name
  • STG NAME
    Stage name
  • STG ID
    Stage ID
  • STG #
    Stage number (1/2)
  • TITLE
    Title that is associated with stage
  • MCF DSN
    Name of MCF file where stage is defined
  • ENTRY STG
    Entry stage attribute (Y/N)
  • Promotion package processing stop-at-stage (Y/N)
List Subsystem Function
The list subsystem CSV function allows you to extract subsystem information from the MCF that satisfies the criteria you specify.
The syntax of the list subsystem CSV function is shown next:
►►─ LISt SUBsystem ─
subsystem-name
────────────────────────────────────► ►─┬───────────────────────────────────┬────────────────────────────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬──────────────────────────────────────────────┬─────────────────────► └─ FROm ─┬─ ENVironment ─
environment-name
──┬─┘ ├─ SYStem ─
sys-name
───────────────┤ └─┬─ STAge ─
stage-id
────────────┬─┘ └─ STAge NUMber ─
stage-number
─┘ ►─┬────────────────────────────────────────────────┬─ . ───────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ ├─ PATh ─┬─────────────┬───┤ │ ├─ LOGical ◄ ─┤ │ │ └─ PHYsical ──┘ │ ├─┬─ NOSearch ◄ ─┬─────────┤ │ └─ SEArch ─────┘ │ └─ RETurn ─┬───────────┬───┘ ├─ FIRst ◄ ─┤ └─ ALL ─────┘
A wildcard, placeholder characters, or both can be used in the environment, system, subsystem, and stage fields. On nonexplicit environment name specifications, subsystem data is extracted individually from each location (environment/stage) that meets its selection criteria.
The FROM ENVIRONMENT SYSTEM STAGE clause is optional. All or part of the keyword specification on this clause can be omitted. On an omitted keyword, a wildcard is assumed. Also, when the environment name is wild, the STAge NUMber keyword cannot be used. You can either omit the stage keyword or specify it through the STAge stage-id keyword.
The PATH, SEARCH, NOSEARCH, and RETURN clauses can be omitted. Default mapping options on nonexplicit environment name requests are: PATH PHYSICAL, NOSEARCH, and RETURN ALL. The PATH LOGICAL, SEARCH, and RETURN FIRST clauses are invalid on nonexplicit environment name requests. Default mapping options on explicit environment name requests are: PATH LOGICAL, RETURN FIRST, and NOSEARCH.
List Subsystem Examples
For the following two examples, two environments (ENVA and ENVB) are defined in the C1DEFLTS table where SYS1/SBS1/SBS2 are defined to environment. ENVA Stage 2 is mapped to ENVB Stage 2.
LIST SUB * TO FILE 'CSVFILE' FROM ENV'*' SYS '*' STA'*'.
Result for this example:
  1. SBS1 from ENVA Stage 1 under SYS1
  2. SBS2 from ENVA Stage 1 under SYS1
  3. SBS1 from ENVA Stage 2 under SYS1
  4. SBS2 from ENVA Stage 2 under SYS1
  5. SBS1 from ENVB Stage 1 under SYS1
  6. SBS2 from ENVB Stage 1 under SYS1
  7. SBS1 from ENVB Stage 2 under SYS1
  8. SBS2 from ENVB Stage 2 under SYS1
LIST SUB * TO FILE 'CSVFILE' FROM ENV'ENVA' SYS '*' STA'*' OPTIONS RETURN ALL PATH LOGICAL SEARCH.
Result for this example:
  1. SBS1 from ENVA Stage 1 under SYS1
  2. SBS1 from ENVA Stage 2 under SYS1
  3. SBS1 from ENVB Stage 2 under SYS1
  4. SBS2 from ENVA Stage 1 under SYS1
  5. SBS2 from ENVA Stage 2 under SYS1
  6. SBS2 from ENVB Stage 2 under SYS1
Extracted Subsystem Data
The output file contains the following types of information:
  • SITE ID
    Site ID
  • ENV NAME
    Environment name
  • SYS NAME
    System name
  • SBS NAME
    Subsystem name
  • STG NAME
    Stage name
  • STG ID
    Stage ID
  • STG SEQ #
    Relative stage sequence number
  • RCD UPDT CNT
    Record update count
  • UPDT DATE
    Update date YYYY/MM/DD
  • UPDT TIME
    Update time HH:MM:SS:TH
  • UPDT USRID
    Update user ID
  • TITLE
    Subsystem Title
  • NEXT SBS
    Next subsystem name in map
  • REL ID
    Record created release ID
  • EXCLUDE FROM PROC O/P CK
    Exclude Subsystem from the duplicate element processor output Type check (Y/N)
List System Function
The list system CSV function allows you to extract system information from the MCF that satisfies the criteria you specify.
The syntax of the list system CSV function is shown next:
►►─ LISt SYStem ─
system-name
─┬───────────────────────────────────┬──────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬──────────────────────────────────────────────┬───────────────────────────► └─ FROm ─┬─ ENVironment ─
environment-name
──┬─┘ └─┬─ STAge ─
stage-id
────────────┬─┘ └─ STAge NUMber ─
stage-number
─┘ ►─┬────────────────────────────────────────────────┬─ . ─────────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ ├─ PATh ─┬─────────────┬───┤ │ ├─ LOGical ◄ ─┤ │ │ └─ PHYsical ──┘ │ ├─┬─ NOSearch ◄ ─┬─────────┤ │ └─ SEArch ─────┘ │ └─ RETurn ─┬───────────┬───┘ ├─ FIRst ◄ ─┤ └─ ALL ─────┘
A wildcard, placeholder characters, or both can be used in the environment, system, and stage fields. On nonexplicit environment name specifications, system data are extracted individually from each location (environment/stage) that meets its selection criteria.
The FROM ENVIRONMENT STAGE clause is optional. All or part of the keyword specification on this clause can be omitted. On an omitted keyword, a wildcard is assumed. Also, when the environment name is wild, the STAge NUMber keyword cannot be used. You can either omit the stage keyword or specify it through the STAge stage-id keyword.
The PATH, SEARCH, NOSEARCH, and RETURN clauses can be omitted. Default mapping options on nonexplicit environment name requests are: PATH PHYSICAL, NOSEARCH, and RETURN ALL. The PATH LOGICAL, SEARCH, and RETURN FIRST clauses are invalid on nonexplicit environment name requests. Default mapping options on explicit environment name requests are: PATH LOGICAL, RETURN FIRST, and NOSEARCH.
List System Examples
For the following two examples, two environments (ENVA and ENVB) are defined in the C1DEFLTS table where SYS1/SYS2 are defined to both environment. ENVA Stage 2 is mapped to ENVB Stage 2.
LIST SYS * TO FILE 'CSVFILE' FROM ENV'*' STA'*'.
Result for this example:
  1. SYS1 from ENVA Stage 1
  2. SYS2 from ENVA Stage 1
  3. SYS1 from ENVA Stage 2
  4. SYS2 from ENVA Stage 2
  5. SYS1 from ENVB Stage 1
  6. SYS2 from ENVB Stage 1
  7. SYS1 from ENVB Stage 2
  8. SYS2 from ENVB Stage 2
LIST SYS * TO FILE 'CSVFILE' FROM ENV 'ENVA' STA'*' OPTIONS RETURN ALL PATH LOGICAL SEARCH.
Result for this example:
  1. SYS1 from ENVA Stage 1
  2. SYS1 from ENVA Stage 2
  3. SYS1 from ENVB Stage 2
  4. SYS2 from ENVA Stage 1
  5. SYS2 from ENVA Stage 2
  6. SYS2 from ENVB Stage 2
Extracted System Data
The information that is contained in the output file is explained in the following list:
  • SITE ID
    Site ID
  • ENV NAME
    Environment name
  • SYS NAME
    System name
  • STG NAME
    Stage name
  • STG ID
    Stage ID
  • STG SEQ #
    Relative stage sequence number
  • RCD UPDT CNT
    Record update count
  • UPDT DATE
    Update date YYYY/MM/DD
  • UPDT TIME
    Update time HH:MM:SS:TH
  • UPDT USRID
    Update user ID
  • TITLE
    Subsystem Title
  • NEXT SYS
    Next system name in map
  • PROC LOAD LIB
    Processor load library name
  • PROC LIST LIB
    Processor listing library name
  • COMMENT REQ
    Comment required flag (Y/N)
  • CCID REQ
    CCID required flag (Y/N)
  • SIGNOUT REQ
    Signout required flag (Y/N)
  • VALIDATE RETR DSN
    Validate retrieve to data set name (Y/N)
  • JUMP OPT REQ
    Jump location allowed flag (Y/N)
  • BACKUP DATE
    Last backup date YYYY/MM/DD
  • BACKUP TIME
    Last backup time HH:MM:SS:TT
  • REL ID
    Record created release ID (nn)
  • DUP ELM REG
    Duplicate element registration (Y/N)
  • DUP ELM REG SEV LL
    Duplicate element registration message severity level (W,C,E,S).
    This field is blank if DUP ELM REG is set to a value of N.
  • PROC O/P REG
    Processor output type registration (Y/N)
  • PROC O/P REG SEV LL
    Processor output type registration message severity level (W,C,E,S).
    This field is blank if PROC O/P REG is set to a value of N.
  • PROC O/P REG ACROSS SBS
    Duplicate element processor output Type check across Subsystems (Y/N)
  • ELM LL AGE RETENTION
    Retain element levels by age (Y/N)
  • CMPNT LL AGE RETENTION
    Retain Component levels by age (Y/N)
  • RETAIN ELM LL # MTH
    Retain element levels for # of months
  • RETAIN CMPNT LL #MTH
    Retain component levels for # of months
List Type Function
The list type CSV function allows you to extract type information from the MCF that satisfies the criteria you specify.
The syntax of the list type CSV function is shown next:
►►─ LISt TYPe ─ type-name ─┬───────────────────────────────────┬──────────────► └─ TO ─┬─┬─ FILe ───┬─
dd-name
───┬─┘ │ └─ DDName ─┘ │ └─ DSName ─
data set-name
─┘ ►─┬──────────────────────────────────────────────┬───────────────────────────► └─ FROm ─┬─ ENVironment ─
environment-name
──┬─┘ ├─ SYStem ─
sys-name
───────────────┤ └─┬─ STAge ─
stage-id
────────────┬─┘ └─ STAge NUMber ─
stage-number
─┘ ►─┬────────────────────────────────────────────────┬─ . ─────────────────────►◄ └─ OPTions ─ ¤ ─┬─ DELImiters ─ character ─┬─ ¤ ─┘ ├─ NOCsv ──────────────────┤ ├─ NOTitle ────────────────┤ ├─ QUAlifier QUOte ────────┤ ├─ PATh ─┬─────────────┬───┤ │ ├─ LOGical ◄ ─┤ │ │ └─ PHYsical ──┘ │ ├─┬─ NOSearch ◄ ─┬─────────┤ │ └─ SEArch ─────┘ │ └─ RETurn ─┬───────────┬───┘ ├─ FIRst ◄ ─┤ └─ ALL ─────┘
Wildcard, placeholder characters, or both are permitted in the environment, system, stage, and type fields. On nonexplicit environment name specifications, type data are extracted individually from each location (environment/stage) that meets its selection criteria.
The FROM clause is optional. All or part of the keyword specification on this clause can be omitted. On an omitted keyword, a wildcard is assumed. Also, when the environment name is wild, the STAge NUMber keyword cannot be used. You can either omit the stage keyword or specify it through the STAge stage-id keyword.
The PATH, SEARCH, NOSEARCH and RETURN clauses can be omitted. Default mapping options on nonexplicit environment name requests are: PATH PHYSICAL, NOSEARCH, and RETURN ALL. The PATH LOGICAL, SEARCH, and RETURN FIRST clauses are invalid on nonexplicit environment name requests. Default mapping options on explicit environment name requests are: PATH LOGICAL, RETURN FIRST and NOSEARCH. Explicit environment name requests for a single stage environment with no types defined to stage 1 require option NOSEARCH.
List Type Examples
For the following two examples, two environments (ENVA and ENVB) are defined in the C1DEFLTS table. SYS1/TYP1/TYP2 are defined to both environments. ENVA Stage 2 is mapped to ENVB Stage 2.
LIST TYP * TO FILE 'CSVFILE' FROM ENV '*' SYS '*' STA '*'.
Result for this example:
  1. TYP1 from ENVA Stage 1 under SYS1
  2. TYP2 from ENVA Stage 1 under SYS1
  3. TYP1 from ENVA Stage 2 under SYS1
  4. TYP2 from ENVA Stage 2 under SYS1
  5. TYP1 from ENVB Stage 1 under SYS1
  6. TYP2 from ENVB Stage 1 under SYS1
  7. TYP1 from ENVB Stage 2 under SYS1
  8. TYP2 from ENVB Stage 2 under SYS1
FROM ENV' ENVA' SYS '*' STA '*' OPTIONS RETURN ALL PATH LOGICAL SEARCH.
Result for this example:
  1. TYP1 from ENVA Stage 1 under SYS1
  2. TYP1 from ENVA Stage 2 under SYS1
  3. TYP1 from ENVB Stage 2 under SYS1
  4. TYP2 from ENVA Stage 1 under SYS1
  5. TYP2 from ENVA Stage 2 under SYS1
  6. TYP2 from ENVB Stage 2 under SYS1
Extracted Type Data
The output file contains the following types of information:
  • SITE ID
    Site ID
  • ENV NAME
    Environment name
  • SYS NAME
    System name
  • TYPE NAME
    Type name
  • TYPE # ID
    Type number ID
  • STG NAME
    Stage name
  • STG ID
    Stage ID
  • STG #
    Stage number (1/2)
  • STG SEQ #
    Relative stage sequence number
  • RCD UPDT CNT
    Record update count
  • UPDT DATE
    Update date YYYY/MM/DD
  • UPDT TIME
    Update time HH:MM:SS:TH
  • UPDT USRID
    Update user ID
  • REL ID
    Record created release ID
  • NEXT TYPE
    Next type name in map
  • DESCRIPTION
    Type description
  • DFLT PROC GRP
    Default processor group name
  • DATA FORMAT
    Format of this type of data. B-Binary, T-TEXT, or blank-not specified.
  • FILE EXT
    File extension that is associated with this type of data. Valid values for this 8-character field are: a-z, A-Z, 0-9, or blanks. Trailing blanks are allowed, but embedded blanks are not.
  • LANG
    Language (COBOL, DATA.)
  • PV/LB LANG
    PV/LB language
  • REGR %
    Regression percent
  • REGR SEV
    Regression error severity level (W/C/E/S)
  • SRC LNG
    Maximum length of source
  • COMPARE (F)
    Start compare column
  • COMPARE (T)
    End compare column
  • AUTO CONSOL
    Auto consolidate flag (Y/N)
  • CONSOL LL
    Consolidation level (000-999)
  • AUTO CONSOL LL
    Auto consolidation level
  • CMPNT AUTO CONSOL
    Component auto consolidate flag (Y/N)
  • CMPNT CONSOL LL
    Component consolidation level (000-999)
  • CMPNT AUTO CONSOL LL
    Component auto consolidation level
  • EXPAND INCL
    Expand includes flag in source output library (Y/N)
  • FWD/REV/IMG/LOG ELM DELTA
    Forward/Reverse/Image/Log delta for element (F/R/I/L)
  • FWD/REV CMPNT DELTA
    Forward/Reverse delta for components (F/R)
  • COMPRESS BASE
    Compress base flag (Y/N)
  • ELM NAME NOT ENCRYPTED
    Not encrypted element name (Y/N)
  • SRC O/P DS TYPE
    Source output data set type (PO/PV/LB/??)
  • SRC O/P DSN
    Source output data set name
  • INCL DS TYPE
    Include data set type (PO/PV/LB/??)
  • INCL DSN
    Include data set name
  • BASE DS TYPE
    Base data set type (PO/PV/LB/EL/VK/??)
  • BASE/IMAGE DSN
    Base data set name
  • DELTA DS TYPE
    Delta data set type (PO/PV/LB/EL/VK/??)
  • DELTA DSN
    Delta data set name
  • USS DELIMITER
    USS file delimiter (COMP/CR/CRLF/F/LF/NL/V) The source output, include, base, and delta data set names are displayed in the format in which they are defined. Therefore, symbolic values are not expanded. The data set type fields contains a value of ?? (unknown) if the corresponding data set name contains symbolic values.
  • ELEMENT RECFM
    Record length format ( F/V/N )
CSV Utility JCL
Sample JCL to execute the CSV utility is located in
iprfx.iqual
.CSIQJCL, member name BC1JCSVU.
Alternatively, the CSV utility can be loaded from an unauthorized library, which can be preferred if you are executing this utility from within a processor. To call the CSV utility using an unauthorized program, specify the following code:
EXEC PGM=BC1PCSV0
To use this EXEC statement, the release CONLIB must be in the STEPLIB concatenation. In addition, users executing the non-authorized program must have the requisite security access to the
CA Endevor
data sets for the function requested. The caller security profile must have sufficient CA Top Secret, CA ACF2, or RACF, access to the
CA Endevor
control files (catalog, master, package, base, delta), because the
CA Endevor
alternate ID facility is not available when running in an unauthorized mode.
The CSV utility shuts down the API server after the utility is finished. To disable API server shutdown, so that the next API call does not start the API server from the beginning, the parameter RETAINAPI must be passed to the JCL or REXX program. For example, to call the CSV utility with the parameter from a REXX program, use the following syntax:
SELECT PGM(BC1PCSV0) PARM(RETAINAPI)
At the end of the calling program, the CSV utility must shut down the API, otherwise the program causes an SA03 abend. So the last call of BC1PCSV0 utility must be done without the RETAINAPI parameter.
Under some circumstances,
CA Endevor
automatically ignores the RETAINAPI parameter to prevent the SA03 abend. This action is done when BC1PCSV0 is attached by the program. For example, the utility is attached by a program when it is used directly in the JCL as PGM=BC1PCSV0,PARM=RETAINAPI or it is used in a REXX program running from IKJEFT01 in the JCL.