Understanding the Service Annotation Element

Annotating Composites 9-3 svcdoc:AIA -- reference As shown in Example 9–2 and Example 9–3 the root of the annotation element of the composite is svcdoc:AIA. Provide annotations for the Service and Reference elements of the Composite under xml comment tags using the annotation elements svcdoc:Service and svcdoc:Reference, respectively. Figure 9–1 illustrates the annotations for Reference and Service elements. Figure 9–1 Example of Annotations

9.1.2 Understanding the Service Annotation Element

The annotation element svcdoc:Service describes the details of the exposed service as denoted by the Service element of the Composite.xml. At a broader level, three annotation elements provide details about a service interface, its implementation, and the transport details only if it is a transport adapter composite or if the composite contains as an adapter component. These annotation elements are: ■ InterfaceDetails This element provides information about the service interface, such as the name of the service, the name of the operation defined on the service, and the type of the service artifact. ■ ImplementationsDetails This element provides information about the application with which the ABCS is interacting. ■ TransportDetails This element provides information about the transport adapters and their details, if the composite has any transport adapters. Figure 9–2 illustrates the annotations for interface, implementation, and transport details. Figure 9–2 Example Of Annotation Elements 9-4 Developers Guide for Oracle Application Integration Architecture Foundation Pack For more information, see Section 9.1.4, Understanding the TransportDetails Element .

9.1.2.1 InterfaceDetails

This element identifies the interface that is being implemented by the AIA service in consideration. The AIA service that implements an interface definition has these details annotated in its composite.xml. This element should provide details such as: ■ The name of the service ■ The name of the service operation ■ The type of the service artifact. The element InterfaceDetails is explained in detail in Table 9–1 . Example 9–4 shows a sample of the interface details annotation element. Example 9–4 Interface Details Annotation Element Example svcdoc:InterfaceDetails svcdoc:ServiceNameCustomerPartyEBSsvcdoc:ServiceName svcdoc:Namespacehttp:xmlns.oracle.comEnterpriseServicesCoreCustomerParty V2svcdoc:Namespace svcdoc:ArtifactTypeEnterpriseBusinessServicesvcdoc:ArtifactType svcdoc:ServiceOperation svcdoc:NameCreateCustomerPartyListsvcdoc:Name svcdoc:ServiceOperation AdditionalServiceInformationThis service supports create customer or billing profile ABM coming out of Siebel 8.0.x and 8.2 versionsAdditionalServiceInformation svcdoc:InterfaceDetails Note: Only when the Composite is that of an Adapter service are the Transport details provided. Table 9–1 Interface Details Elements Element Description ServiceName Identifies the name of the AIA service whose interface is being implemented by the composite under consideration. The Deployment Plan Generator uses this value. Namespace The namespace of the service whose interface is being implemented as defined in its WSDL. ArtifactType The type of service artifact, for example, an ABCS, and so on. The valid values are given here: Valid Values for Annotation Elements. ServiceOperationNa me The element that holds the complete service operation name in the format of verb + entity. The name of the operation of the AIA service whose interface is being implemented by the composite under consideration. AdditionalServiceInf ormation This element can be used to provide the additional service information like the supported application versions along with the base version or any other service related information Example:- This service supports create customer or billing profile ABM coming out of Siebel 8.0.x and 8.2 versions Annotating Composites 9-5 Service Interface details are optional. The AIA artifacts that implement an interface definition have these details annotated. For example, a provider ABCS implements an interface defined by an Enterprise Business Service EBS operation, whereas a requester ABCS does not. So, annotations about the service interface will only be captured in the provider ABCS to identify which interface that particular ABCS is implementing. Therefore, specify Service Interface details in the Composite.xml only if they are applicable.

9.1.2.2 ImplementationDetails

The annotation element ImplementationDetails describes the application for which the AIA service is being implemented. Table 9–2 lists the elements and provides a description for each element. Example 9–5 shows a sample of the ImplementationDetails annotation element. Example 9–5 ImplementationDetails Annotation Element Example svcdoc:ApplicationNameBRMsvcdoc:ApplicationName Table 9–2 ImplementationDetails Elements Element Description ApplicationName The name of the participating application with which the service is interacting. B2BDocument For requester or provider B2B Connector Services, this element contains the name of the B2B document type that is supported by the B2B Connector Service. An example of a B2B document type is an 850 EDI ORDER. The value in this field should also match the DocumentType name in Oracle B2B. B2BDocumentVersio n Contains the version of the B2B document type that is supported by the B2B Connector Service, for example, 4010. The value in this field should also match the DocumentRevision in Oracle B2B. B2BStandard Contains the name of the B2B standardprotocol that is supported by the B2B Connector Service, for example, EDI_X12, OAG, or RosettaNet. B2BStandardVersion Contains the version of the B2B standardprotocol that is supported by the B2B Connector Service, for example, 1.0. BaseVersion The version of the participating application with which the service is interacting. DevelopedBy The name of the Business Unit that developed the service. A possible value is ABSG. OracleCertified Indicates whether it is tested by Oracle or not. ArtifactType Describes the type of the service artifact, for example, whether it is an ABCS, and so on. The valid values are given here: Valid Values for Annotation Elements. AdditionalServiceInf ormation Provide any additional service information . ServiceOperationNa me Holds the complete service operation name in the format of verb + entity. The name of the operation defined in the WSDL of the AIA service that is being implemented. 9-6 Developers Guide for Oracle Application Integration Architecture Foundation Pack svcdoc:ImplementationDetails svcdoc:BaseVersion7.3svcdoc:BaseVersion svcdoc:DevelopedByOraclesvcdoc:DevelopedBy svcdoc:OracleCertifiedYessvcdoc:OracleCertified svcdoc:ArtifactTypeProviderABCSImplementationsvcdoc:ArtifactType svcdoc:ServiceOperation svcdoc:NameCreateCustomersvcdoc:Name svcdoc:ServiceOperation svcdoc:ImplementationDetails

9.1.3 Understanding the Reference Annotation Element