semi合集-English.pdf - 第3467页

SEMI E134-0305 © SEMI 2004, 2005 20 termination request, but the r equested pl an has not bee n previously activated by any consumer, the e quipment shall return the DCPNotActive error. 9.1.2.7. 2 If the consumer doe s n…

100%1 / 7923
SEMI E134-0305 © SEMI 2004, 2005 19
9.1.2.5.5 ActivatePlan Operation Arguments
Table 23 ActivatePlan Argument Definitions
Argument Description Kind Form
planId Identifier for the requested plan. in Text, equal to a valid DCP id.
activatedPlan Confirmation that the requested plan has
been activated.
out Structured data, of type DCPActivated, described
in Section 9.1.2.8.4.
error The consumer submitting the DCP does
not have sufficient privilege to activate
the requested DCP.
error Structured data, of type UnauthorizedOperation,
described in Section 9.1.2.2.5.
error The equipment does not recognize the
requested planId.
error Structured data, of type NoSuchPlan, described in
Section 9.1.2.4.3.
error The requested DCP is invalid. error Structured data, of type InvalidPlan, described in
Section 9.1.2.2.6.
error The consumer making the request has
previously activated the same DCP.
error Structured data, of type DCPIsActive, described in
Section 9.1.2.8.3.
9.1.2.6 GetActivePlanIds — Upon receiving this request, the equipment shall return a list of the id’s of all DCPs
that have been activated by the requesting consumer at the time of the request. If the consumer has sufficient
privilege (see Section 10), the id’s of all activation requests for all currently active DCPs shall be returned.
9.1.2.6.1 If the consumer does not have sufficient privilege (see Section 10) to retrieve the currently-active DCP
id’s, the equipment shall return an UnauthorizedOperation error.
9.1.2.6.2 GetActivePlanIds Operation Arguments
Table 24 GetActivePlanIds Argument Definitions
Argument Description Kind Form
activePlans List of active DCP id’s. out Unordered list of elements of type DCPActivated,
described in Section 9.1.2.8.4. Empty if no DCPs
are active. See Section 9.1.2.6.3 for further
explanation.
error The consumer submitting the DCP does
not have sufficient privilege to retrieve a
list of active DCPs.
error Structured data, of type UnauthorizedOperation,
described in Section 9.1.2.2.5.
9.1.2.6.3 activePlans — The information returned in the response to this operation depends on the privilege
assigned to the requesting consumer. The equipment shall only return the DCPActivated information for activation
requests made by the consumer that is invoking the GetActivePlanIds operation (unless the consumer has sufficient
privilege – see Section 9.1.2.6.3.1). For example, if some DCPs have been activated by other consumers, but not by
the requesting consumer, the equipment shall not return the DCPActivated information for those other DCPs. Also,
if the requesting consumer has activated a DCP, and other consumers have also activated that same DCP, the
equipment shall not return the DCPActivated information for those other consumers.
9.1.2.6.3.1 For consumers with sufficient privilege only (see Section 10), the equipment shall return all available
DCPActivation information for all consumers of all DCPs that are active at the time of the request.
9.1.2.7 DeactivatePlan — Upon receiving this request, the equipment shall stop sending of all event, exception, and
trace requests associated with the identified DCP to the requesting consumer. If there are no other consumers
receiving data from the identified DCP, the equipment shall disable all collection/buffering activity related to this
DCP (see Table 45, transition 8). In this case, the equipment shall discard any buffered data at the time of the
request.
9.1.2.7.1 If the identified DCP has not been previously activated by the requesting consumer, and the request is not
a termination request (see Section 9.1.2.7.5), the equipment shall return the DCPNotActive error. If the request is a
SEMI E134-0305 © SEMI 2004, 2005 20
termination request, but the requested plan has not been previously activated by any consumer, the equipment shall
return the DCPNotActive error.
9.1.2.7.2 If the consumer does not have sufficient privilege (see Section 10) to deactivate the requested DCP, the
equipment shall return an UnauthorizedOperation error.
9.1.2.7.3 DeactivatePlan Operation Arguments
Table 25 DeactivatePlan Argument Definitions
Argument Description Kind Form
planId Identifier for the requested plan. in Text, equal to a valid DCP id.
terminate Whether or not the DCP should be
deactivated for all consumers.
in Boolean. See Section 9.1.2.7.4 for more
information.
deactivatedPlan Confirmation that the requested plan has
been deactivated
out Structure, of type DCPDeactivated, described in
Section 9.1.2.7.6.
error The consumer submitting the DCP does
not have sufficient privilege to deactivate
the DCP
error Structured data, of type UnauthorizedOperation,
described in Section 9.1.2.2.5.
error The equipment does not recognize the
requested planId
error Structured data, of type NoSuchPlan, described in
Section 9.1.2.4.3.
error The requested plan is not active. error Structured data, of type DCPNotActive, described
in Section 9.1.2.7.7.
9.1.2.7.4 planId — This operation defines the following reserved planId to name groups of DCPs for deactivation.
This identifier is not valid for use as a DCP id in any operation other than DeactivatePlan.
9.1.2.7.4.1 “urn:semi-org:dcm:allDCPs” — This identifier can be used to request deactivation of all plans that are
currently active for the requesting consumer. If other consumers have activated any of these same plans, those
consumers shall continue to receive DataCollectionReports from those plans. When used together with a request to
terminate (see Section 9.1.2.7.5), the equipment shall terminate all DCPs currently active on the equipment for all
consumers, including those that have been activated by the requesting consumer.
9.1.2.7.5 terminate — If set to “true”, the equipment shall stop buffering/sending all data included in the identified
DCP to all consumers that have previously activated the DCP. The equipment shall discard any buffered data at the
time of the request. The equipment shall notify each such consumer of the reason for the termination using the
DCPDeactivated notification (see Section 15.1.6.2). The consumer must have sufficient privilege (see Section 10)
to request termination of a DCP.
planId
timeDeactivated
deact ivatedBy
reason
DCPDeactivated
Figure 11
DCPDeactivated Class
SEMI E134-0305 © SEMI 2004, 2005 21
9.1.2.7.6 DCPDeactivated — This class describes a DCP that has been successfully deactivated on the equipment.
9.1.2.7.6.1 DCPDeactivated Attribute Definition Table
Table 26 DCPDeactivated Attribute Definition
Attribute Name Definition Form
planId Identifies a plan that has been deactivated. Text, equal to the ‘id’ attribute of the
DataCollectionPlan that was deactivated.
timeDeactivated The date and time at which the DCP was
deactivated.
Text, formatted according to Section 14.5.
deactivatedBy The identity of the consumer that deactivated the
DCP.
Text, equal to a valid identifier for the consumer that
took the action (see Limitations, Section 3.1.2 ). If
the equipment is deactivating the DCP, 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.
reason A human-readable description of the reason that the
DCP was deactivated.
Text.
planId
DCPNotActive
Figure 12
DCPNotActive Class
9.1.2.7.7 DCPNotActive — This class describes a DCP that has not been activated, either by a specific consumer, or
by any consumer (see Section 9.1.2.7.1).
9.1.2.7.7.1 DCPNotActive Attribute Definition Table
Table 27 DCPNotActive Attribute Definition
Attribute Name Definition Form
planId Identifies the plan that is not active. Text, equal to the ‘id’ attribute of the
DataCollectionPlan that is not active.
9.1.2.8 DeletePlan — Upon receiving this request, the equipment shall delete the requested plan definition from
non-volatile storage. The equipment shall reject this request if the requested plan is currently active for one or more
consumers. For a plan to be deleted, it must be deactivated (no consumer is currently receiving data produced by the
plan). Note that no consumer can delete built-in DCPs provided with the equipment (see Section 11.1.2.1).
9.1.2.8.1 If the consumer does not have sufficient privilege (see Section 10) to delete the requested DCP, the
equipment shall return an UnauthorizedOperation error.
9.1.2.8.2 DeletePlan Operation Arguments
Table 28 DeletePlan Argument Definitions
Argument Description Kind Form
planId Identifier for the requested plan. in Text, equal to a valid DCP id.
deletedPlan Confirmation that the requested plan has
been deleted.
out Structured data, of type DCPDeleted, described in
Section 9.1.2.8.5.