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

1 Getting Started

This chapter introduces the Oracle Communications Order and Service Management (OSM) Order Management Web client. It provides an overview, instructions about starting the application, and information about user interface features.

About the Order Management Web Client

You use the Order Management Web client to display an order's orchestration plan, including dependencies, orchestration stages, order components, order items, and processes. Displaying the orchestration plan is useful for developers who are modeling orders and need to see relationships between order items. You can also perform some order management tasks, such as suspending and resuming orders, canceling orders, and managing fallout.

When you open the Order Management Web client, you see the Search page. You use this page to find orders based on criteria that you select. You can use predefined searches or create your own. You can save searches so that you can use them again.

Orders that match your search criteria are displayed in the Results panel below the Search panel. In the Results panel, you can select an order and open its Order Details page. See "Searching for Orders" for detailed information.

You can also choose from a variety of actions to take on orders. The actions available for an order depend on its current status. See "Managing Orders" for more information about the actions you can take on orders.

Figure 1-1 illustrates the Search page and some of its features.

The Order Details page provides comprehensive information about an order, including its structure, data, orchestration plan, dependencies, amendments, and activity. The page includes an Order Info region containing a hierarchical tree view of the order's structure and the Order Details region, containing tabs with information about the order. You can select entities in the tree view to determine what information is displayed in the main region of the Order Details page. You can select the order itself to see information about the order as a whole, or you can select an item or component to see information about that specific entity. See "Viewing Order Details" for more information.

Figure 1-2 illustrates the Order Details page and some of its features.

Figure 1-2 Order Details Page

Description of Figure 1-2 follows
Description of "Figure 1-2 Order Details Page"

About Orders

You work with orders in the Order Management Web client. You use the application to search for, view details about, and take actions on orders.

An order represents a customer request to be fulfilled. Orders are typically captured by CRM systems such as Siebel or by other front-office applications. See OSM Concepts for more information about orders.

The data for each order includes a header that lists information about the order as a whole, such as the customer name and address. In addition, the order includes any number of line items, each representing a product, service, or bundle to be fulfilled. See "About Items".

When OSM generates orchestration plans for orders, it decomposes orders and associates their items with components. See "About Components".

About Order States

Orders have a life cycle through which they progress as they are processed. An order's life cycle is defined by its order life-cycle policy. Order life-cycle policies are defined in Oracle Communications Design Studio.

In the course of their life cycle, orders move through a number of states. These states can be grouped conceptually into descriptive categories, as shown in Figure 1-3. See OSM Concepts for more information about order states.

Table 1-1 lists and describes all of the possible order states. Not all states are used in all order life cycle policies.

Table 1-1 Order State Descriptions

Order State Description

Not Started

Indicates that the order has not begun processing.

Suspended

Indicates that the order's processing has been paused temporarily. Processing of the order can be resumed.

Waiting For Revision

Indicates that the order has failed at a core level and is awaiting a revision, which should contain the corrected data.

Cancelled

Indicates that the order has been canceled. When the order is canceled, all tasks associated with the order are rolled back. The data shown is the same as what would be displayed for the order at the creation task. No further processing of the order is possible.

Failed

Indicates that an order has stopped processing because of errors. Orders in this state are also called fallout. Orders can be placed in Failed state automatically by OSM or manually in the Order Management Web client.

In Progress

Indicates that the order is being processed normally.

Amending

Indicates that the order is in the process of being amended by another order. Amendments require compensation, including undoing and redoing completed components and completing new components.

Cancelling

Indicates that the order is in the process of being cancelled. Cancellation requires that all tasks associated with the order be rolled back.

Completed

Indicates that an order has been processed successfully by OSM.

Aborted

Indicates that an order has been manually terminated in the Order Management Web client. No further processing of the order is possible.


About Items

Items are individual products, services, and offers to be fulfilled as part of an order. Each item includes the action required to implement it: Add, Suspend, Delete, and so on. For example, a new order might include a wireless router to be added. An order related to an existing service might include an item that requires the deletion of an existing router.

