Skip Headers
Oracle® Communications Order and Service Management Order Management Web Client User's Guide
Release 7.2.2

E35417-02
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

3 Viewing Order Details

This chapter describes how you use the Oracle Communications Order and Service Management (OSM) Order Management Web client to get detailed information about the progress of an order's orchestration plan. The chapter includes an overview of the Order Details page as well as descriptions of the tabs it contains and of the information they contain.

About the Order Details Page

The Order Details page appears when you open an order from the Results panel in the Search page. See "Opening Orders". The page is divided into two main regions: Order Info and Order Details.

The Order Info region displays a hierarchical tree view of the structure of the order. The tree view shows the order itself, its items, and the components into which the order has been decomposed. You can select an entity in the tree to determine which entity's information is displayed in the Order Details region. See "Using the Tree View".

The Order Details region displays information about the order, most of which is read-only. The information is organized into six tabs, which are further divided into panels and regions. Some tabs (or panels within tabs) always display information about the order as a whole, while others display information about the entity that is selected in the tree view.

These are the tabs in the Order Details region:

Using the Tree View

For orders that have an orchestration plan, the tree view displays the order's items and the components into which it has been decomposed. (If the order has no orchestration plan, the tree view displays only the order ID and state.) See OSM Concepts and Design Studio Help for more information about the decomposition and structure of orders.

Selecting entries in the tree view determines the information displayed in the Summary, Data, and Dependencies tabs. (Other tabs always display information about the order as a whole.) You can select the order to see information about the order as a whole, or an item or component to see information about a specific entity within an order.

For example, if you select Order 1 in the tree view shown in Figure 3-1, the Summary tab displays information about the order as a whole. If you select the Wireless Router item, however, the Summary tab displays information about that item.

Figure 3-1 Order Info Tree View

Description of Figure 3-1 follows
Description of "Figure 3-1 Order Info Tree View"

The tree view is hierarchical and reflects the structure of the order. Parent-child relationships among items are displayed in the tree view hierarchy. The tree view is fully expanded when you open it, but you can close and open its contents as necessary.

To select from the Order Info tree view:

  1. In the Order Info region of the Order Details page, expand the tree view if necessary to show the entity about which you want information.

  2. Click the entity about which you want information. Select the top level of the tree view or make no selection to get information about the order as a whole. Select an item or component for specific information about that entity.

    The entity you clicked is highlighted. If you clicked an item or component and the Summary, Data, or Dependencies tab is open, information in the Order Details region changes to reflect your selection.

    Your selection in the tree view is retained if you switch tabs. The Summary, Data, and Dependencies tabs display information about the selected item or component. Other tabs display information about the order as a whole.

Taking Actions on Orders

You can take actions on the order that is open in the Order Details page by selecting an action in the Actions menu in the upper-right corner. The actions you can take depend on the current state of the order. See Chapter 4, "Managing Orders" for more information about the actions you can take.

Returning to Search Results

When you are viewing the Order Details page, you can return to the Search page by clicking the Return to Search button in the upper-right of the page. The Search page displays the results of the most recent search until you run a new search or end your session.

Viewing Summary Information

You use the Summary tab to get an overview of information about an order or about an item or component within an order. Most of this information is also displayed in other tabs.

The Summary tab is displayed by default when you open the Order Details page. The tab is divided into a number of panels, which are described in the following sections.

General Panel

The General panel appears at the top of the Summary tab. It includes a selection of important identifying and status information about the entity selected in the Order Info tree.

Table 3-1, Table 3-2, and Table 3-3 provide descriptions of the fields displayed for orders, items, and components respectively.

Table 3-1 Fields for Orders in the General Panel of the Summary Tab

Field Description

Order ID

OSM order ID

Reference Number

OSM reference number

Version

OSM amendment version, followed by the date the amendment was submitted. If no amendment has been received, the date is displayed.

Priority

The order priority, expressed as an integer from 0 to 9, with 0 having the highest priority. The default value is 5.

