Adding exits


Exit Services enhances IMS Connect functions. For example, you can dynamically add and reload exits and processing options, define security, and create and maintain exits without having to code the exits in assembler language. The following exit types are available:

  • Customer exits are written by using assembler language.
  • Virtual exits are created and maintained only by using Energizer.

Related topics

To add an Exit Services configuration member

  1. On the command line in the Configuration panel, type ADD and press Enter.The New Options panel is displayed.
  2. To define a new Exit Services member, type and press Enter.The Default Exits panel is displayed.

    Default Exits                 
    Command ===> ___________________________________
                                                   
    Select (type a '/') any of the following         
    to add default exits.  Then press Enter.         
                                                    
          / HWSJAVA0 default exit                    
          _ HWSSMPL0 default exit                    
          _ HWSSMPL1 default exit                    
          / IPRCMDS0 virtual exit
    Warning

    Important

    IMS Connect includes HWSJAVA0, HWSSMPL0, and HWSSMPL1 exits. These customer exits were written by using assembler language. For more information about exits, see Defining-message-exits.

    The IPRCMDS0 exit is required when you are using the ISPF interface. This exit processes Energizer commands. If MSGID strings conflict with other exits, you can change them.

  3. By each exit that you want to add, type a slash (/) and press Enter.The Exit Services panel is displayed. For more information about this panel, see the online Help.

                                   Exit Services              Row 1 to 2 of 2  
      Command ===> ________________________________________ Scroll ===> PAGE  
                                        Commands: ADD Locate SAVE Select SORT  
        Exit services name . . ________                                        
        Description  . . . . . ________________________________________        
                                                                              
      Type one or more action codes.                                           
        S=Update C=Copy D=Delete I=Insert T=Toggle-type A=Activate X=Deact     
      A Exit     Type     MSGID1 String       MSGID2 String    Routing Active  
      _ HWSJAVA0 CUSTOMER '*HWSJAV*'_________ A'*HWSJAV*'________    /         
      _ IPRCMDS0 VIRTUAL  '-IPRCMD-'_________ A'-IPRCMD-'________    /         
      *************************** Bottom of data ****************************  

    HWSJAVA0 and IPRCMDS0 exits were added.
  4. At Exit services name, enter the name that you want to use.
  5. (Optional) At Description, enter descriptive text.
  6. Enter an action code to update an exit, or press End.

To copy an Exit Services configuration member

You can clone the new exit services member from the existing exit services member using Copy command on the Energizer configuration panel.

  1. On the command line in the Configuration panel, type Copy <Exit services member name> and press Enter.The exit services panel is displayed.
    File  Display  Help                                                          
  ------------------------------------------------------------------------------
                                   Configuration                07 options found
                                            Commands: ADD COPY Locate Select SORT
  Options library . . . : BOLNXC.IPR.OPTIONS                                     
                                                                                
  Type one or more action codes.  Then press Enter.                              
    S=Display/Update   C=Copy   D=Delete   I=Insert   R=Reload Connect           
  A Name     Type     Saved             User    Description                      
    SD5DELNK eLink    17/11/17 03:08    MVSSYD  Elink for energizer              
    SD5DEGRP eGroup   20/07/16 04:35    MVSSYD  R15 EGRP                         
    SD5DBCON Connect  20/05/12 07:21    MVSSYD  IMS Connect
    SD5DIMS  IMS      17/10/17 07:25    MVSSYD  R15 control region               
    SD5DODBM ODBM     19/12/02 04:42    MVSSYD  ODBM                             
    SD5DR15  Router   20/12/17 01:37    MVSSYB  router                           
    IPREXT15 Exits    23/02/09 04:37    BOLNXC  exit services                    
  ******************************* Bottom of data ********************************
                                                                                
                                                                                   
                                                                                
  Command ===> COPY IPREXT15                                    Scroll ===> PAGE
   F1=Help      F2=Keys      F3=Exit      F4=Prompt    F7=Bkwd      F8=Fwd       
   F9=Retrieve F10=Back     F11=Next     F12=Cancel                              

       2. At exit services name, enter the name that you want to use.

       3. (Optional) At Description, enter descriptive text.

                                Exit Services         
                                  Commands: ADD Locate SAVE Select SORT
  Exit services name . .                                                
  Description  . . . . . exit services                                  
                                                                       
