29 Oracle AIA Naming Standards for AIA Development

29.1.1.1 General Naming Standards

Follow these general naming standards:

• Lower-Camel-case must be used for naming attributes.

  Example: <xsd:attribute name="unitCode"/>

• Upper-Camel-case must be used for naming elements and types.

  Example: <xsd:element name="UnitOfMeasure"/> <xsd:complexType name="InvoiceEBOType"/>

• Names must be singular unless the concept itself is plural.

  For example repeating elements must have a singular name.

• Names must not contain special characters such as: space, '-', '_', '.', '$', '%', '#', ....

• Avoid having numeric characters in the name.

  There are cases were using a numeric character is required to convey some significance.

• Complex type names should end with the 'Type' suffix to make it easier to recognize types from elements.

  Example: <xsd:complexType name="InvoiceEBOType"/>

• The name of a simple type definition should be the name of the root element with the 'ContentType' suffix.

  Example: <xsd:simpleType name="PhoneNumberContentType">

29.1.1.2 General Namespace Naming Standards

These are the general namespace naming rules. More detailed rules are described in the following sections, especially naming rules for EBS and ABCS.

• All namespaces must start with http://xmlns.oracle.com/.

• Namespaces used by Enterprise Business Objects (EBOs) and Enterprise Business Messages (EBMs) start with http://xmlns.oracle.com/EnterpriseObjects/.

  Example: http://xmlns.oracle.com/EnterpriseObjects/Core/EBO/Invoice/V1

• Namespaces used for externally facing services must start with http://xmlns.oracle.com/EnterpriseServices/.

  Examples: http://xmlns.oracle.com/EnterpriseServices/Core/Invoice/V1 http://xmlns.oracle.com /EnterpriseServices/Industry/Telco/Invoice/V1

• Namespaces for versioned artifacts must have the major version number as a suffix with 'V' as an abbreviation for 'version'.

  Example: http://xmlns.oracle.com/ EnterpriseObjects/Core/EBO/Invoice/V1

• The namespace structure should closely map to the taxonomy of the types it encapsulates.

  Example: Horizontal: http://xmlns.oracle.com/EnterpriseObjects/Core/EBO/Invoice/V1.

  Telco: http://xmlns.oracle.com/EnterpriseObjects/Industry/Telco/EBO/Invoice/V1.

• Namespaces for artifacts generated within ABCSs must start with: http://xmlns.oracle.com/ABCS/.

• When importing or including schema in a schema file, the schema location must always use relative path.

  Example: <xsd:importnamespace="http://xmlns.oracle.com/EnterpriseObjects/Core/EBO/Invoice/V1" schemaLocation="../../../../Core/EBO/Invoice/InvoiceEBO .xsd"/>

• Namespace prefixes must be a minimum of six (6) lowercase characters abbreviation of the namespace.

  The abbreviation must be descriptive and unambiguous within the context where it is being used.

• Namespace prefixes for EBOs and EBMs must adhere to the following standard wherever used regardless of the applications or technology used.

  Auto-generated prefixes such as ns1, ns2 must not be used. Auto-generated prefixes for standard namespaces such as xsd, xsi are acceptable.

Table 29-1 provides details on the namespace patterns and files associated with namespace prefixes.

29.1.1.3 Participating Applications Names

When participating application names are part of an artifact name, upper-camel-case short names should be used. For cases where an abbreviation is needed, an upper-case abbreviation should be used.

Table 29-2 provides a list of short names and abbreviations used for participating applications.

29.8.1.1 Map Name

Map names:

• Must start with the object name.

  This allows you to identify maps that belong to a certain object. The object name should be equivalent to the EBO name.

• Should be followed by the element name that needs domain value mapping.

• Must be uppercase.

Pattern: {Object Name}_{Element Name}

Examples: CUSTOMERPARTY_ACCOUNTTYPECODE, INVOICE_REJECT_REASON, SALESORDER_CARRIER_TYPECODE

DVM File Name Examples: CUSTOMERPARTY95ACCOUNTTYPECODE, INVOICE95REJECT95REASON, SALESORDER95CARRIER95TYPECODE

29.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.

Examples: COMMON, EBIZ_01, PSFT_01, SEBL_02, SEBL_03, PORTAL_01, IFLEX_01

29.8.2.1 Table Name

Table names:

• Must not exceed 48 characters.

• Must start with the object name.

  This allows 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

29.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.

• Must be uppercase.

• Must have a column named COMMON added.

  This column contains the values used in the EBOs within the platform.

Examples: COMMON, EBIZ_01, PSFT_01, SEBL_02, SEBL_03, PORTAL_01, IFLEX_01

29.9.1.1 BPEL Process Name and Namespace

The BPEL process JDeveloper project name should match the BPEL process name (use default project setting).

Name standards

• The name should follow the general standard naming standards depending on whether it is being used for EBS, ABCS Impl, or Adapter Service.

• The name should clearly describe the process and action/verb being performed.

Namespace standards:

• The namespace should follow the general namespace standards depending on whether it is being used for EBS, ABCS Impl, or Adapter Service.

• The namespace must reflect the taxonomy of the process.

• The namespace must include the major version number where appropriate.

• BPEL composite's reference component name should follow the general naming standards based on the type of AIA artifacts it is calling.

29.9.1.2 Assign

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts with the Assign prefix.

