Conceptual Model Editors

When working with conceptual model editors, see the following topics:

Conceptual Model Editor Common Tabs

Conceptual model editors use a set of common Design Studio tabs to enable you to configure conceptual model entities.

When working with common editor tabs, see the following topics:

Conceptual Model Editor Data Map Tab

Use the Data Map tab to define the applicability of data elements to the actions in an action family. For example, you can specify whether a data element value must be supplied to or returned by each action in an associated action family.

Field Use
Element Displays all of the top-level data elements defined on and inherited from the associated conceptual model entity. For service actions, this column also includes default data elements that are defined on and inherited from the associated functional area.

For an action code, leave this row blank if the data element is not required by the action.

Persisted Specify whether the data element is persisted on the conceptual model entity subject.

For service actions, only persisted data elements are added to Inventory specifications when you realize the conceptual model entity. See "Conceptual Model Editor Categorization Tab" for information.

Action Codes or Specialized Action Code The column headings display all action codes (for service actions) or specialized action codes (for technical actions) associated with the conceptual model entity. For each action code and data element combination, select one of the following values:
  • Required In: the data element value must be supplied for the associated action.

  • Required Out: the data element value must be returned by the associated action.

  • Required In/Out:: the data element value must be supplied for and returned by the associated action.

  • Optional In: the data element value can be optionally supplied for the associated action.

  • Optional Out: the data element value can be optionally returned by the associated action.

  • Optional In/Out: the data element value can be optionally supplied for or optionally returned by the associated action.

  • Blank: the data element is not applicable to the action.


Related Topics

Conceptual Model Editor Data Elements Tab

About Functional Areas

About Conceptual Model Actions

Conceptual Model Editor Data Elements Tab

Use the Data Elements tab to add simple and structured data elements to a conceptual model entity from a data schema. For example, a customer facing service that you model for a broadband service might include the UploadSpeed and DownloadSpeed data elements to represent the service speeds requested by a customer order.

The Data Elements area data tree displays a hierarchical representation of data elements modeled for the entity.

Conceptual model editors include context menu actions that you access by right-clicking in the Data Elements area data tree. The context menu options that are available depend on the selection in the view. See "Modeling Data Using Context Menus" for more information.

When adding data elements to a conceptual model entity, see the following topics:

Conceptual Model Editor Transformation Tab

Use the Transformation tab to determine which data elements used by Order and Service Management order transformation manager support data propagation. Data propagation impacts performance.

Field Use
Supports Forward Propagation Select to propagate data changes from the original order item to the transformed order item.

Data element changes on the original order item are transformed according to the mapping configuration in the OSM mapping rule, and the result is populated to the transformed order item.

Supports Reverse Propagation Select to propagate data changes from the transformed order item to the original order item.

Data element changes on the transformed order item are transformed in reverse according to the mapping configuration in the OSM mapping rule and the result is populated to the original order item.

For example, if there exists unit-of-measure mapping between data elements on the original and transformed order items, with the original value being in hours and the transformed value being in minutes, the changed value on the transformed order item will be divided by 60 before being updated on the original order item.

Key Path Define a key element for a multi-instance node. This value is used during order transformation management. See "Working with Mapping Rules" for more information. This field appears when you select a structured data element in the Data Elements area.

Related Topics

Conceptual Model Editor Data Elements Tab

Conceptual Model Editor Components Tab

Use the Components tab to associate a conceptual model entity to other conceptual model entities. For example, on the Resource Facing Service editor Components tab, you associate with the RFS all resources that are needed to configure the associated service.

When modeling data in the Components tab, see the following topics:

Conceptual Model Editor Components Tab Components Area

Use the Components area to associate the conceptual model entity with other conceptual model entities.

Field Use
Remove Click to remove the relationship between the conceptual model entities.
Add Click to create a relationship between conceptual model entities.

See "Defining Conceptual Model Components" for more information.


Related Topics

Conceptual Model Editor Common Tabs

Conceptual Model Editor Components Tab Component Detail Area

Use the Component Detail area to define the component options, the number of allowable instances, and the type of relationship the conceptual model entity has with each component.

Details Tab

Field Use
Name Edit the name of the component selected in the Components area. Name your components to emphasize the role that the associated entity serves (rather than naming the component to be the name of the associated entity). This convention enables flexibility and reuse.
Component Type Displays the type of entity that the selected component represents.

The component types that are available is determined by the configuration of the provider function and functional areas with which the entities are associated. You can change the relationship type, as needed.

Options Displays the conceptual model entities that the component can represent. For example, the Internet Access Resource Facing Service component can have multiple options defined, such as DSL, Satellite, Fiber, and so forth.

Do one of the following:

  • Select a value and click Open to open the entity in an editor.

  • Click Add to create a new entity and associate the new entity with the component.

  • Select a value and click Remove to remove the association between the component and the entity.

  • Click Select to associate an existing entity to the component.

Minimum and Maximum The Minimum field indicates the minimum number of option instances, and the Maximum field indicates the maximum number of option instances. Enter 0 in the Minimum field (or select Optional) to indicate that the option is optional. Select Unbounded to define the maximum number of occurrences with no explicit limit.
Relationship Type Displays the type of association between the conceptual model entity and the component. The values in this field are defined in the Common Model Base Data project.

See "Defining Conceptual Model Components" for more information.


Used By Tab

Use the Used By tab to review the projects and entities in which the entity is used.

Notes Tab

Use the Notes tab to annotate entities with descriptions or with other applicable information to support the entity. For example, you can contribute content to Design Studio reports by writing your own internal documentation about entities and data elements, and you can format the documentation using plain text or simple HTML markup.

See "Notes Tab" for more information.

Related Topics

Conceptual Model Editor Components Tab

Conceptual Model Editor Properties Tab

