Skip to main contentIBM ZLPN Documentation

How to Add/Remove Applications from System Automation Policy Database

Quick reference


Overview

This guide provides step-by-step instructions for managing applications in the IBM Z System Automation Policy Database (PDB). The Policy Database contains automation policies that define how applications are monitored, started, stopped, and managed by System Automation.

Prerequisites:

System Information:

System Automation Components:

STC NameSTC UserDescription
AUTOPROCAUTOPROCSystem Automation Netview Agent server
AUTOMANAUTOMANSystem Automation manager server
AUTOSSIAUTOSSISystem Automation subsystem interface

Understanding the Policy Database

What is the Policy Database?

The Policy Database (PDB) is a file that contains:

Key Concepts

Application Group (AGP):

Application Resource (APL):

Automation Policy:

Dependencies:

Back to Quick reference


Adding an Application to the Policy Database

Step 1: Access the Policy Database Editor

  1. Log on to TSO/ISPF

  2. Navigate to the System Automation panels:

    TSO SA
    

    Or from ISPF command line:

    =SA
    
  3. Select option 1 - Edit the Policy Database

    0  Settings        User parameters                                     
                                                                         
    BR Browse          Browse the Policy Database                          
    1  Edit            Edit the Policy Database                            
    2  Build           Build functions for Policy Database                 
    3  Report          Generate reports from Policy Database               
    4  Policies        Maintain Policy Database list                       
    5  Data Management Import policies into a Policy Database              
    U  User            User-defined selections                             
                                                                         
    X  Exit            Terminate Customization Dialog                      
                                                                         
    To switch to another Policy Database, specify the Policy Database name 
    in the following field, or specify a ? to get a selection list.        
    Current Policy Database . . . LTEPLEX_PDB                              
    

Step 2: Create a New Application Resource

  1. Select option 6 APL Applications

    Enter number or entry type or use "BR <entry type>" for browse             
                                                                            
    1 ENT    Enterprise                     30 TMR    Timers                  
    2 GRP    Groups                         32 TPA    Tape Attendance         
    3 SBG    SubGroups                      33 MVC    MVS Components          
    4 SYS    Systems                        34 MDF    MVSCOMP Defaults        
    5 APG    ApplicationGroups              35 SDF    System Defaults         
    6 APL    Applications                   36 ADF    Application Defaults    
    7 EVT    Events                         37 AOP    Automation Operators    
    8 SVP    Service Periods                38 NFY    Notify Operators        
    9 TRG    Triggers                       39 NTW    Networks                
    10 PRO    Processors                    40 XDF    Sysplex Defaults        
    11 MTR    Monitor Resources             41 RES    Resident CLISTs         
                                            42 SCR    Status Display          
    13 PAC    Pacing Gates                  50 DMN    Remote Domains          
                                            51 REF    Resource References     
    20 PRD    Product Automation                                               
    21 MSG    Messages                      99 UET    User E-T Pairs          
    
  2. On Command line type Command ===> new

  3. Fill in the Application Resource Definition panel:

    Define new entry of type Application                                         
                                                                              
    Entry name . . . . . . . MYAPP                                               
                                                                               
    Subsystem Name . . . . . MYAPP                                               
    Object Type  . . . . . . INSTANCE     (CLASS INSTANCE TEMPLATE)            
    Category . . . . . . . .              (IBM-defined, user-defined or blank, 
                                           see help)                           
    Subcategory  . . . . . .              (IBM-defined, user-defined or blank, 
                                           see help)                           
    Job Type . . . . . . . .              (MVS NONMVS TRANSIENT)               
    Job Name . . . . . . . . MYAPP                                               
    Transient Rerun  . . . .              (YES NO)                             
    Scheduling Subsystem . .              (MSTR, JES Subsystem)                
    JCL Procedure Name . . .                                                   
                                                                               
    Short Description  . . . MYAPP                                                  
    Long Description 1 . . .                                                   
    Long Description 2 . . .                                                   
    
  4. PF3 to save the entry.

