semi合集-English.pdf - 第1879页

SEMI E53-0704 © SEMI 1996, 2004 19 8.3.4.7 Collection Event Unlink Table 22 Collection Event Unlink Service Det ail Parameter Req/Ind Rsp/Cnf Comment EvtSrcSpec C C(=) Source object for event report to be unlinked. If om…

100%1 / 7923
SEMI E53-0704 © SEMI 1996, 2004 18
8.3.4.4 Data Report Delete
Table 19 Data Report Delete Service Detail
Parameter Req/Ind Rsp/Cnf Comment
(list of) Report ID C C Identifies data report(s) to be deleted. If data report ispre-defined, then the error
code “Cannot delete pre-defined” is returned. If a ReportID is not recognized, then
the error code “unknown data report” is returned. If parameter is omitted in the
request, then all data reports are deleted. In all cases, the (list of) ReportID that are
deleted, if any, is returned in the response.
ERStatus - C ERAck is set to FALSE if any requested ReportID cannot be deleted.
ErrorCodes:
Unknown data report
Cannot delete predefined
ErrorText shall be set to the ReportID of reports which could not be deleted.
8.3.4.5 Data Report Request — Message asking the service provider to sample the data report and send the resulting
report.
Table 20 Data Report Request Service Detail
Parameter Req/Ind Rsp/Cnf Comment
ReportID M C(=) Identifies requested Data Report to sample. If Report ID is not recognized then the
error code “unknown data report” is returned. Parameter is omitted in the
response when the ReportID is recognized by the service provider.
DataReportSample - Parameter is omitted if ReportID is not recognized.
ERAck - C In the case where no Data Report can be returned then this value is returned set to
FALSE. This informs the service requestor that the message was received but that
for some reason, the report could not be sampled. The most likely reason is the
ReportID was not recognized.
8.3.4.6 Collection Event Link
Table 21 Collection Event Link Service Detail
Parameter Req/Ind Rsp/Cnf Comment
EvtSrcSpec C C(=) Source object for event report to be linked. If omitted, then the default object is
assumed.
CollEventID M M(=) Identifies Collection Event Object to be linked. If CollEventID is not recognized,
then the error code “unknown event” is returned. This error takes precedence over
other errors.
(list of ) ReportID M - Identifies Data Report(s) to be linked to an Event Report for this Collection Event
Object. If ReportID is not recognized, then the error code “unknown data report”
is returned.
ERStatus - C ERAck is set to FALSE if any ReportID cannot be linked.
ErrorCodes:
Unknown event
Unknown data report
ErrorText shall be set to the ReportID of reports which could not be linked.
SEMI E53-0704 © SEMI 1996, 2004 19
8.3.4.7 Collection Event Unlink
Table 22 Collection Event Unlink Service Detail
Parameter Req/Ind Rsp/Cnf Comment
EvtSrcSpec C C(=) Source object for event report to be unlinked. If omitted, then the default object is
assumed.
CollEventID M M(=) Identifies Collection Event to be unlinked. If the ID is not recognized, then the error
code “unknown event” is returned. This error takes precedence over other errors.
(list of) ReportID M - Identifies data report to be unlinked. If link is pre-defined, then the error code
“Cannot delete predefined” is returned. If ReportID is not recognized, then the error
code “unknown data report” is returned. If data report is not linked to the specified
event, then the error code “data report not linked” is returned.
ERStatus - C ERAck is set to FALSE if any ReportID cannot be unlinked.
ErrorCodes:
Unknown event
Unknown data report
Data report not linked
Cannot delete predefined
ErrorText shall be set to the ReportID of reports which could not be unlinked.
8.3.4.8 Trace Create
Table 23 Trace Create Service Detail
Parameter Req/Ind Rsp/Cnf Comment
TraceID C M(=) Identifier of Trace Object to be created. The service user can be responsible for the
uniqueness of the Trace ID. If duplicate ID is used, then the current Trace Object
definition overwritten. If omitted in the request, then the Service Provider will
generate a unique identifer.
Enabled M - If TRUE, then the initial state of trace report is enabled and will start reporting when
the next Start Event occurs, if one is defined, or immediately otherwise.
(list of) ReportID M - Data reports to be linked to trace report.
SamplePeriod M - A Sample Period outside the range supported by the service provider will return the
error code “Sample period out of range.”
TotalSamples C - If this is equal to zero or is omitted, then the trace reporting will continue until it is
stopped by some other means (i.e., by Stop Event, by Trace Report Disable or by
Trace Report Delete).
GroupSize C - If this is omitted, then every sample is immediately reported.
StartEvtSrcSpec C - The object which is the source of the event which starts the trace reporting. If
omitted, then the default object is assumed.
StartEventID C - The event within the event source object which starts the trace reporting. If this is
omitted, then trace reporting begins as soon as it is enabled.
StopEvtSrcSpec C - The object which is the source of the event which stops the trace reporting. If
omitted, then the default is assumed.
StopEventID C - The event within the event source object which stops the trace reporting. If this is
omitted, then trace reporting must be stopped by some other means (i.e., by Total
Samples, or by Trace Report Delete).
AutoDelete C - If this is omitted, then AutoDelete is assumed to be TRUE.
ReportChangeOnly C - If this is omitted, then ReportChangeOnly is assumed to be FALSE.
ErrorCode - C Possible errors:
Duplicate trace ID
Too many data reports
Sample period out or range
Group size too large
Unknown event
SEMI E53-0704 © SEMI 1996, 2004 20
8.3.4.9 Trace Delete
Table 24 Trace Delete Service Detail
Parameter Req/Ind Rsp/Cnf Comment
(list of) Trace ID C C Identifies Trace Object(s) to be deleted. If a Trace Object ispre-defined, then the
error code “Cannot delete predefined” is returned. If a TraceID is not recognized,
then the error code “unknown trace report” is returned. If parameter is omitted in the
request, then all trace reports are deleted. In all cases, the (list of) Trace ID that are
deleted, is returned in the response.
ERStatus - C ERAck is set to false if any requested TraceID cannot be deleted.
ErrorCodes:
Unknown trace report
Cannot delete predefined
ErrorText shall be set to the TraceID of reports which could not be deleted.
8.3.4.10 Trace Report Request — Request the data reports specified by the trace object ID be sampled and sent to
the service user.
Table 25 Trace Report Request Service Detail
Parameter Req/Ind Rsp/Cnf Comment
TraceID M M(=) Identifies requested trace report.
TimeStamp - C Time at which request was serviced and data report samples taken. Parameter is
omitted if Trace ID is not recognized.
(list of)
DataReportSample
- C Samples of data reports assigned to the trace report. Parameter is omitted if Trace ID
is not recognized.
ERAck - C If the Data Report Samples cannot be sent, then this item shall be returned with its
Boolean value set to false. The most likely cause of this would be that the TraceID
was undefined.
8.3.4.11 Trace Report Send — The notification message sent by the service provider to the service user when the
trace object has prepared a trace report according to its definition.
Table 26 Trace Report Send Service Detail
Parameter Req/Ind Comment
TraceID M Identifies trace report.
(list of) TraceReportSample M Number of samples in list is determined by Group Size parameter in TraceReportCreate.
8.3.4.12 Trace Object Reset
Table 27 Trace Reset Service Detail
Parameter Req/Ind Rsp/Cnf Comment
(list of) TraceID C M Identifies trace report(s) to be reset. If a Trace ID is not recognized, then the error
code “unknown trace report” is returned. If parameter is omitted in the request, then
all trace reports are reset. In all cases, the (list of) TraceID that are reset is returned in
the response.
ERStatus - C ERAck is set to false if any requested TraceID cannot be reset.
ErrorCodes:
Unknown trace report
ErrorText shall be set to the TraceID of reports which could not be reset.