Add Alert Description (ADDALRD)

Where allowed to run: All environments (*ALL)
Threadsafe: No
Parameters
Examples
Error messages

The Add Alert Description (ADDALRD) command adds an alert description to the specified alert table.

Top

Parameters

Keyword Description Choices Notes
MSGID Message identifier Name Required, Positional 1
ALRTBL Alert table Qualified object name Required, Positional 2
Qualifier 1: Alert table Name
Qualifier 2: Library Name, *LIBL, *CURLIB
ALRTYPE Alert type X'00'-0, *NONE Optional
ALRD Alert description code point X'0000'-X'FFF0', *NONE Optional
PBLCAUSE Probable cause code point Single values: *NONE
Other values (up to 99 repetitions): X'0000'-X'FFF0'
Optional
CAUSE Cause Single values: *NONE
Other values (up to 99 repetitions): Element list
Optional
Element 1: Cause type *USER, *INSTALL, *FAILURE
Element 2: Cause code point Hexadecimal value
Element 3: Detail data ID 1 Hexadecimal value, *NONE
Element 4: Detail data 1 Character value, *NODATA
Element 5: Detail data ID 2 Hexadecimal value, *NONE
Element 6: Detail data 2 Character value, *NODATA
Element 7: Detail data ID 3 Hexadecimal value, *NONE
Element 8: Detail data 3 Character value, *NODATA
Element 9: Product identifier *NONE, *SNDHDW, *SNDSFW, *RSCHDW
ACTION Recommended action Single values: *NONE
Other values (up to 99 repetitions): Element list
Optional
Element 1: Action type *USER, *INSTALL, *FAILURE, *UNKNOWN
Element 2: Action code point Hexadecimal value
Element 3: Detail data ID 1 Hexadecimal value, *NONE
Element 4: Detail data 1 Character value, *NODATA
Element 5: Detail data ID 2 Hexadecimal value, *NONE
Element 6: Detail data 2 Character value, *NODATA
Element 7: Detail data ID 3 Hexadecimal value, *NONE
Element 8: Detail data 3 Character value, *NODATA
Element 9: Product identifier *NONE, *SNDHDW, *SNDSFW, *RSCHDW
Top

Message identifier (MSGID)

Specifies the message ID to which this alert description corresponds.

This is a required parameter.

name
Specify the message identifier.
Top

Alert table (ALRTBL)

Specifies the alert table in which this alert description is created.

This is a required parameter.

Qualifier 1: Alert table

name
Specify the name of the alert table to be used.

Qualifier 2: Library

*LIBL
All libraries in the job's library list are searched until the first match is found.
*CURLIB
The current library for the job is used to locate the alert table name. If no library is specified as the current library for the job, the QGPL library is used.
name
Specify the library where the alert table name is located. Only the library named is searched. The user must have *USE authority for the specified library.
Top

Alert type (ALRTYPE)

Specifies the code point for the alert type.

*NONE
There is no alert type code point for this alert description.
X'00'-X'F0'
Specify the alert type code point.
Top

Alert description code point (ALRD)

Specifies the code point for the alert description.

*NONE
There is no alert description code point for this alert description.
X'0000'-X'FFF0'
Specify the alert description code point to be used.
Top

Probable cause code point (PBLCAUSE)

Specifies a maximum of 99 code points for probable causes, which are listed in order of decreasing probability.

Single values

*NONE
There are no probable cause code points for this alert description.

Other values (up to 99 repetitions)

X'0000'-X'FFF0'
Specify the probable cause code point.
Top

Cause (CAUSE)

Specifies user, install, or failure causes. A maximum of 99 causes can be specified.

Up to three detailed data qualifiers or one product identifier qualifier can be specified for a code point, depending on the code point. For a detailed data qualifier, specify the detailed data ID and the detailed data.

Single values

*NONE
There are no cause code points for this alert description.

Other values (up to 99 repetitions)

Element 1: Cause type

*USER
A user cause code point follows.
*INSTALL
An install cause code point follows.
*FAILURE
A failure cause code point follows.

Element 2: Cause code point

hexadecimal-value
Specify the cause code point.

Element 3: Detail data ID 1

*NONE
There is no detailed-data-ID code point for this code point.
hexadecimal-value
Specify the detailed data identifier code point used to identify the data. Detailed data identifiers can be specified up to three times in each session.

Element 4: Detail data 1

*NODATA
There is no detailed data for this code point.
character-value
Specify up to 40 characters of detailed data. A substitution variable from the corresponding message description can be specified, in which case the message data is substituted into the alert description when the alert is created.

Element 5: Detail data ID 2

*NONE
There is no detailed-data-ID code point for this code point.
hexadecimal-value
Specify the detailed data identifier code point used to identify the data. Detailed data identifiers can be specified up to three times in each session.

Element 6: Detail data 2

*NODATA
There is no detailed data for this code point.
character-value
Specify up to 40 characters of detailed data. A substitution variable from the corresponding message description can be specified, in which case the message data is substituted into the alert description when the alert is created.

Element 7: Detail data ID 3

*NONE
There is no detailed-data-ID code point for this code point.
hexadecimal-value
Specify the detailed data identifier code point used to identify the data. Detailed data identifiers can be specified up to three times in each session.

Element 8: Detail data 3

