semi合集-English.pdf - 第3605页

SEMI E139-0705 © SEMI 2005 29 8.4.2.6. 3 If the list of uid con tains multiple references to the same PDE , the RapNode shall delete the PDE and provide a successful response. Table 20 deletePDE () Service Parameters Par…

100%1 / 7923
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.
SEMI E139-0705 © SEMI 2005 30
transferContainer - C The actual TransferContainer. It is included only if PDEs are returned as a
result of the request.
getRspInfo - M Report success or failure for each requested PDE.
8.4.2.9 requestToSendPDE()
8.4.2.9.1 Request for permission to send a TransferContainer containing PDEs to the service provider. The size of
the proposed TransferContainer is provided so that the service provider can ensure that room is available.
8.4.2.9.2 The response to the request is contained in the rtsRspStat. If the returned value is “OK”, the service
provider is indicating that the proposed sendPDE() service should succeed. The requestToSendPDE() service shall
not be required to be send prior to the sendPDE() service. It provides an opportunity to check on a proposed transfer
before that transfer is attempted.
8.4.2.9.3 The tcid appears in both the requestToSendPDE() and sendPDE() services. This provides a way for the
RaPnode to match a received TransferContainer with the earlier requestToSendPDE() message.
Table 23 requestToSendPDE() Service Parameters
Parameter Name Req/Ind Rsp/Cnf Comment
tcid M = Identification of the TransferContainer to be transferred.
transferSize M - Size of the TransferContainer in bytes.
rtsRspStat - M Response to the request to send.
8.4.2.10 sendPDE()
8.4.2.10.1 The sendPDE() service is used to transfer PDEs contained in a TransferContainer to the service
provider. Any response other than success (“OK”) shall be considered an indication that the recipe was not
accepted. If a duplicate PDE is contained in the TransferContainer, the service provider shall store one and discard
the other. This shall not be considered an error. If a PDE in the TransferContainer is already stored on the service
provider, the newly received PDE shall overwrite the existing one.
8.4.2.10.2 Refer to ¶8.5.1.3 for requirements related to PDE transfer that apply to EquipmentNodes.
Table 24 sendPDE() Service Parameters
Parameter Name Req/Ind Rsp/Cnf Comment
tcid M - Identifier of the TransferContainer being sent.
transferContainer M - The actual TransferContainer being transferred.
sendRspInfo - M Report success or failure for each PDE.
8.4.2.11 resolvePDE()
8.4.2.11.1 In the recipe hierarchy, each reference of a PDE is either a uid or a gid value. All gids must be resolved
to uids before a recipe can be executed. The EquipmentNode is responsible for the final resolution of any gids not
resolved by the client (see ¶8.5.4). The resolvePDE() service is a request for the EquipmentNode to provide the
resolution of all gids in a hierarchy. The EquipmentNode shall resolve the recipe hierarchy exactly the same as if the
recipe was to be executed at the time of the resolvePDE() request.
8.4.2.11.2 The structure of a recipe can be determined by successively resolving the ReferencedPDEs at a level of
the hierarchy and then moving downward to the next level. Note that the resolution of a gid at one level will affect
the recipe structure at the next level down. The response to the resolvePDE() service shall comprehend the entire
hierarchy below the targetPDE.
8.4.2.11.3 While the targetPDE will typically be a Master PDE, there is no requirement for this to be the case. This
service can be used to resolve a subset of a complete recipe. The targetPDE shall contain a gid or a uid value.
8.4.2.11.4 The inputMap parameter specifies a list of PDE references with the corresponding uid that resolves each.
This is a list of client specified resolutions for the gids that may be encountered during the resolution process. If,