Order State

The order state, such as Failed or In Progress. See "About Order States".

Target Order State

The state to which the order will transition after the grace period expires. Applicable only to orders currently in a grace period.

Expected Order Completion Date

The date when the order is expected to be completed. This is calculated as follows:

  • If OSM receives the order after the Expected Start Date, then the Expected Order Completion Date is the Expected Duration added to the Order Creation Date.

  • If OSM receives the order before the Expected Start Date, or if it has no Expected Start Date because it is a process-based order, then Expected Order Completion Date is the Expected Duration added to the Expected Start Date.

Requested Delivery Date

The date by which the customer requests the order be delivered.

Expected Start Date

The date when the order is expected to start being processed. Displayed in bold if this is a future-dated order.

Expected Duration

The amount of time the order is expected to take to complete processing. The expected duration format is as follows:

P[<days>D][T[<hoursH][<minutes>M][<seconds>S]]

Amends

The order ID of the amended order. The order ID is a link that opens the Order Details page and Summary tab of the amended order.

Appears only for amending orders.

Amended By

The last amendment received for the order along with the total number of amendments received. This field appears only for orders that have been amended.

The field value takes the form

order_id[total: number]

where:

  • order_id is the OSM order ID of the last received amendment for the current order. The order ID is a hyperlink that opens the Summary tab of the amending order. If no amendments for the order have been received, this value is not displayed.

  • number is the total number of received amendments.


Table 3-2 Fields for Components in the General Panel of the Summary Tab

Field Description

Name

The name of the component. See "About Components" for more information.

State

The current component state (Created, Started, or Completed)


Table 3-3 Fields for Items in the General Panel of the Summary Tab

Field Description

Name

The item name

Expected Order Item Completion Date

The order item expected completion date

Expected Order Item Start Date

The order item expected start date


Order Components Panel

The Order Components panel appears below the General panel when the Summary tab is displaying information about an order or item. The information shown in the Order Components panel depends on whether an order or item is selected in the Order Info tree.

  • When an order is selected, the panel includes a table that lists all of the components associated with the order.

  • When an item is selected, the panel contains a table of the components that include the item.

Components are identified by their names broken into columns based on the orchestration sequence used to generate them. For example, if the orchestration sequence includes three stages, the table has a column for each stage that displays the portion of each component name that corresponds to that stage. See "About Components" for more information about how component names are generated.

Table 3-4 lists the information displayed in the Order Components panel.

Table 3-4 Columns in the Order Components Panel of the Summary Tab

Column Description

Orchestration Stage Name

Lists the portion of the component name derived from this orchestration stage

State

The current component state (Created, Started, or Completed)

Expected Start Date

The order component expected start date


Dependencies Panel

The Dependencies panel appears below the Order Components panel when an order or item is selected in the tree view or as the first panel when a component is selected. It contains information about orders, components, or items on which the entity selected in the Order Info tree depends.

This information is also displayed in the Dependencies On Others panel in the Dependencies tab. See "Dependencies on Others Panel" for details.

Recent Activity Panel

The Recent Activity panel appears below the Dependencies panel. It displays the same information that is displayed in the Activity tab., except that only the most recent events are shown. See "Viewing Order Activity" for more details about the information that is displayed.

The Recent Activity panel does not reflect the selection in the Order Info tree. The panel always displays information for the order as a whole.

Custom Panels

Cartridge designers can use the Query Tasks feature in Design Studio to configure one or more views to be included as panels in the Summary tab. See Design Studio Help for more information.

The content of these custom panels is arranged using functionality similar to that of the Data tab. See "Viewing Order Data" for more information.

Viewing Order Data

You use the Data tab to view the data in the currently-selected entity.

The Data tab supports behavior functionality. See OSM Concepts for more information.

Note:

You cannot make changes to the order data in the Order Management Web client. Changes to orders are normally made with amendments or follow-on orders. Changes to order data can also be made by using the Order Editor in the Task Web client.