Items are structured hierarchically within an order. Parent items can include child items, which can in turn include their own children. Item hierarchies are defined as part of commercial bundling in the product catalogs in CRM systems such as Siebel.

Figure 1-4 shows an item hierarchy as shown in the tree view in the Order Details page.

Figure 1-4 Item Hierarchy

Description of Figure 1-4 follows
Description of "Figure 1-4 Item Hierarchy"

OSM associates items with components during orchestration plan generation. See "About Components".

About Components

Components are groupings of items that share characteristics as determined by the orchestration sequence used to generate the order's orchestration plan. For example, in an order-to-activate solution, components include items that share the same function, are destined for the same fulfillment system, and share the same processing granularity.

Components are mapped by OSM to tasks that are executed. When the tasks for all components are complete, the order is complete.

Components are based on component specifications. Component specifications are defined in Design Studio and are used by OSM during orchestration plan generation. OSM generates components as orders are decomposed. See OSM Concepts and the Design Studio Help for more information about components, orchestration plans, and decomposition.

The names displayed for components in the Order Management Web client are derived from the decomposition stages that produced the components.

For example, if an order-to-activate solution has three decomposition stages that determine the function required to fulfill an item, the item's fulfillment system, and the processing granularity, component names would have the following syntax:

Function.FulfillmentSystem.ProcessingGranularity

where:

For example, if a component is named FulfillBillingFunction.BRM-REZDB.ServiceBundleGranularity, the function is FulfillBillingFunction, the fulfillment system is BRM-REZDB, and the granularity is ServiceBundleGranularity.

About Fallout

Fallout refers to orders that encounter problems during fulfillment and therefore fall out of normal processing. OSM places these orders in Failed state. You can also manually fail orders.

Orders can fail for a number of reasons, including:

These problems often result in unresolved dependencies, which block the order from proceeding beyond a certain point in its processing.

In the Order Management Web client, you can search for failed orders, identify the reason for the failure by viewing order details, and resolve dependencies to allow order processing to proceed. In cases where the dependency cannot be resolved, you can cancel or terminate the order. See "Searching for Orders" and "Managing Orders" for more information.

Starting and Ending Your Order Management Web Client Session

The Order Management Web client is a Web-based application that you open in a browser. Refer to OSM Installation Guide for details on Web browser and version compatibility with the Web client.

Note:

If you try to open the client in an unsupported browser, you may see an error message that incorrectly indicates support for a variety of browsers.

The Web client application URL takes the form:

http[s]://host:port/OrderManagement/orchestration

where:

The Order Management Web client requires a user name and password, which you receive from an OSM system administrator. The user name must be a member of the OMS_client WebLogic group to gain access to the application. To modify an order's priority or reference number, the user name must also be a member of a group associated with those functions. (Order priority and reference number information is displayed as read-only if you are not a member of an appropriate group.) See OSM System Administrator's Guide for information about setting up groups.

Note:

To log in to the Management Web client with multiple user accounts from the same browser, you must establish a new browser session for each user account. Consult the browser documentation for instructions about how to establish a new session.

To log into the Order Management Web client:

  1. In your browser, enter the Order Management Web client URL.

    The login dialog box appears.

  2. In the Username field, enter your user name.

  3. In the Password field, enter your password.

  4. Click Login.

    The Order Management Web client opens, displaying the Search page.

To log out of the Order Management Web client:

  1. Click Logout.

Note:

If you do not log out, your session will automatically timeout after 45 minutes (the default setting). This setting is configurable. See "Changing the Default Timeout Setting" for more information.

Changing the Default Timeout Setting

To change the default timeout setting:

  1. Unpack the oms.ear file. See OSM System Administrator's Guide for more information.

  2. Open the OSM_Home/SDK/Customization/osmwebui/WEB-INF/web.xml file, where OSM_Home is the directory in which OSM is installed.

  3. Search for the following parameter:

    session-timeout
    
  4. Change the value of the session-timeout parameter to your desired value (in minutes).

  5. Save and close the file.

  6. Repack oms.ear. See OSM System Administrator's Guide for more information.

