About Importing Cartridges Created in OSM Administrator

Design Studio replaces much of the functionality previously included in the old OSM Administrator application. OSM administrator functionality, for example managing workgroups, schedules, and calendars, is provided in the Administration area of the OSM Order Management web client. For information about migrating cartridges that were created in the OSM Administrator into Design Studio, see Design Studio Order and Service Management Cartridge Migration Guide.

The following table describes how entities defined in the Administrator and imported into Design Studio are mapped into the Design Studio environment:

Entity Considerations

Cartridge Name and Version

At import, Design Studio preserves the namespace and version, using namespace as the project name, and version as the version number of the cartridge.

You cannot import into Design Studio a cartridge with a name identical to an existing Design Studio cartridge (even if it is a different version), per workspace.

Data Dictionary and Master Order Template

Design Studio does not require that you build a master order template or explicitly model order data. As you model task data, the system automatically builds the order template.

Design Studio maps all data elements to a Data Dictionary that you specify in the Import wizard, and maps order template elements to the Order editor Order Template tab.

Order Source

Design Studio imports the order source. It is visible in the Order editor Details tab.

Workgroups

Design Studio maps workgroups to roles. Permissions are visible in the Role editor and also in the Order editor and Task editor Permissions tabs.

Tasks

Manual and automated tasks appear as separate task entities in the project directory.

If you are importing a cartridge that contains a task used by multiple order types and sources (using different views in OSM Administrator), Design Studio creates duplicate tasks, one for each order, and renames each task with the original task name concatenated with the order type and source. Design Studio updates all references to the task. If the task name is referenced in an automation map, Design Studio creates duplicate entries.

Views

In Design Studio, views are not independent entities, but are implicit in the configuration of data nodes in tasks and order templates. Upon import, the data associated with an order or task appear in the Order and Task editors, respectively.

Processes

If you associated a process with multiple order type and sources using rules, Design Studio duplicates the process for each associated order type and source. On import, the type/source-to-process mappings are replaced by an equivalent top-level process and subprocess.

If you are importing a cartridge that contains a process used by multiple order types and sources (using different views in OSM Administrator), Design Studio creates duplicate processes, one for each order, and renames each process with the original process name concatenated with the order type and source. Design Studio updates all references to the process, including any references in the automation map.

Rules, event delays, timer delays, subprocesses, and process exceptions appear in the Process editor, not as separate entities.

Behaviors

Upon import, Design Studio saves behaviors to the following editors:

  • Behaviors defined at the task level appear in the Behaviors tab of the Task editor.

  • Behaviors defined at the order level appear in the Behaviors tab of the Order editor.

  • Behaviors defined at the data element level appear in the Data Dictionary's OSM tab for the element definition.

Rules

In Design Studio, rules are defined within a specific order. Upon import, Design Studio determines which rules are used by an order and adds those rules to the Order editor Rules tab.

If you are importing text-based rules (SQL rules), Design Studio imports the text-based rules as separate text files, using name_of_the_rule.sql as the rule name. Design Studio saves the rule to the resources folder and displays the rule with the other rules in the Order editor Rules tab. To modify text-based rules, click the name of the file to access the rule in a SQL editor.

Rule expressions defined with order type and source operands are not supported in Design Studio. On import, these operands are mapped to an expression with the same data element on each side. If the order-based operand matches the imported order, the generated expression evaluates to true. For example:

/VPN_Name = /VPN_Name

Otherwise, it evaluates to false:

/VPN_Name_Count ! /VPN_Name_Count

Notifications

Design Studio imports polled-type notifications as jeopardy notifications, and all others as event notifications.

Design Studio does not support or import system notifications (notifications that are not associated with any order, task or activity) or mixed transition notification types (for example, notifications are both transitional and polled).

Data Providers

Design Studio imports inline, external, and XQuery instances that are defined as part of an Information rule as a Data Provider entity type. In Design Studio, you can use a Data Instance behavior in conjunction with a Data Provider to retrieve information from an external system.

Process Exceptions

Design Studio maps process exceptions to the Process editor under the following conditions:

  • A restriction defined in the OSM Administrator must be valid in the imported order, and the type and source of the imported order must match the restriction; otherwise, it will not be imported.

  • The process exception status used in the OSM Administrator must be available in the Design Studio process.

  • Activities defined for the process exception must be available in the Design Studio process.

Automation Maps

Design Studio generates automation maps automatically, based on the configurations of automated tasks. If you are importing a cartridge with custom automation plug-ins, you can specify which automation maps to include from within the Import wizard.

Responsibility and Category

Design Studio does not support or import Responsibility and Category entities created in the OSM Administrator.

Entity Names

If Design Studio detects entity name conflicts, it automatically renames the entity. Review the Import Summary report to acquire a list of all entity name changes made during import. You may be required to edit references to the affected entity names in Java code or XSLT files.

Note:

Cartridges created in the OSM Administrator are not necessarily valid upon import to Design Studio. Design Studio performs logical validations to ensure that errors are detected before deploying a cartridge to an OSM run-time environment. For example, if you import a cartridge that contains a rule to check values of a specific data node, Design Studio ensures that the data node exists in the corresponding order data. You must resolve all cartridge errors before deploying to a run-time environment.