If an order is selected in the tree view, the Data tab shows data that is defined by the workgroup view. If a component or item is selected, the data is defined by a view for the order type and component type. Views are defined in Design Studio as part of the cartridge configuration.

The data is displayed hierarchically in a tree view that you can expand and collapse to display the information you need.

OSM supports the following oms-config.xml file configuration parameters that enhance the Order Management Web client performance when retrieving order data:

For more information about oms-config.xml configuration parameters, see OSM System Administrator's Guide.

In addition, you can jump to specific data, search for data, and select the view. You can also get the history of data. For more information see:

Jumping to Specific Data

Orders are frequently quite large and complex, so scrolling through the tree view to find what you want can be time consuming. To move quickly to specific data, use the Jump To list. The Jump To list includes all of the data in the order.

To jump to specific data:

  1. In the Data tab, open the Jump To list.

  2. Select the data to which you want to jump.

    The panel in the Data tab displays the data you selected. The panel is also renamed to reflect your selection.If you selected a parent line item, the data includes all of its children. If you selected a child line item with no children of its own, only that specific data is displayed.

Searching for Data

You can search for characters that appear in the data. For example, you could search for all occurrences of the text BRM. The search results are all of the data line items for the order that include the search text.

Search results appear in the panel in the Data tab, similar to the way data is displayed for the Jump To list. If the data line item is a parent, the panel displays all of its children. The panel is renamed to correspond to this data.

The total number of results appears near the Find field along with the sequential number of the data line item you are currently viewing. Next and Previous buttons enable you to move between search results.

Figure 3-2 illustrates a data search and its results.

To search for data:

  1. In the Data tab, enter text in the Find field.

  2. Press the Enter key.

    The first matching data line item is displayed as if you had used the Jump To list. If the data line item is a parent, the panel displays all of its children. The panel in the tab is renamed to correspond to this data. The total number of results appears near the Find field and the Next button becomes active.

  3. Click the Next button to see the next result.

    The next data line item is displayed in the panel. The Previous button is now active.

  4. Use the Next and Previous buttons to move among the search results.

  5. When you are finished viewing the results, perform a new search or use the Jump To list to navigate to data.

Selecting the View

Cartridge designers can create different data views to show or hide data based on business needs. These views determine what is displayed in the Data tab. If more than one view is available, you can switch between views.

To select a data view:

  • In the Data tab, select a view from the View list.

    The data display changes to reflect the view you selected.

Getting Data History

You can display the history of data line items in the Data tab. You can get history at any level in the data hierarchy. If you get the history for parent data, the history includes all children. If you get history for data with no children, you see information about only that data.

Data history is shown in a dialog box that lists the activity for the selected line item and its children (if any). Information about each event (creation, update, or deletion) in the data's history is displayed. Table 3-5 lists the information you see in the Data History dialog box.

Table 3-5 Columns in the Data History Dialog Box

Column Description

Field

The name of data line item

Value

The value of the data line item. No value is shown when header lines are selected.

Timestamp

The date and time when the data was created or changed

User

The user that performed the action on the data line item

Action

The type of change (Create, Update, or Delete)


Figure 3-3 shows the Data History dialog box for a parent data line item.

Figure 3-3 Data History Dialog Box

Screenshot of the Data History dialog box.

To get data history:

  • In the Data tab, double-click a line in the tree view.

    The Data History dialog box appears. If you double-clicked a parent, the dialog box includes history information for all of its children.

Viewing Orchestration Information

You can view graphical representations of the current order's orchestration plan and dependencies. The Orchestration Plan tab always displays information about the order as a whole and is visible only for orders with an orchestration plan. You can use this information during solution design to validate that order decomposition and orchestration plan generation is functioning as intended. The graphical representation shows exactly how an order is fulfilled.

The Orchestration Plan tab includes two different graphical representations:

Both of these graphical representations are displayed fully zoomed out in their regions so you can get an overview of the content. You can enlarge the diagrams and zoom, scroll, and pan to view particular sections of the graph in more detail. See "Working with Graphics".