Note:

Changing the session-timeout parameter changes the automatic timeout for both Order Manager and Task Manager.

Working with the Order Management Web Client Interface

This section includes information about how you use Order Management Web client user interface features.

Working with Panels

Many Order Management Web client pages and tabs are divided into panels. Each panel has a name and a title bar. A panel displays a particular feature or set of data, often contained in a table. In many cases, the panel includes a toolbar that you use to work with its content.

Panels are expanded by default, but you can collapse them to save space. For example, the Summary tab in the Order Details page includes a number of panels. You can collapse some of them to make it possible to see others without scrolling.

To collapse or expand a panel, click the minus sign or plus sign button to the left of the panel name.

Working with Regions

Some Order Management Web client pages and tabs are divided into regions. For example, the Order Details page is divided into the Order Info and Order Details regions.

Unlike panels, regions do not have title bars. Instead, they are surrounded by a solid line and have a name displayed at the top. You can resize these regions and also hide them to allow more space for other regions.

Resizing Regions

To resize a region:

  1. Position the cursor on the line that separates one region from another.

    The cursor changes to a line segment with an arrow on each end.

  2. Drag the dividing line until the regions are arranged properly.

Hiding and Showing Regions

You can hide regions to allow more space for other regions. For example, you could hide the Order Info region to make it easier to read information in the Order Details region.

To hide or show a region:

  • Click a region's Collapse Pane button. The button is a small rectangle enclosing a triangle. For vertically-oriented regions, the button is the middle of the vertical line that separates the region from other regions. For horizontally-oriented regions, the button is near the upper-right corner.

    A screenshot that shows a region’s Collapse Pane button.

    The region is hidden. The button remains in view, with the triangle pointed in the opposite direction. You can show the region again by clicking the button.

Working with Tables

Much of the information presented in the Order Management Web client is displayed in tables. These tables all have the same basic functionality, although not all features are available in all tables.

With the exception of column arrangements in the Results panel of the Search page, which you can save along with searches, changes you make to tables are not maintained when you leave the current Order Details page. Tables display their default content each time you open a particular Order Details page. See "Saving Searches" for information about saving column arrangements in the Results panel of the Search page.

Getting More Information About Rows

Some tables, such as those listing dependencies and order activities, allow you to view additional information about a row. Tables with this feature include an Expand button to the left of the first column in each row, as illustrated in Figure 1-5.

Figure 1-5 Expand Buttons

Description of Figure 1-5 follows
Description of "Figure 1-5 Expand Buttons"

When you click an Expand button, the row expands to show additional information, as shown in Figure 1-6. You can view information about more than one row at the same time.

Figure 1-6 Additional Row Information

Description of Figure 1-6 follows
Description of "Figure 1-6 Additional Row Information"

To get more information about a row in a table:

  1. In a table, click the Expand button to the left of the first column in a row.

    A region opens below the row, displaying additional information.

  2. Click the Expand button again to close the information region.

Setting Table Height

You can specify a fixed or variable table height, depending on the value of the is_tablelayout_height_fixed parameter in the oms-config.xml file. You can set the value of is_tablelayout_height_fixed to True or to False.

The default value of is_tablelayout_height_fixed is True, causing all tables to use the value of the height_of_tablelayout parameter, also found in oms-config.xml. The default setting of height_of_tablelayout is 400 pixels.

Using fixed table heights can create excessive white space in and between tables. Setting is_tablelayout_height_fixed to False causes table height to be solely determined by the number of rows in the table and can help eliminate white space.