Type one or more action codes.                                          
  S=Update C=Copy D=Delete I=Insert T=Toggle-type A=Activate X=Deact    
A Exit     Type     MSGID1 String       MSGID2 String    Routing Active
  HWSJAVA0 CUSTOMER '*HWSJAV*'          A'*HWSJAV*'            /        
  HWSSMPL0 VIRTUAL  '*SAMPLE*'          A'*SAMPLE*'            /        
  IPRCMDS0 VIRTUAL  '-IPRCMD-'          A'-IPRCMD-'            /        
*************************** Bottom of data ****************************
                                                                        

      4. Enter an action code to update an exit, or press End.

To update a customer exit

  1. From the Exit Services panel, press Tab until you reach the customer exit that you want to edit (for example, the HWSJAVA0 exit).
  2. Type S, and press Enter.The Customer Exit Options panel is displayed. For more information about this panel, see the online Help.

                              Customer Exit Options

      Type the options for Customer (assembler) exits defined to IMS Connect.
      Scroll down for more options and samples.                              
                                                                            
        Customer exit name . : HWSJAVA0                                      
                                                                            
      Select (type a '/') any of the following.                              
        / Activate message routing for this exit                             
        _ Return fullword message length                                     
        _ Call termination routine when exit is reloaded                     
        _ Call initialization routine when exit is reloaded                  
                                                                            
      String options           MSGID1 String       MSGID2 String             
        String . . . . . . . . '*HWSJAV*'_________ A'*HWSJAV*'________       
                                                                            
        String usage.  Select one of the following.                          
         1 1. Verify that the exit uses the above strings                    
           2. Override the strings coded in the exit with the above strings  
           3. Ignore the above strings and use those coded in the exit       
                                                                            
    Sample strings (use quotes for mixed case)                               
        Type EBCDIC strings like this . : '*SAMPLE*'                         
        Type ASCII strings like this  . : A'*SAMPLE*'         (use A')       
        Type hex strings like this  . . : X'2A63414D50C4452A' (use X')

    IRM header fields        Offset  (offset=0 for default)              
      Userid . . . . . . . . 00                                          
      Group  . . . . . . . . 00                                          
      Password . . . . . . . 00              
  3. Enter information, and press End.

To update a virtual exit

  1. From the Exit Services panel, press Tab until you reach the virtual exit (for example, the IPRCMDS0 exit).
  2. Type S, and press Enter.For more information about the panels, see the online Help.

    The first screen of the Virtual Exit Options panel is displayed.

                             Virtual Exit Options
                                                               More:     +  
    Type the options for Virtual exits not defined to IMS Connect.         
    Scroll down for more options and samples.                              
                                                                          
      Virtual exit name  . : IPRCMDS0                                      
                                                                          
    Select (type a '/') any of the following.                              
      / Activate message routing for this exit                             
      / Return fullword message length                                     
      / Allow Energizer extensions                                         
      _ Force transaction expiration for all messages                      
                                                                          
    String options           MSGID1 String       MSGID2 String             
      String . . . . . . . . '-IPRCMD-'_________ A'-IPRCMD-'________       
                                                                          
      Activate translation . _                   /        ('/' to activate)
        Client to IMS table. ________            ________ (blank=default)  
        IMS to client table. ________            ________                  
  3. Enter information that you want to update, and scroll to the next screen.

                              Virtual Exit Options                           
                                                                More:   - +
        IMS to client table. ________            ________                  
                                                                          
    IRM header fields        Offset Status  (offset=0 for default)         
      Userid . . . . . . . . 0____ REQUIRED (if any checks selected below)
      Group  . . . . . . . . 0____ OPTIONAL (REQUIRED or OPTIONAL or NONE)
      Password . . . . . . . 0____ OPTIONAL (REQUIRED or OPTIONAL or NONE)
      New password . . . . . 80___ OPTIONAL (OPTIONAL or NONE)             
      Application id . . . . 0____ NONE____ (REQUIRED or OPTIONAL or NONE)
      Reroute/Clientid . . . 0____ NONE____ (REQUIRED or OPTIONAL or NONE)
      MFS Modname  . . . . . 0____ NONE____ (REQUIRED or OPTIONAL or NONE)
    Other options                                                          
      Maximum timeout. . . . ____ (0.01 to 3600 seconds, blank for none)
      User virtual exit name ____________   
                                                                          
    Virtual exit options for security checks within IMS Connect            
      Select (type a '/') any of the following.                            
  4. Enter information that you want to update, and scroll to the next screen.

                              Virtual Exit Options                           
                                                                More:   - +
      Select (type a '/') any of the following.                            
      _ Enable userid authentication                                       
      _ Enable IMS Connect authentication                                  
      _ Enable transaction authentication                                  
                                                                          
      IMS Connect resource . ____________ (used for IMS Connect authentication)
      Security exit name . . ____________ (your exit for additional checks)    
      Trusted IP address . . ______________________________________________
      Trusted IP list member ____________(PROCLIB member containing IP addresses
                                          / Port Numbers/ SAFID for ACEE cache)
                                    
    OTMA security options for security checks within IMS                   
      Default userid . . . . ________ (passed to IMS if no userid in IRM)  
      Default group  . . . . ________ (passed to IMS if no group in IRM)   
      Security level to be used when /SECURE OTMA PROFILE used in IMS.     
       3 1. NONE  - no authentication within IMS                           
         2. CHECK - IMS authenticates commands and transactions         
  5. Enter information that you want to update, and scroll to the next screen.

                              Virtual Exit Options                           
                                                                More:   - +
      Security exit name . . ____________ (your exit for additional checks)    
      Trusted IP address . . ______________________________________________
      Trusted IP list member ____________(PROCLIB member containing IP addresses
                                          / Port Numbers/ SAFID for ACEE cache)
                                    
    OTMA security options for security checks within IMS                   
      Default userid . . . . ________ (passed to IMS if no userid in IRM)  
      Default group  . . . . ________ (passed to IMS if no group in IRM)   
      Security level to be used when /SECURE OTMA PROFILE used in IMS.     
       3 1. NONE  - no authentication within IMS                           
         2. CHECK - IMS authenticates commands and transactions            
         3. FULL  - Same as CHECK plus dependent region checks             
                                                                          
    Sample strings (use quotes for mixed case)                             
        Type EBCDIC strings like this . : '*SAMPLE*'                       
        Type ASCII strings like this  . : A'*SAMPLE*'         (use A')     
        Type hex strings like this  . . : X'2A63414D50C4452A' (use X')
  6. Enter information that you want to update, and press End.

To add a new exit

  1. On the command line in the Exit Services panel, type ADD and press Enter.The New Exit panel is displayed.

                   New Exit               
                                         
    Select one of the following to        
    create a new exit.  Then press Enter.
                                         
     _ 1. Customer exit                   
       2. Virtual exit                    
       3. HWSJAVA0 default exit           
       4. HWSSMPL0 default exit           
       5. HWSSMPL1 default exit           
       6. IPRCMDS0 virtual exit
  2. Enter the number of the exit to add, and press Enter.Based on the selection that you made, the Customer Exit Options panel or the Virtual Exit Options panel is displayed. For more information about the displayed panel, see the online Help.
  3. Add information, and press End.

To delete an exit

  1. Select the exit services member you want to modify.
  2. Enter an action code to delete the exit.
                              Exit Services              Row 1 to 3 of 3
                                   Commands: ADD Locate SAVE Select SORT
   Exit services name . : SD5DEX16                                       
   Description  . . . . . exit services                                  
                                                                        
 Type one or more action codes.                                          
   S=Update C=Copy D=Delete I=Insert T=Toggle-type A=Activate X=Deact    
 A Exit     Type     MSGID1 String       MSGID2 String    Routing Active
 d HWSJAVA0 CUSTOMER '*HWSJAV*'          A'*HWSJAV*'            /        
   HWSSMPL0 VIRTUAL  '*SAMPLE*'          A'*SAMPLE*'            /        
   IPRCMDS0 VIRTUAL  '-IPRCMD-'          A'-IPRCMD-'            /        
 *************************** Bottom of data ****************************  

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC AMI Energizer for IMS Connect 1.9