The Control Data/Functions structure is populated by orchestration plan generation for every order component of the orchestration plan and is based on data defined on the Order Template tab in the Order Component Specification editor.
The ControlData/Functions structure is a data repository area that is required to process the fulfillment function; this data area includes the order items the decomposition process has generated for the fulfillment function.
The control data structure for order components is modeled automatically or manually depending on the following:
If you have the OracleComms_OSM_CommonDataDictionary model project in your workspace (recommended), and if the order component is both associated with an orchestration order and associated with a fulfillment pattern that is part of the orchestration plan, Design Studio automatically creates its control data structure.
If you do not have the OracleComms_OSM_CommonDataDictionary model project in your workspace, you must manually model the control data structure for each order component that is associated to a fulfillment pattern that is part of the orchestration plan. You must also manually add a reference node to it that points back to the order item control data structure. See "Modeling Order Component Control Data Manually" for information on adding this reference node.
Design Studio automatically defines the data on the Order Template tab in the Order Component Specification editor by using the OracleComms_OSM_CommonDataDictionary model project (see "About the OracleComms_OSM_CommonDataDictionary Model Project" for information on this project).
If you do not use the OracleComms_OSM_CommonDataDictionary model project, you must manually define the simple and structured data elements for the Control Data/Functions structure in the cartridge project of your choice and then manually add the data from its data schema onto the Order Template tab of the Order Component Specification editor. Manually modeling the Control Data/Functions structure for an order component is not recommended and should only be required if you decide not to use the OracleComms_OSM_CommonDataDictionary model project (for example, to minimize the upgrade impact of existing cartridges).
See "Modeling Order Component Control Data Automatically" for information on how to ensure that Design Studio can model the order component control data automatically by using the OracleComms_OSM_CommonDataDictionary model project.
See "Modeling Order Component Control Data Manually" for instructions on how to model the order component control data manually.
Note:
You must model a structure for order item control data in addition to modeling a structure for order component control data. For information on modeling a structure for order item control data, see "About Modeling Order Item Control Data".About Modeling Order Item Control Data
When the OracleComms_OSM_CommonDataDictionary model project is in your workspace, Design Studio automatically generates control data structures for order components and associates them with the order provided the following conditions are met:
Note:
The following conditions reflect basic orchestration setup requirements for all orchestration-related cartridges. Order component control data is automatically created if you preconfigure your orchestration cartridges correctly.The orchestration setup of your cartridges is in place. For example, the following orchestration configuration has been modeled:
The order item specification is created and contains the base ControlData/OrderItem structure.
When creating a new solution, the order item specification is typically created before order components are created. You must create or import at least a skeleton order item specification that contains the base ControlData/OrderItem structure; this allows the autogeneration of a required reference node (ControlData/Functions/Order_Component_Name/OrderItem/orderItemRef) in the control data of function order components that are subsequently created.
The order has an orchestration process as the default process (it is an orchestration order).
The orchestration process references an orchestration sequence.
The orchestration sequence references the order item specification.
The orchestration sequence has orchestration stages.
The orchestration stages produce the required order components (for example, the base order components Function, System, and ProcessingGranularity are set up).
You must model the orchestration stages to produce the appropriate order components; this step determines which order components participate in decomposition (orchestration plan generation).
The orchestration sequence is associated to an order item specification.
The order components are associated to a fulfillment pattern
If the preceding conditions are met, Design Studio automatically adds the following relevant data elements for control data to the Order Template tab of the order component specification:
ControlData
ControlData/Functions
ControlData/Functions/Order_Component_Name
ControlData/Functions/Order_Component_Name/orderItem
ControlData/Functions/Order_Component_Name/componentKey
ControlData/Functions/Order_Component_Name/calculatedStartDate
ControlData/Functions/Order_Component_Name/duration
ControlData/Functions/Order_Component_Name/orderItem/orderItemRef
orderItemRef is a reference data type that points to the node /ControlData/OrderItem that has been inherited from the order item specification.
Autogeneration of order component control data works as follows:
You select an orchestration process as the default process to which an order is submitted (to create the orchestration order).
Design Studio looks for the OracleComms_OSM_CommonDataDictionary model project in your workspace; if it does not exist, Design Studio prompts you to create it.
If you agree to create the model project when prompted, Design Studio creates it in your workspace.
The OracleComms_OSM_CommonDataDictionary model project contains the base ControlData structure and the data elements it references: base order item data elements and base function data elements.
You associate the order component with the orchestration order.
You add the order component to a fulfillment pattern that is part of the orchestration plan.
Design Studio does one of the following:
If the ControlData structure does not exist for the order, the base ControlData structure is automatically included from the data schema of the OracleComms_OSM_CommonDataDictionary model project into the Order Template of the order and order component. The required orchestration data for the new order component is added to the structure as ControlData/Functions/Order_Component_Name.
If the ControlData structure already exists for the order, Design Studio updates the existing ControlData structure in the order with the required orchestration data for the new order component (creating the substructure ControlData/Functions/Order_Component_Name). Design Studio adds the structure to the Order Template tab of the order component.