Retrieve Service Attributes (QESRSRVA) API


  Required Parameter Group:

1 Receiver variable Output Char(*)
2 Length of receiver variable Input Binary(4)
3 Number of service attribute keys Input Binary(4)
4 Service attribute keys Input Array(*) of Binary(4)
5 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The Retrieve Service Attributes (QESRSRVA) API copies specified service attributes into the receiver variable.


Authorities and Locks

None.


Required Parameter Group

Receiver variable
OUTPUT; CHAR(*)

The variable in which this API returns the data. See Receiver Variable Format

Length of receiver variable
INPUT; BINARY(4)

The length of the receiver variable. The length of the receiver variable is 16 times the number of service attributes to be retrieved, plus the length of each service attribute retrieved, plus 4.

As an example, the size of the receiver variable needed to retrieve the automatic problem analysis and automatic problem reporting attributes is (16 * 2) + 1 + 1 + 4.

Note: If this value is larger than the actual size of the receiver variable, the results may not be predictable.

Number of service attribute keys
INPUT; BINARY(4)

The total number of service attributes to retrieve.

Service attribute keys
INPUT: ARRAY(*) of BINARY(4)

A list of keys that identify which service attributes to retrieve. The keys and their associated service attributes are:

Key Service attribute
1 Automatic problem analysis
2 Automatic problem reporting
3 Service provider to report problem
4 PTF install type
5 Critical message recipients
6 Send data packets
Start of change7 Copy PTFs End of change
10 System-disabled reporting connection number
11 System-disabled call-back connection number
12 Service provider connection number

Error code
I/O; CHAR(*)

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


Receiver Variable Format

The format of the receiver variable is:

Offset Type Field
Dec Hex
0 0 BINARY(4) Number of service attributes retrieved
4 4 ARRAY(*) of BINARY(4) Offsets to service attribute templates
* * CHAR(*) Service attribute templates


Field Descriptions

Number of service attributes retrieved.

The number of service attributes the API put into the receiver variable. This number will be less than the number requested if the receiver variable is too small.

Offsets to service attribute templates. A list of values. Each value is an offset from the beginning of the receiver variable to a service attribute template.

Service attribute templates. The templates of the requested service attributes. There is one template for each service attribute retrieved. The formats of the templates are shown in Service Attribute Template Format


Service Attribute Template Format

The format of a service attribute template is:

Offset Type Field
Dec Hex
0 0 BINARY(4) Service attribute key
4 4 CHAR(1) Start of changeData type of service attribute End of change
5 5 CHAR(1) Start of changeStatus of service attribute End of change
6 6 CHAR(2) Start of changeReserved End of change
8 8 BINARY(4) Start of changeLength of service attribute End of change
12 C CHAR(*) Service attribute


Field Descriptions

Data type of service attribute. The type of data returned.

0 The service attribute was not available.
1 The service attribute is returned in character format.
2 The service attribute is returned in binary format.

Length of service attribute. The length of the service attribute. If the service attribute was not available, this value is 0.

Reserved. This field will contain null characters.

Service attribute. The requested service attribute. See Service Attributes Format for the formats of the service attributes.

Service attribute key. A value that identifies the service attribute that was retrieved.

Status of service attribute. Whether the service attribute was available for retrieval.

0 The service attribute was available.
1 The service attribute was locked.

Service Attributes Format

The Service Attributes Format has the following self-explanatory keys to solve problems:


Key 1--Automatic Problem Analysis

Offset Type Field
Dec Hex
0 0 CHAR(1) Attribute


Field Descriptions

Attribute. The problem analysis attribute specifies when to analyze problems.

0 Problems will not be analyzed when they are logged. Instead, the operator must analyze the problem from the QSYSOPR message queue or from the Work with Problems (WRKPRB) command.
1 The system will analyze the problem as soon as the problem is logged.


Key 2--Automatic Problem Reporting

Offset Type Field
Dec Hex
0 0 CHAR(1) Attribute


Field Descriptions

Attribute. The problem reporting attribute specifies when to report problems.

0 Problems will not be reported when they are logged. Instead, the operator must report the problem from the QSYSOPR message queue or from the Work with Problems (WRKPRB) command.
1 If the problem analysis attribute specifies that problems are to be analyzed as soon as the problem is logged, the system will report the problem to the service provider specified in the Service provider to report problem attribute as soon as the problem is analyzed.


Key 3--Service Provider to Report Problem

Offset Type Field
Dec Hex
0 0 CHAR(1) Name format
1 1 CHAR(17) Service provider name


Field Descriptions

Name format. This is an 'A' to show that the name is an SNA node name.

