Skip to content
CA Datacom Tools - 15.0
Documentation powered by DocOps

Communication Utility (SVCOMPR)

Last update February 8, 2019

The SVCOMPR batch utility communicates service requests to the Mainframe Server from an input file. Use the SVCOMPR batch utility to do the following:

  • Terminate a server
  • Turn on the trace facility
  • Turn off the trace facility
  • Get a list of connections from workstations to the server
  • Cancel a connection that is waiting on a request from the workstation
Note: If you run SVCOMPR and use CCI to communicate, you must run SVCOMPR on the same system as the Server mainframe region with which you want to communicate. If you run using TCP/IP, then SVCOMPR can be run on any system that has TCP/IP connectivity to the host where the Server Mainframe region is running.

The following topics are discussed:

z/OS SVCOMPR Batch Job

The following z/OS SVCOMPR batch job example is found in CAYTMAC member SVCOMPR:

//SVCOMPR  JOB (ACCT,INFO),'PROGRAMMER',                               

//     CLASS=0,MSGCLASS=T,MSGLEVEL=(1,1),                              
//     GROUP=,USER=*UID,PASSWORD=*PSW                                  
//*  CA DATACOM SERVER COMMUNICATION UTILITY.                          

//* INSTRUCTIONS:                                                      
//*      ***  CHANGE JOB CARD AS NECESSARY FOR YOUR SITE.              
//*      USED IN YOUR SITE.                                            
//*      datacom.db.CUSLIB       - Datacom CUSLIB for DBSIDPR          
//*      datacom.server.CAYTLOAD - Server target loadlib               
//*      datacom.db.CABDLOAD     - Datacom target loadlib              
//*      caipc.CAVQLOAD          - Datacom Ideal IPC loadlib 

//*      YOUR SITE.                                                    
//*      APPLID=        - Required. Identifies the Server Mainframe    
//*                       region to which commands are to be sent.     
//*      HOSTNAME=      - Optional. Identifies the TCPIP host or IP    
//*                       address on which the Server Mainframe region 
//*                       resides. If not provided, CAICCI will be     
//*                       used as the communication protocol.          
//*      PORT=          - Optional. Identifies the TCPIP listener port 
//*                       of the Server Mainframe region. Required     
//*                       with HOSTNAME and must match the PORT=       
//*                       startup option in the Server. Optional if    
//*                       CAICCI is the desired communication protocol 

//SVCOMPR  EXEC PGM=SVCOMPR,REGION=6000K                               
//STEPLIB  DD DISP=SHR,DSN=datacom.db.CUSLIB                           
//         DD DISP=SHR,DSN=datacom.server.CAYTLOAD                     
//         DD DISP=SHR,DSN=datacom.db.CABDLOAD                         
//         DD DISP=SHR,DSN=caipc.CAVQLOAD                              
//SYSOUT   DD SYSOUT=*                                                 
//SYSPRINT DD SYSOUT=*                                                 
//SYSUDUMP DD SYSOUT=*                                                 
//CEEUOPT  DD DISP=SHR,DSN=datacom.server.CAYTMAC(CEEUOPT)             
//SYSIN    DD *                                                        
  insert optional input parameters here, for example:              

z/OS SVCOMPR JCL Control Statements

The JCL control statement SVCOMPR parameter requirements for CA Datacom® Server are as follows:

  • EXEC
    Identifies the executable program name (SVCOMPR) for the server communications utility.
  • JOB
    Specifies a valid JOB statement for the site using site-specific parameters.
    Specifies the SNAPER data set used by CA Datacom®/DB.
    Specifies the DSN statements used by CA Datacom® Server, CA Datacom®/DB, and the CA Common Services for z/OS load libraries. The CA Datacom®/DB custom load library includes the specification for the Multi-User Facility to which the server is to connect. If an operating group of servers is running at the same time, each can only connect with one Multi-User Facility. However, each Multi-User Facility can be accessed by more than one server.
    The library containing the URTs to load must be concatenated into the server STEPLIB. 
    Writes messages to SYSPRINT.
    Produces diagnostic information if there is an abend.
    Explicitly identifies which data set to use to obtain the parameters defined by TCPIP.DATA when no GLOBAL TCPIPDATA is configured.
    Provides output for LE in the event of an abend in one LE controlled module.
    This DD statement is used if an LE module issues a message to STDOUT, typically in the event of an exception being thrown by an LE module.

SVCOMPR Commands