To set the table height:

  1. Open OSM_Home/SDK/Customization/osm-ejb/security/META-INF/oms-config.xml, where OSM_Home is the directory in which OSM is installed.

    Note:

    You may need to unpack oms-config.xml to be able to edit it. For instructions on how to unpack oms-config.xml, see OSM System Administrator's Guide.
  2. Search for the following parameter:

    is_tablelayout_height_fixed
    
  3. Do one of the following:

    • To set the table height to fixed, set is_tablelayout_height_fixed to True.

      You may desire a fixed height different from the default. If so, change the fixed height of all tables.

      To change the fixed height of all tables:

      1. Search for the following parameter:

        height_of_tablelayout
        
      2. Set height_of_tablelayout to the desired numerical value.

        The default setting is 400 pixels.

    • To set the table height to variable, set is_tablelayout_height_fixed to False.

      Table height will now vary for each table, depending on the number of rows in the table.

  4. Save and close the file.

    Note:

    After saving and closing oms-config.xml, you may have to redeploy it. See OSM System Administrator's Guide to determine if you need to redeploy oms-config.xml and for instructions for redeploying it.

Refreshing Tables

Tables show information that is current as of the time when the page was opened. You can refresh most tables so that they display the latest information. Tables that can be refreshed include a Refresh button in their toolbars.

To refresh a table:

  • In the toolbar of a table, click the Refresh button.

Showing and Hiding Columns

By default, tables display all the columns that are available to them. You can change the default arrangement of columns so that only the columns you want are displayed.

To show or hide table columns:

  1. In the toolbar of the table, select Columns from the View menu.

    A submenu appears, containing a Show All command, commands for the first 10 available columns, and a Show More Columns command.

  2. Do one of the following:

    • To show all the available columns, select Show All. The columns are displayed immediately.

    • To show or hide that column, select or deselect the column name. Your changes are visible immediately.

    • To open a dialog box in which you can work with all available columns, select Show More Columns.

      The Show More Columns dialog box appears.

      Description of clt_columns_dialog.gif follows
      Description of the illustration clt_columns_dialog.gif

  3. Select columns in the Hidden Columns or Visible Columns list, then click the Move or Remove button to transfer columns from one list to the other. Click the Move All or Remove All button to transfer all columns.

  4. (Optional) To change the column order, select columns in the Visible Columns list, then click the up or down arrow buttons to the right of the list.

  5. Click OK.

    The table displays the column arrangement you specified.

Reordering Table Columns

There are several ways to change the order of table columns. You can specify the order of columns while you are selecting which columns to display. See "Showing and Hiding Columns" for more information. You can also reorder columns by dragging them or by using the Reorder Columns dialog box.

To reorder columns by dragging:

  • Click the heading of a column you want to move, and drag it to a new location.

    The column is inserted into the new location and the surrounding columns move to accommodate it.

To reorder columns by using the Reorder Columns dialog box:

  1. In the toolbar of the table, select Reorder Columns from the View menu.

    The Reorder Columns dialog box appears, containing a list of the visible columns in the table.

    Description of clt_reorder_columns.gif follows
    Description of the illustration clt_reorder_columns.gif

  2. From the Visible Columns list, select the columns and click the arrow buttons to the right of the list.

  3. Click OK.

    The table displays the column order you specified.

Filtering Table Contents

Some tables allow you to filter data to display only rows that match criteria you specify. You can use two fields to enter filter criteria:

  • The Find field enables you to enter criteria that are applied across all data in the table. Partial matches are allowed. For example, if you enter the letter s in the search field, the table is filtered to display all rows that contain that letter in any field.

    Note:

    The search value applies to all columns, even those that are not currently displayed. If you enter characters that are not present in any visible column but do exist in hidden columns, the rows with the matching hidden data are displayed.
  • Query By Example fields are available for some columns. Criteria you enter in a Query By Example field apply only to that column. Unlike the Find field, Query By Example does not allow partial matches, but you can use * as a wildcard. For example, to find the component name InitiateBillingFunction.BRM-VOIP.OrderGranularity in a Query By Example field above a Blocked Component column, you must enter either the full component name or appropriate characters and a wildcard, such as Ini*.

The Find field (if available for a table) is always displayed, but you must expose Query By Example fields before using them.