Service provider name. This identifies the service provider to report problems to if the automatic problem reporting' attribute specifies that problems are to be reported as soon as a problem is analyzed. If this field contains *IBMSRV, problems will be sent to IBM. Otherwise, the first eight characters of this field contain the control point name of the service provider. The next nine characters contain either the network identifier of the service provider, or *LCLNETID if the network identifier of the service provider is the same as that of the system that is reporting the problem.


Key 4--PTF Install Type

Offset Type Field
Dec Hex
0 0 CHAR(10) Type of PTF install


Field Descriptions

Type of PTF install. This service attribute determines whether the immediate PTFs are applied immediately or delayed.

*DLYIPL All PTFs will be marked for delayed apply and the system will be IPLed.
*DLYALL All PTFs will be marked for delayed apply and the system will not be IPLed.
*IMMONLY The immediate PTFs will be applied and the delayed PTFs marked for apply at the next IPL.
*IMMDLY Only the immediate PTFs will be applied and the system will not be IPLed.


Key 5--Critical Message Recipients

Offset Type Field
Dec Hex
0 0 BINARY(4) Number of entries
4 4 ARRAY(50) of CHAR(10) User list


Field Descriptions

Number of entries. This is the number of entries in the user list.

User list. This is an ordered list of user identifiers and user classes. If the system detects a critical condition such as a DASD failure, and the first entry in this list is a user identifier, and that user is signed on, the system will send a break message to that user. If the first entry is a user class, the system will try to send a break message to all the users in that class that are signed on.

If the specified user is not signed on, or none of the users in the user class are signed on, the system tries to send the break message to the user identifier or user class in the second entry of this list.

The system keeps trying to find a user that is signed on until it reaches the end of the list.

This function is only used if problem analysis routines are run automatically at the time of failure (the ANZPRBAUTO service attribute is *YES).

*SYSOPR All users of user class *SYSOPR will receive a message when a critical message is sent.
*SECOFR All users of user class *SECOFR will receive a message when a critical message is sent.
*SECADM All users of user class *SECADM will receive a message when a critical message is sent.
*PGMR All users of user class *PGMR will receive a message when a critical message is sent.
*USER All users of user class *USER will receive a message when a critical message is sent.


Key 6--Send Data Packets

Offset Type Field
Dec Hex
0 0 CHAR(1) Attribute


Field Descriptions

Attribute. The Send data packets attribute specifies whether or not to send problem data to the service provider.

0 Data will not be sent to the service provider.
1 Up to 2000 bytes of data will be sent to the service provider.


Start of changeKey 7--Copy PTFs

Offset Type Field
Dec Hex
0 0 CHAR(1) Attribute


Field Descriptions

Attribute. The Copy PTFs attribute specifies whether or not to copy PTF save files and cover letters into *SERVICE when PTFs are loaded from a tape or optical device. PTF save files must be in *SERVICE when distributing PTFs to other systems or when using the Save System Information (SAVSYSINF) command.

0 PTF save files and cover letters are not copied into *SERVICE when PTFs are loaded from tape or optical.
1 PTF save files and cover letters that do not already exist are copied into *SERVICE when PTFs are loaded from tape or optical.End of change


Key 10--System-Disabled Reporting Connection Number

Offset Type Field
Dec Hex
0 0 CHAR(30) System-disabled reporting connection number


Field Descriptions

System-disabled reporting connection number. The complete electronic connection number used for automatic reporting to external support when this system is disabled. This number should include the entire sequence of numbers required to complete the call, including international access codes, country or region codes, area codes, exchanges, and so on, as appropriate.


Key 11--System-Disabled Call-Back Connection Number

Offset Type Field
Dec Hex
0 0 CHAR(30) System-disabled call-back connection number


Field Descriptions

System-disabled call-back connection number. The complete electronic connection number used to call back this system from external support when this system is disabled. This number should include the entire sequence of numbers required to complete the call, including international access codes, country or region codes, area codes, exchanges, and so on, as appropriate.


Key 12--Service Provider Connection Number

Offset Type Field
Dec Hex
0 0 CHAR(30) Service provider connection number


Field Descriptions

Service provider connection number. The complete electronic connection number to the service provider. This number should include the entire sequence of numbers required to complete the call, including international access codes, country or region codes, area codes, exchanges, and so on, as appropriate.


Error Messages

Message ID Error Message Text
CPF24B4 E Severe error while addressing parameter list.
CPF3C19 E Error occurred with receiver variable specified.
CPF3C90 E Literal value cannot be changed.
CPF3CF1 E Error code parameter not valid.
CPF8C50 E Key in input list not valid.
CPF8C51 E Error with receiver variable length.
CPF8C52 E Number of values in input list not valid.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.


API introduced: V3R1
Top | Problem Management APIs | APIs by category