32.1 General Guidelines

The goal is to ensure that the intent of each artifact is clear, and that the text associated with the artifact conveys as much information as possible given the space constraints. The following should be applied whenever applicable:

Avoid abbreviations.

Abbreviations may be ambiguous. The names used must be spelled out. Do not abbreviate unless the object name becomes too long.

Artifact names must be alphanumeric.

Names must be composed only of alphanumeric character with these rules:

Word comprising a name should be concatenated without spaces in an upper camel-case fashion.

Example: Purchase Order

Avoid using numeric characters in the name unless it is required to convey some business meaning.

No special characters such as spaces, '-', '_', '.', '$', '%', '#', []

Indicate artifact type in the name to reduce ambiguity.

When the same name is used for different artifact types, append a suffix to indicate its type. It makes it easier to distinguish these artifacts by identifying their types:

<Artifact Name><Type Suffix>

Example: InvoiceEBO, InvoiceEBOType, InvoiceEBM, InvoiceEBMType.

The total path length to a named artifact must not exceed 17000 characters.

Some operating systems such as Windows have a limit of 255 characters for file names. Some room is left for prefixing with complete network directory or URL.

32.1.1 XML Naming Standards

The following standards are based on UN/CEFACT - XML Naming and Design Rules.

32.4 Enterprise Business Services

Enterprise Business Services (EBS) are SOA Mediator Routing Services with routing rules to invoke the appropriate composite business processes, Enterprise Business Flows, and Application Business Connector Services.

Table 32-4 provides details about the naming standards for Enterprise Business Services.

Here the "JMSQueue" indicates "WLS JMS Queue" by default. For other JMS providers, a prefix should be added like AqJMSQueue, TibJMSQueue...and so on.

While coming up with the queue/topic names, you could use the meaningful short names or abbreviations in the following use cases:

Long Application/Industry name.Long EBO/ABO name.

JMS provider having a restriction on the number of characters. For example: AQ JMS provider has 24 characters limitation on queue name.

Use short form "JMSQ" instead of "JMSQueue" and "JMST" in the above cases. Based on the JMS provider's maximum characters limitation on their queue name, it is recommended to come up with a suitable & meaningful queue or topic name by following short names or abbreviations of application/industry and EBO/ABO names. Example: AIA_PSFTCurExchangeJMSQ, AIA_SEBLCustPartyJMSTV1

32.8.1.2 Map Column Names

Map column names:

Must be set to the participating application instance name abbreviation that the column value represents. This name can be the application name and its version, or an instance name in case two similar applications of the same version are integrated. The name must be a unique identifier for the application instance across the integration platform in the form: {Application Abbreviated Name}_{Sequence Number}. The sequence number uniquely identifies multiple instances of the same application.

Must be uppercase.

A column named COMMON must be always added. This column contains the values used in the EBOs within the platform.

32.8.2 Cross References

When creating cross-reference virtual tables in the cross reference tables, the following naming standard should be followed:

32.8.2.1 Table Name

Table names:

Must not exceed 48 characters.

Must start with the object name.

This enables you to identify cross-references that belong to a certain object. The object name should be equivalent to the EBO name.

Must be followed by the element name that needs cross-referencing.

If exceeds 48 characters, it should be properly abbreviated.

Must be uppercase.

Pattern: {Object Name}_{Element Name}

Examples: ORDER ORDERID, INVOICE INVOICEID, CUSTOMER ID

32.8.2.2 Column Names

Column names:

Must not exceed 48 characters.

Must be set to the participating application instance name abbreviation that the column value represents.

The name must be a unique identifier for the application instance across the integration platform in the form: {Application Abbreviated Name}_{Sequence Number}. The sequence number uniquely identifies multiple instances of the same application.

Externally facing services implemented in Java must have the version number part of the package to be in line with our namespace naming standards. This also enables you to publish the same service under different versions at the same time.

oracle.apps.aia.<lba>... v<version> where lba stands for logical business area.

Tip:

To avoid collisions, 'aia' must be defined as an application in the Fusion Application.

The ODI and the main deployment plan can coexist. In the command argument of the deployment plan generator you must give "-DODIinput=ODIBOM.xml" as an additional argument to generate the combined deployment plan.

You can also generate deployment plan for the ODI alone by skipping the "-Dinput" and "-DharvesterSettings" arguments.

Deployment Plan generator automatically generates <PIP Code>HS.xml

Deployment Plan holding customer extensions

<PIP Code>CustomDP.xml

Deployment instructions for the artifacts created by the customer

"<ProjectCode>CustomDP.xml :re-generated deployment plan on customer sites using PLW and DPG. It contains only native artifacts

This is similar to the main deployment plan with all the Preinstall, Configurations, Deployments and PostInstall section.

Deployment Plan holding non-native artifacts

<PIP Code>SupplementaryDP.xml

Deployment instructions for non-native artifacts (J2EE application, java class, web services and every other artifact that could not be harvested)

Pre-Built Integrations having non-native artifacts alone should deliver this plan

This is similar to the main deployment plan with all the Preinstall, Configurations, Deployments and PostInstall section.

Scripting on this page enhances content navigation, but does not change the content in any way.