About Modeling Data in OSM Cartridge Projects

Modeling data in OSM cartridge projects is the process of defining the order data of your solution. Order data is data on the incoming sales order, control data used for orchestration, and any other data used in the order.

You model data in two primary areas:

Within the data schemas in your workspace

You define data element information in the data schemas of model projects, OSM cartridge projects, and other Design Studio application feature cartridge projects; for example, in the data schema of a Design Studio Activation cartridge project.
Within OSM entities

You model the data elements represented by orders, tasks, product specifications, order components, and order item specifications in the OSM editors associated with these OSM entities (by adding data elements from the data schemas).

When you model data in an OSM cartridge project, you first define data element information within the data schemas of the projects in your workspace and then use that data element information to model data within OSM entities.

OSM entities can use any data element defined in any data schema in the workspace, including data schemas for projects defined outside of OSM. For example, OSM entities can use an atomic action defined in the data schema of a Design Studio Activation cartridge project. The data elements OSM can use are visible in the Data Element view, which displays data schemas and entity types. You can drag data elements from the Data Element view to OSM entities.

Data is modeled within OSM entities as follows:

Orders

You add data elements from the data schema of projects onto the Order editor Order Template tab. OSM uses the data you model here to drive the fulfillment, provisioning, and system interactions of the order. The Order Template tab is the hub of modeling data in context of the order and is the focal point for modeling OSM solution data.

Other OSM entities contribute to data modeled on the Order Template tab of the order. For example, the order item specification and order components contribute data to the ControlData structured data element defined on the order.
Tasks

You add data elements from the data schema of projects or from the Order editor Order Template tab of orders onto the Task Data area of the Task editor. OSM uses the data you model here to execute tasks.
Order items

You add data elements from the data schema of projects onto the Order Item Specification editor Order Template tab for every order item property on the order item specification that is required for OSM orchestration. The structure you model here is referred to as order item control data. OSM uses order item control data to add order items into the OSM order from the customer orders that come from the customer relationship management system; order item control data serves as the storage area on the order for each order item property. See "About Modeling Control Data" for more information on order item control data.

The data schema recommended for modeling order item control data structures is the predefined data schema of the OracleComms_OSM_CommonDataDictionary model project. The data schema of this model project includes the base structure for order item control data (ControlData/OrderItem). See "About the OracleComms_OSM_CommonDataDictionary Model Project" in the Modeling OSM Orchestration Help for information on this model project.
Order components

Design Studio automatically adds data elements onto the Order Component Specification editor Order Template tab. The structure Design Studio models here is referred to as the order component control data. Order component control data is automatically generated for an order component that is associated with an orchestration process and associated to a fulfillment pattern that is part of the orchestration plan. Each order component that is used in orchestration requires order component control data. OSM uses the order component control data for OSM orchestration; it serves as the storage area for the order component on the order.

Design Studio automatically adds order component control data to the order component and the order template of the order. You do not manually add data elements to the Order Component Specification editor Order Template tab unless you do not use the OracleComms_OSM_CommonDataDictionary model project. See "About Modeling Order Component Control Data" for more information.
Composite cartridge views

You add data elements from the data schema of projects or from the Order editor Order Template tab onto the Task Data area of the Composite Cartridge view editor. A composite cartridge view is used when you use composite cartridges to add task data and behaviors to a solution without having to directly modify the existing component cartridges of that solution. The task data in the composite cartridge view is additive task data to the overall solution. OSM uses the task data to execute tasks for function order components you add to a solution. See "Working with Composite Cartridge Projects" for more information on composite cartridge views.

Data structures organized in OSM editors, such as structures represented by orders, tasks, order components, and so on, and the behaviors you apply to data elements organized in OSM editors are not available for reuse in the workspace by other (non-OSM) Design Studio application feature cartridge projects.

The data element information defined in the data schemas of the workspace cannot be overridden in OSM editors. You can augment data elements after you drag them from data schemas into OSM editors, but you cannot change them. However, you can configure OSM-specific extensions to schema data elements by using the OSM tab of the Data Schema editor. See "Data Schema Editor OSM Tab" for more information.

A data element is typically defined at the root level in its associated data schema. If a data element is defined within another element in the schema, the path of the data element in the data schema is upheld as the relative path in the editor of the OSM entity in which the data element can be organized into any data structure. By defining a data element at the root level in its data schema and upholding its relative path within OSM entities, you can reuse the data element in multiple entity types without having to duplicate it in other paths or in other data schemas.

When you add a data element from a data schema of another Design Studio application feature cartridge project onto an OSM editor, double-clicking the data element opens the editor in which the data element is defined. For example, if you are in the Order Template tab of the Order editor, double-clicking a data element that is part of a service action opens the ASAP Service Action editor, in which the data element is defined.