Use the Properties tab to define how the conceptual model entity is realized, to associate fulfillment patterns to the conceptual model entity, and to extend a conceptual model entity from another conceptual model entity.

Field Use
Extends Extends the conceptual model entity from another conceptual model entity. When you extend one entity from another, the target entity inherits all of the data elements defined for the extended entity.

See "Extending Design Studio Entities" for more information.

Implementation System Define the system where the application entity is used. Select one of the following:
  • Select None if the conceptual model entity will not be realized as an application entity. You select this option, for example, if the conceptual model entity is intended for informational use only.

  • Select Unified Inventory Management if the conceptual model entity will be realized as an entity used in the Design Studio for Inventory application.

  • Select Other System if the conceptual model entity will be realized as an application entity that will be used in a system other than Unified Inventory Management.

Note: The design patterns that are delivered with Design Studio and that realize the conceptual model entities add configuration to your workspace only if you define this field with the Unified Inventory Management value.

Realization Design Pattern Select which design pattern converts the conceptual model entity into an application entity and creates the application entity configuration.
Implementation Method Specify how the conceptual model entity realizes as an application entity. For example, a customer facing service realizes as a Service specification in a Design Studio for Inventory project.

If you change the value in this field and re-run a Design Studio default design pattern, the design pattern does not delete any previously generated entities.

See "Realizing Conceptual Model Entities into Application Entities" for information about how each conceptual model entity realizes.

Run Realization Design Pattern Automatically Select to synchronize conceptual model entities and application entities automatically. When you select this option, Design Studio runs a design pattern automatically when you:
  • Save of the editor of the conceptual model entity.

  • Change the conceptual model entity using an option that you select from the context menu.

  • Manually synchronize or realize a direct child of the conceptual model entity. For example, when this option is selected, Design Studio automatically runs a design pattern for an RFS if you manually synchronize a child resource.

See "Synchronizing Conceptual Model Entities with Application Entities" for more information.

Strict Configuration Checking Deselect to relax the configuration warnings associated with entity realization. For example, consider that your model includes a conceptual model specification that is realized by a pre-existing Inventory Service specification and Service Configuration specification, and that these specifications include a configuration that violates the Design Studio model validation rules. You can deselect the Strict Configuration option to limit the validation severity to a warning.
Realized By Displays the name of the application entity realized from the conceptual model entity. This field is blank if the design pattern selected in Realization Design Pattern has not yet run.
Fulfillment Pattern Associate fulfillment patterns to the conceptual model entity. A fulfillment pattern provides an order and service management system with the steps required to orchestrate the service order at run-time.

Do one of the following:

  • Click Select to associate an existing fulfillment pattern to the conceptual model entity.

  • Click Add to create a new fulfillment pattern and associate the new fulfillment pattern to the conceptual model entity.

  • Select a value and click Open, which opens the fulfillment pattern in the Fulfillment Pattern editor.

  • Select a value in the Fulfillment Pattern field and click Remove to remove the association between the fulfillment pattern and the conceptual model entity.

Key Enter a value to enable the Order and Service Management order transformation manager to identify the payload of a line item at run time.

The default value for this field is the name of the entity. You can define a different key value for an entity if your business processes require a naming convention less restrictive than then entity name requirements.


Related Topics

Conceptual Model Editor Common Tabs

Conceptual Model Editor Other Relationships Tab

Use the Other Relationships tab to associate conceptual model entities with any other entity, even if there is no implied relationship in the delivered service fulfillment definitions. This tab enables you to extend the delivered conceptual model.

When working with the Other Relationships tab, see the following topics:

Other Relationships Tab Other References Area

Use the Other References area to associate the conceptual model entity with other conceptual model entities.

Field Use
Remove Click to remove the reference between the entity and the selected component.
Add Click to create a relationship between the entity and the selected component.

Related Topics

Conceptual Model Editor Other Relationships Tab

Other Relationships Tab Relationship Detail Area

Use the Relationship Detail area to associate the conceptual model entity with other conceptual model entities.

Details Tab

Use the Details tab to further define entity information.

Field Use
Name Edit the name of the target entity.
Option Displays the conceptual model entities that the associated component can represent.

Do one of the following:

  • Select a value and click Open to open the entity in an editor.

  • Click Add to create a new entity and associate the new entity with the component.

  • Select a value and click Remove to remove the association between the component and the entity.

  • Click Select to associate an existing entity to the component.

Minimum and Maximum Define the entity cardinality. The Minimum field indicates the minimum number of times the entity can appear, and the Maximum field indicates the maximum number of times the entity can appear.

Also, indicate whether the entity is Required or Optional or whether there can be multiple occurrences of the entity.

To define a range, do one of the following:

  • Define a range with at least one occurrence.

    Select the value 1 in the Minimum field and select Unbounded (no explicit limit) in the Maximum field.

  • Define a range with no required minimum number of occurrences.

    Select the value 0 in the Minimum field and select Unbounded in the Maximum field.


Used By Tab

Use the Used By tab to review the projects and entities in which the target component is used.

Notes Tab

Use the Notes tab to annotate entities with descriptions or with other applicable information to support the entity. For example, you can contribute content to Design Studio reports by writing your own internal documentation about entities and data elements, and you can format the documentation using plain text or simple HTML markup.

See "Notes Tab" for more information.

Related Topics

Conceptual Model Editor Other Relationships Tab

Conceptual Model Editor Categorization Tab

Use the Categorization tab to tag data elements with Inventory-specific tags and to specify which data elements are persisted to a Customer Facing Service, a Resource Facing Service, a Resource, or a Location entity.

Field Use
Element Displays all of the data elements defined for the conceptual model entity on the Data Elements tab.
Characteristic Select Yes to tag the data element as a characteristic, which means it is relevant to Design Studio for Inventory and Design Studio for Network Integrity data models.

You must tag a data element with the Characteristic tag (in the data schema) to add it to an Inventory Service specification during realization.