Understanding the Dependency Graph

The dependency graph illustrates the dependencies among the components in the order.

Note:

Only intra-order dependencies are shown in the graph. Inter-order dependencies are not included. See "Viewing Order Dependencies" for more information about the difference between intra-order and inter-order dependencies.

The graph shows all the executable components (based on having passed through all orchestration stages) in the order. Arrows show dependencies between components or items. Each component lists the items it contains and colors differentiate components based on the first orchestration stage. A legend illustrates the meaning of each color.

The components with no dependencies are show on the left side of the graph. These are the components on which other components depend. Execution of the orchestration plan starts with these components. When these components are completed, the dependencies on them are resolved. These resolutions allow the dependent components, shown to the right of the first group, to be executed. The resolution of this next group of dependencies in turn frees other components to be executed. This process continues until all components are executed. The final components to be executed are those on the right side of the graph.

Figure 3-4 shows a simple set of dependencies as displayed in the Dependency Graph. Components are color coded based on the first orchestration stage. They are named after the orchestration stages. In this case, there are three stages, so the names have three parts. Note that the first part of the name corresponds to the color coding: all components of the same color share the same first name segment. See "About Components" for additional information about component names.

Note also that a component can be dependent on another component both directly and indirectly (by being dependent on a component that is itself dependent on another). For example, in Figure 3-4, component E[1][y] is dependent on component A[1][z] both directly and indirectly through component D[2][z].

Figure 3-4 Dependency Graph

Diagram showing a simplified version of a dependency graph.

Setting the Dependency Graph Detail Level

The Dependency Graph can display two different detail levels:

  • Component: At this level, the graph shows a single arrow for each component-to-component dependency.

  • Dependent Item: At this level, the graph shows arrows for each item in a component. The arrows point from dependent item to the item on which it depends.

To set the detail level:

  • In the upper-left corner of a Dependency Graph, click the Component or Item button.

    The graph redisplays to show the detail level you selected.

Understanding the Decomposition Tree

The Decomposition Tree illustrates the orchestration stages into which an order is broken. Each item in the order is shown in the components into which it is grouped by the orchestration sequence.

The graph displays a series of regions for progressively more specific orchestration stages as you move from left to right in the image. The regions are labeled at the top with the name of the orchestration stage. The number of stages and their names depend on how the stages are defined for orders in Design Studio. See Design Studio Help and OSM Concepts for more information about orchestration stages.

  • On the left of the diagram, the first region displays a grey box listing all of the items in the order. Above that box, a legend shows colors used to differentiate functions in the diagram.

  • The next region to the right shows the results of the first orchestration stage. For example, if the first stage is DetermineFulfillmentFunctionStage, this region displays color-coded boxes into which items are grouped into components by function. Note that the same item frequently appears in more than one component.

  • The third section shows the next orchestration stage. For example, for a sequence where the next stage is DetermineFulfillmentSystemStage, this region shows components with items broken down by both function and fulfillment system. The color coding continues to differentiate functions.

  • Additional regions correspond to additional orchestration stages. For example, for an orchestration sequence that includes a third and last stage called DetermineProcessingGranularityStage, the last region on the right displays executable components that include function, fulfillment system, and granularity. This final column reflects the named components that you see in other regions of the Order Management Web client, such as the tree view in the Order Items region and the Dependency Graph. See "About Components" for more information.

Because components are generated for items based on product specifications, the graph can show separate components for items that have the same orchestration stages. For example, there could be separate components for items that share the same function, fulfillment system, and processing granularity if the items are mapped to different product specifications.

The following greatly simplified example illustrates how the decomposition tree displays the orchestration sequence for a particular item in an order-to-activate solution.

Note:

For clarity, this example shows the decomposition of a single item. In a real order, the components in each stage would include many items, so the relationships would be much more complex.

