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
The annotation element svcdoc:Reference describes the Reference element of the composite.
Figure 9–3 illustrates the Reference annotation element. The child elements
of this element and their purpose are described below.
Figure 9–3 Reference Annotation Element Example
These annotation elements are:
■
ArtifactType
Describes the type of AIA artifact used at the Reference service.
■
ServiceOperationName
Holds the complete service operation name in the format of verb + entity, as defined on the Reference service.
■
TransportDetails
Provides information about the transport adapters and their details, if the composite has any transport adapters. See
Section 9.1.4, Understanding the TransportDetails Element
for details about the TransportDetails element.
■
AdditionalServiceInformation
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. This provides more information about the service in the OER. Example:- This service supports EBiz 11.x and 12.x application adapters
Note: Only when the Composite is for an Adapter service would
TransportDetails be provided.
Annotating Composites 9-7
9.1.4 Understanding the TransportDetails Element
Use the annotation element TransportDetails to provide details about a transport adapter in a composite if a nonSOAP transport is used to interface with an application,
either using inbound or outbound connectivity.
The structure of the element TransportDetails is shown in Figure 9–4
.
Figure 9–4 Example of the TransportDetails Element
9.1.4.1 Annotating DBAdapter
If you give ApplicationName details for DBAdapter and set the ResourceType value to Business Event, then the deployment plan generator executes the SQL scripts on the
participating application layer and the datasource is created for the database in the participating application. If not, then Deployment Plan Generator executes the SQL
scripts on the middleware layer, that is, on the same server where PIP or project is to be deployed.
Table 9–3 lists the elements found in the DBAdapter element and provides a
description for each.
Table 9–3 DBAdapter Elements
Element Description
ResourceProvider Holds data about the Database Provider name. Examples: Oracle 10g,
Oracle 11g, MS-SQL 9, MySQL 9. Based on this tag, the Deployment Plan Generator identifies and
generate the appropriate configurations for the database. ConnectionFactory
Holds the name of the connection factory. Using this value, the AIA installation driver creates data sources during deployment. The DB
Adapter.rar file is updated during deployment. For example: eisDBAIASamplesDB
ApplicationName The name of the source or target application, depending on whether it
is an inbound or outbound adapter. For example: EBizDB, SiebelDB
BaseVersion The version of the application database with which the service is
interacting. XAEnabled
Used by the Deployment Plan Generator to decide if DataSource is to be configured using XA connection or not. Possible values are true and
false. Based on the whether the tag is true or false, the AIA installation driver
selects the appropriate JDBC driver and other configurations.
9-8 Developers Guide for Oracle Application Integration Architecture Foundation Pack
9.1.4.2 Annotating JMSAdapter
Table 9–4 lists the elements found in JMSAdapter and provides a description for each.
ResourceTargetIdenti fier
Identifier that is used as the element name in the AIAInstallProperties.xml to retrieve database information while
running the deployment plan. The xpath to retrieve database details is presented in DP as xpath, for example, pips.projectCode_
fromBOM.db.ResourceTargetIdentifier. The AIA installation driver uses this element during deployment. Examples: EBIZ1, EBIZ2,
JMSUSER1, JMSUSER2
Resource Type Identifies what type of resource must be configured.
ResourceName Holds data about database table name. The Deployment Plan
Generator uses this element to create and configure data sources. ResourceFileName
Holds data about SQL file name of the database table creation script. The Deployment Plan Generator uses this element to create and
configure data sources. AdditionalResourceI
nformation Provide additional resource information such as the supported adapter
versions or specifications or any other resource related information.
Table 9–4 JMSAdapter Elements
Element Description
ResourceProvider Holds data about JMS Provider name. Examples: WLSJMS, AQJMS,
Tibco, MQ-Series, and SonicMQ. Based on this tag, the Deployment Plan Generator identifies whether it
is AQJMS or WLSJMS and generate the appropriate configurations for AQ or WLS.
ConnectionFactory Holds the name of the connection factory. Using this value, the AIA
installation driver creates JMS modules during deployment. The JMS Adapter.rar file is updated during deployment. Example: eisjms
AIAApplication NameCF.
XAEnabled The Deployment Plan Generator uses this element to decide whether
the DataSource should be configured using XA connection. Possible values are true and false.
Based on the whether this tag is true or false, the AIA installation driver selects the appropriate JDBC driver and other configurations.
ResourceTargetIdenti fier
Can be either blank or filled in. If blank, AIAJMSModule is used to create resources on WLS. If filled in, AIAJDBCJMSModule is used to
create resources on WLS. ResourceType
Identifies what type of the JMS resource must be configured. The value can be Queue or Topic.
ResourceName Holds data about the Queue or Topic name. The AIA installation driver
uses this element to create and configure data sources. ResourceFileName
Holds data about the SQL file name of the database table creation script. The AIA installation driver uses the SQL file to create and
configure data sources. AdditionalResourceI
nformation Provide the additional resource information such as the supported
adapter versions or specifications or any other resource related information. This provides more information about the service in the
OER.
Table 9–3 Cont. DBAdapter Elements
Element Description
Annotating Composites 9-9
9.1.4.3 Annotating AQJMS Adapter
Table 9–5 lists the elements found in AQJMSAdapter and provides a description for
each.
9.1.4.4 Annotating Other Resources
If you want to use other resources like File or FTP adapters or any other resource, you must provide the following annotations. The Deployment Plan Generator does not
have support for all the resource adapters. For more information on supported resource adapters, refer to the Foundation Pack release notes.
Table 9–6 lists the elements used to annotate other resources and provides a
description for each.
Table 9–5 AQJMSAdapter Elements
Element Description
ResourceProvider Holds data about AQJMS Provider name. Examples: AQJMS.
Based on this tag, the Deployment Plan Generator generates the appropriate configurations for AQJMS.
ConnectionFactory Holds the name of the connection factory. Using this value, the AIA
installation driver creates AQJMS modules during deployment. The AQ Adapter .rar file is updated during deployment. Example:
eisaqjms AIAApplication NameCF.
XAEnabled The Deployment Plan Generator uses this element to decide whether
the DataSource should be configured using XA connection. Possible values are true and false.
Based on the whether this tag is true or false, the AIA installation driver selects the appropriate JDBC driver and other configurations.
JMSForeignServerNa me
Value used to create JMSForeignServer under JMSModule ResourceTargetIdenti
fier Identifier used as the element name in the AIAInstallProperties.xml to
retrieve database information while running the deployment plan. The xpath to retrieve database details is presented in DP as xpath, for
example, pips.projectCode_ fromBOM.db.ResourceTargetIdentifier.
ResourceType Identifies what type of the AQ resource must be configured. The value
can be Queue or Topic. ResourceName
Holds data about the Queue or Topic name. The Deployment Plan Generator uses this element to create and configure data sources.
ResourceFileName Holds data about the SQL file name of the database table creation
script. The AIA installation driver uses to create and configure data sources.
AdditionalResourceI nformation
Provide additional Resource information such as the supported adapter versions or specifications or any other resource related information.
This provides more information about the service in the OER.
Table 9–6 Elements for Other Resources
Element Description
ResourceProvider Holds data about Resource Provider name like FILE or FTP or AQ.
ConnectionFactory Holds the name of the connection factory. Using this value, the AIA
installation driver can create JNDI reference to the target URI. BaseVersion
The version of the application with which the service is interacting. This provides more information about the service in the OER.
9-10 Developers Guide for Oracle Application Integration Architecture Foundation Pack
9.1.4.5 Annotating Application Adapter
If you give ApplicationName details for EBiz Adapter and set the ResourceType value to Business Event, then the deployment plan generator executes the SQL scripts on the
edge application layer and the datasource is created for the database in the participating application. If not, then Deployment Plan Generator executes the SQL
scripts on the middleware layer, that is, on the same server where PIPproject is to be deployed.
Table 9–7 lists the elements found in ApplicationAdapter and provides a description
for each. XAEnabled
The Deployment Plan Generator uses this element to decide whether the DataSource should be configured using XA connection. Possible
values are true and false. Based on the whether this tag is true or false, the AIA installation
driver selects the appropriate JDBC driver and other configurations. ResourceTargetIdenti
fier The value of the application product code name. The AIA installation
driver uses this element during deployment. If ResourceTargetIdentifier is used for AQAdapter, then it is the
identifier that is used as the element name in the AIAInstallProperties.xml to retrieve database information while
running the deployment plan. The xpath to retrieve database details is presented in DP as xpath, for example, pips.projectCode_
fromBOM.db.ResourceTargetIdentifier.
ResourceName Holds data about the Queue or Topic name. The AIA installation driver
use this element to create and configure data sources. ResourceType
Identifies what type of the resource must be configured. ResourceFileName
Holds data about the SQL file name of the database table creation script or Shall scripts to create the file folders at a specified location. The AIA
installation driver uses to create and configure these sources. AdditionalResourceI
nformation Provide the additional Resource information like the supported adapter
versions or specifications or any other resource related information. This provides more information about the service in the OER.
ResourceLocation Provide the information about the location or relative path of the file.
This is used to create the source or target folders at appropriate local or remote locations.
Table 9–7 Application Adapter Elements
Element Description
ResourceProvider Holds data about EBiz Provider name.
ConnectionFactory Holds the name of the connection factory. Using this value, the AIA
installation driver creates EBiz modules during deployment. The EBiz Adapter .rar file is updated during deployment.
Application Name The name of the source or target application, depending on whether it
is an inbound or outbound adapter. BaseVersion
The version of the application with which the service is interacting. This provides more information about the service in the OER.
Table 9–6 Cont. Elements for Other Resources
Element Description
Annotating Composites 9-11
9.2 How to Annotate the Service Element in a Requester ABCS Composite