Changeable Select Yes if the data element changes frequently or if you need to track the life cycle of a service. For example, customers often upgrade services for higher download speeds. You can tag the DownloadSpeed data element with the Changeable tag and track the data element's history for auditing purposes.

When realizing customer facing services and resource facing services, the default design patterns save data elements that are tagged as Changeable to the Service Configuration specifications.

Persisted Select Yes to persist the data element on the conceptual model entity.

You must tag a data element with the Persisted tag to add it to an Inventory Service specification during realization. Data elements that are tagged as Changeable and Persisted, and structured data elements that are tagged as Persisted are added to the Configuration specification during realization.


Related Topics

Working With Tags

Product Editor

Use the Product editor to model entities that represent something ordered by a customer on a commercial order.

When modeling data in the Product editor, you use some editor tabs that are common among multiple conceptual model entity editors, and you use some editor tabs that are specific to the Product editor.

When working with the Product editor, see the following topics:

Product Editor Derivation Tab

Use the Derivation tab to associate products to customer facing services and resources.

When modeling data in the Derivation tab, see the following topics:

Product Editor Derivation Tab Customer Facing Services Area

Use the Customer Facing Services area to associate the product with customer service facing components.

Field Use
Remove Click to remove the relationship between the product and the selected component.
Add Click to create a relationship between the product and the selected component.

See "Defining Conceptual Model Components" for more information.


Related Topics

Product Editor Derivation Tab

Product Editor Derivation Tab Customer Facing Service Detail Area

Use the Customer Facing Service Detail area to define the component options, the cardinality, and the type of relationship the product has with each component.

Details Tab

Field Use
Name Displays the name of the component.
Customer Facing Service Displays the customer facing service that the component can represent.

Do one of the following:

  • Select a value and click Open to open the entity in an editor.

  • Click Add to create a new entity and associate the new entity with the component.

  • Select a value and click Remove to remove the association between the component and the entity.

  • Click Select to associate an existing entity to the component.

Relationship Type Displays the type of relationship defined for the association. Do one of the following:
  • Click Select to select a different type of relationship.

  • Click Relationship Type to open the listed value in the Relation Type editor.

See "Defining Conceptual Model Components" for more information.

Note: Every Customer Facing Service entity must have a Primary relationship defined with at least one product.


Used By Tab

Use the Used By tab to review the projects and entities in which the component is used.

Notes Tab

Use the Notes tab to annotate entities with descriptions or with other applicable information to support the entity. For example, you can contribute content to Design Studio reports by writing your own internal documentation about entities and data elements, and you can format the documentation using plain text or simple HTML markup.

See "Notes Tab" for more information.

Related Topics

Product Editor Derivation Tab

Product Editor Derivation Tab Resources Area

Use the Resources area to associate the product with resource components.

Field Use
Remove Click to remove the relationship between the product and the selected component.
Add Click to create a relationship between the product and the selected component.

See "Defining Conceptual Model Components" for more information.


Related Topics

Product Editor Derivation Tab

Product Editor Derivation Tab Resource Detail Area

Use the Resource Detail area to define the component options, the cardinality, and the type of relationship the product has with each component.

Details Tab

Field Use
Name Displays the name of the component.
Resource Displays the resource that the component can represent.

Do one of the following:

  • Select a value and click Open to open the entity in an editor.

  • Click Add to create a new entity and associate the new entity with the component.

  • Select a value and click Remove to remove the association between the component and the entity.

  • Click Select to associate an existing entity to the component.

Relationship Type Displays the type of relationship defined for the association. Do one of the following:
  • Click Select to select a different type of relationship.

  • Click Relationship Type to open the listed value in the Relation Type editor.

See "Defining Conceptual Model Components" for more information.


Used By Tab

Use the Used By tab to review the projects and entities in which the component is used.

Notes Tab

Use the Notes tab to annotate entities with descriptions or with other applicable information to support the entity. For example, you can contribute content to Design Studio reports by writing your own internal documentation about entities and data elements, and you can format the documentation using plain text or simple HTML markup.

See "Notes Tab" for more information.

Related Topics

Product Editor Derivation Tab

Product Editor Properties Tab

Use the Properties tab to define product import information, to associate fulfillment patterns to the product, and to extend a product from another product.

Field Use
Effective Start Date and Effective End Date Displays start and end date information if included during a product import.
Extends (Optional) Extend the product from another product. When you extend one entity from another, the target entity inherits all of the data elements defined for the extended entity.

Do one of the following:

  • Click Extends to create and extend a new source product.

  • Click Select to extend an existing source product.

Fulfillment Pattern Associate fulfillment patterns to the product. Fulfillment patterns realize as Oracle Communications Order and Service Management (OSM) fulfillment patterns. See "Working with Fulfillment Patterns" for more information.

Do one of the following:

  • Click Select to associate an existing fulfillment pattern to the product.

  • Click Add to create a new fulfillment pattern and associate the new fulfillment pattern to the product.

  • Select a value in the Fulfillment Pattern field and click Open to open the fulfillment pattern in the Fulfillment Pattern editor.

  • Select a value in the Fulfillment Pattern field and click Remove to remove the association between the fulfillment pattern and the product.

Key Enter a value to enable the Order and Service Management order transformation manager to identify the payload of a line item at run time.

The default value for this field is the name of the entity. You can define a different key value for an entity if your business processes require a naming convention less restrictive than then entity name requirements.


Related Topics

Product Editor

About Fulfillment Patterns

Customer Facing Service Editor

Use the Customer Facing Service editor to model entities that define the characteristics of a service.

When modeling data in the Customer Facing Service editor, you use editor tabs that are common among multiple conceptual model entity editors. See the following topics:

Resource Facing Service Editor

Use the Resource Facing Service editor to configure the technical sets of services that describe how a customer facing service is provided.

