ADDALRD (Add Alert Description)

ADDALRD Command syntax diagram

 

Purpose

The Add Alert Description (ADDALRD) command allows the user to create the description of an alert condition for a particular message identifier. The user provides the SNA generic alert code points that are used to create an alert. More information on alerts is in the Alerts Support book.

 

Required Parameters

MSGID
Specifies the message identifier to which this alert description corresponds.

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

The name of the alert table can be qualified by one of the following library values:

*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 searched. If no library is specified as the current library for the job, the QGPL library is used.

library-name: Specify the name of the library to be searched.

alert-table-name: Specify the name of the alert table that is used.

 

Optional Parameters

ALRTYPE
Specifies the code point (a hexadecimal number) for the alert type.

*NONE: There is no alert type code point for this alert description.

alert-type-code-point: Specify the alert type code point.

ALRD
Specifies the code point for the alert description.

*NONE: There is no alert description code point for this alert description.

alert-description-code-point: Specify the alert description code point.

PBLCAUSE
Specifies probable causes, which are listed in order of decreasing probability. Up to 99 code points for probable cause can be listed.

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

probable-cause-code-point: Specify the probable cause code point.

CAUSE
Specifies user, install, or failure causes. Up to 99 causes can be specified.

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

Element 1: Type of Code Point

*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

cause-code-point: Specify the cause code point. Up to three detailed data qualifiers or one product identifier qualifier can be specified for each code point. A detailed data qualifier consists of a detailed data identifier code point and detailed data. Specify *NONE or *NODATA if there is no detailed data.

Element 3: First Detailed Data Identifier

*NONE: There is no detailed data identifier code point for this cause.

detailed-data-ID: 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: Detailed Data for First Identifier

*NODATA: There is no data for this cause.

detailed-data: Specify up to 40 characters of detail data. A substitution variable from the corresponding message description can be specified and the message data is substituted into the alert description when the alert is created.

Element 5: Product Identifier

*NONE: There is no product identifier for this cause.

*SNDHDW: Indicates the sender hardware, which is the iSeries 400 server.

*SNDSFW: Indicates the sender software specified in the LICPGM keyword of the CRTALRTBL command.

*RSCHDW: Indicates the failing resource hardware, which is determined by the resource hierarchy in the message description.

Note: The user can specify either 0 to 3 detailed data qualifiers or one product identifier qualifier, but not both.

ACTION
Specifies a recommended action for a user, install, or failure cause. Up to 99 recommended actions can be listed.

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

Element 1: Type of Action Code Point

*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 recommended action for a 'cause undetermined' error follows.

Element 2: Action Code Point

action-code-point: Specify the recommended action code point. Up to three detailed data qualifiers or one product identifier qualifier can be specified for each code point. A detailed data qualifier consists of a detailed data ID code point and detailed data. Specify *NONE *NODATA if there is no detailed data.

Element 3: First Detailed Data Identifier

*NONE: There is no detailed data identifier code point for this action.

detailed-data-ID: 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: Detailed Data for First Identifier

*NODATA: There is no data for this action.

detailed-data: Specify up to 40 characters of detail data. A substitution variable from the corresponding message description can be specified and the message data is substituted into the alert description when the alert is created.

Element 5: Product Identifier

*NONE: There is no product identifier for this action.

*SNDHDW: Indicates the sender hardware, which is the iSeries server.

*SNDSFW: The sender software, specified in the PRDID keyword of the CRTALRTBL command is used.

*RSCHDW: Indicates that the failing resource hardware, which is determined by the resource hierarchy in the message description is used.

Note: The user can specify either 0 to 3 detailed data identifiers or one product identifier qualifier, but not both.

Example for ADDALRD

ADDALRD   MSGID(USR1234)  ALRTBL(USER/USRMSGS)
  ALRTYPE(01) ALRD(3100)
  PBLCAUSE(1000 3121)
  CAUSE((*USER 6001)  (*FAILURE 1000)
  (*FAILURE 3121))  ACTION((*USER 1000)
  (*FAILIRE 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.

Error messages for ADDALRD

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