XML Naming Standards General Guidelines
29.1.1 XML Naming Standards
The following standards are based on UNCEFACT - XML Naming and Design Rules.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=PhoneNumberContentType29.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.comEnterpriseObjects. Example: http:xmlns.oracle.comEnterpriseObjectsCoreEBOInvoiceV1 Oracle AIA Naming Standards for AIA Development 29-3 ■ Namespaces used for externally facing services must start with http:xmlns.oracle.comEnterpriseServices . Examples: http:xmlns.oracle.comEnterpriseServicesCoreInvoiceV1 http:xmlns.oracle.com EnterpriseServicesIndustryTelcoInvoiceV1 ■ 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 EnterpriseObjectsCoreEBOInvoiceV1 ■ The namespace structure should closely map to the taxonomy of the types it encapsulates. Example: Horizontal: http:xmlns.oracle.comEnterpriseObjectsCoreEBOInvoiceV1. Telco: http:xmlns.oracle.comEnterpriseObjectsIndustryTelcoEBOInvoiceV1. ■ Namespaces for artifacts generated within ABCSs must start with: http:xmlns.oracle.comABCS . ■ When importing or including schema in a schema file, the schema location must always use relative path. Example: xsd:importnamespace=http:xmlns.oracle.comEnterpriseObjectsCoreEBOInvoiceV1 schemaLocation=........CoreEBOInvoiceInvoiceEBO .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. Table 29–1 Namespace Prefixes Prefixes Namespace Pattern Files corecomcust http:xmlns.oracle.comEnter priseObjectsCoreCustomCo mmonV1 CustomCommonComponents, CustomReferenceComponents coreinvcust http:xmlns.oracle.comEnter priseObjectsCoreCustomEB O InvoiceV1 CustomInvoiceEBO corecom http:xmlns.oracle.comEnter priseObjectsCoreCommon V1 CommonComponents. Reference Components coreinv http:xmlns.oracle.comEnter priseObjectsCoreEBOInvoic eV1 InvoiceEBO coreinv http:xmlns.oracle.comEnter priseObjectsCoreEBOInvoic eV1 InvoiceEBM 29-4 Developers Guide for Oracle Application Integration Architecture Foundation Pack29.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. telcocomcust http:xmlns.oracle.comEnter prisObjectsIndustryTelcoC ustomCommonV1 CustomCommonComponents, CustomReferenceComponents telcoinvcust http:xmlns.oracle.comEnter priseObjectsIndustryTelcoC ustomEBOInvoiceV1 CustomInvoiceEBO telcocom http:xmlns.oracle.comEnter priseObjectsIndustryTelcoC ommonV1 CommonComponents. Reference Components telcoinv http:xmlns.oracle.comEnter priseObjectsIndustryTelcoE BOInvoiceV1 InvoiceEBO telcoinv http:xmlns.oracle.comEnter priseObjectsIndustryTelcoE BOInvoiceV1 InvoiceEBM Table 29–2 Short Names and Abbreviations for Participating Application Names Application Short Name Abbreviation Oracle E-Business Suite Ebiz EBIZ Oracle Siebel Siebel SEBL Oracle PeopleSoft PeopleSoft PSFT Oracle JD Edwards Enterprise One JDEOne JDE1 Oracle JD Edwards World JDEWorld JDEW Oracle Transportation Management Suite Logistics LOGIS Oracle Telephony Work Telephony TELE Oracle Demantra Demantra DMTR Oracle Communications Billing and Revenue Management Portal PORTAL Oracle Retail Applications Retek RETEK Table 29–1 Cont. Namespace Prefixes Prefixes Namespace Pattern Files Oracle AIA Naming Standards for AIA Development 29-529.2 Composites
Parts
» Oracle Fusion Middleware Online Documentation Library
» How to Use the AIA Development Guide Introduction to Project Lifecycle Workbench
» Select a Service Type value: Requestor ABCS, Provider ABCS, Enterprise
» Use the query criteria in the Search area to locate the service solution component
» How to Set Up Environments to Enable Design-Time Harvesting
» Introduction to Bills of Material
» How to Generate a Bill of Material for an AIA Lifecycle Project
» How to View a Bill of Material for an AIA Lifecycle Project
» Introducing Project Lifecycle Workbench Seed Data
» Introduction Oracle Fusion Middleware Online Documentation Library
» Input for Deployment Plan Generator Executing Deployment Plan Generator
» Deploying New or Custom Built Artifacts
» Undeploying Services Oracle Fusion Middleware Online Documentation Library
» Understanding the ODIBOM.xml File
» Understanding the ODI Deployment Plan
» Understanding the Service Annotation Element
» Understanding the Reference Annotation Element Understanding the TransportDetails Element
» How to Annotate the Service Element in a Requester ABCS Composite
» How to Annotate the Service Element in Composite Business Process Composite
» Understanding EBS Types Working with the Enterprise Business Service Library
» Understanding Design Guidelines Understanding Design Considerations
» Creating Routing Rules Working with Message Routing
» Routing at the EBS Guidelines for EBS Routing Rules
» How to Implement Fire-and-Forget Pattern with EBS One-Way Calls Creating EBS WSDLs
» How to Implement the Request-Delayed Response Pattern with the Two One-Way Calls of the EBS
» ABCS Types Introduction to ABCS
» Defining the Role of the ABCS
» Constructing ABM Schemas Analyzing the Participating Application Integration Capabilities
» Introduction to MEPs Choosing the Appropriate MEP
» Outbound Interaction with the Application
» Using BPEL for Building ABCS
» Prerequisites Constructing an ABCS
» ABCS as a Composite Application How Many Components Need to Be Built
» How to Construct the ABCS Composite Using JDeveloper Developing the BPEL Process
» How to Create References, Services, and Components Moving Abstract Service WSDLs in MDS
» Setting Correlation for the Asynchronous Request-Delayed Response MEP
» Using the Programming Models for the Request-Delayed Response Pattern
» Create Invoking Enterprise Business Services
» Update Invoking Enterprise Business Services
» Delete Sync Invoking Enterprise Business Services
» Validate Invoking Enterprise Business Services
» Process Invoking Enterprise Business Services
» Query Invoking Enterprise Business Services
» Introduction to Enabling Requester ABCS for Extension
» Introduction to Enabling Provider ABCS for Extension
» How to Design Extensions-Aware ABCS
» Designing an ABCS Composite with Extension Defining Service at Extension Points
» How to Specify a Concrete WSDL at Deployment Time
» Interfacing with Transport Adapters
» How to Develop Transport Adapters When to Put Adapters in a Single Composite
» How to CAVS Enable the Requester ABCS Introduction to the CAVSEndpointURL Value Designation
» How to Ensure Transactions in AIA Services
» Transactions in Oracle Mediator Transactions in BPEL
» Developing ABCS to Participate in a Global Transaction How to Transaction-Enable AIA Services
» Guidelines for Versioning Versioning ABCS
» Introduction to Enterprise Business Flows
» How to Implement the EBF as a BPEL Service Overview of B2B Integration Using AIA
» B2B Support in AIA Error Handling Framework
» How to Identify the B2B Document Protocol
» How to Identify the B2B Document Type and Definition
» How to Identify the EBO, EBS, and EBM to Be Used How to Design Mappings for the B2B Document
» Introduction to a Provider B2B Connector Service How to Identify the Message Exchange Pattern
» How to Develop a B2BCS Service Contract
» How to Annotate B2B Connector Services
» How to Support Trading Partner-Specific Variants
» How to Enable Error Handling
» How to Route Based on Trading Partner B2B Preferences
» How to Test Using CAVS How to Test Using Dummy Trading Partner Endpoints
» Monitoring Using Oracle B2B Reports Monitoring Using Oracle Enterprise Manager Console
» How to Support Trading Partner-Specific Variants How to Enable Error Handling
» If an additional target is needed, click the Additional Target button on the Service
» Optionally, click the Save As button to save a service solution component request Click Finish.
» Updating SOA MDS with AIA MetaData Using MDS in AIA Content of AIA_HOMEAIAMetaData
» Working with AIA Components Content in AIA_HOMEAIAMetaData
» How to Change an Existing File How to Create a New File
» Introduction to the Tools Used
» Understanding Integration Styles with Integration Framework
» Bulk Data Processing Integration Style Choice Matrix
» Identifying the EBO Designing an Oracle AIA Integration Flow
» Enter your search criteria and click Search to execute a search for a particular
» Inbound Connectivity Outbound Connectivity
» When to Use Web Services with SOAPHTTP
» Session Management for Web Services with SOAPHTTP
» Error Handling for Web Services with SOAPHTTP
» Security for Web Services with SOAPHTTP Message Propagation Using Queues or Topics
» Ensuring Guaranteed Message Delivery When to Use JCA Adapters
» Outbound - Siebel Application Interaction with AIA Services Web Services with SOAPHTTP
» Inbound: E-Business Suite Application Interaction with AIA Services Concurrent Program Executable
» Business Event Subscription JCA Connectivity Using OAPPS Adapter
» Outbound: Oracle E-Business Suite Application Interaction with AIA Services
» Testing an Oracle AIA Integration Flow Design Guidelines
» Initial Data Loads High Volume Transactions with Xref Table Intermittent High Volume Transactions
» Using Error Handling Oracle Fusion Middleware Online Documentation Library
» Click OK to save your changes. Click the Generate and Deploy tab to deploy it on the OC4J server.
» Considerations for Creating Transformation Maps Handling Missing or Empty Elements
» How to Map an Optional Source Node to an Optional Target Node How to Load System IDs Dynamically
» Introduction to DVMs When to Use DVMs Using Cross-Referencing
» Standard Elements Introducing EBM Header Concepts
» Sender Introducing EBM Header Concepts
» Target Introducing EBM Header Concepts
» BusinessScope Introducing EBM Header Concepts
» Use Case: Request-Response Use Case: Asynchronous Process
» Use Case: Synchronous Process with Spawning Child Processes
» EBMTracking Introducing EBM Header Concepts
» Understanding Oracle BPEL Error Handling Understanding Oracle Mediator Error Handling
» What Do I Need to Know About Fault Policy Files
» How to Implement Fault Handling in BPEL Processes
» Guidelines for Defining Fault Policies
» Guidelines for BPEL Catch and Catch-All Blocks in Synchronous Request-Response
» Guidelines for Configuring Mediator for Handling Business Faults
» Overview Implementing Error Handling for the Synchronous Message Exchange Pattern
» Configuring Milestones Implementing Error Handling for the Synchronous Message Exchange Pattern
» Configuring Services Between Milestones
» Describing the EBMReference Element Describing the B2BMReference Element
» Describing the FaultNotification Element
» Introduction to Extending Fault Messages
» In the Error Extension Handler field on the Error Notifications page, enter the
» Introduction to Extending Error Handling Implementing an Error Handling Extension
» Synchronous Request-Reply Pattern: How to get Synchronous Response in AIA
» Asynchronous Fire-and-Forget Pattern AIA Message Processing Patterns
» Guaranteed Delivery Pattern: How to Ensure Guaranteed Delivery in AIA
» Service Routing Pattern: How to Route the Messages to Appropriate Service Provider in AIA
» Extending Existing Schemas in AIA
» Extending AIA Services Extending Existing Transformations in AIA
» Enabling Security for AIA Services
» Overriding Policies Using a Deployment Plan Testing Secured Services using CAVS
» Oracle AIA Recommendations for Policies
» AIA Security Configuration Properties
» Understanding the Structure for Security Context Using Attribute Names
» Interpreting Empty Element Tags in XML Instance Document
» Purging the Completed Composite Instances Syntactic Functional Validation of XML Messages
» Provide Provision for Throttling Capability Artifacts Centralization Separation of Concerns
» Adapters Inside ABCS Composite OR as Separate Composite AIA Governance
» Using BPEL as Glue, Not as a Programming Language
» Avoiding Global Variables Wherever Possible
» How to Use Baselines How to Handle Resource Saturation How to Use Proactive Monitoring
» How to Eliminate Bottlenecks
» How to Tune the Oracle Database Introducing Automatic Workload Repository
» Configuring Performance Related Database Initialization Parameters
» Tuning Redo Logs Location and Sizing Automatic Segment-Space Management ASSM
» Configuring Database Connections and Datasource Statement Caching
» Oracle Metadata Service MDS Performance Tuning
» Configuring SOA Infrastructure Properties
» Configuring BPEL Process Service Engine Properties
» Configuring BPEL Properties Inside a Composite
» Configuring Mediator Service Engine Properties
» How to Tune JMS Adapters How to Tune AQ Adapters
» Overview of AIA Error Handler Framework Purging the Completed Composite Instances
» How to Optimize the JVM Heap - Specifying Heap Size Values
» XML Naming Standards General Guidelines
» Composites Composite Business Process Enterprise Business Services
» Requester Application Business Connector Service Provider Application Business Connector Services
» DVMs DVMs and Cross References
Show more