When modeling data in the Resource Facing Service editor, you use editor tabs that are common among multiple conceptual model entity editors. See the following topics:

Resource Editor

Use the Resource editor to configure the technical components of a solution.

When modeling data in the Resource editor, you use editor tabs that are common among multiple conceptual model entity editors. See the following topics:

Location Editor

Use the Location editor to configure locations.

When modeling data in the Location editor, you use editor tabs that are common among multiple conceptual model entity editors. See the following topics:

Action Editor

Use the Action editor to configure the data required by, the specific properties of, and the actions for action families.

When working with actions, see the following topics:

Action Editor Action Codes Tab

Use the Action Codes tab to review the action codes associated with an action, to add new action codes, to remove action codes that are not applicable, and to edit specialized action code names.

Field Use
Application Role Displays the name of the application role that represents a specific type of downstream delivery system. The application role characterizes the technical action family and the specialized action code names that are associated with a specific edge fulfillment system. Design Studio includes a set of predefined application roles.

Click the Application Role link to open the application role in the Application Role editor.

Specialized Action Code Displays the list of action codes associated with the action. The list that initially appears is inherited from the associated application role.

You can add or remove Specialized Action Name and Action Code pairs.

The action codes available to add to the action are defined on the functional area associated with the application role (specified in the Action Type field). For example, when modeling technical actions, you can add any action code defined on the Technical functional area.

Specialized Action Code Details (Technical actions only) In the Specialized Action Name field, you can edit the value to ensure that the Specialized Action Name is specific to the application role and to the fulfillment system to which the name is relevant.

Click the Action Code link to open the action code in the Action Code editor.


Related Topics

Action Editor

Configuring Actions

About Conceptual Model Actions

About Application Roles

Action Editor Properties Tab

Use the Properties tab to review or define information about the action and to define how the action realizes.

Field Use
Action Type Displays the functional area to which the action belongs, such as Service or Technical. Click Select to define the action with a different action type.
Subject Displays the conceptual model entity with which the action is associated. Click Select to associate the action with a different entity.
Extend Subject If selected, indicates that the data elements defined on an associated conceptual model entity are inherited by the action.
Target Select the resource (or, in a limited number of scenarios, the resource facing service) against which the technical action family executes.
Key Enter a value to enable the Order and Service Management order transformation manager to identify the payload of a line item at run time.

The default value for this field is the name of the entity. You can define a different key value for an entity if your business processes require a naming convention less restrictive than then entity name requirements.

Implementation System Define the system where the application entity is used. Select one of the following:
  • Select None if the action will not be realized as an application entity. You select this option, for example, if the action is intended for informational use only.

  • Select Unified Inventory Management if a service action will be realized as an entity used in the Design Studio for Inventory application.

  • Select ASAP if the technical action will be realized as an entity used in the Design Studio for ASAP application.

  • Select Other System if the action will be realized as an application entity that will be used in a system other than Unified Inventory Management.

Note: The design patterns that are delivered with Design Studio and that realize the conceptual model entities add configuration to your workspace only if you define this field with the Unified Inventory Management value.

Realization Design Pattern Select which design pattern converts the action into an application entity and creates the application entity configuration in the workspace.
Implementation Method Specify the application entity into which the action realizes. Select:
  • Activation Service Action Structure to realize technical actions in Design Studio for ASAP projects as service actions (CSDLs).

  • None if the action will not realize as a Design Studio entity. If you select this option, the Realization Design Pattern field is not available.

  • Other Action if the action will not realize as one of the available Design Studio entities but if you want to select a custom design pattern from the Realization Design Pattern field to generate code. See Design Studio Developer's Guide for more information about creating custom design patterns.

  • Ruleset Structure to realize service actions in Design Studio for Inventory project as rulesets.

  • Scan Action Structure to realize technical actions in Design Studio for Network Integrity projects as scan actions.

Run Realization Design Pattern Automatically Select to synchronize the action and application entities automatically. When you select this option, Design Studio runs a design pattern automatically when you:
  • Save the Action editor.

  • Change the action using an option that you select from the context menu.

  • Manually synchronize or realize a direct child of the action.

See "Synchronizing Conceptual Model Entities with Application Entities" for more information.

Realized By Displays the name of the application entity realized from the action. This field is blank if the design pattern selected in Realization Design Pattern has not yet run.

Related Topics

Configuring Actions

Action Editor

About Conceptual Model Actions

Action Code Editor

Use the Action Code editor to review the functional areas (or action types) to which the action code belongs. The action codes delivered with Design Studio are defined in the Common Model Base Data cartridge project. See "Generating the Common Model Base Data Project" for more information.

Field Use
Functional Area Displays the list of functional areas in which the action code is included as a default value. Do one of the following:
  • Click Open to open functional area in the Functional Area editor.

  • Click Remove to delete a functional area from the list.

  • Click Select to add an existing functional area to the list.


Related Topics

Action Editor

About Conceptual Model Actions

Application Role Editor

Use the Application Role editor to define specialized action code name and action code pairs. These pairs can be added to technical action families and can be associated with a specific edge fulfillment system.

Field Use
Short Name Enter an abbreviation for the application role. This value is required.

When you create technical actions, Design Studio uses this value to help generate the default name of the action. The default name that is generated is a combination of the action prefix defined in the functional area, followed by the application role short name, followed by the subject.

For example:

TechnicalActions_ACT_DSL_RFS

where TechnicalActions is the action prefix defined on the functional area, ACT is the short name defined for the Activation application role, and DSL_RFS is the resource facing service that is the subject of the action.

Action Type Displays the functional area associated with the application role. The application role can include any action code defined on the associated functional area. Click the Action Type link to open the functional area in the Functional Area editor.
Specialized Action Code Click Add to include an action code and to specify a corresponding specialized action name. The action codes available to add to the application role are defined on the functional area associated with the application role (specified in the Action Type field). For example, when modeling technical actions, you can add any action code defined on the Technical functional area.

