Oracle Integration Cloud Naming Convention
Oracle Integration Cloud (OIC) is a suite of cloud-based tools and services that facilitate the integration of different applications, data, and processes. When working with Oracle Integration Cloud, it’s essential to follow a standardized naming convention to ensure clarity, consistency, and maintainability across your projects.
Though Oracle might not enforce a strict naming convention, it’s best to adhere to a consistent and descriptive naming pattern. Below are some general naming guidelines and best practices that can be followed in OIC:
Use Descriptive Names: Names should clearly describe the purpose or functionality of the integration component.
Avoid Special Characters: Using special characters might cause confusion or compatibility issues. Stick with alphanumeric characters and underscores where needed.
Follow CamelCase or snake_case: Depending on your organization’s standards, you might prefer one of these two popular naming conventions. CamelCase combines words without spaces, capitalizing each word’s first letter (e.g.,
CustomerDetailsIntegration). Snake_case uses underscores to separate words (e.g.,customer_details_integration).Include Versioning If Necessary: If you manage different versions of the same integration, you may include the version number within the name.
Keep it Short but Meaningful: Names should be concise but still provide enough information to understand the component’s purpose.
Consider Hierarchical Naming: If applicable, use prefixes or suffixes to group related components. For example, you could prefix integration names with
INT_, mappings withMAP_, etc.Adhere to Organizational Standards: If your organization has specific naming conventions or guidelines, make sure to follow them.
Don’t Use Reserved Words: Avoid using reserved words in the chosen programming or scripting language.
Environment Specifics: If an integration or artifact is specific to a particular environment (such as test, development, or production), consider including that in the name.
Here is an example of a naming convention for an integration that retrieves customer details:
- Integration:
INT_CustomerDetails_V1 - Connection:
CONN_Salesforce_Customer - Mapping:
MAP_Customer_Details - Lookups:
LKUP_Country_Codes