In this example, the On Top of the World Broadband VoIP item progresses through three orchestration stages: DetermineFulfillmentFunctionStage, DetermineFulfillmentSystemStage, and DetermineProcessingGranularityStage.

In the first stage, illustrated in Figure 3-5, the item is decomposed into three functions.

Figure 3-5 Orchestration Stage 1

Diagram of the first stage of orchestration.

In the next stage, illustrated in Figure 3-6, each of these three functions is decomposed based on the fulfillment system. In this case, InitiateBillingFunction requires two fulfillment systems, while the other two functions require only one fulfillment system each.

Figure 3-6 Orchestration Stage 2

Diagram showing the second stage of a decomposition process.

In the final stage, each of the function-fulfillment system components is decomposed into one fully qualified component that includes the function, fulfillment system, and granularity level. In this case, each function-fulfillment system component corresponds to a single executable component.

Figure 3-7 Orchestration Stage 3

Description of Figure 3-7 follows
Description of "Figure 3-7 Orchestration Stage 3"

Working with Graphics

Both the Dependency Graph and Decomposition Tree include tools that enable you to view the information you need. You can see an enlarged version of each diagram, zoom in and out, and pan.

Viewing Enlarged Graphics

Most orders are complex, so their dependency graphs and decomposition trees must be reduced in size to fit in their regions on the Orchestration Plan tab. For greater legibility, you can open enlarged versions of the diagrams in separate windows that you can move and resize. You can also zoom and pan in these windows. See "Zooming In and Out" and "Panning" for more information.

  • In the Dependency Graph or Decomposition Tree region of the Orchestration Plan tab, click the Enlarge button.

    A new window displaying the diagram appears.

Zooming In and Out

Because of the complexity of orders, you often need to zoom in to see the detail you need. You can zoom using three methods:

  • By using the Zoom In and Zoom Out buttons to zoom in or out on the center of the current view of the diagram.

  • By using the Zoom button to zoom in on an area that you select.

  • By using the zoom level indicator on the right of the diagram to specify a zoom level.

Figure 3-8 shows a dependency graph zoomed in to show details of a component. The circle in the indicator on the right shows the zoom level. The triangles enable you to increase or decrease the zoom level.

Figure 3-8 Zoomed Graphic

Screenshot showing a zoomed in area of a Dependency Graph.

To zoom in and out of the center of diagram:

  • In a Dependency Graph or Decomposition Tree window, click the Zoom In or Zoom Out button in the toolbar.

    You zoom into or out of the center of the current view of the diagram.

To zoom into a particular area:

  1. In a Dependency Graph or Decomposition Tree window, click the Zoom button in the toolbar.

    The cursor turns into a plus sign.

  2. Drag out the area into which you want to zoom.

    The diagram zooms to the area you designated.

To set the zoom level:

  • On the right side of a Dependency Graph or Decomposition Tree, click and upward or downward-facing triangle to zoom to that level. The current zoom level is marked with a circle. The top triangle corresponds to the lowest zoom level and the bottom triangle corresponds to the maximum zoom level.

Panning

When you are zoomed into the diagram, not all areas are visible. You can pan to move to other areas.

To pan:

  1. In a Dependency Graph or Decomposition Tree window, click the Pan button in the toolbar.

    The cursor turns into a hand symbol.

  2. Click in the diagram, then drag it to move to the area you want to see.

Viewing Order Dependencies

Dependencies are relationships in which a condition related to one item must be satisfied before the other item can be completed. For example, a piece of equipment must be shipped to a location before it can be installed. There are three dependency types: Completion, Data, and Order Item. See "Understanding Dependency Types".

Although dependencies arise between items, they are managed by OSM at the level of components. All items in one component that are dependent on items in another component are grouped together into a single dependency. Only when the required conditions for all the items involved in a dependency are satisfied is the dependency resolved.

Dependencies can be between components in the same order (intra-order dependencies) or between components in different orders (inter-order dependencies). Inter-order dependencies are particularly common in situations that involve amendments or follow-on orders.