Select the Specialized Action Name and Action Code pair and click Remove to remove the pair.

Specialized Action Code Detail Edit the Specialized Action Name to ensure that the value is specific to the application role and to the fulfillment system to which the name is relevant.

Click the Action Code link to open the action code in the Action Code editor.


Related Topics

About Application Roles

Creating Actions

Action Parameter Binding Editor

You use the Action Parameter Binding editor to map data elements defined for conceptual model entities and components (the source data) to data elements defined for technical actions (the target data).

When working with the Technical Action Parameter Binding editor, see:

Action Parameter Binding Editor Bindings Tab

You use the Bindings tab to map the simple and structured data elements in the conceptual model tree on the left to the action family simple and structured data elements displayed on the right. In a simple action parameter binding, the subject contains all of the data that the action family requires.

Field Use
Input Displays the simple and structured data elements defined for the conceptual model entity. You can select an entity, a simple data element, or a structured data element and drag the selection to a simple or structured data element in the Action Family area to bind the two selections.

Binding a data element indicates that the data element defined in the conceptual model entity is the source for the target data element defined in the action family.

Output Displays all of the data elements defined for all actions in the action family.

Right-click a data element in the Action Family area and select Add Custom Binding to define a relative path to a data element outside of the conceptual model subject.

Design Studio displays a marker next to data elements defined with custom bindings to enable you to identify those bindings quickly. All custom bindings are displayed on the Custom Bindings tab.


Related Topics

Action Parameter Binding Editor

Creating Action Parameter Bindings

About Action Parameter Bindings

Action Parameter Binding Editor Conditions Tab

You use the Conditions tab to define the conditions under which an action is created for a subject. You define conditions to ensure that run-time changes to an entity initiate the execution of the correct set of technical actions.

Field Use
Action Conditions Displays a list of the condition name and action combinations. You can apply conditions to each name and action combination in the list.
Action Displays the name of the action that is selected in the Action Conditions list. Click Select to associate a different action with the condition name.
Action Code Displays the action code associated with the action selected in the Action Conditions list. Technical actions are associated with a single action code. Click Select to associate a different action code with the action.
Condition Enter the XPath expression to describe the condition under which the technical action is applicable to the action parameter binding.

Related Topics

Action Parameter Binding Editor

Creating Action Parameter Bindings

About Action Parameter Bindings

Action Parameter Binding Editor Context Tab

You use the Context tab to define the context in which the action parameter binding is to be used and to define which technical actions to include in the action family.

Field Use
Subject Displays the conceptual model entity that contains the source data.
Context Define the context in which the action parameter binding is to be used. By default, the context is defined using the relative path of the subject, and indicates that the action parameter binding is to be used wherever the subject is used. You can change the context if the action parameter binding is applicable for a more specific context.

You may need to define the context more broadly if the information required by the set of technical actions must be sourced from multiple areas of a conceptual model tree.

Action Family Do one of the following:
  • Select Include All Actions to include all technical actions defined for the subject in the action family.

  • Select Select Specific Actions to limit the scope of the action parameter binding to a subset of actions defined for the subject. The actions appear in the Action field. You can add to or remove any technical actions defined for the subject.

    For example, you might have technical actions to create, modify, and delete entries in the network address template. You can create a single action parameter binding for all of these technical actions, or you can limit the scope if you require alternate bindings for specific scenarios.

    By default, all actions associated with the subject are included in the action parameter binding.


Related Topics

Action Parameter Binding Editor

Creating Action Parameter Bindings

About Action Parameter Bindings

Action Parameter Binding Editor Binding Details Tab

You use the Binding Details tab to review binding details. For example, you can review the bindings on this tab to edit or delete invalid bindings.

Field Use
Bindings Displays a list of the bindings. Select a binding from the list to edit the properties. Select a binding and click Remove to clear the binding.
Contributor Displays the path to the source conceptual model entity.
Source Displays the entity or the data element defined on the conceptual model entity for which the binding is defined.
Source Path Displays the relative path to the source data element.
Target Displays the simple or structured data element defined on the technical action for which the binding is defined.
Target Path Displays the relative path to the target data element.

Related Topics

Action Parameter Binding Editor

Creating Action Parameter Bindings

About Action Parameter Bindings

Action Parameter Binding Editor Custom Bindings Tab

You use the Custom Bindings tab to create custom bindings, which enable you to define XPath expressions for target action data.

For example, you can bind the technical action data element to a source data element defined outside of the subject. You can create custom action parameter bindings when a subject does not contain all of the data required by the associated technical actions.

Field Use
Custom Bindings Displays a list of the custom bindings. Select a custom binding from the list to edit the properties.
Target Data Element Displays the data element defined on the technical action for which the custom binding is defined. Click Select to associate a different target data element with the custom binding.
Target Data Element Path Displays the relative path to the target data element.
Custom Binding Displays the binding defined for the target data element. Click into this field to edit the binding.

Related Topics

Action Parameter Binding Editor

Creating Action Parameter Bindings

About Action Parameter Bindings

Action Parameter Binding Editor Binding Conditions Tab

You use the Binding Conditions tab to define the conditions under which a custom binding is created. You define conditions to ensure that run-time changes to an entity initiate the execution of the correct set of technical actions.

Field Use
Bindings Conditions Displays a list of the custom bindings in the action parameter binding. You can apply conditions to each of the bindings in the list.
Target Data Element Displays the name of the target data element that is selected in the Binding Conditions list. Click Select to associate a different target element with the binding condition.
Target Data Element Path Displays the relative path to the target data element.
Binding Condition Enter the XPath expression to describe the condition under which the technical action is applicable to the action parameter binding.

Related Topics

Action Parameter Binding Editor