The Find and Query By Example fields work together. When you enter criteria in both, the table is filtered to show only rows that match all the criteria. For example, if you enter BRM in the Find field and created in the Query By Example field for the State column, the table is filtered to show only rows that include the string BRM somewhere in their data and have the state created.

You can also use one of the filtering methods without specifying criteria in the other.

Figure 1-7 shows a the search field with BRM as the criterion and a Query By Example field for the Blocking Order ID column with the value 10000.

Figure 1-7 Search and Query By Example Fields

Description of Figure 1-7 follows
Description of "Figure 1-7 Search and Query By Example Fields"

To filter table contents by using the Find field:

  • In the toolbar of a table, enter filter criteria in the search field.

    The contents of the table are filtered as you type.

To filter table contents by using Query By Example fields:

  1. In the toolbar of a table, click the Query By Example button.

    Fields appear above the columns that are enabled for query-by-example filtering.

  2. Enter criteria into one or more Query By Example fields.

  3. Press the Enter key.

    The contents of the table are filtered to show only rows that match the criteria you entered.

Sorting Tables by Column Values

You can sort tables by the values in any of their columns.

To sort a table by column values:

  1. Place the cursor in the column on which you want to sort.

    An upward-facing and a downward-facing triangle appear in the heading.

  2. Click the downward-facing triangle to sort in descending alphanumeric order or the upward facing triangle to sort in ascending order.

    The two triangles remain in the column, with the selected triangle highlighted. The table contents are sorted by the column you selected in the order you specified.

Exporting Table Data

You can export data from some tables into Microsoft Excel-format (.xls) spreadsheet files. Only the currently visible data is exported. You can choose to save the file or open it in read-only mode.

To export table data:

  1. In the toolbar of a table, click the Export to Spreadsheet button.

    The standard browser dialog box for downloading files appears.

  2. Open or save the file.

Detaching Tables

You can detach some tables so that they are enlarged into windows that appear on top of the page. You can move the window, but you cannot work in other parts of the application when it is open.

This feature is useful if you want to see more rows in a table than are visible in the normal configuration.

To detach a table:

  1. In the toolbar of a table, click the Detach button. Alternatively, select Detach from the View menu.

    The table is detached from the rest of the page and appears as a window on top of the rest of the content.

  2. When you are finished, close the window by clicking the Close button in the title bar.

    The table is reattached to its previous location at its original size.

Viewing Information About the Application

To view the release number of the OSM application and its copyright statement, click About on the title bar.

The About Order and Service Management dialog box appears. The OSM release number and copyright information is included in the dialog box.

Opening the Task Web Client

When you are using the Order Management Web client to investigate an order's orchestration plan, it may be necessary to access and edit task-level data for the order in the Task Web client. For example, when managing fallout, you must edit the task data of an orchestration order component so that the order can continue to process.

To open the Task Web client from within the Order Management Web client:

  1. On the Search page, search for the orchestration order.

  2. In the Results area, open the order for which you want to work on a task of that order by doing one of the following:

    • Right-click on the order and select Open Order.

    • Double-click the order row.

    The Order Details page appears.

  3. Click the View Tasks button.

    The Worklist page of the Task Web client is displayed in a new window. The Worklist page is displayed in context for the order you selected and shows the tasks associated with the orchestration order.

    Notes:

    • The View Tasks button is not visible for orders that have a status of Completed.

    • The Worklist displays only orders on which you are assigned to work (that you have privileges to edit).

    Tip:

    You can use your Web browser general settings to choose to display the Task Web client on a new tab or display it in a new window.
  4. Edit the tasks of the orchestration order in the Worklist as needed.

    For example, select a task to perform some action, and update or submit the task.

  5. Close or exit the window and return to the Order Management Web client.

    Important:

    Close or exit the window instead of logging out of the Task Web client. Logging out of one Web client automatically logs you out of the other Web client.
  6. If you edited data in the Task Web client, refresh the Order Management Web client UI to see the data updates.