Dependencies are configured in Design Studio and instantiated for an order when OSM generates its orchestration plan. See OSM Concepts and Design Studio Help for more information about dependencies.

The Dependencies tab displays information about two different dependency relationships:

Dependency information is current as of the time that the Order Details page is opened.

Understanding Dependency Types

The information about each dependency in the Dependencies tab includes information about the dependency type. There are three dependency types:

  • A Completion dependency means that the dependent item requires that another item complete before it can begin. For example, the Provisioning component for the VoIP Service item cannot begin until the Provisioning component for the High Speed Internet Service item is complete.

  • A Data Change dependency indicates that an item has a dependency on data in another item. For example, the status of the Provisioning component for the VoIP Service item must be set to Designed before the Ship Order component for the same item can begin.

  • An Order Item dependency indicates that an item is dependent on the completion of another item in another order. Because orders can contain many items, a component of an order can contain many Order Item dependencies. Order Item dependencies support follow-on orders. Follow-on orders always have at least one item that has a dependency on an item in a base order. The line item in the base order must be completed before the line item in the follow-on order can begin processing.

Components can have combinations of these types of dependencies. For example, an Installation component may have a Data dependency on the status of a Ship Order component as well as Order Item dependencies among its items and items in other orders.

Understanding Dependency IDs

Dependency IDs uniquely identify dependencies so that you can easily tell which items are included in which dependencies. OSM manages dependencies at the component level, so all items in the same component share the same dependency ID.

Note:

Dependency IDs are used only for this purpose and don't correspond to any other IDs used in the application.

When you view dependencies for items in the Dependencies tab, each item is listed separately, even though their dependencies are actually grouped by component. Dependency IDs enable you to identify the component-based dependency into which items are grouped.

For example, Figure 3-9 shows a list of four blocking items. Although there are four items listed, there are only two dependencies, corresponding to the two components with which the items are associated. You can understand this relationship at a glance by noting the dependency IDs of the items.

Figure 3-9 Dependency IDs

Screenshot showing Dependency IDs in a table.

Understanding which items share dependencies is particularly important when you take actions to resolve dependencies. Resolving a single dependency with a particular ID can affect multiple items. See "Resolving Dependencies" for more information.

Getting Information About Dependency Resolution Delay

Listings of dependencies include information about their resolution delays. A resolution delay defines a period of time for OSM to resolve a dependency after the dependent component is complete. Resolution delays are defined in Design Studio.

You can see the resolution delay for a dependency by expanding a row in a table listing dependencies. See "Getting More Information About Rows" for more information about expanding rows.

Depending on whether or how the resolution delay is configured, you can see one of three types of information:

  • If no delay is configured for a dependency, you see Wait Until: N/A.

  • If the resolution delay defines a specific date or it defines a duration and the dependency is complete, you see Wait Until:date, where date is one of the following:

    • The specific date configured for the dependency

    • A date calculated from the completion date and the specified duration.

    This date can be in the past if the dependency has been resolved.

  • If the resolution delay defines a duration and the dependency is not complete, you see Wait For:duration where duration specifies the length of the duration defined for the dependency.

Dependencies on Others Panel

The Dependencies on Others panel lists entities on which the current entity depends. (This is the same information that is displayed in the Dependencies panel of the Summary tab.)

The information displayed depends on the selection in the Order Info tree. Table 3-6, Table 3-7, and Table 3-8 provide descriptions of the columns displayed in the tables for orders, items, and components respectively.

Table 3-6 Columns for Orders in the Dependencies on Others Panel

Column Description

Blocked Component

The name of a component that includes an item or items with a dependency. You can determine which items are blocked by selecting the blocked component in the tree view.

Blocking Order ID

The ID of the order on which the blocked component is dependent. This is the ID of the current order for an intra-order dependency.

Blocking Component

The name of the component that includes the item on which the item in the current row's component depends

Dependency Type

The type of dependency (Completion, Data Change, or Order Item)

Dependency ID