Creating Action Parameter Bindings

About Action Parameter Bindings

Relationship Type Editor

You use the Relationship Type editor to review the action code mappings that the Order and Service Management order transformation manager requires to transform customer-focused order items (what the customer bought) to service-focused order items (the services that equate to what the customer bought).

The action code mappings delivered with Design Studio describe the behavior of Primary and Auxiliary relationships between products and customer facing services. You can also create your own relationship types.

Field Use
Add Click to create a new action code mapping.
Remove Click to remove the selected action code mapping.
Source Action Code Displays the requested action to be performed against the product on the order line.

Do one of the following:

  • Click Source Action Code to open the code in the Action Code editor.

  • Click Select to select an action code.

Current Target Action Code Displays the last action requested against a service.

Do one of the following:

  • Click Current Target Action Code to open the code in the Action Code editor.

  • Click Select to select an action code.

New Target Action Code Displays the action to be performed against a service when the associated source action and current target action types are present.

Do one of the following:

  • Click New Target Action Code to open the code in the Action Code editor.

  • Click Select to select an action code.


Related Topics

Defining Conceptual Model Components

Domain Editor

Use the Domain editor to organize conceptual model entities in ways that are meaningful to your design. For example, you can create domains that are service or project-based.

Field Use
Conceptual Model Select the conceptual model entities that you want to associate with the domain.

Do one of the following:

  • Click Open to open the conceptual model entity editor.

  • Click Add to create a new conceptual model entity and associate the new entity to the domain.

  • Click Remove to delete the selected conceptual model entity from the list.

  • Click Select to associate an existing conceptual model entity to the domain.

Functional Area Associate the domain to a functional area, such as Service or Technical.

Do one of the following:

  • Click Open to open the selected functional area in the Functional Area editor.

  • Click Add to create a new functional area and associate it to the domain.

  • Click Remove to delete the selected functional area from the list.

  • Click Select to associate an existing functional area to the domain.

Sub Domain Associate the domain to a subdomain. You can create hierarchies of domains by creating and associating subdomains with domains.

Do one of the following:

  • Click Open to open the selected domain in the Domain editor.

  • Click Add to create a new domain as a subdomain.

  • Click Remove to delete the selected domain from the list.

  • Click Select to associate an existing domain as a subdomain.


Related Topics

About Domains

Functional Area Editor

Use the Functional Area editor to specify whether the functional area supports actions, to define the entities that can be associated with the functional area actions, to define how the Functional Area entity is realized into an application entity, and to define default data elements for associated service actions.

When working with the Functional Area editor, see the following topics:

Functional Area Editor Action Support Tab

Use the Functional Area editor Action Support tab to specify whether the functional area supports actions and to define the conceptual model entities that can be associated with the functional area actions.

Field Use
Action Support area Select This Functional Area Supports Action if the functional area supports actions.

Service order management and technical order management layers support actions. Commercial order management layers do not support actions.

Define the naming convention of the functional area actions by specifying a value in the Action Prefix field. For example, if configuring a service order management functional area, you might define this value as service_action.

Supported Entity Types area Click Add to specify the conceptual model entities with which the functional area actions can be associated. Click Remove to remove a conceptual model entity from the list.
Supported Entity Type Details area For the selected conceptual model entity, define the following:
  • Mandatory: Select to indicate that the conceptual model entity requires an association with the type of action defined by the functional area. When this option is selected for an entity in the Supported Entity Types table, Design Studio automatically creates an action entity and associates the action entity with any new entities that you create.

  • Multi Instance: Select to indicate that multiple actions can be associated with the conceptual model entity. Customer facing services can have only one associated service action. Resources, however, can be associated with multiple technical actions.

  • Extend Subject by Default: If selected, indicates that the data elements defined on the conceptual model entity are inherited by associated actions.

Default Action Codes area Displays the action codes that are supported in the functional area. Action codes represent the base operation types in a solution. For example, the default values defined for a functional area can include Add, Modify, and Delete action codes.

Select an action code and click Open to open the code in the Action Code editor.


Related Topics

Creating Functional Areas

Creating Actions Automatically

About Functional Areas

Functional Area Editor Realization Tab

Use the Functional Area editor Realization tab to specify how the Functional Area entity is realized into an application entity.

Field Use
Implementation System Indicate whether the Functional Area entity will be realized as an Order and Service Management (OSM) order.

Each functional area can be realized by a different OSM order, each with a unique orchestration configuration.

Realization Design Pattern Select which design pattern converts the Functional Area entity into an application entity and creates the application entity configuration.
Run Realization Design Pattern Automatically Select to synchronize the Functional Area entity and the realized application entity automatically. When you select this option, Design Studio runs a design pattern automatically when you:
  • Save of the Functional Area entity.

  • Change the Functional Area entity using an option that you select from the context menu.

  • Manually synchronize or realize a direct child of the Functional Area entity.

See "Synchronizing Conceptual Model Entities with Application Entities" for more information.

Realized By Displays the name of the application entity realized from the Functional Area entity. This field is blank if the design pattern selected in Realization Design Pattern has not yet run.
Provider Functions Associate the functional area with provider functions.

Provider functions are processing components that perform a defined set of tasks based on its role in a solution. Design Studio includes the configuration for some provider functions, such as Calculate Service Order, Design and Assign, Calculate Technical Order, and Activation.

Do one of the following:

  • Click Open to open the selected provider function in the Provider Function editor.

  • Click Add to create a new provider function to associate with the functional area.

  • Click Remove to delete the selected provider function from the list.

  • Click Select to associate an existing provider function with the functional area.


Related Topics

Creating Functional Areas

About Functional Areas

Provider Function Editor

Use the Provider Function editor to review the configuration of the provider functions delivered with Design Studio or to create your own provider functions. For example, you might create a provider function that works with your workforce management system.

