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

The Order Management web client enables you to preform both order management and administration tasks.

You can perform the following order management tasks:

• Manage Orders: Links to the order management capabilities of the application. See "About Managing Orders" for more information.

• View Faults: Links to the fault viewing capabilities. See "Finding Faults" for more information.

• Manage Tasks: Opens the OSM Task web client. See OSM Task Web Client User's Guide for more information.

You can also perform the following administration tasks:

• Administer Workgroups: Links to workgroup administration capabilities. For more information, see the following sections:

  • Managing Workgroups

  • Defining Workgroup Calendars

• Administer Users: Links to user administration capabilities. See "Managing Users" for more information.

• Manage Notifications: Links to notification management capabilities. See "Managing Notifications" for more information.

• Manage System Errors: Links to notification management capabilities. See "Managing System Errors" for more information.

• Refresh Server Cache: Provides the ability to refresh the OSM server metadata cache. See "Refreshing the Server Cache" for more information.

The tasks to which you have access are determined by the permissions you have been granted. If you do not have access to a task you need, see your system administrator.

About Managing Orders

You can perform many order management tasks in the Order Management web client. These include:

• Viewing information about the order, order items, and order components to see their progress and status. Included in this information are the orchestration plan and dependency graph, which is useful for seeing the relationships between order items and order components. See "Viewing Order Details" for more information.

• Changing the processing of an order, for example, suspending and resuming orders, canceling orders, and managing fallout. See "Managing Orders" for more information.

• Retrying or resolving failed tasks and viewing information about the relationships between original order items, transformed order items, and order components. See "Managing Order Items and Order Components" for more information.

For more information about orders, order states, order items, and order components, see OSM Concepts.

Logging In to and Out of the Order Management Web Client

The Order Management web client is a web-based application that you open in a browser. For browser and version compatibility with the Order Management web client, see OSM Compatibility Matrix.

Note:

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

For access to the Order Management web client, you need a user name and password provided by an OSM system administrator. The user name must be a member of the OMS_client WebLogic group. 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 the appropriate group. See OSM System Administrator's Guide for information about setting up users and groups.

Ensure that your browser is not set to display the client using Compatibility View. For more information about Compatibility View, consult the documentation for your browser.

To avoid errors when accessing the Order Management web client:

• Clear your Internet cache before accessing the Order Management web client for the first time after an OSM upgrade

• Configure your browser to automatically check for newer versions of stored pages

Logging In to the Order Management Web Client

To log into the Order Management web client:

1. In your web browser, enter the following URL:

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

   where:

   • host is the IP address of the Oracle WebLogic server that hosts the Order Management web client. In OSM cloud native, the base hostname required to access this instance is instance.project.osm.org.

   • port is the Oracle WebLogic server's port number

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.

Note:

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

Logging Out of the Order Management Web Client

To log out of the Order Management web client, click Sign Out.

Note:

Closing your browser or navigating to another URL does not log you out of the Order Management web client. However, after the predefined session timeout interval has passed, you are logged out automatically and any unsaved updates are lost. The default value for the session timeout interval is 45 minutes, but it can be set to a different value at installation or changed after installation by a system administrator.

Working with the Order Management Web Client Interface

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

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

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 area containing a hierarchical tree view of the order's structure and the Order Details page, containing tabs with information about the order. You can select entities in the Order Info tree to determine what information is displayed in the main area 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 order item or order component to see information about that specific entity. See "Viewing Order Details" for more information.

Using Accessibility Features

The Order Management web client allows you to turn on the following accessibility options:

• I use a screen reader

• I use high contrast colors

• I use large fonts

Turning on these options optimizes the web client for your situation.

To turn on one of the options above, select it from the Accessibility menu at the top of the window.

Working with Different Kinds of Areas

The Order Management web client pages and tabs have different kinds of areas. Areas display a particular features or sets of data, often contained in a table. In many cases, areas include toolbars that you use to work with their content.

The primary difference between the types of areas is the method you use to change how much of the window they use. Most areas are expanded by default, but you can collapse them to save space. Following is the difference between the two types of areas:

• Type 1: The name of this type of area has an arrow before its name. For example, the Order tab, Summary subtab in the Order Details page includes a number of this type of areas. You can collapse some of them to make it possible to see others without scrolling.

• Type 2: This type of area has Collapse Pane and Restore Pane buttons (which are small arrow buttons) on one or more of its sides, which you can use to expand or collapse the area. You can also resize this type of area. For example, the Order Items tab has an area at the top that contains the order item hierarchy, and the Details area at the bottom that contains a set of subtabs.

Collapsing and Expanding Areas with Arrows Before Their Names

To collapse this type of area, click the down arrow button next to the area name. The arrow to collapse the General area is circled in Figure 1-1.

Figure 1-1 Collapse Button for General Area

Description of "Figure 1-1 Collapse Button for General Area"

To expand this type of area, click the right arrow next to the area name of a collapsed area.

Collapsing, Expanding, and Resizing Areas with Collapse Pane and Restore Pane Buttons

You can collapse (hide), expand (show), and resize these types of areas.

To expand or collapse an area of this type, click the area's Collapse Pane or Restore Pane button. The buttons look the same, with a small rectangle enclosing a triangle or arrow. If you hove over the button with your mouse, it will show you whether it is a Collapse Pane or a Restore Pane button. For vertically-oriented areas, the button is the middle of the vertical line that separates the area from other areas. For horizontally-oriented areas, the button is near the upper-right corner of the area. The direction of the arrow shows what the button will do.

In Figure 1-2, the following Collapse Pane and Restore Pane buttons are marked:

• The Collapse Pane button on the left, enclosed in an oval, will collapse the left-most area if you click it, because the arrow is pointing left.

• The Collapse Pane button toward the right, enclosed in a circle, will collapse the Details area if you click it, because the arrow is pointing down.

• The Restore Pane button farthest on the right, enclosed in a rectangle, will expand an area that is currently hidden (the Activity area), because the arrow is pointing left and there is no area currently displayed to the right of the button.

Figure 1-2 Order Details Window with Collapse Pane and Restore Pane Buttons

Description of "Figure 1-2 Order Details Window with Collapse Pane and Restore Pane Buttons"

To resize an area of this type, click somewhere on the bar that contains the Collapse Pane or Restore Pane button (but not on the button itself), and drag the bar in the direction you would like.

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 area 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 a Search" for information about saving column arrangements in the Results area 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-3.

Figure 1-3 Expand Buttons

Description of "Figure 1-3 Expand Buttons"

When you click an Expand button, the row expands to show additional information. You can view information about more than one row at the same time.

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.

   Additional information is displayed below the row.

2. Click the Expand button again to hide the additional information.

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:

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

   The latest information will be displayed in the table.

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 is displayed.

2. Do one of the following:

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

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

   • To open a dialog box in which you can work with all available columns, select Manage Columns from the submenu.

     The Manage Columns dialog box is displayed, as in Figure 1-4.

     Figure 1-4 Manage Columns Dialog Box

     
     Description of "Figure 1-4 Manage Columns Dialog Box"

3. Select columns in the Hidden Columns or Visible Columns list, then click the Move or Remove (single left or right arrow) button to transfer columns from one list to the other. Click the Move All or Remove All (double left or right arrow) 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 that 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 is displayed, containing a list of the visible columns in the table, as in Figure 1-5.

   Figure 1-5 The Reorder Columns Dialog Box

   
   Description of "Figure 1-5 The Reorder Columns Dialog Box"

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 allows 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 order component ID InitiateBillingFunction.BRM-VOIP.OrderGranularity in a Query By Example field above a Blocked Component column, you must enter either the full order component ID 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-6 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-6 Search and Query By Example Fields

Description of "Figure 1-6 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 are displayed 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 is displayed.

2. Open or save the file.

Detaching Tables

You can detach some tables so that they are enlarged into windows that are displayed 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 is displayed 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.

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:

• In the Orders area of the left-hand area, click Manage Tasks.

  The Task web client opens in a separate window.

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 is displayed.

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.

   Note:

   • 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.

   Note:

   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 information in the Order Management web client to see the data updates.