The ID of the dependency. Because this table lists components, each dependency ID is unique. See "Understanding Dependency IDs" for more information.


Table 3-7 Columns for Components in the Dependencies on Others Panel

Column Description

Blocked Item

The name of the dependent item in the selected component

Blocking Order ID

The ID of the order that includes the item on which an item in the selected component is dependent. This is the ID of the current order for an intra-order dependency.

Blocking Component

The name of the component that includes the item on which the item in the selected component is dependent.

Blocking Item

The name of the item on which the item in the selected component is dependent.

Dependency Type

The type of dependency (Completion, Data Change, or Order Item)

Dependency ID

The ID of the dependency. Because this table lists items, the same ID can appear multiple times for items associated with the same components. See "Understanding Dependency IDs" for more information.


Table 3-8 Columns for Items in the Dependencies on Others Panel

Column Description

Blocked Component

The name of the component that includes the selected item

Blocking Order ID

The ID of the order that includes the item on which the selected item is dependent. This can be the ID of the current order if the selected item is dependent on another item in the same order.

Blocking Component

The name of the component that includes the item on which the selected item is dependent

Blocking Item

The name of the item on which the selected item is dependent

Dependency Type

The type of dependency (Completion, Data Change, or Order Item)

Dependency ID

The ID of the dependency. See "Understanding Dependency IDs" for more information.


Dependencies on This Panel

The Dependencies on This panel lists entities that depend on the current entity.

The information displayed depends on the selection in the Order Info tree. Table 3-9, Table 3-10, and Table 3-11 provide descriptions of the columns displayed in the tables for orders, items, and components respectively.

Table 3-9 Columns for Orders in the Dependencies on This Panel

Field Description

Blocking Component

The name of a component in the selected order that includes an item or items on which other items depend

Blocked Order ID

The ID of the order that includes a dependency on an item in the selected order. This is the ID of the current order for an intra-order dependency.

Blocked Component

The name of the component that includes an item dependent on an item in the selected order

Dependency Type

The type of dependency (Completion, Data Change, or Order Item)

Dependency ID

The ID of the dependency. Because this table lists components, each dependency ID is unique. See "Understanding Dependency IDs" for more information.


Table 3-10 Columns for Components in the Dependencies on This Panel

Field Description

Blocking Item

The name of the item in the selected component on which another item is dependent

Blocked Order ID

The ID of the order that includes a dependency on an item in the selected component. This is the ID of the current order for an intra-order dependency.

Blocked Component

The name of the component that includes an item dependent on an item in the selected component

Blocked Item

The name of the item that depends on an item in the selected component

Dependency Type

The type of dependency (Completion, Data Change, or Order Item)

Dependency ID

The ID of the dependency. Because this table lists items, the same ID can appear multiple times for items in the same components. See "Understanding Dependency IDs" for more information.


Table 3-11 Columns for Items in the Dependencies on This Panel

Field Description

Blocking Component

The name of the component that includes the selected item

Blocked Order ID

The ID of the order that is blocked by the selected item. This can be the ID of the current order.

Blocked Component

The name of the component that includes the item that depends on the selected item

Blocked Item

The name of the item that depends on the selected item

Dependency Type

The type of dependency (Completion, Data Change, or Order Item)

Dependency ID

The ID of the dependency. Because this table lists items, the same ID can appear multiple times for items in the same components. See "Understanding Dependency IDs" for more information.


Viewing Order Amendments

You can use the Amendments tab to view information about the amendments that have been received for an order. Amendments are orders that revise or modify another order that is in progress. Amendments require compensation, such as redoing or undoing actions that were completed for the original order. See OSM Concepts for more information about amendments and compensation.

Amendments are processed at the order level, so the tab always displays information pertaining to the order as a whole, even if a component or item is selected in the Order Info tree. The tab displays no information if the current order has no amendments or is an amendment to another order.

The Amendments tab contains a single table with the columns described in Table 3-12.

Table 3-12 Columns for Order Amendments

Column Description

Order ID

The ID of the amending order

