Oracle Communications Order and Service Management Order

Oracle Communications Order and Service Management Order
Oracle® Communications Order and Service
Management
Order Management Web Client User's Guide
Release 7.2.2
E35417-02
March 2013
Oracle Communications Order and Service Management Order Management Web Client User's Guide,
Release 7.2.2
E35417-02
Copyright © 2009, 2013, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,
transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is
prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it
on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software,
any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users
are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and
agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and
adaptation of the programs, including any operating system, integrated software, any programs installed on
the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to
the programs. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management
applications. It is not developed or intended for use in any inherently dangerous applications, including
applications that may create a risk of personal injury. If you use this software or hardware in dangerous
applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other
measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages
caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks
are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD,
Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced
Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information on content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle
Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your
access to or use of third-party content, products, or services.
Contents
Preface ................................................................................................................................................................ vii
Audience...................................................................................................................................................... vii
Related Documents .................................................................................................................................... vii
Documentation Accessibility ................................................................................................................... viii
1 Getting Started
About the Order Management Web Client......................................................................................... 1-1
About Orders............................................................................................................................................. 1-3
About Order States ............................................................................................................................ 1-3
About Items ............................................................................................................................................... 1-4
About Components .................................................................................................................................. 1-5
About Fallout ............................................................................................................................................ 1-6
Starting and Ending Your Order Management Web Client Session ............................................. 1-6
Changing the Default Timeout Setting ........................................................................................... 1-7
Working with the Order Management Web Client Interface.......................................................... 1-7
Working with Panels ......................................................................................................................... 1-8
Working with Regions....................................................................................................................... 1-8
Resizing Regions ......................................................................................................................... 1-8
Hiding and Showing Regions ................................................................................................... 1-8
Working with Tables ......................................................................................................................... 1-9
Getting More Information About Rows .................................................................................. 1-9
Setting Table Height ................................................................................................................... 1-9
Refreshing Tables..................................................................................................................... 1-10
Showing and Hiding Columns .............................................................................................. 1-11
Reordering Table Columns..................................................................................................... 1-11
Filtering Table Contents.......................................................................................................... 1-12
Sorting Tables by Column Values ......................................................................................... 1-13
Exporting Table Data............................................................................................................... 1-14
Detaching Tables ...................................................................................................................... 1-14
Viewing Information About the Application.............................................................................. 1-14
Opening the Task Web Client ....................................................................................................... 1-14
2 Searching for Orders
About Searching ....................................................................................................................................... 2-1
Searching for Orders.......................................................................................................................... 2-1
iii
Selecting a Saved Search ...................................................................................................................
Adding and Removing Fields ..........................................................................................................
Saving Searches ..................................................................................................................................
Modifying Saved Searches.........................................................................................................
Deleting Saved Searches ............................................................................................................
Entering Search Criteria ....................................................................................................................
Working with Search Results ................................................................................................................
Opening Orders..................................................................................................................................
2-2
2-2
2-2
2-3
2-3
2-4
2-5
2-5
3 Viewing Order Details
About the Order Details Page ................................................................................................................ 3-1
Using the Tree View .......................................................................................................................... 3-2
Taking Actions on Orders................................................................................................................. 3-3
Returning to Search Results.............................................................................................................. 3-3
Viewing Summary Information ............................................................................................................ 3-3
General Panel ...................................................................................................................................... 3-3
Order Components Panel ................................................................................................................. 3-4
Dependencies Panel ........................................................................................................................... 3-5
Recent Activity Panel......................................................................................................................... 3-5
Custom Panels .................................................................................................................................... 3-5
Viewing Order Data................................................................................................................................. 3-5
Jumping to Specific Data................................................................................................................... 3-6
Searching for Data.............................................................................................................................. 3-6
Selecting the View .............................................................................................................................. 3-7
Getting Data History.......................................................................................................................... 3-8
Viewing Orchestration Information..................................................................................................... 3-9
Understanding the Dependency Graph.......................................................................................... 3-9
Setting the Dependency Graph Detail Level........................................................................ 3-10
Understanding the Decomposition Tree ..................................................................................... 3-10
Working with Graphics.................................................................................................................. 3-13
Viewing Enlarged Graphics ................................................................................................... 3-13
Zooming In and Out ................................................................................................................ 3-13
Panning...................................................................................................................................... 3-14
Viewing Order Dependencies ............................................................................................................ 3-15
Understanding Dependency Types.............................................................................................. 3-15
Understanding Dependency IDs .................................................................................................. 3-16
Getting Information About Dependency Resolution Delay ..................................................... 3-16
Dependencies on Others Panel ..................................................................................................... 3-17
Dependencies on This Panel.......................................................................................................... 3-18
Viewing Order Amendments.............................................................................................................. 3-19
Viewing Order Activity........................................................................................................................ 3-20
Viewing Activity Event Details..................................................................................................... 3-20
Viewing Error Messages ...................................................................................................................... 3-22
Configuring Role-based Access to Client Tabs and Views .......................................................... 3-22
4 Managing Orders
Changing the Order Priority .................................................................................................................. 4-1
iv
Changing the Order Reference .............................................................................................................. 4-2
Adding Node Instances .......................................................................................................................... 4-2
Deleting Node Instances......................................................................................................................... 4-4
Suspending Orders .................................................................................................................................. 4-5
Resuming Orders...................................................................................................................................... 4-7
Failing Orders ........................................................................................................................................... 4-7
Resolving Dependencies ........................................................................................................................ 4-9
Resolving Order Failures..................................................................................................................... 4-10
Canceling Orders................................................................................................................................... 4-11
Terminating Orders .............................................................................................................................. 4-13
v
vi
Preface
This document provides information about using the Oracle Order and Service
Management (OSM) Order Management Web client. The Order Management Web
client is one of two OSM client applications that you use for different purposes:
■
■
Use the Order Management Web client (this application) 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, cancelling orders, and managing fallout.
Use the Task Web client to monitor and manage the tasks in an order. This
application is typically used by order processing personnel to ensure that all the
tasks are completed. It is also used by order fallout managers. You can also
suspend and resume orders, cancel orders, and create orders manually. See OSM
Task Web Client User’s Guide for information about using that application.
See OSM Concepts for more information about OSM in general and about the purposes
of the two clients.
Audience
This document is intended for the following audiences:
■
■
■
Fallout administrators responsible for locating orders with errors, determining the
causes of failures, and taking the necessary corrective actions.
Operations and management personnel who monitor the progress of orders.
Orchestration plan designers. Designers can use this application to test and
validate orchestration-based orders during the planning and implementation of
OSM solutions.
Related Documents
See the following related documents:
■
OSM Concepts
■
OSM Task Web Client User's Guide
vii
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle
Accessibility Program website at
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.
Access to Oracle Support
Oracle customers have access to electronic support through My Oracle Support. For
information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or
visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing
impaired.
viii
1
Getting Started
1
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.
Getting Started 1-1
About the Order Management Web Client
Figure 1–1 Search Page
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.
1-2 OSM Order Management Web Client User's Guide
About Orders
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.
Getting Started 1-3
About Items
Figure 1–3 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
1-4 OSM Order Management Web Client User's Guide
About Components
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
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:
Getting Started 1-5
About Fallout
■
Function refers to the operation that must be executed for this component.
■
FulfillmentSystem refers to the system on which the function will be performed.
■
ProcessingGranularity refers to the grouping of order items necessary for the
function to perform adequately.
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:
■
Problems in capturing information about an incoming order
■
Missing or incorrect information from external systems
■
Processing or data errors in fulfillment systems
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:
■
host is the IP address of the Oracle WebLogic server that hosts the client
■
port is the Oracle WebLogic server port
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
1-6 OSM Order Management Web Client User's Guide
Working with the Order Management Web Client Interface
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.
Getting Started 1-7
Working with the Order Management Web Client Interface
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.
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.
1-8 OSM Order Management Web Client User's Guide
Working with the Order Management Web Client Interface
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
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
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.
Getting Started 1-9
Working with the Order Management Web Client Interface
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:
a.
Search for the following parameter:
height_of_tablelayout
b.
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.
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.
Note:
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.
1-10 OSM Order Management Web Client User's Guide
Working with the Order Management Web Client Interface
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.
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.
Getting Started 1-11
Working with the Order Management Web Client Interface
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.
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*.
1-12 OSM Order Management Web Client User's Guide
Working with the Order Management Web Client Interface
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
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.
Getting Started 1-13
Working with the Order Management Web Client Interface
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.
1-14 OSM Order Management Web Client User's Guide
Working with the Order Management Web Client Interface
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.
Getting Started 1-15
Working with the Order Management Web Client Interface
1-16 OSM Order Management Web Client User's Guide
2
Searching for Orders
2
This chapter explains the search features of the Oracle Communications Order and
Service Management (OSM) Order Management Web client. It includes information
about performing searches and about viewing search results.
About Searching
The Order Management Web client includes features that enable you to find orders by
using a variety of criteria. When you first open it, the application includes three saved
searches:
■
■
■
Minimal Fields: Includes search criteria for a limited set of fields, including order
ID, reference number, namespace, and type.
Failed Orders: Finds all orders in the Failed state. This is the default search until
you specify another as the default. See "Saving Searches" and "About Order States"
for more information.
All Fields: Includes search criteria for all available fields, including the standard
fields applicable to all orders with orchestration plans as well as any custom fields
defined for a particular orchestration plan.
You can select one of these searches or create a customized search by adding or
removing fields. See "Selecting a Saved Search" and "Adding and Removing Fields".
You can save customized searches so that you can use them again. See "Saving
Searches".
The techniques you use for these different searches are the same, aside from the
particular criteria that you specify. For more information about the Service
Management Order Management Web client search fields, see the discussion about the
query filters area in OSM Task Web Client User’s Guide.
Searching for Orders
Although there are many different ways to configure a search, the basic procedure is
the same in almost all cases. The one exception is when you configure a search to run
automatically when you select it. See "Saving Searches" for more information about
configuring searches to run automatically.
To search for orders:
1.
Select a saved search (or use the default). See "Selecting a Saved Search".
2.
(Optional) Add additional fields to the search. See "Adding and Removing Fields".
3.
Enter search criteria. See "Entering Search Criteria".
Searching for Orders
2-1
About Searching
4.
Click the Search button.
The Order Management Web client displays the orders that match your search in
the Results panel. See "Working with Search Results".
Selecting a Saved Search
When you open the Order Management Web client, the Search panel displays the
default search. Until you set a different default search, you see a simple set of criteria,
including order ID, reference number, namespace, and type. See "Saving Searches" for
more information about setting the default search.
You can select a different search from the list of predefined and saved searches.
■
From the Saved Search list, select the search you want to use.
The Search panel displays the fields and operators defined in the saved search.
You can use these criteria as they are or add to them. See "Adding and Removing
Fields".
If the search you selected is configured to run automatically, it runs automatically
when you select it.
Adding and Removing Fields
You can add fields to the criteria displayed in the Search panel. When you add a field,
a search operator appropriate to that type of field is also added. For example, if you
add a number field, it includes Equals, Between, and Less Than operators. See
"Entering Search Criteria" for information about the search operators for each field
type.
You can also remove fields from the Search panel and reset it to its last-saved set of
fields and operators.
After adding or removing fields, you can save the search so that you can reuse it. See
"Saving Searches".
To add a field:
■
From the Add Fields list in the Search panel, select a field that you want to
include.
The field appears in the Search panel, along with one or more search operators.
To remove a field:
■
In the Search panel, click the red X to the right of the field you want to remove.
The field and its operator are removed.
To reset the Search panel:
■
In the Search panel, click the Reset button.
The Search panel is restored to its last-saved arrangement of fields and operators.
Saving Searches
You can save a search so that you can reuse it. A saved search includes fields and
search operators. It can optionally include the layout of the Results panel. Saved
searches are available only to the users who created them.
You can select from the following options when you save a search:
2-2 OSM Order Management Web Client User's Guide
About Searching
■
■
■
Set as Default: Configures the search to appear when you open the Order
Management Web client.
Run Automatically: Configures the search to run automatically when you select it.
If you select both this option and Set as Default, the search runs automatically
each time you open the application.
Save Results Layout: Saves any changes you have made in the Search Results
panel so that results are displayed the same way when you run the search again.
See "Working with Search Results" for more information about search results.
To save a search:
1.
In the Search panel, click the Save button.
The Create Saved Search dialog box appears.
2.
Enter a name for the search. This is the name that will appear in the Saved
Searches list.
3.
(Optional) Select one or more of the three options displayed in the dialog box.
4.
Click OK.
The dialog box closes and the search name appears in the Saved Searches list.
Modifying Saved Searches
After a search has been saved, you can modify it. You can change the name, set the
search as the default, and configure it to run automatically. You can also delete saved
searches. See "Deleting Saved Searches".
Note:
You cannot save changes to the three predefined searches.
To modify a saved search:
1.
From the Saved Searches list, select Personalize.
The Personalize Saved Searches dialog box appears.
2.
In the Personalize Saved Searches field, select a saved search.
3.
(Optional) Enter a new name for the search.
4.
Select one or more of the options displayed in the dialog box.
5.
Click Apply to apply your changes and leave the dialog box open. Click OK to
apply your changes and close the dialog box.
Deleting Saved Searches
You can delete saved searches that you no longer need.
To delete a saved search:
1.
From the Saved Searches list, select Personalize.
The Personalize Saved Searches dialog box appears.
2.
In the Personalize Saved Searches field, select a saved search.
Note: You cannot delete the search that is currently selected in the
Saved Searches list in the Search region.
Searching for Orders
2-3
About Searching
3.
Click Delete.
A Warning dialog box appears.
4.
Click Yes.
The Warning dialog box closes and the search no longer appears in the
Personalize Saved Searches field.
5.
In the Personalize Saved Searches dialog box, click OK.
The Personalize Saved Searches dialog box closes.
Entering Search Criteria
You search for orders by entering a value or range of values for a field and then
selecting a search operator. For example, in Figure 2–1, Priority is a numeric field. You
can select from three operators and then enter a value. (If you select the Between
operator, an additional field is added for a second value.)
Figure 2–1 Search Operator
The operators available for a search field depend on the type of data the field stores.
Table 2–1 lists the search operators for the various field types.
Table 2–1
Field Types and Available Search Operators
Field Type
Available Search Operators
Currency
Equals (default), Between, Less Than
Date
On or before, On or after, Between
Numeric
Equals (default), Between, Less Than
Phone
Starts With, Ends With, Equals (default), Contains
Text
Starts With, Ends With, Equals (default), Contains, Like
List
No operator displayed. Select a value in the list.
Duration
Greater Than, Between, Less Than (no default). Format is:
P[<days>D][T[<hoursH][<minutes>M][<seconds>S]]
When specifying hours, minutes, or seconds, you must use the 'T'
as part of the value. For example:
PT8H - eight hours.
PT8H4M - eight hours, four minutes.
PT4M - four minutes.
PT8H6S - eight hours, six seconds.
P9DT8H - nine days, eight hours.
P9D - nine days (no hours/minutes/seconds, so no 'T' required).
PT0S, P0D, PT0H0M - zero duration.
The following are not valid:
P8H - intended to be eight hours, but 'T' is missing.
P9D8H - intended to be nine days, eight hours, but once again 'T' is
missing.
2-4 OSM Order Management Web Client User's Guide
Working with Search Results
Working with Search Results
The Results panel in the Search page displays the orders that are returned by searches.
The matching orders are displayed in a table with a row for each order. Each row
includes columns that display information about the order. By default, the Results
panel displays columns for all available fields. (These are the same fields visible in the
All Fields saved search.) Figure 2–2 illustrates a search results panel.
Figure 2–2 Search Results Panel
Note that the expected start date for this order is in bold. When an expected start date
is in bold, this indicates that the order is a future-dated order. A future-dated order is
an order that will be processed at a future date. OSM displays regular orders in normal
font.
To see more detailed information about an order, you can open it. See "Opening
Orders". You can also take actions, such as suspending the order or changing the
reference ID, on orders you select in the Results panel. See Chapter 4, "Managing
Orders".
You can change the arrangement of the columns in the Results panel using the
standard techniques for tables in the Order Management Web client. You can choose to
display only a subset of the available columns and change the order in which columns
are displayed. See "Showing and Hiding Columns" and "Reordering Table Columns".
When you save a search, you can optionally include the arrangement of the search
results. This ensures that any changes that you have made to the selection and order of
columns is preserved when you run the saved search in the future. See "Saving
Searches"
Opening Orders
To see full information about an order that is returned by a search, you open the order
to view its Order Details page.
Searching for Orders
2-5
Working with Search Results
■
In the Results panel, select the order you want to open, then click Open Order.
Alternatively, double-click the order.
The Order Details page appears. See "Viewing Order Details".
2-6 OSM Order Management Web Client User's Guide
3
Viewing Order Details
3
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:
■
■
■
■
■
■
Summary: Provides a selection of the most important information about the
selected order, component, or item. The Summary tab is displayed by default
when you open the Order Details page. See "Viewing Summary Information".
Data: Displays data for the selected order, component, or item. See "Viewing Order
Data".
Orchestration Plan: Displays a graphical representation of the current order's
orchestration stages and intra-order dependencies. This tab is visible only for
orders that have orchestration plans. See "Viewing Orchestration Information".
Dependencies: Displays lists of dependencies for the selected order, component,
or item. This tab is visible only for orders that have orchestration plans. See
"Viewing Order Dependencies".
Amendments: Displays information about amendments to the current order. See
"Viewing Order Amendments".
Activity: Provides a list of activities related to the current order, such as data
changes, amendments, and state changes. See "Viewing Order Activity".
Viewing Order Details 3-1
About the Order Details Page
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
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.
3-2 OSM Order Management Web Client User's Guide
Viewing Summary Information
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.
Viewing Order Details 3-3
Viewing Summary Information
Table 3–1 (Cont.) Fields for Orders in the General Panel of the Summary Tab
Field
Description
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]]
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.
Amends
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:
■
■
Table 3–2
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.
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.
3-4 OSM Order Management Web Client User's Guide
Viewing Order Data
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.
Viewing Order Details 3-5
Viewing Order Data
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:
■
■
To avoid performance issues, you can configure a database fetch limit for large
orders with many hundreds or even thousands of lines. This threshold sets a limit
to the amount of data that can be requested from the database at one time. The
default threshold is 50 lines per database fetch.
In addition, you can also configure a table layout style threshold that
automatically applies the style behavior table layout for multi-instance nodes that
exceed the configured threshold.
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
■
Searching for Data
■
Selecting the View
■
Getting Data History
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.
3-6 OSM Order Management Web Client User's Guide
Viewing Order 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.
Figure 3–2 Data Search
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.
Viewing Order Details 3-7
Viewing Order Data
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
To get data history:
3-8 OSM Order Management Web Client User's Guide
Viewing Orchestration Information
■
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:
■
■
The Dependency Graph region includes a representation of dependencies in the
selected order. The graph includes a subset of the dependencies shown in the
Dependencies tab. The graphic includes only intra-order dependencies, not
inter-orders dependencies. See "Understanding the Dependency Graph" for more
information.
The Decomposition Tree region illustrates the orchestration stages into which OSM
has broken the order. Items associated with components at each orchestration
stage are visually linked to the same item in the subsequent stage. See
"Understanding the Decomposition Tree" for more information.
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.
Viewing Order Details 3-9
Viewing Orchestration Information
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
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
3-10 OSM Order Management Web Client User's Guide
Viewing Orchestration Information
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.
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.
Note:
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.
Viewing Order Details 3-11
Viewing Orchestration Information
Figure 3–5 Orchestration Stage 1
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
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.
3-12 OSM Order Management Web Client User's Guide
Viewing Orchestration Information
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.
Viewing Order Details 3-13
Viewing Orchestration Information
Figure 3–8 Zoomed Graphic
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.
3-14 OSM Order Management Web Client User's Guide
Viewing Order Dependencies
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:
■
■
Dependencies in which the current entity is dependent on other entities. See
"Dependencies on Others Panel".
Dependencies in which other entities depend on the current entity. See
"Dependencies on This Panel".
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.
Viewing Order Details 3-15
Viewing Order Dependencies
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
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
3-16 OSM Order Management Web Client User's Guide
Viewing Order Dependencies
–
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.
Viewing Order Details 3-17
Viewing Order Dependencies
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)
3-18 OSM Order Management Web Client User's Guide
Viewing Order Amendments
Table 3–10 (Cont.) Columns for Components in the Dependencies on This Panel
Field
Description
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
Viewing Order Details 3-19
Viewing Order Activity
Table 3–12 (Cont.) Columns for Order Amendments
Column
Description
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:
■
Amendments
■
State changes
■
Notifications
■
Data changes
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.
3-20 OSM Order Management Web Client User's Guide
Viewing Order Activity
Table 3–14 (Cont.) Amendment Event Details
Field
Description
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)
Viewing Order Details 3-21
Viewing Error Messages
Table 3–17 (Cont.) Notification Event Details
Field
Description
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:
■
■
■
■
Upward-pointing Arrow: Clicking this button, enables you to navigate to the first
message located at the top of the pane
Downward-pointing Arrow: Clicking this button, enables you to navigate to the
last message located at the bottom of the pane.
Left-pointing Arrow: Clicking this button, enables you to navigate to the message
previous to the message at which you cursor is currently positioned.
Right-pointing arrow: Clicking this button, enables you to navigate to the
message that is subsequent to the message at which you cursor is currently
positioned
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:
■
Summary tab
■
Data tab
■
Orchestration Plan tab
3-22 OSM Order Management Web Client User's Guide
Configuring Role-based Access to Client Tabs and Views
■
Dependencies tab
■
Amendments tab
■
Activity tab
■
Tree View region
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.
Viewing Order Details 3-23
Configuring Role-based Access to Client Tabs and Views
3-24 OSM Order Management Web Client User's Guide
4
Managing Orders
4
This chapter describes how you use the Oracle Communications Order and Service
Management (OSM) Order Management Web client to manage orders, particularly
fallout orders. The actions you can take to manage orders include the following:
■
Changing the Order Priority
■
Changing the Order Reference
■
Adding Node Instances
■
Deleting Node Instances
■
Suspending Orders
■
Resuming Orders
■
Failing Orders
■
Resolving Dependencies
■
Resolving Order Failures
■
Canceling Orders
■
Terminating Orders
The actions you can take on any particular order depend on its current state and on the
order life cycle policy defined for the order. See OSM Concepts and Design Studio Help
for more information about order lifecycle policies.
Changing the Order Priority
You can change the priority of an order, provided you have relevant security
permissions. Orders with lower priority numbers are processed before orders with
high numbers. The default order priority is 5.
To change the order priority:
1.
Do one of the following:
■
■
In the Results panel of the Search page, right-click an order in the table, then
select Change Order Priority from the menu that appears.
In the Order Details page, select Change Order Priority from the Actions
menu in the upper-right corner.
The Change Priority dialog box appears. The title of the dialog box includes the
order number. The current priority is shown in the Current Priority field.
2.
Use the slider in the New Priority field to select the priority.
Managing Orders
4-1
Changing the Order Reference
3.
Click OK.
The dialog box closes and the order priority is updated.
Changing the Order Reference
You can change the order reference value. The order reference is an alphanumeric
value, typically used as an identifier to external systems. Reference numbers can be
used as keys to correlate orders between systems.
Note: You should make sure you understand how the order
reference is used in your environment before you make any changes.
In some cases, changing the reference number can break relations
between orders on different systems.
To change the order reference:
1.
Do one of the following:
■
■
In the Results panel of the Search page, right-click an order in the table, then
select Change Reference from the menu that appears.
In the Order Details page, select Change Reference from the Actions menu in
the upper-right corner.
The Change Reference dialog box appears. The title of the dialog box includes the
order number.
2.
In the New Reference field, enter the new reference.
3.
Click OK.
The dialog box closes and the reference is updated.
Adding Node Instances
You can add instances of group or value nodes to an order, either individually or in
bulk.
To add node instances individually:
1.
Log in to the Web client.
2.
Do one of the following:
■
■
To add a node instance to a Worklist order:
–
In the Worklist, locate the relevant order.
–
Double-click the order.
To add a node instance to a new order:
–
Using the Order Editor, create the order.
–
Double-click the order to open it.
3.
Navigate to the node to which you will add an instance.
4.
Ensure that the instance count box is blank.
5.
Click + adjacent to the node.
An instance of the node is created in the system:
4-2 OSM Order Management Web Client User's Guide
Adding Node Instances
6.
Repeat steps 2 through 5 to add additional node instances.
The system restricts the number of instances you can add for each node based on the
values of the Current and Allowed parameters displayed beside the instance count
box. The value of the Current parameter indicates the number of instances currently in
the system for a specific node. The value of the Allowed parameter indicates the
maximum permissible instances for the node.
The maximum number of instances you can add to a node equals the difference
between the values of the Allowed and Current parameters.
The + icon disappears the moment the number of instances you add matches this
difference. This prevents you from adding instances in excess of the maximum
permissible limit for instances.
To add node instances in bulk:
1.
Log in to the Web client.
2.
Do one of the following:
■
■
To add node instances in bulk to a Worklist order:
–
In the Worklist, navigate to the relevant order.
–
Double-click the order.
To add node instances in bulk to a new order:
–
Using the Order Editor, create an order.
–
Double-click the order.
3.
Navigate to the node to which you will add instances.
4.
In the instance count box, specify the number of node instances you want to add.
The values of the Current and Allowed parameters appear beside the instance
count box. These values help you determine the number of additional instances
you can add to the node. The value of the Current parameter updates dynamically
based on the number of instances currently in the system.
5.
Click + adjacent to the node.
The new instances are created if their count does not exceed the difference between the
Allowed and Current parameter values. Otherwise, the system prompts you to either
create the number of instances that equals this difference or cancel the entire operation.
The + icon disappears the moment the number of instances you add matches this
difference. This prevents you from adding instances in excess of the maximum number
allowed by the system.
Managing Orders
4-3
Deleting Node Instances
The response time of the Order Editor page increases with the number of nodes in an
order. To avoid slow response times, the order_editor_submit_mode_threshold
parameter in the oms_config.xml file is configured to a threshold value for node
instances saved in the system. If the number of saved instances increases this threshold
value, the system automatically switches from AJAX to form-submit mode when
edited orders are saved or submitted for processing.
Deleting Node Instances
You can delete instances of group or value nodes from an order, either individually or
in bulk.
To delete node instances individually:
1.
Log in to the Web client.
2.
In the Worklist, navigate to the order from which you want to delete a node
instance.
3.
Double-click the order.
4.
Navigate to the node from which you want to delete an instance.
5.
Do one of the following:
■
■
To delete an instance of a value node:
–
Select the check box adjacent to the instance.
–
Click the Trash icon.
To delete an instance of a group node:
–
Select the check box on the header bar.
–
Ensure that the instance count box is blank.
–
Click -.
An instance of the node is deleted from the system:
6.
Repeat steps 2 through 5 to delete additional node instances.
The system restricts the number of node instances you can delete based on the
minimum and maximum permissible instances for a node. These limits are displayed
beside the instance count box.
You can delete node instances until the number of current instances falls to the
minimum permissible limit. At this point, the - icon disappears, thereby preventing
you from deleting additional instances.
To delete nodes in bulk:
4-4 OSM Order Management Web Client User's Guide
Suspending Orders
1.
Log in to the Web client.
2.
In the Worklist, navigate to the order from which you want to delete node
instances.
3.
Double-click the order.
4.
Navigate to the node from which you want to delete instances.
5.
Do one of the following:
■
■
To delete instances of a value node:
–
Select the check box adjacent to the instance.
–
Click the Trash icon.
To delete instances of a group node:
–
Select the check box on the header bar.
–
In the instance count box, specify the number of instances you want to
delete.
–
Click -.
The system restricts the number of instances you can delete based on the values of the
Current and Allowed parameters displayed beside the instance count box.
The system deletes the instances, starting from the last, after verifying that after
deletion the instance count does not fall below the minimum permissible limit.
You can delete node instances till the number of current instances falls to the minimum
permissible limit. At this point, the - icon disappears, thereby preventing you from
deleting additional instances.
Suspending Orders
Suspending an order stops its processing temporarily. The order cannot be updated
while it is suspended, but unlike a canceled or terminated order, you can resume its
processing. See "Resuming Orders".
Note: Make sure you understand how other systems in your order
processing solution handle suspended orders. Depending on how
your solution is implemented, upstream systems may not be aware
that an order has been suspended.
You can choose to suspend an order with no grace period, with an infinite grace
period, or with a grace period that you define. If you suspend with a defined grace
period, you can also specify an interval at which jeopardy events are sent to notify
other systems of the pending suspension of the order.
To suspend an order with no grace period or an infinite grace period:
1.
Do one of the following:
■
■
In the Results panel of the Search page, right-click an order in the table, then
select Suspend Order from the menu that appears.
In the Order Details page, select Suspend Order from the Actions menu in the
upper-right corner.
Managing Orders
4-5
Suspending Orders
The Suspend Order dialog box appears. The title of the dialog box includes the
order number.
2.
To suspend the order immediately, click No Grace Period. To suspend the order
after waiting until all in-process tasks are complete, click Infinite Grace Period.
3.
(Optional) In the Reason text box, enter the reason for suspending the order.
4.
Click OK.
The dialog box closes and the order is suspended. The order state is changed to
Suspended.
To suspend an order with a defined grace period:
1.
Do one of the following:
■
■
In the Results panel of the Search page, right-click an order in the table, then
select Suspend Order from the menu that appears.
In the Order Details page, select Suspend Order from the Actions menu in the
upper-right corner.
The Suspend Order dialog box appears. The title of the dialog box includes the
order number.
2.
Click Suspend After Grace Period.
The dialog box expands to include additional fields.
4-6 OSM Order Management Web Client User's Guide
Failing Orders
3.
In the Grace Period field, click the calendar icon and specify the date on which the
suspension begins.
4.
(Optional) Use the Days, Hours, Minutes, and Seconds fields to specify an
interval for jeopardy events.
5.
(Optional) In the Reason text box, enter the reason for suspending the order.
6.
Click OK.
The order is scheduled for suspension on the date you specified.
Resuming Orders
You can resume processing of orders that have been suspended or are in the Waiting
for Revision state. The availability of this action depends on the order specification
design.
To resume a suspended order:
1.
Do one of the following:
■
■
In the Results panel of the Search page, right-click an order in the table, then
select Resume Order from the menu that appears.
In the Order Details page, select Resume Order from the Actions menu in the
upper-right corner.
The Resume Order dialog box appears. The title of the dialog box includes the
order number.
2.
(Optional) In the Reason text box, enter the reason for resuming order processing.
3.
Click OK.
The dialog box closes and order processing resumes. The order state is set to In
Progress.
Failing Orders
You can fail orders manually. Failing an order stops its processing and sets its state to
Failed.
Managing Orders
4-7
Failing Orders
Note: In most environments, fallout handling rules detect processing
problems and automatically fail orders. Manually failing orders is
therefore not normally required. There may be some situations and
environments when it may be necessary to manually fail orders,
however.
Make sure you understand how other systems in your order
processing solution handle failed orders. Depending on how your
solution is implemented, upstream systems may not be aware that an
order has been manually failed.
Orders you fail manually are treated the same ways as orders failed automatically by
the system. Manually-failed orders are returned by the Failed Orders predefined
search along with automatically-failed orders. See "Selecting a Saved Search" for
information about search for failed orders.
It is not possible to change the state of a failed order or to make other changes until
you resolve the order failure. See "Resolving Order Failures".
You can choose to fail an order with no grace period, with an infinite grace period, or
with a grace period that you define. If you fail the order with a defined grace period,
you can also specify an interval at which jeopardy events are sent to notify other
systems of the pending failure of the order.
To fail an order with no grace period or an infinite grace period:
1.
Do one of the following:
■
■
In the Results panel of the Search page, right-click an order in the table, then
select Fail Order from the menu that appears.
In the Order Details page, select Fail Order from the Actions menu in the
upper-right corner.
The Fail Order dialog box appears. The title of the dialog box includes the order
number.
2.
To fail the order immediately, click Fail Immediate. To fail the order after waiting
for all current tasks to be completed, click Infinite Grace Period.
3.
(Optional) In the Reason text box, enter the reason for terminating the order.
4.
Click OK.
The dialog box closes. The order’s state is set to Failed and its processing stops.
To fail an order with a defined grace period:
4-8 OSM Order Management Web Client User's Guide
Resolving Dependencies
1.
Do one of the following:
■
■
In the Results panel of the Search page, right-click an order in the table, then
select Fail Order from the menu that appears.
In the Order Details page, select Fail Order from the Actions menu in the
upper-right corner.
The Fail Order dialog box appears. The title of the dialog box includes the order
number.
2.
Click Fail After Grace Period.
The dialog box expands to include additional fields.
3.
In the Grace Period field, click the calendar icon and specify the date on which to
fail the order.
4.
(Optional) Use the Days, Hours, Minutes, and Seconds fields to specify an
interval for jeopardy events.
5.
(Optional) In the Reason text box, enter the reason for failing the order.
6.
Click OK.
The order is scheduled for failure on the date you specified.
Resolving Dependencies
You can resolve dependencies manually so that blocked components and orders can be
processed. For example, if you are analyzing a failed order and discover an unresolved
dependency that is blocking the processing of a component, you can resolve it.
In some cases, resolving a dependency may require that you take action to correct a
problem such as a failure in an external system. In other cases, a revision order may be
received that corrects an issue in the order.
If it is not possible to resolve a dependency in some other way, you can resolve it
manually in the Order Management Web client. Resolving a dependency in the Order
Management Web client does not make any changes in the underlying order data, it
just marks a dependency as resolved so that processing can proceed.
Managing Orders
4-9
Resolving Order Failures
Note: Resolving a dependency is specific to the order. Because
dependencies are determined in orchestration plans, other orders of
the same type continue to include the dependency until the design is
modified.
Resolving a dependency is irreversible. If, at a later point, changes in orders or
components mean that the conditions of the dependency are no longer met, the
dependency remains resolved. In other words, a dependency is permanently resolved
if the dependency condition has been met at least once or if the dependency has ever
been resolved manually.
Make sure you understand the impact on other systems of
manually resolving dependencies. You can introduce order processing
inconsistencies by manually resolving dependencies. For example,
resolving a dependency may cause other systems to expect that a
particular service has been provisioned when it has not.
Caution:
Dependencies are managed at the component level, so when you resolve a
dependency, you resolve it for all items in the component. You can use dependency
IDs to understand which items will be affected by resolving a dependency. See
"Understanding Dependency IDs" for more information.
The Resolve Dependency action is available only when an order is in the Failed state.
After you resolve dependencies, you must resolve the order failure to allow the order
to continue processing. See "Resolving Order Failures".
To resolve a dependency:
1.
In a table that lists dependencies, select one or more dependencies that you want
to resolve. See "Viewing Order Dependencies" for more information about where
dependencies are displayed.
2.
In the toolbar of the panel containing the table, click the Resolve Dependency or
Resolve Dependencies button.
The Resolve Dependencies dialog box appears, listing the dependencies that will
be resolved.
3.
Click Yes.
The dialog box closes and the dependency is resolved.
Resolving Order Failures
When the reason for an order failure has been corrected, typically by resolving a
dependency, you can resolve the order failure. See "Resolving Dependencies" for more
4-10 OSM Order Management Web Client User's Guide
Canceling Orders
information. Resolving the order failures allows the order to continue processing.
Processing resumes automatically if there is a pending task to be completed.
To resolve an order failure:
1.
Do one of the following:
■
■
In the Results panel of the Search page, right-click an order in the table, then
select Resolve Order Failure from the menu that appears.
In the Order Details page, select Resolve Order Failure from the Actions
menu in the upper-right corner.
The Resolve Order Failure dialog box appears. The title of the dialog box includes
the order number.
2.
(Optional) In the Reason text box, enter the reason for resolving the failure.
3.
Click OK.
The dialog box closes. The order state is set to In Progress and order processing
resumes.
Note: If the order failed because of a recognition rule failure or after
reaching its point of no return (PoNR), it cannot be resolved.
Canceling Orders
You can cancel an order to stop its processing and roll back all the tasks associated
with it. Canceling an order stops its processing either immediately or after a grace
period that you specify. It is not possible to restart an order after it has been canceled.
You must resubmit the order if you want to process it again.
Canceling an order is similar to terminating it except that terminating an order does
not result in a rollback of tasks. See "Terminating Orders".
Make sure you understand the impact on other systems of
canceling orders. Depending on how your solution is implemented,
upstream systems may not be aware that an order has been canceled.
Caution:
You can choose to cancel an order with no grace period, with an infinite grace period,
or with a grace period that you define. If you cancel the order with a defined grace
period, you can also specify an interval at which jeopardy events are sent to notify
other systems of the pending cancellation of the order.
To cancel an order with no grace period or an infinite grace period:
1.
Do one of the following:
Managing Orders 4-11
Canceling Orders
■
■
In the Results panel of the Search page, right-click an order in the table, then
select Cancel Order from the menu that appears.
In the Order Details page, select Cancel Order from the Actions menu in the
upper-right corner.
The Cancel Order dialog box appears. The title of the dialog box includes the order
number.
2.
To cancel the order immediately, click No Grace Period. To cancel the order after
waiting until all in-process tasks are complete, click Infinite Grace Period.
3.
(Optional) In the Reason text box, enter the reason for canceling the order.
4.
Click OK.
The dialog box closes and the order is canceled or scheduled to be canceled. While
the order is in the process of being canceled, its state is Cancelling. After the
cancellation is complete, the state is Canceled.
To cancel an order with a defined grace period:
1.
Do one of the following:
■
■
In the Results panel of the Search page, right-click an order in the table, then
select Cancel Order from the menu that appears.
In the Order Details page, select Cancel Order from the Actions menu in the
upper-right corner.
The Cancel Order dialog box appears. The title of the dialog box includes the order
number.
2.
Click Cancel After Grace Period.
The dialog box expands to include additional fields.
4-12 OSM Order Management Web Client User's Guide
Terminating Orders
3.
In the Grace Period field, click the calendar icon and specify the date on which the
order should be canceled.
4.
(Optional) Use the Days, Hours, Minutes, and Seconds fields to specify an
interval for jeopardy events.
5.
(Optional) In the Reason text box, enter the reason for canceling the order.
6.
Click OK.
The order is scheduled for cancellation on the date you specified.
Terminating Orders
You can terminate orders that have not progressed through the system and cannot be
recovered. A terminated order cannot be resumed. Terminating an order is similar to
cancelling an order except that no tasks are rolled back. As a result, cleanup may be
required after terminating an order.
Make sure you understand the impact on other systems of
terminating orders. Depending on how your solution is implemented,
upstream systems may not be aware that an order has been
terminated.
Caution:
To terminate an order:
1.
Do one of the following:
■
■
In the Results panel of the Search page, right-click an order in the table, then
select Terminate Order from the menu that appears.
In the Order Details page, select Terminate Order from the Actions menu in
the upper-right corner.
The Terminate Order dialog box appears. The title of the dialog box includes the
order number.
Managing Orders 4-13
Terminating Orders
2.
(Optional) In the Reason text box, enter the reason for terminating the order.
3.
Click OK.
The dialog box closes and the order is terminated. The order state is set to
Aborted.
4-14 OSM Order Management Web Client User's Guide
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement