Defining Order Data

The data that you define for an order is available to the tasks included in the process associated with the order. When defining order data, see the following topics:

Related Topics

Order Editor

Adding New Data to an Order

You can create new data in the Data Dictionary and add it to the order.

To create new data:

  1. From the Studio menu, select Show Design Perspective.

  2. Click the Studio Projects tab.

  3. Double-click an existing order.

    The Order editor opens with the Order Template tab active. See "Order Editor Order Template Tab" for more information.

  4. Right-click inside the Order editor Order Template tab and select Open Data Element view.

    The Data Element view opens.

  5. Right-click inside the Data Element view and select Add Simple Schema Element or Add Structured Schema Element.

    The Create Data Schema Element dialog box or the Create Data Schema Structure dialog box is displayed.

  6. Complete the form and click Finish.

  7. Drag the new data from the Data Element view into the Order editor Order Template tab.

    Tip:

    Press and hold the Shift key to select multiple consecutive elements. Press and hold the Control key to select multiple non-consecutive elements.

Related Topics

Order Editor

Adding Existing Data to an Order

You select data previously created in the data dictionary to add to an order.

To add data you have previously created:

  1. From the Studio menu, select Show Design Perspective.

  2. Click the Studio Projects tab.

  3. Double-click an existing order.

    The Order editor opens with the Order Template tab active. See "Order Editor Order Template Tab" for more information.

  4. Right-click inside the Order editor Order Template tab and select Select from Data Dictionary.

    The Select Data Elements dialog box is displayed.

    Note:

    You can alternatively select Open Data Element view and then drag and drop data elements from the Data Dictionary onto the Order Template tab.
  5. Select the data you want to add to the order.

    Tips:

    When selecting data to add to the order template:
    • Press and hold the Shift key to select multiple consecutive elements. Press and hold the Control key to select multiple non-consecutive elements.

    • Select a parent node to add all data elements (simple and structured data elements) in its hierarchy.

    • Select a child node to add only the child node and its parent nodes. Design Studio automatically adds parent nodes associated to the child node up to the root of the data schema.

  6. Click OK.

    Design Studio adds the data to the Order editor Order Template tab.

  7. Click Save.

Related Topics

Order Editor

About Modeling Data in the Order Template

Adding Reference Data Nodes

When modeling data in the order template, you can add reference nodes. A reference data node is a data node that is created by referencing another data node within the order template. The reference data node has the same data typing and structure of the node that it is referencing. However, the reference data node is a distinct instance of the data structure that it references.

For example, OrderItemRef is a reference data node for an order component that references the orderItem data structure in the order template. The OrderItemRef reference data node is a distinct instance of orderItem in the order component, but shares the structure of orderItem - a data node that is already defined and contributed by the Order Item Specification.

Note:

This feature is not available in releases prior to OSM 7.0.

To add a reference node:

  1. From the Studio menu, select Show Design Perspective.

  2. Click the Studio Projects tab.

  3. Double-click an existing order.

    The Order editor opens with the Order Template tab active. See "Order Editor Order Template Tab" for more information.

  4. Add a reference node to the root-level of the order template or to a data structure by doing one of the following:

    1. To add a reference node to the root-level of the order template, in the Order editor Order Template tab, right-click in the tab area and select Add Reference Node.

    2. To add a reference node to a data structure, in the Order editor Order Template tab, right-click on the data structure and select Add Reference Node.

      The Reference Node Creation dialog box is displayed.

  5. Select the data node to which the reference node will point.

    At run time, the reference node will obtain its value from the data node that you select.

  6. Click OK.

  7. Click Save.

You must set up reference nodes at order creation time in addition to creating the reference node association in the order template; otherwise, the reference node will be empty at run time. For an example of how to set up reference nodes when you create an order using the CreateOrderBySpecification web service operation, see the discussion on setting up reference nodes in OSM Developer's Guide.

Related Topics

About Reference Nodes

Order Editor

Adding a New Data Structure Definition to an Order

You can create a data structure definition and add it to an order.

To create a data structure definition:

  1. From the Studio menu, select Show Design Perspective.

  2. Click the Studio Projects tab.

  3. Double-click the existing order to which you want to add a data structure definition.

    The Order editor opens with the Order Template tab active. See "Order Editor Order Template Tab" for more information.

  4. In the Order editor Order Template tab, right-click on the data element, select Select Data Structure Definition and click New.

    The Data Structure Definition wizard is displayed.

  5. Enter a name for the data structure definition.

  6. Click Finish.

  7. Click Save.

Related Topics

About Modeling Data in the Order Template

Order Editor

Adding an Existing Data Structure Definition to an Order

You can add an existing data structure definition to an order.

To add a data structure definition to an order:

  1. From the Studio menu, select Show Design Perspective.

  2. Click the Studio Projects tab.

  3. Double-click the existing order to which you want to add a data structure definition.

    The Order editor opens with the Order Template tab active. See "Order Editor Order Template Tab" for more information.

  4. In the Order editor Order Template tab, right-click on the data element, select Select Data Structure Definition.

  5. In Matching items, select a data structure definition.

  6. Click OK.

    The data structure definition is added to the order, and all child data elements and structures of the data structure definition are also added and displayed.

    Note:

    Derived data structure definitions are not displayed in the order template.
  7. Click Save.

Related Topics

About Modeling Data in the Order Template

Order Editor

Renaming Data Elements at the Order Level

You rename a data element at the order level by providing an alias for the data element in the Order editor Order Template tab. When you rename data elements at the order level, Design Studio automatically updates that data element name in all associated tasks and extended orders. However, the data element instance in the Data Dictionary is not affected by the change.

For example, consider that you have a data model that contains two instances of a data element called EmployeeID: one defined as a string (defined by the employee's name and a two-digit number), the other defined as an integer (defined by a six-digit number). To avoid data type collisions in the run-time environment, you can rename one instance of the EmployeeID data element at the order level.

To rename data elements at the order level:

  1. From the Studio menu, select Show Design Perspective.

  2. Click the Studio Projects tab.

  3. Double-click the existing order that contains the data element to rename.

    The Order editor opens with the Order Template tab active. See "Order Editor Order Template Tab" for more information.

  4. In the Order editor Order Template tab, right-click on the data element, select Refactoring, and then select Rename.

    The Rename Order Template Node dialog box is displayed.

    The dialog box displays the current data element node name and the data element node name as defined in the Data Dictionary. The rename that you make here does not affect the node name at the Data Dictionary level.

  5. In the Name field, enter the new name for the data element.

  6. (Optional) Click the Preview button.

    The Rename Order Template Node dialog box shows all instances of the data element defined in related tasks and extended orders that will change after you rename it at the order level.

    If the rename is not allowed, a problem error is displayed. You can check the error log for information on why the rename failed.

    Click Continue to proceed.

  7. Click OK.

    Design Studio implements the change immediately in the project.

Related Topics

Order Editor