Step 3: Define Policy Selection

  1. From the Application Resource panel, select:

    Option 2 - Automation Policy
    
  2. Configure the Upward Class settings by placing a S on that line and hitting enter:

    Entry Type : Application             PolicyDB Name   : LTEPLEX_PDB            
    Entry Name : MYAPP                   Enterprise Name : LTEPLEX_PDB            
                                                                                  
    Action      Policy Name          Policy Description                           
                DESCRIPTION          Enter description                            
       s        UPWARD CLASS         Select a class to inherit data from             
    
  3. Attach C_APPL by placing a S and hit enter:

    Entry Type : Application           PolicyDB Name   : LTEPLEX_PDB           
    Entry Name : MYAPP                 Enterprise Name : LTEPLEX_PDB           
                                                                               
    Action      Status     Entry Name            Category    Upward Class Link 
                           C_AM                                                
       s                   C_APPL    
    
  4. PF3 to save the changes.

  5. Configure Application Info by placing a S and hit enter:

    Entry Type : Application             PolicyDB Name   : LTEPLEX_PDB          
    Entry Name : MYAPP                   Enterprise Name : LTEPLEX_PDB          
                                                                               
    Action      Policy Name          Policy Description                         
                UPWARD CLASS         Select a class to inherit data from        
       s        APPLICATION INFO     Define application information             
    
  6. Take Default by PF3 to save the changes.

    Note: If the application is one from the below chart do not take defaults

    CategorySubcategory
    CICSAOR TOR FOR DOR QOR CMAS WUI
    DB2MSTR SPAS IRLM DBM1 DIST WLMS ADMT
    IMSCTL TP DBRC DLS FP BMP FDR
    ITMKAHAGENT TEMS
    LIFELINEADVISOR AGENT
    OPCCONTROLLER TRACKER SERVER DATASERVER
  7. Configure Relationship by placing a S:

    Entry Type : Application             PolicyDB Name   : LTEPLEX_PDB      
    Entry Name : MYAPP                   Enterprise Name : LTEPLEX_PDB      
                                                                            
    Action      Policy Name          Policy Description                     
                APPLICATION INFO     Define application information         
                AUTOMATION FLAGS     Define application automation flags    
                APPLICATION SYMBOLS  Define application symbols             
                TRIGGER              Select trigger                         
                SERVICE PERIOD       Select service period                  
                PACING GATE          Select pacing gate                     
       s        RELATIONSHIPS        Define relationships         
    
  8. On Command line type Command ===> NEW and hit enter

  9. Define the relationship:

    Relationship Type. . HASPARENT               MAKEAVAILABLE MAKEUNAVAILABLE  
                                                 PREPAVAILABLE PREPUNAVAILABLE  
                                                 HASPARENT HASPASSIVEPARENT     
                                                 HASMONITOR PEEROF              
                                                 FORCEDOWN EXTERNALLY           
    Supporting Resource. JES2/APL/=
    
  10. PF3 to save changes.

  11. PF3 to save relationship.

  12. Configure Where used by placing a S and hitting Enter

Entry Type : Application             PolicyDB Name   : LTEPLEX_PDB            
Entry Name : MYAPP                   Enterprise Name : LTEPLEX_PDB            
                                                                              
Action      Policy Name          Policy Description                           
            RELATIONSHIPS        Define relationships                         
            MESSAGES/USER DATA   Define messages and user data                
            STARTUP              Define startup procedures                    
            SHUTDOWN             Define shutdown procedures                   
            THRESHOLDS           Define error thresholds                      
            MINOR RESOURCES      Define application minor flags and thresholds
            SYSTEM ASSOCIATION   Define primary and secondary associations    
            -------------------- -----RESOURCES-------------------------------
            GENERATED RESOURCES  List resources generated for this entry      
            MEMBER OF            List resources where this entry is a member  
            -------------------- ---------------------------------------------
      s     WHERE USED           List application groups linked to this entry 
  1. Place a S next to BASE_SYS and hit Enter
Entry Type : Application           PolicyDB Name   : LTEPLEX_PDB
Entry Name : MYAPP                 Enterprise Name : LTEPLEX_PDB
                                                               
Action      Status            Name                        Type  
   s                          BASE_SYS                    APG   
  1. PF3 to save the changes.
  2. PF3 to save all changes to policy before build.
  3. Activate the Policy Changes

Back to Quick reference


Deleting an Application from the Policy Database

Step 1: Access the Policy Database Editor

  1. Log on to TSO/ISPF

  2. Navigate to the System Automation panels:

    TSO SA
    

    Or from ISPF command line:

    =SA
    
  3. Select option 1 - Edit the Policy Database

    0  Settings        User parameters                                     
                                                                         
    BR Browse          Browse the Policy Database                          
    1  Edit            Edit the Policy Database                            
    2  Build           Build functions for Policy Database                 
    3  Report          Generate reports from Policy Database               
    4  Policies        Maintain Policy Database list                       
    5  Data Management Import policies into a Policy Database              
    U  User            User-defined selections                             
                                                                         
    X  Exit            Terminate Customization Dialog                      
                                                                         
    To switch to another Policy Database, specify the Policy Database name 
    in the following field, or specify a ? to get a selection list.        
    Current Policy Database . . . LTEPLEX_PDB  
    

