User Exits

This section discusses the user exits that allow you to customize
View
.
view
This section discusses the user exits that allow you to customize
View
.
User exits allow you to customize the product to fit your requirements.
  • The code for the exits and the mapping macros for the
    View
    control blocks are distributed in CAI.CVDESRC.
  • The exits must be link-edited and placed in the library containing the
    View
    load modules.
  • EBCCICUX CICS/cross-memory connection ID
    The EBCCICUX exit determines the CICS/ cross-memory connection ID used for online retrieval. This exit is called by the CICS/cross-memory features to supply the connection ID whenever the feature is initially invoked by a user.
  • EBCxxxUX Cross-memory connection ID
    The EBCxxxUX exits can determine the cross-memory connection ID used for online retrieval. You can also use the sample exit JCL found in CAI.CVDEJCL to assemble and link these exits outside of SMP.
  • SAR$xxxx Device specific
    SAR$xxxx provides any configuring information required by "smart" devices that have multiple operating and/or emulating modes. This special configuring data can be sent to the device before and after the OPEN, and before and after the CLOSE.
  • SARACFUX ACIF archival task exit
    The SARACFUX exit can modify report attributes and to analyze the records for exceptional conditions. The report ID, generation number, sequence number, and archival date cannot be modified.
  • SARACTUX Job accounting
    SARACTUX extracts accounting data for a job or time sharing session. The exit is passed the type-20 SMF record for the job or time sharing session and returns 20 bytes of accounting data. If SYSOUT for the same job or time sharing session is subsequently archived, these 20 bytes of data are copied to the user accounting data field in the group control record for the SYSOUT (GCRUSER).
  • SARARAUX Automatic report archival
    The automatic report archival feature of
    View
    extensions gives control to SARARAUX. The exit then determines whether a copy of a SYSOUT data set is to be produced for archival purposes. The exit can also be used to modify the SYSOUT attributes. These attributes are used to create the archival copy of the data set and to assign a SYSOUT ID to it.
  • SARATHUX Authorization
    SARATHUX determines whether a specified job is authorized to perform high-level database functions. To do this,
    View
    passes the request type and request data requiring authorization to the exit. SARATHUX returns a return code to the caller that indicates the authorization condition. The standard exit that is supplied with the product authorizes all jobs to perform all functions.
    • SARATHU1 External security sample
      SARATHU1 performs external security authorization checking for database functions.
  • SARBKTUX Backup cycle
    SARBKTUX is invoked by the
    View
    backup cycle before a report is copied to tape. The exit can be used to override the decision to back up a report to tape.
  • SARDSTUX Reprint destinations
    SARDSTUX determines whether a user or job is authorized to invoke an output (print) command to a specified destination.
  • SARD00UX Migrate Cycle exit
    SARD00UX is invoked by the
    View
    optical migration task before a report is migrated to optical. The exit can be used to override the decision to migrate a report to optical.
  • SARD03UX Secondary Storage Drive exit
    SARD03UX is invoked by the secondary storage disk driver for migration of permanent SYSOUT groups using the FILETEK callable interface. This exit can be used to obtain model file name and file location for the Filetek Optical secondary disk storage driver SARD2D03.
  • SARD05UX Secondary Storage Drive exit
    SARD05UX is invoked by the secondary storage disk driver for migration of permanent SYSOUT groups using the IBM DFP object access method callable interface. This exit can be used to obtain the collection name for the IBM DFP object access optical secondary disk storage driver SARD2D05.
  • SAREASUX EAS for tape and robotics exit
    SAREASUX is available for customizing the expanded access option for tape and robotics.
    • SAREASU1 Tape compare sample
      SAREASU1 compares tapes to determine whether a given tape is to be queued to the same processing thread within SAREAS (the tape server) and if it is to be the next one serviced.
  • SARFVCUX View collector archival task exit
    The SARFVCUX exit can modify the data set attributes and to analyze the records for exceptional conditions.
  • SARMFPUX Microfiche
    The exit is invoked during the SARMFP process; it can be used to control which SYSOUTs get selectively written to the Microfiche OUT file during the SARMFP process.
  • SAROMSUX Online management system
    Before a call is issued to the display services the online management system exit, SAROMSUX is invoked. This exit lets you examine and/or change the Online Exit Block (OXB) and its contents.
    • SAROMSU1 Identify the online management system sample
      SAROMSU1 identifies the Online Management DISPLAY function and panel. The exit might change the panel name, invoke an alternate panel or change the value of a panel variable.
  • SARPACUX SARPAC tape consolidation
    SARPACUX can override the internal decision made by SARPAC that determines whether to consolidate a tape.
  • SARPAMUX SARPAM Service Routine exit
    The SARPAMUX exit can modify attributes in the GCR record for the data set.
  • SARPRFUX User profile
    The exit can be used to modify report attributes and to analyze the records for exceptional conditions. The report ID, generation, and sequence numbers cannot be modified. The archive date and archive time can be modified only when using a
    View
    database that has the ARCHCHG=yyyy SARINIT parameter specified.
  • SARPRTUX Print
    When a SYSOUT group is reprinted from online, from batch, or by the
    View
    started task during archival, SARPRTUX is invoked. This user exit can be used to analyze or modify the print data set attributes, model a banner page member name or banner page records, and produce special print records.
  • SARSECUX Security
    You can use user exit SARSECUX to determine whether a user or job is authorized to access, update, or delete data within the
    View
    database.
    • SARSECU1 Determine USER/JOB access sample
      The SARSECU1 exit determines if a USER or JOB is allowed to access a SYSOUT group or mount a tape.
  • SARSMFUX SMF processing
    The SMF records generated by
    View
    are passed to SARSMFUX, the existing
    View
    SMF user exit, before it writes the SMF record. This record records user logons, user logoffs, report viewing, report reprinting, report loading, and report deletes.
  • SARSPFUX Selection list formatting
    SARSPFUX formats the SYSOUT selection list for online retrieval. The exit must be link-edited and placed in the library containing the
    View
    load modules
    • SARSPFU1 Format lines for lists sample
      SARSPFU1 formats lines for the SYSOUT Selection List or the Report Selection List. This exit is customized for special Optical Disk application.
  • SARSRQUX Selection request
    SARSRQUX examines each selection code entered on the SYSOUT selection list, or the Data Set List.
    • SARSRQU1 Update the GCR records sample
      SARSRQU1 examines the SYSOUT Selection List request to process or pass it on to
      View
      for standard processing. This exit updates the GCR records to reflect print, load and view counts.
    • SARSRQU2 Suppress the P reprint request sample
      SARSRQU2 examines the SYSOUT Selection List request to process or pass it on to
      View
      for standard processing. This exit suppresses the P (REPRINT) request.
    • SARSRQU3 Create SMF records for user-issued commands sample
      SARSRQU3 examines the SYSOUT Selection List request to process it or pass it on to
      View
      for standard processing. This exit creates SMF records for user-issued line commands in a SYSOUT.
    • SARSRQU4 Suppress specific sysout commands sample
      SARSRQU4 examines the SYSOUT Selection List request to process it or pass it on to
      View
      for standard processing. This exit suppresses all commands when the SYSOUT is on tape and use is EXP MODE.
  • SARSTCUX Archival task
    The SARSTCUX exit can modify the data set attributes and to analyze the records for exceptional conditions.
    • SARSTCU1 Modifies the GCR Record
      SARSTCU1 modifies the GCR record for a SYSOUT data set that is selected for archival. The exit maintains only one copy of a sysout data set record that might have been created multiple times due to the use of the /*JOBPARM COPIES=X or DD COPIES=X specification.
    • SARSTCU2 Modify the GCR Record, Print Number of Lines
      SARSTCU2 modifies the GCR record to print and not archive the SYSOUT data sets that are more than a certain number of lines.
    • SARSTCU3 Modify GCR Record, Archive Number of Lines
      SARSTCU3 modifies the GCR record to archive SYSOUT data sets to tape if they are more than a certain number of lines.
    • SARSTCU4 Identify Exception Conditions in GCR Record
      SARSTCU4 identifies exceptional conditions in the GCR record for a SYSOUT data set that is selected for archival.
    • SARSTCU5 Reset GCR Record Attributes for External Writer
      SARSTCU5 resets attributes in the GCR record so that the system uses the External Writer name when it prints the data set.
    • SARSTCU6 Modify the GCR Record, MAXLINES
      SARSTCU6 modifies the GCR record to archive SYSOUT data sets to tape if they are more than the MAXLINES initialization parameter.
    • SARSTCU7 Modify the GCR Record, Display Zeroes
      SARSTCU7 modifies the GCR record to display leading zeros in the JES JOB-ID.
    • SARSTCU8 Reset GCR Record Attributes
      SARSTCU8 resets attributes in the GCR record so that the system will use the External Writer name when it prints the data set. This exit also moves the writerid to the jobname.
    • SARSTCU9 MAXLINES by data set
      SARSTCU9 provides the functionality to either print or direct-to-tape a Sysout within a Sysout group if the Sysout exceeds a specified line limit.
    • SARSTCUA Exceptional condition checking and JCL errors
      SARSTCUA works with Exceptional Condition Checking user exit SARXCTU3 to eliminate JCL errors that were resolved by STOPX37 product
    • SARSTCUC Modifies Archive Date and Time
      SARSTCUC scans the JCL USERDATA OUTPUT fields for an override archival date and time to be used for the report in
      View
      . This sample exit works with the ARCHCHG=YYYY SARINIT parameter.
  • SARSUBUX Job submission
    Online retrieval invokes SARSUBUX to examine and control the submission of jobs for
    View
    . This exit can modify the records for
    View
    to submit or take over the submission of the JCL itself.
    • SARSUBU1 Control Job Submission
      SARSUBU1 examines job records and controls submission of jobs and the display of the SARRPJ panel.
    • SARSUBU2 Insert JCL Statement
      SARSUBU2 inserts the JCL statement //*FROMJOB on the //* JCL card passed by online retrieval if it was invoked by ROSCOE, VTAM, or XMS.
    • SARSUBU3 Insert JCL Keyword
      SARSUBU3 inserts the JCL keyword parameter 'USER=' on the //* JCL card passed by online retrieval if it was invoked by ROSCOE or VTAM. This exit also extracts and appends the USER ID to the 'USER=' keyword parameter.
  • SARTPOUX Tape creation volser exit
    You can use SARTPOUX to customize tape creation. This exit is most commonly used with tape-emulation optical devices with the STORGRXn SARINIT parameters mxblks. SARTPOUX is invoked during the backup cycle and when SARPAC is run whenever a new volume is created from a VOLSER range.
  • SARUNLUX Selective Unload User exit
    SARUNLUX is invoked during the SARDBASE UNLOAD process. This exit is used to control which SYSOUTs to selectively unload to tape during the unload process.
  • SARUSxUX User ID determination
    SARUSxUX represents the user ID determination exits for online retrieval
  • SARXCTUX Exceptional condition checking
    You can customize SARXCTUX to analyze and make a final decision when it detects a user specified condition or a system exceptional condition
    • SARXCTU1 Cause Exception JCLERR Override sample
      SARXCTU1 causes the exception "JCLERR" to override all other exceptions in the SARSTC archival task
    • SARXCTU2 Bypass Cancel Request sample
      SARXCTU2 bypasses the "CANCEL" request when the SARSTC archival task has a RESTART parameter
    • SARXCTU3 and SARSTCUA Processing
      SARXCTU3 and SARSTCUA are sample exits provided to eliminate JCLERR w/STOPX37.