Send Service Request (QPDETSND) API


  Required Parameter Group:

1 Request Data Input Char(*)
2 Length of request data Input Binary(4)
3 Format or request data Input Char(8)
4 Error Code I/O Char(*)

  Default Public Authority: *EXCLUDE

  Threadsafe: No

The Send Service Request (QPDETSND) API sends the request to the Service Monitor or to the Service Control job.

If the Service Control job is not active, the job will be submitted.

If the Service Monitor is not active, and the request is for a Service Monitor function, a request will be submitted to the Service Control job to start the Service Monitor before sending the request.


Authorities and Locks

Authority to use the API
*SERVICE When format SNDR0100 (Refresh policy file request) is sent.

Required Parameter Group

Request data
INPUT; CHAR(*)

Information to use while processing the request. The format of this data is specified by the Format of request data parameter.

Length of request data
INPUT; BINARY(4)

How long the request data is.

Format of request data. This indicates the type of request being submitted. Only the following values are accepted:
INPUT; CHAR(8)

SNDR 0100    Send a refresh Service Monitor policy file request.

SNDR 0200    Send a start function request.

SNDR 0300    Send a stop function request.

SNDR 0400    Send a Service event request.

SNDR 0500    Send a change logging level request.

SNDR 0600    Send a handle changed system value request.

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


SNDR0100 - Refresh Policy File Request

Offset Type Field
Dec Hex
0 0 BINARY(4) Type of policy data
4 4 BINARY(4) Length of policy data
8 8 CHAR(*) Policy data


SNDR0200 - Start a Function Request

Offset Type Field
Dec Hex
0 0 BINARY(4) Number of functions to start
4 4 Array of BIN(4) Functions to start


SNDR0300 - Stop a Function Request

Offset Type Field
Dec Hex
0 0 BINARY(4) Number of functios to stop
4 4 Array of BIN(4) Functions to stop


SNDR0400 - Service Event Request

Offset Type Field
Dec Hex
0 0 BINARY(4) Length of header information
4 4 BINARY(4) Offset to service event
8 8 BINARY(4) Length of service event data
12 C CHAR(10) Service event type
22 16 CHAR(10) Service event identifier
32 20 CHAR(10) Service event error detection
42 2A CHAR(*) Service event data


SNDR0500 - Change Logging Levels Request

Offset Type Field
Dec Hex
0 0 BINARY(4) Logging Level


SNDR0600 - Handle Changed System Value Request

Offset Type Field
Dec Hex
0 0 BINARY(4) Number of system values changed
4 4 Array of CHAR(10) System Value names


Field Descriptions

Functions to start. An array of BINARY(4) values. Each value indicates a particular function to start. Supported values are:

1  Start the Service Monitor function
2  Start the Communications Trace Analyzer Function


Functions to stop. An array of BINARY(4) values. Each value indicates a particular function to stop. Supported values are:

1  Stop the Service Monitor function
2  Stop the Communications Trace Analyzer Function
3  Stop the Service Control function


Length of header information. The length of the fixed portion of the header information. It must be 42.

Length of policy data. The length of the provided data.

Length of service event data. The length of the service event data provided.

Logging level. The logging level of the Service Monitor function. This value should only be used when requested by IBM Support personnel. This changes the amount of data which the Service Monitor logs for problem determination reasons. Supported values are:

0  No logging
1  Low logging
2  Medium logging
3  High logging


Number of functions to start. How many functions to start.

Number of functions to stop. How many functions to stop.

Number of system values changed. How many system values where changed.

Offset to service event. The offset to the field that holds the service event request. It must be 36.

Policy data. This data is in schema validated XML format. The location of the XSD file is imbedded within the XML.

Service event data. Data about the service event being sent. This data is in schema validated XML format. The location of the XSD file is imbedded within the XML. This format can be generated by using the Convert Format of Service Information (QPDETCVT) API with a format name of CVTS0100 or CVTS0200.

Service event error detection. Indicates who found the error and sending a service request.

The possible values are:

*ERROR Error detected by watch exit program. The watch session that was passed in Service event identifier parameter will be ended.
  Blanks No error detected by watch exit program

Service event identifier. The name of the session that is sending a request. If there is not session identifier, the value should be *NONE


Service event type. Type of event that is sending a request.

The possible values are:

*MSGID  Message identifier.
*LICLOG  LIC log entry.
*PAL  PAL entry.

System value names. An array containing the names of the system values that were changed. Supported values are:

QSFWERRLOG Software Error Logging

Type of policy data. The type of policy data provided. Supported values are:

0 The policy data provided contains the path name to an IFS file containing policy data.
1 The policy data provided contains the actual policy data.


Error Messages

The following messages may be sent from this function:

CPF3CF1 Error code parameter not valid.
CPF3CF2 Error(s) occurred during running of * API.
CPF3C1D Input variable length in parameter * not valid.
CPF3C1E Required parameter * omitted.
CPF3C17 Error occurred with input data parameter.
CPF3C19 Error occurred with receiver variable specified.
CPF3C21 Format name * is not valid.
CPF3C24 Length of receiver variable not valid.
CPF3C39 Value for reserved field not valid.
CPF3C4A Value not valid for field *.
CPF3C4B Value not valid for field *.
CPF3C4C Value not valid for field *.
CPFE083 Service Monitor is not running.
CPFE084 Value Duplicated functions requested.



API introduced: V5R4

[ Back to top | Problem Management APIs | APIs by category ]