Step 2: Delete the Application Resource

  1. Return to Application Resources Select option 6 APL Applications

    Enter number or entry type or use "BR <entry type>" for browse             
                                                                            
    1 ENT    Enterprise                     30 TMR    Timers                  
    2 GRP    Groups                         32 TPA    Tape Attendance         
    3 SBG    SubGroups                      33 MVC    MVS Components          
    4 SYS    Systems                        34 MDF    MVSCOMP Defaults        
    5 APG    ApplicationGroups              35 SDF    System Defaults         
    6 APL    Applications                   36 ADF    Application Defaults    
    7 EVT    Events                         37 AOP    Automation Operators    
    8 SVP    Service Periods                38 NFY    Notify Operators        
    9 TRG    Triggers                       39 NTW    Networks                
    10 PRO    Processors                    40 XDF    Sysplex Defaults        
    11 MTR    Monitor Resources             41 RES    Resident CLISTs         
                                            42 SCR    Status Display          
    13 PAC    Pacing Gates                  50 DMN    Remote Domains          
                                            51 REF    Resource References     
    20 PRD    Product Automation                                               
    21 MSG    Messages                      99 UET    User E-T Pairs          
    
  2. Locate the application to remove

  3. Enter line command D (Delete) next to the application:

    D  MYAPP    My Application Description
    
  4. Confirm the deletion when prompted, press ENTER:

    Name              : MYAPP                                               
    Short description :                                                   
                                                                         
    Press ENTER to confirm delete of this entry.                          
    Press CANCEL or END to cancel delete.                                 
                                                                         
    The following links exist in the WHERE USED policy:                   
                                                                         
    Name                  Type    Short Description                       
    BASE_SYS              APG     Base z/OS, Network and Automation       
    
  5. Activate the Policy Changes

Back to Quick reference


Activating Policy Changes

After adding or removing applications, activate the changes:

Rebuild and Activate

Build Policy Database with the new Application

Step 1: Access the Policy Database for a Build

  1. Log on to TSO/ISPF

  2. Navigate to the System Automation panels:

    TSO SA
    

    Or from ISPF command line:

    =SA
    
  3. Select option 2 - Build functions for Policy Database

Step 2: Build a Complete Enterprise

  1. Select option 1 - Build a Complete Enterprise and hit enter:
       Option ===>  1                                
                                              
       1 Build a complete enterprise                                           
       2 Build sysplex group or stand alone system                             
          Sysplex / System name. .                        (*, ?, or name)     
       3 Build entry type or entry name                                        
          Entry Type. . . . . . . .                       (*, ?, or type)     
          Entry Name. . . . . . . . *                     (*, ?, or name)     
       4 View build report                                                     
       5 Delete unused build output members                                    
                                                                               
    Build options:                                                            
       Output Data Set . . . . 'SYSAUTO.PDB.SOCNTL.BUILD'                      
       Mode. . . . . . . . . . ONLINE      (ONLINE BATCH)                      
       Type. . . . . . . . . . MODIFIED    (MODIFIED ALL)                      
       Configuration . . . . . NORMAL      (NORMAL ALTERNATE TERTIARY)       
    

    Note: Type Modified, this is needed after the first build to make updates.

  2. To refresh the Automation Control file, submit the following sample jcl:
    //BACKUP   EXEC PGM=IEBCOPY                             
    //INLIB    DD DSN=SYSAUTO.PDB.SOCNTL.BUILD,DISP=SHR     
    //OUTLIB   DD DSN=SYSAUTO.PDB.SOCNTL(+1),               
    //         UNIT=SYSDA,                                  
    //         DISP=(NEW,CATLG),                            
    //         VOL=SER=LTECAT,                              
    //         LIKE=SYSAUTO.PDB.SOCNTL.BUILD                
    //SYSPRINT DD SYSOUT=H                                  
    //SYSIN    DD *                                         
    COPY OUTDD=OUTLIB,INDD=INLIB                           
    //*      
    
  3. Issue a =sdsf on the command line to get to the console.
  4. Issue a /%sae1 @ref to dynamically take effect.

Back to Quick reference


Verifying Changes

Verify Automation is Active

  1. Issue the display command:

    /%SAE1 DISPSTAT MYAPP
    
  2. Review the output:

Test Automation Behavior

  1. Test Auto-Start:

    • Stop the application manually: %SAE1 SASTART MYAPP
    • Verify System Automation restarts it automatically
    • Check the automation log for restart messages
  2. Test Auto-Stop:

    • Stop the application manually: %SAE1 SASTOP MYAPP
    • Verify System Automation stops

Back to Quick reference


System Automation Command Quick Reference from SDSF

CommandDescription
/%SAE1 @refRefresh automation control file (dynamically activate changes)
/%SAE1 SASTART <appname>Start an application
/%SAE1 SASTOP <appname>Stop an application
/%SAE1 DISPSTAT <appname>Display status of an application
/%SAE1 INGVOTE  Display outstanding votes

IBM System Automation Documentation

IBM Netview Documentation

Back to Quick reference