semi合集-English.pdf - 第3604页

SEMI E139-0705 © SEMI 2005 28 8.4.2.4 Service Message Definitions 8.4.2.4. 1 This section specifies the allowable/required param ete rs for each service. Table 17 shows the format of the Service Parameters tables used fo…

100%1 / 7923
SEMI E139-0705 © SEMI 2005 27
Parameter Name Form Description Where Used
verifyDepth Enumeration
Verifies the scope of the PDEs to be verified.
“Single” — Only the specified PDE is checked.
“All” — Verify the specified PDE, plus all PDEs it
references directly or indirectly (e.g. by the PDEs
that are referenced). It requires a check that all
required PDEparameters are supplied by each
referencing PDE. This may be used with a Master
PDE to verify all the PDEs it will need for an
activity. Note that if a PDE is referenced by
multiple other PDEs within the scope of a
verifyPDE() request, it only needs to be verified
once during this process.
verifyPDE()
verifyInfo
list of (uid,
verifyRspStat)
One value set is returned for each PDE that was
reviewed by the verification process. The uid
identifies the PDE that was found to have an error.
verifyPDE()
verifyRspStat Error
Status response for the getPDE() service. The
following values are allowed:
“OK” — Indicates successful verification of the
PDE.
“NotFound” — The specified PDE was not found.
“ChecksumFail” — The computed checksum of
the PDEheader or of the PDEbody did not match
the values in the PDE.
“SyntaxError” — The syntax of the PDE or its
body was found to be incorrect.
“ContentError” — The content of the PDE did not
match allowed values or did not follow all content
rules.
“Other” — The verification error did not match the
other enumerated categories.
verifyInfo Parameter,
sendRspStat Parameter
verifySuccess Boolean
Returns “true” if no errors were encountered
during the entire verifyPDE() operation. Otherwise
returns “false”.
verifyType
Enumeration
Specifies the type of verification to perform. The
following values are allowed:
“Checksum” — computes the checksum of each
applicable PDE and compares the value to the
checksum value contained in the PDE. It computes
the checksum of any related external PDEbodies
and compares the value to the bodyChecksum value
contained in the PDE. It also confirms that the
PDEbody is matched to the proper PDE.
“Validity” – For each PDE to be verified, ensures
that the PDE can be executed as part of a recipe
without error. This verification checks the syntax
of the PDE. It includes “Checksum” verification
plus any other criteria the equipment can provide.
Also included is a check that a compatible
ExecutionTarget exists on the equipment (if any
ExecutionTargets are specified for this PDE).
Successful verification does not guarantee the
desired process results.
verifyPDE()
SEMI E139-0705 © SEMI 2005 28
8.4.2.4 Service Message Definitions
8.4.2.4.1 This section specifies the allowable/required parameters for each service. Table 17 shows the format of
the Service Parameters tables used for this purpose.
Table 17 Service Parameters
Parameter Name Req/Ind Rsp/Cnf Comment
Name see below see below Descriptive Text
8.4.2.4.2 Each service has an initial message (Request to the sender, Indicator to the receiver, hence Req/Ind).
Services that are “Request/Response” have a return message (Response to the sender, Confirmation to the receiver,
hence Rsp/Cnf). The Req/Ind and Rsp/Cnf columns indicate in which message each parameter is to be included.
The codes from Table 18 are used in these columns to give further information.
Table 18 Req/Ind and Rsp/Cnf Codes
Code Description
M Mandatory Parameter — Must be given a valid value.
C Conditional Parameter — May be defined in some circumstances and undefined in others. Whether a value is given
may be completely optional or may depend on the value of the other parameters.
U User-Defined Parameter.
- The parameter is not used.
= (For response only) Indicates that the value of this parameter in the response must match that in the primary (if
defined).
8.4.2.5 getPDEdirectory()
8.4.2.5.1 The getPDEdirectory() service is used by the FICS to request a list of PDEs maintained by the service
provider. The requestor may supply a filter that will yield a subset of the full list of PDEs. A subset of the
PDEheader’s attributes can be reported for each returned PDE if desired.
8.4.2.5.2 When multiple PDEFilters are specified, these filters are to be AND’ed together. That is, each filter is
applied in turn with the reduced list that is output from one becoming the input for the next. Note that no
PDEDirItems are returned when no PDE’s are found that pass the filters.
8.4.2.5.3 The requestor may choose not to include PDEFilters or PDEAttributes in the request.
Table 19 getPDEdirectory() Service Parameters
Parameter Name Req/Ind Rsp/Cnf Comment
list of PDEFilter C - List of criteria for which PDEs to report. If no PDEFilters supplied, all
PDEs will be reported
list of PDEAttribute C - Lists the attributes to be returned for each PDE reported
list of PDEDirItem - C List of the PDEs on the service provider that match the provided filter.
The values of the specified attributes are included for each.
dirRspStat M Denotes any error found. If there is an error, no PDEDirItems are
returned.
8.4.2.6 deletePDE()
8.4.2.6.1 The deletePDE() service is used by the FICS to request that specified PDEs be deleted from the service
provider. The request includes a list of the PDEs to be deleted. The requestor may wish to first use the
getPDEdirectory() service to obtain a list of the available PDEs.
8.4.2.6.2 The delRspInfo lists any errors encountered by the service provider in the completion of the deletePDE()
request. All PDEs not referenced by delRspInfo shall be deleted.
SEMI E139-0705 © SEMI 2005 29
8.4.2.6.3 If the list of uid contains multiple references to the same PDE, the RapNode shall delete the PDE and
provide a successful response.
Table 20 deletePDE() Service Parameters
Parameter Name Req/Ind Rsp/Cnf Comment
list of uid M - Specifies which PDEs are to be deleted. At least one PDE must be listed.
delRspInfo - M Information concerning the result of the service.
8.4.2.6.4 RaP allows deletion of a PDE, even if it is referenced by another PDE. The user should be aware that
deletion of PDEs may make execution of one or more Master PDEs impossible due to unsatisfied references.
8.4.2.7 getPDEheader()
8.4.2.7.1 The getPDEheader() service is used to request that the headers of one or more PDEs be returned from the
service provider. Prior to sending a response, the service provider shall be responsible for locating the PDEs
requested, extracting the headers, packaging them in a TransferContainer, and generating a tcid for the
TransferContainer.
8.4.2.7.2 When reported separately from its PDEbody, a PDEheader serves only a documentation role and is not
usable as part of a recipe. The PDEbody is never transferred separately from its PDEheader.
8.4.2.7.3 The getRespInfo parameter contains information about any errors that occur. If errors are encountered,
then the TransferContainer shall contain all requested PDEheaders for which no error is reported.
8.4.2.7.4 If the list of uids contains duplicate entries, the RapNode shall combine these requests and (in the absence
of other problems) return only one copy of the requested PDEheader. The returned getRspStat value for each
original request shall reflect the status of the combined request (that is, “OK” if one copy is returned).
Table 21 getPDEheader() Service Parameters
Parameter Name Req/Ind Rsp/Cnf Comment
list of uid M - Indicates the identifiers for the PDEs whose headers are to be returned in
the TransferContainer.
tcid - C uuid of the TransferContainer that has been returned.
transferContainer - C The actual TransferContainer. It is included only if PDEheaders are
returned as a result of the request.
getRspInfo - M Report success or failure for each requested PDEheader.
8.4.2.8 getPDE()
8.4.2.8.1 The getPDE() service is used to request that one or more PDEs be returned from the service provider.
Prior to sending a response, the service provider shall be responsible for locating the PDEs requested, packaging
them in a TransferContainer, and generating a uuid for the TransferContainer.
8.4.2.8.2 The getRespInfo parameter contains information about any errors that occur. If errors are encountered,
then the TransferContainer shall contain all requested PDEs for which no error is reported.
8.4.2.8.3 If the list of uids contains duplicate entries, the RapNode shall combine these requests and (in the absence
of other problems) return only one copy of the requested PDE.” The returned getRspStat value for each original
request shall reflect the status of the combined request (that is, “OK” if one copy is returned).
Table 22 getPDE() Service Parameters
Parameter Name Req/Ind Rsp/Cnf Comment
list of uid M - Indicates the identifiers for the PDEs requested to be returned in the
TransferContainer.
tcid - C uuid of the TransferContainer that has been returned.