The following options are commands that you can send to the Mainframe Server region. Entries must begin in column 1.

    Identifies the Mainframe Server region to which subsequent commands should be sent. If a CAICCI communication protocol is used, APPLID= is the Application Identifier. If a TCP/IP communication protocol is used, the APPLID is a token that uniquely identifies the Mainframe Server region. Valid columns and entries are as follows:
    • (1-7) APPLID=
    • (8-15) 1-8 characters to identify the CA Common Services for z/OS or the CA CIS application ID to receive the communication.
    Valid Entries: 1 to 20 alphabetic characters, following the rules for SQL names
    Default Value: No default
    (Optional) Cancels the connection. Issue the STATUS command to get a list of connections. Then, issue the CANCEL command for the connection number you want to terminate. Valid columns and entries are as follows:
    • (1-7) CANCEL=
    • (8-15) 1-8-digit number specifying the number of the connection that is obtained from the STATUS list
    (Optional) The DB_THREADS command prints or displays a DB Queue Depth Report. This report shows a measure of the CA Datacom® MUF (DB) thread utilization for the threads/tasks allocated to a Server region by the DBUSERS startup option. 

    CA Datacom Server Version 15.0 generates message DSV00067I to show that the following report is returned:

    DSV00136I-DB Thread Requests
    DSV00136I --------- --------
    DSV00136I-    1        237594
    DSV00136I-    2          7371
    DSV00136I-    3          6092
    DSV00136I-    4          4884
    DSV00136I-    5          3995
    DSV00136I-    6          3449
    DSV00136I-    7          3057
    DSV00136I-    8          2695
    DSV00136I-    9          2376
    DSV00136I-    10         2038
    DSV00136I-    11         1680
    DSV00136I-    12         1325
    DSV00136I-    13         1019
    DSV00136I-    14          672
    DSV00136I-    15          335
    DSV00136I-DB Requests delayed due to no thread available: 0

    For more information about the report written see DB_THREADS Report.

  • EOJ
    (Optional) Tells the server to terminate immediately. A Mainframe Server should terminate automatically if its MUF fails while there are active database requests. Terminate the server manually with the EOJ parameter if the following occurs:
    • If the MUF fails and the server does not terminate automatically
    • If you need to restart a server with different input parameters
    (1-3) EOJ  

  • HOSTNAME=xxxxxxxx
    (Optional)Specifies the hostname or IP address of the Server Mainframe region (SVDBSPR) to which you want to communicate. PORT= is required with HOSTNAME= and must match the corresponding SVDBSPR startup options. Additionally, PROTOCOL=BOTH or PROTOCOL=TCP is required in the SVDBSPR region startup options.

    Note: HOSTNAME and PORT options permit TCP/IP communication with the Server Mainframe region as an alternative to CAICCI.
    (Optional) Specifies startup Mainframe Server options that you can modify while the server is active. Any option that this statement modifies is in effect for all connections to the server after modification. It is also in effect until another MODIFY is issued or until the server is terminated. The following input options can be modified:


    Valid columns and entries are:

    • (1-7) MODIFY
    • (8-80) Options to be modified separated by commas, with no embedded blanks. A MODIFY statement may not be continued, but there may be multiple MODIFY statements in the input to the utility.
    (Optional) Requests SVCOMPR to report a list of all the Mainframe Server options and their current settings.
    (1-7) OPTIONS
  • PORT=xxxxx
    Specifies the TCP/IP listener PORT for the Server Mainframe (SVDBSPR) region to which you want to communicate. HOSTNAME= is required with PORT= and must match the corresponding SVDBSPR startup options. Additionally, PROTOCOL=BOTH or PROTOCOL=TCP is required in the SVDBSPR startup options.

    Note: If all TCP/IP ports are in use and the request is a STATUS or OPTIONS command, a timeout may occur. Resubmit the job or use the console interface to issue the STATUS or OPTIONS command.
    (Optional) Produces a status report of activity that the Mainframe Server currently processes including a list of current tasks or connections.
    For more information about the reports written, see STATUS Report.
    (1-6) STATUS
    (Optional) Turns on the trace facility.
    (1-7) TRACEON
    (Optional) Turns off the trace facility.
    (1-8) TRACEOFF
    (Optional) Turns on the abbreviated date/time stamp trace.
    (1-9) TRACETIME
  • TRUSER1=
  • TRUSER2=
  • TRUSER3=
  • TRUSER4=
  • TRUSER5=
    (Optional) Enables an SQL Syntax trace and defines the userids to trace. When enabled, the SQL syntax generated by the application of the user is written to SYSPRINT. The output of the SQL Syntax trace is typically brief but depends on the length of the SQL statements. An example of the output is shown in the Input Parameters topic of Mainframe Server Component Implementation.
    The global TRACEON option overrides TRUSERx=. If TRACEON=YES is coded in the Server Mainframe Region startup options, or TRACEON is issued as a previous console or SVCOMPR command, the SQL syntax trace entries are not written to SYSPRINT.
    • *(1-8)
    • *(9-17) Enter a valid userid, TRUSRALL, TRUSROFF, or blanks.
      • TRUSERx= useridx enables the SQL Syntax trace for a specific userid.
      • TRUSERx= disables the SQL Syntax trace for a specific userid.
      • TRUSER1=TRUSRALL enables the SQL Syntax trace for ALL userids.
      • TRUSER1=TRUSROFF disables the SQL Syntax trace for ALL userids including those enumerated by a previous TRUSERx= command.
    Valid entries are: A valid user ID, TRUSRALL, or TRUSROFF
Was this helpful?

Please log in to post comments.