Clarification of the parameters available to be used by the SARSAM8 program (also called ADLIST)

Document ID : KB000056947
Last Modified Date : 14/02/2018
Show Technical Document Details

The ADLIST program can be used to retrieve certain information from the database.  
                                                                    
******************************************************************************
                                                                    
Sample JCL:                                                   
                                                                    
         //ADLIST   EXEC PGM=ADLIST,PARM='.....DB_HLQ......'         
         //STEPLIB  DD DSN=...............CVDELOAD,DISP=SHR         
         //SYSPRINT DD SYSOUT=*                                     
         //CTLCARD  DD  DSN=......CTLCARD,DISP=(NEW,CATLG),         
         //             UNIT=SYSDA,SPACE=(TRK,(1,1)),               
         //             DCB=(,RECFM=FB,LRECL=80,BLKSIZE=8000)       
         //SYSIN    DD *                                            
         /LIST  ARCHDATE=|STARTDATE=MM/DD/YY|ENDDATE=MM/DD/YY[-MM/DD/YY]
                          |*|TODAY                
                [ARCHTIME=|STARTTIME=HH:MM-[HH:MM]ENDTIME=HH:MM-[HH:MM]]    
                        
                [REPORTID=XXX]                                     
                [RDRDATE]                                          
                [INDEX]                                            
                [ORIG=[SAR|EXP|ALL]                                
                [CCREATE[(COMMAND)]] 

                [XCODE|RETENTION|TEMP|BNDW|MAXLINES|MAXLINES(9999999999)|USERCOM]                                  
         /*                                                         
                                                                    
*****************************************************************************     

     
Using any of these parameters will cause ADLIST to list all reports. 
      ARCHDATE=*                                                
      STARTDATE=*                      
      ENDDATE=*                                                 
    

Using any of these parameters will cause ADLIST to list all reports with Today's date.                                            
      ARCHDATE=TODAY                                            
      STARTDATE=TODAY   
      ENDDATE=TODAY                                             


When using a date range or a single date, the format is:                                                                
      ARCHDATE=MM/DD/YY
      ARCHDATE=MM/DD/YY-MM/DD/YY        When using ARCHDATE to specify a single date the time is specified by  the ARCHTIME parameter.

ARCHTIME=specifies a time or a time range within ARCHDATE and the default range is 00:00-23:59.   
  
      ARCHTIME=HH:MM-[HH:MM]                 

                                               
When a date range (DATE(1)-DATE(2)) is specified for ARCHDATE and a time range (TIME(1)-TIME(2)) is specified for ARCHTIME:                    

      TIME(1) applies to DATE(1)              
      TIME(2) applies to DATE(2)            
      ARCHTIME has no effect if ARCHDATE is not specified.    
                      

When using STARTDATE to specify a single date, the time is specified by the STARTTIME parameter which specifies a time or a time range within STARTDATE.  The default time range for STARTTIME is 00:00-23:59.   
  
      STARTTIME=HH:MM-[HH:MM]                  

                                               
When a date range (DATE(1)-DATE(2)) is specified for STARTDATE and a time range (TIME(1)-TIME(2)) is specified for STARTTIME:                   
     
      TIME(1) applies to DATE(1)              
      TIME(2) applies to DATE(2)            
      STARTTIME has no effect if STARTDATE is not specified.    
   

When using ENDDATE to specify a single date, the time is specified by the ENDTIME parameter which specifies a time or a time range within ENDDATE.  The default time range for ENDTIME is 00:00-23:59.   
  
      ENDTIME=HH:MM-[HH:MM]                  

                                               
When a date range (DATE(1)-DATE(2)) is specified for ENDDATE and a time range (TIME(1)-TIME(2)) is specified for ENDTIME:                   
     
      TIME(1) applies to DATE(1)              
      TIME(2) applies to DATE(2)            
      ENDTIME has no effect if ENDDATE is not specified.    
 
 
***************************************************************************    

You can also specify a secondary parameter to further restrict the output.                                                   

     When you specify:
      1. REPORTID    The general list function is restricted to the specified Rreport Id.  The Report Id can have a wildcard (*) and then aoll reports matching that number of significant characters will be returned.     
                                                                  
       
      2. RDRDATE     When this parameter is used the ADLIST utility will display the Reader Date/Time instead of
                             the "Last Print" date and time.             
  

     3. INDEX           This parameter will cause ADLIST to display only reports which have a logical view page index 
                             on disk.                 
                                                                  
      4. CCREATE     This parameter will cause the utility to create SARBCH control cards
                   
                              The format is CCREATE(COMMAND)
                                   Up to 60 characters will be moved to the control card.  
                                        
                                   If the CCREATE parameter is coded without the '(COMMAND)', X's will be placed in the SARBCH 
                                  command field.             
      
                                  If CCREATE is used, the CTLCARD DD must be coded
                        
                                  The Control card parameter must fit on a single statement but any number of statements can be
                                  coded to define all the required parameters 
                                                             
      5. ORIG=ALL   This parameter will cause the utility to list areports (this is the default if the original parameter is not   coded) 

                                                                                                  
**********************************************************************************************
                                                                   
In this section the parameters that are listed are mutually exclusive (only one can be used): 
                           
         XCODE       List only reports which have exception codes        
                                                                    
         RETENTION   List ERO Rention values    
                     NOTE: If RETENTION is specified, the RDRDATE          
                                                                    
         TEMP        List all reports in 'TEMP' status                   
                                                                    
         BNDW      List all reports in 'BUNDLE WAIT' status            
                                                                    
         MAXLINES    List only reports which exceed the 'MAXLINES' initialization parameter            
                                                                 
         MAXLINES(9999999999)  List only reports which exceed the specified number of lines     (Up to 10 digits)    
                                                                  
         USERCOM     Displays the contents of the User Field