semi合集-English.pdf - 第2245页

SEMI E58-0703 © SEMI 1997, 2003 26 Figure 5 ARAM Service Message Flow 13.7 Services Parameter Dictionary — Table 9 defines all of the param eter s, including the elem ents of complex parameters, used in AR AMS message se…

100%1 / 7923
SEMI E58-0703 © SEMI 1997, 2003 25
13.4 User-Defined ARAMS Symptom Tables — Where
ARAMS Symptom Tables are supported, the
descriptive text for symptoms provided within existing
ARAMS Symptom Tables shall be presented to the
operator for selection, according to the specifications in
Section 10.4, at the time the operator selects an
ARAMS State (Section 14.3). The operator is not
required to select a symptom. If the operator selects a
symptom, the symptom identifier is stored in the
variable SymptomID and the descriptive text is stored
in SymptomText.
13.5 Table Access — Where the equipment supports
one or both types of tables specified by ARAMS
(Sections 10.3 and 10.4), the operator shall have full
access to entries within those tables that are user-
defined. The operator shall be able to enter (define),
modify, and delete user-defined entries within ARAMS
table. The operator shall not be able to change or delete
the generic ARAMS Substate Codes defined in Section
9 or supplier extensions to those generic codes.
2.1.4 The operator shall be able to read the contents of
all existing ARAMS tables.
13.6 Color Codes — The use of color associated with
the display of ARAMS state information is optional. To
ensure consistency for the user, the following color
schemes shall be applied for all cases where color is
associated with an ARAMS state.
Uptime states
PRODUCTIVE: green
STANDBY: yellow
ENGINEERING: blue
Downtime states
SCHEDULED DOWNTIME: light red
UNSCHEDULED DOWNTIME: red
Other
NON-SCHEDULED TIME: grey
2.1.5 This scheme provides a visual grouping.
NOTE 21: The colors used for the two downtime states
should be both clearly related and readily distinguishable,
such as pink and bright red.
3 Services
3.1 This section formally defines the message services
specifically required to support ARAMS functionality.
3.1.1 Formal definition has three parts:
• A list of the services defined (Table 8),
• a common parameter dictionary defining all of the
parameters of these services (Table 9), and
• a dictionary of the individual services that defines
the parameters used by each service.
3.1.2 Services that are used by ARAMS, but are not
specific to ARAMS, are defined by other standards and
are referenced in Section 3.
3.1.3 Both the equipment and the host provide the
services TableSend and TableRequest, and both may
use the services provided by the other. The service
ARAMSStateChange is provided by equipment only.
3.1.4 Table 8 lists the ARAMS services. There are two
types of services:
• An initial message and response between the
service user and the service provider.
• A notification message from the service provider to
the service user that does not require a response.
3.1.5 The column in Table 8 that is called “Type” is
used to indicate whether the service consists of a
request/response message pair (R) or a single
notification message (N).
Table 8 Table 8 ARAMS Services
Message Service Name Type Description
TableSend R Used by the service user to send or delete a table.
TableRequest R A request to receive a table.
ResetAccumulators R A request to reset the set of accumulators.
ARAMSStateChange R Request to go to a specified ARAMS state/substate.
3.1.6 Figure 5 shows the message flow for each of the above ARAMS services.
SEMI E58-0703 © SEMI 1997, 2003
26
Figure 5
ARAM Service Message Flow
13.7 Services Parameter Dictionary — Table 9 defines all of the parameters, including the elements of complex
parameters, used in ARAMS message services. Parameters are listed in alphabetical order.
3.1.7 The “Form” column in Table 9 indicates the data type for the parameter. A list of the standard data types for
“Form” is included in Section 4.3.
Table 9 Table 9 ARAMS Services Parameter Dictionary
Parameter Definition Form
ARAMSCode ARAMS state/substate code. Alphanumeric text with fixed length of four characters.
AttrData The value of an attribute. Varies with attribute.
AttrName The attribute’s name. Text. Varies with object type.
ColHdr Column header. Text. 1–20 characters.
ErrorCode Contains the code for the specific error
found.
Enumerated.
ErrorText Text in support of the error code to provide
additional information.
Text.
ObjSpec The object specifier, used to specify the
owner of the target object.
Formatted text.
RequestStatus The result of the request to change to a new
ARAMS state/substate.
Enumerated:
0 = Acknowledge, action has been effected.
2 = Cannot perform now.
3 = Invalid parameter
4 = Acknowledge, action will be performed with
completion signaled later by an event.
6 = Object unknown.
Status Error information. Structure consisting of ErrorCode and ErrorText.
SymptomID The numeric symptom identifier. Unsigned integer.
SymptomText Descriptive text for symptom. Text. 0–80 characters.
TableAck Indicates the success (=T) or failure (=F) of
the operation.
Boolean.
TableAttr A table attribute other than object (table)
type or object (table) identifier. (See NOTE
1.)
Structure consisting of AttrName and AttrData.
TableCmd Instructions concerning the table transfer. Enumerated:
Entire table
Add new rows
Append new columns
Replace existing rows
Replace existing columns
TableElem One of the basic elements of a table. Varies with table type and (column) position within the row.
TableID Table identifier. Text. 1–80 characters.
SEMI E58-0703 © SEMI 1997, 2003 27
Parameter Definition Form
TableRow A row of the table in terms of its elements
TableElem.
Structure, consisting of different table elements, following the
order of the column headers.
TableStatus Information concerning the success or
failure of the operation.
Structure consisting of TableAck and (List of) Status.
TableType Type of table. Text = “TableARAMSCode” or “TableARAMSSymptom”.
NOTE 1: ARAMS tables use only the general table attributes: number of rows, number of columns, and table length.
3.2 TableSend — The TableSend service is used to transfer or delete a table.
3.2.1 Table 10 defines the parameters for the TableSend service. A table that is not structurally valid shall be
rejected and discarded.
Table 10 Table 10 TableSend Service
Parameter Req/Ind Rsp/Conf Description
ObjSpec C - The object specifier, used to specify the owner of the target object. When omitted,
the receiver of the message is intended.
TableType M M Signifies the type of table to be sent.
TableID C C(=) Table identifier. Required for table type TableARAMSSymptom.
TableCmd M - Instructions about the table being transferred.
TableAttr (list of) M - The table’s attributes.
ColHdr (list of) M - Table column headers.
TableRow (list of) C - Table contents, organized by rows. Rows may or may not be ordered, depending on
the definition for a specific table type. Must be omitted when deleting a table.
TableStatus - M Information concerning the success or failure of the request.
3.3 TableRequest — The TableRequest service is used to request the service provider to send a table. A table that is
not structurally valid shall be discarded.
3.3.1 Table 11 defines the parameters for the TableRequest service.
Table 11 Table 11 TableRequest Service
Parameter Req/Ind Rsp/Conf Description
ObjSpec C - The object specifier, used to specify the owner of the target object. When omitted,
the receiver of the message is intended.
TableType M M Signifies the type of table to be sent.
TableID C C(=) Table identifier. Required for table type TableARAMSSymptom.
TableCmd M - Instructions about the table being transferred.
TableElem (list of) C - Row identifiers of requested rows. If omitted, entire table is requested.
TableAttr (list of) - M Table attributes.
ColHdr (list of) - M Table column headers. Omitted only if table for specified type and identifier does
not exist.
TableRow (list of) - M Table rows. Omitted only if table for specified type and identifier does not exist.
TableStatus - M Information concerning the success or failure of the request.
3.4 ARAMSStateChange — The ARAMSStateChange service is sent to the service provider to request a change to
a new ARAMS state/substate.
3.4.1 Table 12 defines the parameters for the ARAMSStateChange service.