*NODATA
There is no detailed data for this code point.
character-value
Specify up to 40 characters of detailed data. A substitution variable from the corresponding message description can be specified, in which case the message data is substituted into the alert description when the alert is created.

Element 9: Product identifier

*NONE
There is no product identifier for this code point.
*SNDHDW
Indicates the sender hardware (always iSeries).
*SNDSFW
Indicates the sender software code responsible for the alert. This is from the LICPGM value from the Create Alert Table (CRTALRTBL) command.
*RSCHDW
Indicates the failing resource hardware, which is determined by the resource hierarchy in the message description.
Top

Recommended action (ACTION)

Specifies a recommended action for a user, install, or failure cause. A maximum of 99 actions can be listed.

Single values

*NONE
There are no recommended action code points for this alert description.

Other values (up to 99 repetitions)

Element 1: Action type

*USER
A user cause code point follows.
*INSTALL
An install cause recommended action code point follows.
*FAILURE
A failure cause recommended action code point follows.
*UNKNOWN
A code point for a recommended action for a 'cause undetermined' error follows.

Element 2: Action code point

hexadecimal-value
Specify the recommended action code point.

Up to three detailed data qualifiers or one product identifier qualifier can be specified for a code point, depending on the code point. For a detailed data qualifier, specify the detailed data ID and the detailed data.

Element 3: Detail data ID 1

*NONE
There is no detailed-data-ID code point for this code point.
hexadecimal-value
Specify the detailed data identifier code point used to identify the data. Detailed data identifiers can be specified up to three times in each session.

Element 4: Detail data 1

*NODATA
There is no detailed data for this code point.
character-value
Specify up to 40 characters of detailed data. A substitution variable from the corresponding message description can be specified, in which case the message data is substituted into the alert description when the alert is created.

Element 5: Detail data ID 2

*NONE
There is no detailed-data-ID code point for this code point.
hexadecimal-value
Specify the detailed data identifier code point used to identify the data. Detailed data identifiers can be specified up to three times in each session.

Element 6: Detail data 2

*NODATA
There is no detailed data for this code point.
character-value
Specify up to 40 characters of detailed data. A substitution variable from the corresponding message description can be specified, in which case the message data is substituted into the alert description when the alert is created.

Element 7: Detail data ID 3

*NONE
There is no detailed-data-ID code point for this code point.
hexadecimal-value
Specify the detailed data identifier code point used to identify the data. Detailed data identifiers can be specified up to three times in each session.

Element 8: Detail data 3

*NODATA
There is no detailed data for this code point.
character-value
Specify up to 40 characters of detailed data. A substitution variable from the corresponding message description can be specified, in which case the message data is substituted into the alert description when the alert is created.

Element 9: Product identifier

*NONE
There is no product identifier for this code point.
*SNDHDW
Indicates the sender hardware (always iSeries).
*SNDSFW
Indicates the sender software code responsible for the alert. This is from the LICPGM value from the Create Alert Table (CRTALRTBL) command.
*RSCHDW
Indicates the failing resource hardware, which is determined by the resource hierarchy in the message description.
Top

Examples

ADDALRD   MSGID(USR1234)  ALRTBL(USER/USRMSGS)
          ALRTYPE(01)  ALRD(3100)  PBLCAUSE(1000 3121)
          CAUSE((*USER 6001)(*FAILURE 1000)(*FAILURE 3121))
          ACTION((*USER 1000)
                 (*FAILURE 00B0 00A5 'DSPMSG QSYSOPR')
                 (*FAILURE F0A0 22 '&5')
                 (*FAILURE 00E1 *NONE *NODATA *NONE
                  *NODATA *NONE *NODATA *SNDHDW))

This command defines three recommended failure actions:

Failure recommended action 'F0A0' specifies a message substitution variable ('&5') as the detailed data. When the message 'USR1234' is sent, the message data for variable '&5' is put into the alert for the detailed data.

Failure action X'00E1' references a product identifier; in this case, it is the sending hardware iSeries server. Place holders are needed for the detailed data qualifiers.

Top

Error messages

*ESCAPE Messages

CPF1A01
Alert table &1 in &2 cannot be extended.
CPF1A02
Alert code &1 already in alert table &2.
CPF1A03
Alert identifier &1 already in alert table &2.
CPF1A05
Alert table &1 in &2 damaged.
CPF2499
Message identifier &1 not allowed.
CPF7BB0
Alert description already exists.
CPF7BB5
Alert description &1 could not be added to alert table &2 in library &3.
CPF9801
Object &2 in library &3 not found.
CPF9802
Not authorized to object &2 in &3.
CPF9803
Cannot allocate object &2 in library &3.
CPF9807
One or more libraries in library list deleted.
CPF9808
Cannot allocate one or more libraries on library list.
CPF9810
Library &1 not found.
CPF9811
Program &1 in library &2 not found.
CPF9812
File &1 in library &2 not found.
CPF9814
Device &1 not found.
CPF9820
Not authorized to use library &1.
CPF9821
Not authorized to program &1 in library &2.
CPF9822
Not authorized to file &1 in library &2.
CPF9825
Not authorized to device &1.
CPF9830
Cannot assign library &1.
CPF9831
Cannot assign device &1.
CPF9899
Error occurred during processing of command.
Top