• Followed by a name describing what is being assigned. If what is assigned is a message, then use the message name.

• In case there are multiple assignments, provide a name that describes the group of assignments if possible.

Pattern: Assign<Name of what is being assigned>

Example: AssignPaymentEBM, AssignOrderInitialValues

29.9.1.3 Compensate

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts with the Compensate prefix.

• Followed by the name of the scope encapsulating the tasks to be compensated.

Pattern: Compensate<scope name>

Example: CompensateProcessCreditCheckMilestone, Compensate TranseferFundsScope

29.9.1.4 Flow

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts by a name describing the tasks being run concurrently.

• Ends with the Flow suffix.

Pattern: <Name describing concurrent tasks>Flow

Example: CallManufacturersFlow, GetQuotesFlow

29.9.1.5 FlowN

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts by a name describing the dynamic tasks being run concurrently.

• Ends with the FlowN suffix.

• The index variable name should be the flow name with Index as suffix.

Pattern: name = <Name describing concurrent tasks>FlowN, index variable = <Name describing concurrent tasks>FlowNIndex

Example: ActivateUsersFlowN (ActivateUsersFlowNIndex), CheckSuppliersFlowN (CheckSuppliersFlowNIndex)

29.9.1.6 Invoke

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts with the Invoke prefix.

• Followed by the partner link to be invoked.

• Followed by Call if synchronous invocation or Start if asynchronous invocation.

• Followed by the operation name within the partner link.

Pattern: Invoke<Partner Link Name>{Call/Start}<Operation>

Example: InvokeCustomerServiceCallGetCustomer, InvokeNotificationServiceStartNotifyByEmail

29.9.1.7 Java Embedding

Follow these guidelines:

• The name should follow the general standard naming standards.

• The name should be similar to a Java method Name with lower-camel-case.

Pattern: <A name describing the functionality>

Example: getDiscountPrice

29.9.1.8 Pick

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts with the Pick prefix.

• Followed by a name describing as accurate as possible all branches (onMessage and onAlarm) within the pick activity.

Pattern: Pick<Name describing the branches to pick from>

Example: PickOrderAckOrTimeout, PickFirstQuote

29.9.1.9 Receive

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts with the Receive prefix.

• Contains the name of the message it is receiving.

Pattern: Receive<Message Name>

Example: ReceiveUpdateInvoiceEBM

29.9.1.10 Scope

Follow these guidelines:

• The name should follow the general standard naming standards.

• Including brief information about transaction type may be appropriate.

• Use Milestone as the suffix if the scope is a candidate for end-user monitor.

• If it is not intended for the end-user monitor, use Scope as the suffix.

Pattern: <Name describing the Scoped Tasks>{ Scope |Milestone}

Examples: GetCreditRatingScope, GetLoanOfferScope, ProcessCreditCheckMilestone

29.9.1.11 Sequence

Follow these guidelines:

• The name should follow the general standard naming standards.

• The sequence name should describe the steps performed in the sequence.

• The sequence name should end with Sequence suffix.

Pattern: <Name describing the Sequenced Tasks>Sequence

Example: GetCustomerInfoSequence

29.9.1.12 Switch

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts with the Switch prefix.

• Followed by the name of what is being evaluated

Pattern: Switch<Name of what is being evaluated>

Example: SwitchCreditRating

29.9.1.13 Case

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts with the Case prefix.

• Followed by the name of the evaluated value.

Pattern: Case<Name evaluated value>

Example: CaseBadCredit, CaseApprovalRequired

29.9.1.14 Terminate

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts with the Terminate prefix.

• Followed by a name describing the termination reason.

Pattern: Terminate<reason of termination>

Example: TerminateTimeout, TerminateEndOfProcess

29.9.1.15 Throw

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts with the Throw prefix.

• Followed by the fault name.

• The fault variable name is typically named the same as the fault name.

Pattern: Throw<fault name>

Example: ThrowExceededMaxAmount, which uses ExceededMaxAmount variable.

29.9.1.16 Transform

Follow these guidelines:

The name should follow the general standard naming standards.

• Starts with the Xform prefix.

• Followed by the source name.

• Followed by To.

• Followed by the destination name.

Pattern: Xform<source>To<destination>

Example: XformBillToPortal80Bill

29.9.1.17 Wait

Follow these guidelines:

The name should follow the general standard naming standards.

• Starts with the Wait prefix.

• Followed by a name describing the reason for waiting.

Pattern: Wait<Name describing the waiting reason>

Example: WaitOrderAcknowledgeTimeout, WaitWarmUpTime

29.9.1.18 While

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts with the While prefix.

• Followed by a name describing the loop condition.

Pattern: While<Name describing the loop condition>

Example: WhileAllMsgsSent

29.9.2.1 Variables

Follow these guidelines:

• The name should follow the general standard naming standards.

• Use lower-camel-case for variable names.

• The data type must not be part of the variable name.

Example: accountBalance, invoiceAmount.

29.9.2.2 Properties

Property names follow the general BPEL variables naming standards.

29.9.2.3 Correlation Sets

Follow these guidelines:

• The name should follow the general standard naming standards.

• Starts with a name describing the correlation set.

• Ends with CorSet suffix.

Pattern: <Name describing the correlation>CorSet

Example: PurchaseOrderCorSet

29.9.2.4 Correlation Set Properties

The correlation set property names follows the general BPEL variables naming standards.