semi合集-English.pdf - 第3458页

SEMI E134-0305 © SEMI 2004, 2005 11 9.1.2.2 DefinePlan — Upon receiving this request, the equipment shall first verify th at the cons umer has sufficient privilege (see Section 10) to define a new DCP. If so, the equip m…

100%1 / 7923
SEMI E134-0305 © SEMI 2004, 2005 10
visualization of the equipment to an end user who relies on the application to call attention to problem conditions on
the equipment.
8.7.2 This document specifies a mechanism for consumers to issue ad-hoc requests for data in order to support these
uses, through the GetObjectInstanceIds and GetParameterValue operations of the DataCollectionManager interface
(see Sections 9.1.2.9 and 9.1.2.10).
9 Data Collection Plan Management
9.1 DataCollectionManager Interface
9.1.1 Figure 6 shows the interface used to manage data collection plans on the equipment, as well as making ad-hoc
requests for specific data, and for determining the current performance conditions on the equipment.
DefinePlan(in newPlan : DataCollectionPlan) : DCPDefined
GetDefinedPlanIds() : DCPDefined[]
GetPlanDefinition(in dc pId : String) : DataCollec tionPlan
Ac tivatePlan(in dc pI d : String) : D C PAct ivated
GetActivePlanIds() : DCPActivated[]
DeactivatePlan(in dcpId : String, in terminate : boolean) : DCPDeactivated
DeletePlan(in dcpId : DCPIdentifier) : DCPDeleted
GetParameterValues(in parameterRequest : ParameterRequest[]) : ParameterValu
e
GetObjT ypeIns tanceIds (in request : ObjT ypeReques t[ ] ) : ObjTypeResult[]
GetCurrentPerformanceStatus() : PerformanceStatus
«interface»
DataCollectionManager
Figure 6
The Data CollectionManager Interface
9.1.2 DataCollectionManager — The DataCollectionManager interface provides consumers with operations to
manage data collection activities on the equipment. The interface provides operations for consumers to submit new
DCP’s, activate and deactivate them, look up existing plans, and delete defined plans. The DataCollectionManager
interface also provides operations to request the current equipment performance status as well as requesting ad-hoc
data on demand.
9.1.2.1 DataCollectionManager Operations
Table 5 DataCollectionManager Operation Definition
Operation Description Type Requestor/Sen
der
Responder/Rec
eiver
DefinePlan Submit a new plan definition to the equipment for
validation.
RR Consumer Equipment
GetDefinedPlanIds Retrieve a list of all valid DCP id’s known to the
equipment.
RR Consumer Equipment
GetPlanDefinition Retrieve the definition of a specific DCP. RR Consumer Equipment
ActivatePlan Activate a defined DCP. RR Consumer Equipment
GetActivePlanIds Retrieve a list of all currently active DCPs. RR Consumer Equipment
DeactivatePlan Deactivate an active DCP. RR Consumer Equipment
DeletePlan Delete a DCP. RR Consumer Equipment
GetParameterValues Retrieve the most recent values of one or more
Parameters.
RR Consumer Equipment
GetObjTypeInstanceIds Retrieve a current list of the unique instance id’s for one
or more E39 ObjTypes.
RR Consumer Equipment
GetCurrentPerformanceStatu
s
Retrieve the most recent equipment performance status. RR Consumer Equipment
SEMI E134-0305 © SEMI 2004, 2005 11
9.1.2.2 DefinePlan — Upon receiving this request, the equipment shall first verify that the consumer has sufficient
privilege (see Section 10) to define a new DCP. If so, the equipment shall then validate the plan name for
uniqueness and all referenced events, exceptions, parameters, and trace reports for existence and correctness. The
equipment shall place no a-priori limitation on the number of plans that can be defined.
9.1.2.2.1 Any hard limitations imposed by constraints on available storage capacity shall be documented by the
equipment supplier. If such limitations are encountered at runtime, the equipment shall return an equipment-defined
error indicating that the DCP was not successfully defined, and a human-readable description of the reason. The
mechanism for supporting such errors shall be fully specified in implementation mappings provided for this
specification.
9.1.2.2.2 If there are any issues with the submitted plan, the equipment shall return a description of all problems
detected with the plan (see Section 9.1.2.2.6 for a description of possible DCP definition problems), and the plan
shall not be defined on the equipment.
9.1.2.2.3 If there are no issues with the submitted plan, the equipment shall record the date and time at which the
plan definition was submitted and the id of the consumer that submitted the plan. The equipment shall store this
information and the plan definition in non-volatile storage. It shall thereafter be legal for DCP requests to refer to
the submitted plan by its id field.
9.1.2.2.4 DefinePlan Operation Arguments
Table 6 DefinePlan Argument Definitions
Argument Description Kind Form
newPlan The definition of a new DCP. in Structured data, of type DataCollectionPlan,
described in Section 11.1.2 .
planDefined An acknowledgement that the new DCP
definition was well-formed, correct, and
supportable.
out Structured data, of type DCPDefined, described in
Section 9.1.2.2.4 .
error The consumer submitting the DCP does
not have sufficient privilege to define
DCPs.
error Structured data, of type UnauthorizedOperation,
described in Section 9.1.2.2.5 .
error The DCP definition is invalid. error Structured data, of type InvalidPlan, described in
Section 9.1.2.2.6 .
planI d
timeDef ined
definedBy
DCPDefin ed
Figure 7
DCP Defined Class
9.1.2.2.5 DCPDefined — This class describes a DCP that has been successfully defined on the equipment.
9.1.2.2.5.1 DCPDefined Attribute Definition Table
Table 7 DCPDefined Attribute Definition
Attribute Name Definition Form
planId Identifies a defined DCP. Text, equal to the ‘id’ attribute of the
DataCollectionPlan defined on the equipment.
timeDefined The date and time at which the DCP was originally
defined.
Text, formatted according to Section 14.5 For built-in
plans (see Section 11.1.2.1), this field shall be equal to
SEMI E134-0305 © SEMI 2004, 2005 12
the date and time at which the plan was installed on
the equipment.
definedBy The identity of the consumer that defined the DCP. Text, equal to a valid identifier for the consumer that
took the action (see Limitations, Section 3.1.2). For
built-in plans (see Section 11.1.2.1 ), this field shall be
a URN of the form “urn:semi-org:equipment”. The
valid values to use for this attribute to identify
consumers shall be specified by any adjunct document
defining a technical binding for this specification.
des cript ion
requiredPrivilege
Unauthoriz edOperation
Figure 8
UnauthorizedOperation Error
9.1.2.2.6 UnauthorizedOperation — This class describes an authorization error associated with a specific operation.
9.1.2.2.6.1 UnauthorizedOperation Attribute Definition Table
Table 8 UnauthorizedOperation Attribute Definition
Attribute Name Definition Form
description A description of the error Text, including the name of the operation and a
description of any important context associated with
the original request.
requiredPrivilege The name of the privilege that is required for the
operation
Text, equal to a valid privilege name or identifier (see
Section 10 ) defined on the equipment that the
consumer must possess in order to execute the
operation. The valid values to use for this attribute
shall be specified by any adjunct document defining a
technical binding for this specification.