Retrieve Service Attributes (QESRSRVA) API

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
7	Copy PTFs
8	PTF group levels
9	ECS message queue
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 follows.

Field Descriptions

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 follows.

Field Descriptions

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

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.

Service Attributes Format

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

• Key 1--Automatic Problem Analysis
• Key 2--Automatic Problem Reporting
• Key 3--Service Provider to Report Problem
• Key 4--PTF Install Type
• Key 5--Critical Message Recipients
• Key 6--Send Data Packets
• Key 7--Copy PTFs
• Key 8--PTF group levels
• Key 9--ECS message queue
• Key 10--System-Disabled Reporting Connection Number
• Key 11--System-Disabled Call-Back Connection Number
• Key 12--Service Provider Connection Number

Key 1--Automatic Problem Analysis

Field Descriptions

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

Key 2--Automatic Problem Reporting

Field Descriptions

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

Key 3--Service Provider to Report Problem

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

Field Descriptions

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

Key 5--Critical Message Recipients

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 disk 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).

Key 6--Send Data Packets

Field Descriptions

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

Key 7--Copy PTFs

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.

Key 8--PTF group levels

Field Descriptions

Attribute. The PTF group levels attribute specifies the maximum number of levels of a PTF group to keep on the system. The following special value can be returned:

Key 9--ECS message queue

Field Descriptions

ECS message queue. The message queue name where electronic customer support (ECS) will be sending the message when resuming PTF orders.

Library. The library where the message queue is located.

Key 10--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

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

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

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