When working with the Provider Function editor, see the following topics:

Provider Function Editor Inputs Outputs Action Tab

Use the Inputs Outputs Action tab to define the conceptual model entities and the associated action types that the provider function requires as input and generates as output.

Field Use
Input Types Displays the types of conceptual model entities that the provider function recognizes as input values. Click the Add and Remove buttons to extend or filter the list of acceptable entities.

For example, the Calculate Service Order provider function only recognizes Product entities as input.

Input Type Details Displays the conceptual model entity type and associated action type of the conceptual model entity displayed in the Input Types area.
  • Entity Type displays the conceptual model entity type that is selected in the Input Types table. Click the menu to change the value to a different entity type.

  • Action Type displays the type of action associated with the conceptual model entity selected in the Input Types table. The provider function uses the actions associated with the entity type as input.

    The value that initially appears in this field is determined by the configuration defined in the functional area.

    Click Select to select a different functional area.

Output Types Displays the types of conceptual model entities that the provider function generates as output. Click the Add and Remove buttons to extend or filter the list of generated entities.

For example, the Calculate Service Order provider function only recognizes products as input, and generates only the actions associated with Customer Facing Service and resources.

Output Type Details Displays the conceptual model entity type and associated functional area of the conceptual model entity displayed in the Output Types area.
  • Entity Type displays the conceptual model entity type that is selected in the Output Types table. Click the menu to change the value to a different entity type.

  • Action Type displays the type of action associated with the conceptual model entity selected in the Output Types table. The provider function uses the actions associated with the entity type as output.

    The value that initially appears in this field is determined by the configuration defined in the functional area.

    Click Select to select a different functional area.


Related Topics

About Provider Functions

Provider Function Editor Relationship Types Tab

Use the Relationship Types tab to define how the conceptual model entities that the provider function requires as input can be related to the conceptual model entities that the provider function generates as output.

The relationship types that you define here will determine how conceptual model entities are associated with the components in the conceptual model entity editor Components tab, Derivation tab, and Other Relationships tab.

Field Use
Default Relationship Displays the default relationship between the input conceptual model entities and the generated output conceptual model entities.

For example, the Calculate Service Order provider function recognizes products as input, and generates actions associated with customer facing services as output. The relationship between a product and a CFS entity is derivational, meaning that the CFS entity has a primary relationship to one product. Typically, Calculate Service Order generates a CFS entity (it can also generate resources, but that scenario is less common). Therefore, the default relationship is defined as Primary. See Design Studio Concepts for more information.

Relationship Types Displays all of the relationship types that can exist among the input conceptual model entities and the generated output conceptual model entities. Do one of the following:
  • Click Open to open the entity in Relationship Type editor.

  • Click Add to create a new entity and to include the new entity as an additional relationship type.

  • Click Remove to remove the relationship type from the provider function.

  • Click Select to add an existing relationship to the provider function.


Related Topics

About Provider Functions

Provider Function Editor Realization Tab

Use the Realization tab to define how the provider function is converted to an application entity. The provider functions that are delivered with Design Studio are realized as Design Studio for Order and Service Management transformation manager entities.

Field Use
Implementation System Specify how the Provider Function entity will realize. Select:
  • None if the Provider Function entity does not realize as an Order Transformation Manager entity.

  • Transformation Manager to specify that the Provider Function entity realizes as a Transformation Manager entity.

Realized By Displays the application entity into which the Provider Function entity is converted.

Click Open to open the selected application entity editor.


Related Topics

About Provider Functions

Fulfillment Pattern Editor

Use the Fulfillment Pattern editor to define the functional area (such as customer, service, or technical) that the pattern supports, the provider functions that are associated with the pattern for a group of related products in a product catalog, and the fulfillment functions that the pattern supports.

Field Use
Implementation System Define the system where the application entity is used. Select one of the following:
  • Select None if the conceptual model entity will not be realized as an application entity. You select this option, for example, if the conceptual model entity is intended for informational use only.

  • Select Order and Service Management if the conceptual model entity will be realized in a Design Studio for Order and Service Management project as a Fulfillment Pattern entity.

  • Select Other System if the conceptual model entity will be realized as an application entity that will be used in a system other than Order and Service Management.

Implementation Method Specify how the Fulfillment Pattern entity realizes as an application entity. Select:
  • Fulfillment Pattern Structure if the Fulfillment Pattern entity realizes as an OSM Fulfillment Pattern entity.

  • None if the Fulfillment Pattern entity realizes as an entity other than an OSM Fulfillment Pattern entity.

Realization Design Pattern Select which design pattern converts the Fulfillment Pattern entity into an application entity and creates the application entity configuration.
Run Realization Design Pattern Automatically Select to synchronize the Fulfillment Pattern entity and the realized application entity automatically. When you select this option, Design Studio runs a design pattern automatically when you:
  • Save of the Fulfillment Pattern editor.

  • Change the Fulfillment Pattern entity using an option that you select from the context menu.

  • Manually synchronize or realize a direct child of the Fulfillment Pattern entity.

See "Synchronizing Conceptual Model Entities with Application Entities" for more information.

Realized By Displays the name of the application entity realized from the Fulfillment Pattern entity. This field is blank if you have not yet realized the Fulfillment Pattern entity.

Click Open to open the selected application entity editor.

Functional Area Associate a functional area to the fulfillment pattern.

Do one of the following:

  • Click Select to associate an existing functional area to the fulfillment pattern.

  • Click Add to create a new functional area and associate the new functional area to the fulfillment pattern.

  • Select a value in the Functional Area field and click Open to open the functional area in the Functional Area editor.

  • Select a value in the Functional Area field and click Remove to remove the association between the functional area and the fulfillment pattern.

Provider Function Associate a provider function to the fulfillment pattern.