Received Date

The data and time that the amending order was received

Version

The version number of the amending order.

Status

The status of the amendment. Can be one of the following values:

  • In Progress

  • Queued

  • Completed

  • Skipped

Compensation Started

The date and time that compensation caused by the amending order began

Compensation Completed

The date and time that compensation caused by the amending order was completed


Viewing Order Activity

You use the Activity tab to view information about the activity related to an order. Each event that involves the order is logged. The following types of events are included:

The table in the Activity tab displays a list of all activity events. The table includes four columns:

Table 3-13 Columns for Activity Events

Column Description

Timestamp

The date and time of the event

Entity Type

The type of entity (order or component) that the event affects

Entity Name

The name of the affected order or component

Event Type

The event type. Can be one of the following values:

  • Amendment

  • State change

  • Notification

  • Data change


You can see additional event details by expanding rows. See "Viewing Activity Event Details".

Viewing Activity Event Details

You can view additional information about an event by clicking the Expand button next to its row. See "Getting More Information About Rows" for instructions about expanding rows.

The information displayed for a row depends on the event type. Table 3-14, Table 3-15, Table 3-16, Table 3-17, and Table 3-18 list the fields in the for amendment, state change, notification, and data change events.

Table 3-14 Amendment Event Details

Field Description

Amendment Order ID

The ID of the amending order.

Amended Order ID

The ID of the amended order. This is the same as the contents of the Entity Name column in the main table.

Timestamp

The date and time that the amendment event occurred. This is the same as the contents of the Timestamp column in the main table.

Revision

The version number of the amending order

Status

The status of the event (In Progress, Queued, Completed, or Skipped)


Table 3-15 Order State Change Event Details

Field Description

Order ID

The ID of the order

From Order State

The state from which the order transitioned

To Order State

The state to which the order transitioned

Transition Start

The date and time that the state change started

Transition End

The date and time that the state change ended. This is the same as the content of the Timestamp column of the main table.

Transition Duration

The duration of the state change

User

The user that initiated the state change

Reason

The reason for the transition


Table 3-16 Order Data Change Details

Field Description

Order ID

The ID of the order

Timestamp

The date and time that the data change occurred. This is the same as the content of the Timestamp column of the main table.

Field

The path to the affected field. The path reflects the field's place in the data hierarchy of the order, which you can view in the Data tab.

Value

The changed (new, updated, or deleted) value of the field

Action

The type of change (Create, Update, or Delete)

User

The user that initiated the state change


Table 3-17 Notification Event Details

Field Description

Order ID

The ID of the order

Timestamp

The date and time that the notification event occurred

Notification ID

The internally-generated ID of the notification

Description

The description from the notification specification.

Type

The notification type (Data, Process, or Poll)

Priority

The notification priority (1 to 255, with 1 as the highest priority)

Author

The notification event author

Action

The action taken on the notification (Create, Update, or Delete)

Message

The user-supplied acknowledgement message


Table 3-18 Component State Change Event Details

Field Description

Order ID

The ID of the order

Timestamp

The date and time that the component state change event occurred

Component Name

The component name. See "About Components" for information about how component names are constructed.

State

The current state of the component (Created, Started, or Completed)


Viewing Error Messages

The Error pane displays hyperlinked error messages for errors that occur on the Order Editor page.

Clicking a hyperlinked message enables you to navigate to the error location, even if it is on a different tab.

This feature helps you quickly locate inconspicuous errors on a multi-tabbed Order Editor page, which otherwise would require you to explore several tabs to find the error.

The Error pane provides the following navigation buttons to help you navigate to the relevant error message:

Configuring Role-based Access to Client Tabs and Views

You can configure role-based access to the following tabs and views in the Order Management Web client:

You can add a cartridge role name to oms-config.xml parameters that give permission to all Order Management Web client users associated with that role to view specific tabs or views. By default all roles are enabled.

For more information about oms-config.xml configuration parameters, see OSM System Administrator's Guide.