Adding status descriptors (DDFADD)

Purpose

The DDFADD command issues a request to the EZLTDDF task to add a status descriptor to a status component with data supplied by a calling program, a command list, or NetView® command facility (NCCF) operator. The date and time are provided automatically.

Format

DDFADD

Read syntax diagramSkip visual syntax diagramDDFADDroot_comp .stat_comp (def_comp),keyword=value
Note: You can specify more than one keyword=value pairs.

Parameters

def_comp
The element in the DDF tree that organized DDF descriptors into groups. This element is usually a resource type, service point name, or group name defined in DDFGROUP control file entries. For example, you can define CNM01.LINE99(LINE) where CNM01 is the root_comp, LINE99 is the stat_comp, and LINE is the def_comp.
keyword=value
The status information that is necessary to add a status descriptor. In general, the only keywords that are needed are reference value, priority, and data. Valid values are:
COlor = {Red | Blue | Turquoise | Green | Pink | Yellow | White}
Specifies color. If this is not specified, color is based on priority.
DAta =text
Specifies that text can be user or message data with a maximum length of 240 characters. Data can be composed of one or more lines. Each line of data can be delimited to produce a formatted display. Delimiters can be any unique character that does not occur in the text. Delimiters between lines must be doubled. For example:
DA=#LINE1-DATA #### LINE2-DATA #### LINE3-DATA #
Causes the following to display on the status descriptor data field:
LINE1-DATA
LINE2-DATA
LINE3-DATA
DataType = {OTH|MSG}
MSG specifies that message data is to be displayed on the status descriptor. OTH specifies that the data field contains user-defined data.
HighL = {Normal|Blink|Reverse|Underscore|Panel}
If this is not specified, highlighting is determined by the panel definition.
INfo= text
Specifies the information displayed on DDF status panel in the STATUSTEXT field with a maximum length of 80 alphanumeric characters. The text must be delimited. Delimiters can be any unique character that does not occur in the text. The length of the text field must be within the range specified by the start and end positions in the corresponding STATUSFIELD entry. See Locating the status component (STATUSFIELD) for more information.
PRiority= value
Specifies a valid number within the range specified in the EZLINIT file. If the field is not specified, a program default priority of 999 is used.
PropDwn ={Yes|No}
Specifies propagation downward. If this is not specified, propagation down is governed by entry in the EZLINIT file.
ProplvLD = {*|root_comp.stat_comp}
An asterisk (*) specifies that the status is to be propagated to the leaves of the tree. If a status component is specified, the status is only propagated down the leaves until, and including, the specified status component.
ProplvLU = {*|root_comp.stat_comp}
An asterisk (*) specifies that the level to which the status is to be propagated is the root of the tree. If a status component is specified, the status is only propagated up to, and including, the specified status component.
PropUp = {Yes|No}
Specifies propagation upward. If this is not specified, propagation up is governed by the entry in the EZLINIT file.
RefValue= value
Specifies reference value, which must be alphanumeric, with a maximum length of 20 (for example RV=NCP01).
root_comp
The root component name that is defined in the root node of the tree structure. The root component is required because different systems can have status components with the same name defined in their respective tree structures. The root component must be unique, therefore, each status component in a tree structure can be uniquely identified by prefixing it with the root component entry.
stat_comp
A valid resource name or resource type, as defined in the EZLTREE member, which can contain up to 8 characters.

Usage

If the data supplied in the DDFADD command exactly matches an existing descriptor in the chain, the new descriptor is not added.

With AON, status changes are logged in the automation log. The AON common logging routines provide the data for the DDFADD command and issue the DDFADD command. Any resource that is monitored by AON is automatically updated. User applications can also call the common logging routines to add DDF descriptors. The logging routines refer to the control file for status and priority information. See Understanding Dynamic Display Facility (DDF) design for more details.

Examples

DDFADD CNM01.NCP001(NCP),RV=NCP001,PR=550,DT=MSG,
       DA='EZL509I NCP001 IS UNAVAILABLE (REPORTED BY AUTNET1)'

In this example, a status descriptor is added for NCP001 on CNM01 with a priority of 550. NPC001 is green on the status panel because priority 550 is in the green color range.