semi合集-English.pdf - 第1876页

SEMI E53-0704 © SEMI 1996, 2004 16 Parameter Definition Form ReportChangeOnly If TRUE, then only data reports linked to the trace object which h ave changed since the last sam ple will be sent with the trace report. Othe…

100%1 / 7923
SEMI E53-0704 © SEMI 1996, 2004 15
Service Type Description
Trace Report Reset R Resets one or more trace objects back to their initial state when created regardless of the current
state of the trace object. All trace objects may be reset at once providing a simple way to re-
establish the event reporting setup after modifications have been made.
8.3.2 Use Object Services — Attributes of the standardized objects listed in Table 12: SEMI E39 shall be accessed
by using the GetAttr and SetAttr messages as defined in SEMI E39.
Table 12 SEMI E39 Access
Object Attribute Comment
Collection Event Enabled When set to TRUE, a Collection Event Report will be sampled and sent when the Collection
Event occurs. When FALSE, Collection Event Reports are not sampled and sent.
Trace Enabled When set to TRUE, a Trace Report will be sampled and as described by the Trace Report
definition. When FALSE, Trace Reports are not sampled and sent.
Data Source AttrList Use GetAttr to get the names of the attributes of a data source. These names can be used in the
Data Report Create message.
Data Report AttrList Use GetAttr and SetAttr to change the variables included in a data report definition.
8.3.3 Parameter Dictionary
Table 13 Event Reporting Parameters
Parameter Definition Form
EvtSrcSpec The object specifier of the Event Source Object. Formatted text
CollEventID References the Object Identifier of the collection event, within the scope of the
event source object, that triggers an event report to be sent.
Text
Enabled Specifies whether an Event or Trace Report is enabled. Boolean:
TRUE – Successful
FASLE – Unsuccessful
DatSrcSpec The object specifier of the data source object. Formatted text
(list of) AttrName An ordered list of attribute names from the data source object which specify the
samples to be included in a data report. Maximum must be documented by
supplier.
Text
ReportID References the Object Identifier of a data report, either pre-defined by the
service provider or specified by the service user.
Text
TraceID References the Object Identifier of a trace object specified by the service user. Text
(list of) ReportID A list of data reports to be linked to a trace. Maximum must be documented by
supplier.
Text
SamplePeriod The time delay between samples. Minimum and maximum must be
documented by supplier.
Float
TotalSamples The number of samples to be taken before trace data reporting stops
automatically.
Positive Integer
GroupSize The number of trace report samples made before the report is sent to the
service user. Maximum group size must be documented by supplier.
Positive Integer
StartEvtSrcSpec The object which is the source of the event which starts the trace reporting. Text
StartEventID The Collection Event Object Identifier within the event source object which
starts the trace reporting.
Text
StopEvtSrcSpec The object which is the source of the event which stops the trace reporting. Text
StopEventID The Collection Event Object Identifier within the event source object which
stops the trace reporting.
Text
AutoDelete Specifies if trace report automatically deletes itself when its reporting cycle is
complete.
Boolean:
TRUE – Successful
FASLE – Unsuccessful
SEMI E53-0704 © SEMI 1996, 2004 16
Parameter Definition Form
ReportChangeOnly If TRUE, then only data reports linked to the trace object which have changed
since the last sample will be sent with the trace report. Otherwise, all data
reports will be sent with the trace report.
Boolean:
TRUE – Successful
FASLE – Unsuccessful
(list of)
DataReportSample
A list of data reports. Each data report sample contains the values of the
variables specified in the data report at the time at which the sample was taken
(see TimeStamp).
Structure
(list of)
TraceReportSample
Trace report data. Each trace report contains a set of data report samples taken
at a single point in time. This parameter is used when several trace report
samples are made before notifying the service user (see Group Size).
Structure
ERAck Indicates whether the activity was successful. Boolean:
TRUE – Successful
FALSE - Unsuccessful
ErrorCode Identifies errors that may arise. Enumerated:
Unknown event
Unknown attribute
Unknown data report
Duplicate Report ID
Data report not linked
Unknown trace report
Duplicate Trace ID
Cannot delete predefined
Too many data reports
Sample period out of range
Group size too large text
ErrorText Text in support of Error code. Text
ERStatus Reports the acceptance or rejection of a requested operation. Structure Composed of:
ERAck (list of)
Status
Status Reports any errors found. Structure Composed of:
ErrorCode
ErrorText
Table 14 Data Report Sample Parameter Detail
Parameter Definition Form
ReportID Unique identifier of a data report. Text
TimeStamp Records time at which report sample values were recorded. Formatted text:
YYYMMDDhhmmsscc
(list of) AttributeValue An ordered list of attribute values that match the (list of) AttrName in the
data report.
(depends on attribute)
Table 15 Trace Report Sample Parameter Detail
Parameter Definition Form
(list of) DataReportSample Samples of data reports assigned to the trace report. Structure
SEMI E53-0704 © SEMI 1996, 2004 17
8.3.4 Service Detail
8.3.4.1 Event Report Request — When the event object receives this message, it immediately generates and sends
an event report to the service user.
Table 16 Event Report Request Service Detail
Parameter Req/Ind Rsp/Cnf Comment
EvtSrcSpec C C(=) Source object for requested event report. If omitted, then the default object is
assumed.
CollEventID M M(=) Identifies requested Event Report. If not recognized, then the error code
“unknown event” is returned.
TimeStamp - C Time at which request was received. Parameter is omitted if Event ID is not
recognized.
(list of)DataReportSample - C Samples of data reports linked to the event. Parameter is omitted if Event ID
is not recognized.
ERStatus - C Possible errors:
Unknown event
8.3.4.2 Event Report Send — This is a notification message to the service user. It contains the event report for the
collection event which has triggered this action.
Table 17 Event Report Send Service Detail
Parameter Req/Ind Comment
EvtSrcSpec C Source object for event report to be sent. If omitted, then the default object is assumed.
CollEventID M Event Report being sent.
TimeStamp M Time at which Collection Event occurred.
(list of)DataReportSample M Samples of data reports linked to the event. An empty list can be sent by the service
prvider when there are no data reports linked to the Collection Event.
8.3.4.3 Data Report Create
Table 18 Data Report Create Service Detail
Parameter Req/Ind Rsp/Cnf Comment
DatSrcSpec C - Source object for data report to be created. If omitted, then the default object is
assumed.
AttrList M - Attributes of data source object to be included in data report. If an AttrName is not
recognized, then the error code “unknown attribute” is returned.
ReportID C M(=) If ReportID is not specified in the request, then the provider will return a unique
ID to the user. If the user specifies ReportID, then the user must be responsible for
making it unique, otherwise, the ReportID already identifies a Data Report, then
that Report definition will be overwritten.
ErrorCode - C Possible errors:
Unknown Data Source
Unknown Attribute