Do one of the following:

  • Click Select to associate an existing provider function to the fulfillment pattern.

  • Click the clear button (represented by a red X) to remove the association.

Fulfillment Function Associate fulfillment functions to the fulfillment pattern.

Do one of the following:

  • Click Select to associate an existing fulfilment function to the fulfillment pattern.

  • Click Add to create a new fulfilment function and associate the new fulfilment function to the fulfillment pattern.

  • Select a value in the Fulfilment Function field and click Open to open the fulfilment function in the Fulfilment Function editor.

  • Select a value in the Fulfilment Function field and click Remove to remove the association between the fulfilment function and the fulfillment pattern.


Related Topics

About Fulfillment Patterns

Fulfillment Function Editor

Use the Fulfillment Function editor to define the functions that represent the work to be performed against an action.

Field Use
Implementation System Define the system where the application entity is used. Select one of the following:
  • Select None if the conceptual model entity will not be realized as an application entity. You select this option, for example, if the conceptual model entity is intended for informational use only.

  • Select Order and Service Management if the conceptual model entity will be realized in a Design Studio for Order and Service Management project as an Order Component specification.

  • Select Other System if the conceptual model entity will be realized as an application entity that will be used in a system other than Order and Service Management.

Implementation Method Specify how the Fulfillment Function entity realizes as an application entity. Select:
  • OSM Order Component if the Fulfillment Pattern entity realizes as an OSM Order Component specification.

  • None if the Fulfillment Pattern entity realizes as an entity other than an OSM Order Component specification.

Realization Design Pattern Select the design pattern that converts the Fulfillment Function entity into an application entity and creates the application entity configuration.
Run Realization Design Pattern Automatically Select to synchronize the Fulfillment Function entity and the realized application entity automatically. When you select this option, Design Studio runs a design pattern automatically when you:
  • Save of the Fulfillment Function editor.

  • Change the Fulfillment Function entity using an option that you select from the context menu.

  • Manually synchronize or realize a direct child of the Fulfillment Function entity.

See "Synchronizing Conceptual Model Entities with Application Entities" for more information.

Realized By Displays the name of the application entity realized from the Fulfillment Function entity. This field is blank if you have not yet realized the Fulfillment Function entity.

Click Open to open the selected application entity editor.


Conceptual Model Unit of Measure Editor

Use the conceptual model Unit of Measure editor to define units of measure for any integer data element types. You can define units of measure for data elements that you include in conceptual model entities.

A unit of measure is a quantity or increment by which something is divided, counted, or described. For example, Kbps is a unit that measures a bit rate. If you use Order and Service Management Order Transformation Manager, you may need to define units of measure to ensure that your mapping rules are valid.

Field Use
Unit of Measure area Click Add to define a new unit of measure. Select a unit of measure and click Remove to delete the unit of measure from the workspace.
Name Displays the unit of measure selected in the Unit of Measure area table. You can edit the name in this field.
Display Name Displays the name that appears in Design Studio selection dialog boxes and in run-time environments. You can edit the display name in this field.
Value Displays the value assigned to the unit of measure. You can edit the value in this field.
Description Displays a description of the unit of measure. You can edit the description in this field.

Synchronization Record Editor

Use the Synchronization Record editor to review synchronization records and to correct invalid data in records.

When working with the Synchronization Record editor, see the following topics:

Synchronization Record Editor Synchronization Details Tab

Use the Synchronization Details tab to review information about the design pattern and the project associated with the synchronization record.

Field Use
Design Pattern Displays the design pattern associated with the synchronization record.
Time Stamp Displays the date and time when the design pattern last ran.
Synchronization Subject Displays the conceptual model entity against which the design pattern ran.
Projects area Displays all design pattern project tokens and the values supplied for those project tokens.

Tokens are placeholders that represent information to be collected by the Design Pattern wizard from a user applying a design pattern. Tokens ensure that the resources a design pattern copies to a workspace are based on information supplied by the user who applies the design pattern. See the Design Studio Developer's Guide for more information.

Project Token Displays the design pattern project token selected in the Projects area.
Value Displays the value of the selected token supplied by the user who applied the design pattern.

Related Topics

Synchronization Record Editor

Realizing Conceptual Model Entities into Application Entities

Synchronizing Conceptual Model Entities with Application Entities

Synchronization Record Editor Token Values Tab

Use the Token Values tab to review the tokens defined in the design pattern and the values supplied by the user who last applied the design pattern.

Field Use
Tokens area Displays all of the design pattern tokens (that do not collect project information) and the values supplied for those tokens.

Tokens are placeholders that represent information to be collected by the Design Pattern wizard from a user applying a design pattern. Tokens ensure that the resources a design pattern copies to a workspace are based on information supplied by the user who applies the design pattern. See the Design Studio Developer's Guide for more information.

Token Displays the design pattern token selected in the Tokens area.
Value Displays the value of the selected token supplied by the user who applied the design pattern.

Related Topics

Synchronization Record Editor

Realizing Conceptual Model Entities into Application Entities

Synchronizing Conceptual Model Entities with Application Entities

Synchronization Record Editor References Tab

Use the References tab to review the element and entity reference tokens defined in a design pattern.

Field Use
Element Tokens area Displays all of the design pattern tokens and the values supplied for those tokens.

Tokens are placeholders that represent information to be collected by the Design Pattern wizard from a user applying a design pattern. Tokens ensure that the resources a design pattern copies to a workspace are based on information supplied by the user who applies the design pattern. See the Design Studio Developer's Guide for more information.

Entity Tokens area The Token field displays the design pattern token selected in the Tokens area.

The Value field displays the value of the selected token supplied by the user who applied the design pattern. Click Select to change the value. Click Value to open the token value in the appropriate Design Studio editor.


Related Topics

Synchronization Record Editor

Realizing Conceptual Model Entities into Application Entities

Synchronizing Conceptual Model Entities with Application Entities