Dashboard

An Order Management Dashboard is a graphical user interface that organizes and presents rich and enhanced information in a format that is easy to read and interpret. The Dashboard is the default view when the user accesses the Order Management.

Features of the dashboard include:

  • An intuitive graphical display that is easy to navigate - A rich Graphical User Interface (GUI) with user/role security to manage/view orders.
  • A logical structure that makes information easily accessible - Ability to view all orders through graphical Dashboard summary.
  • Data displays that can be customized and categorized - Ability to drill down into order details by setting display preferences.
  • Regular and frequent updates of dashboard information for accuracy and relevance - Ability to auto-refresh to display updated details for an order cancellation, amendment, suspension, and resumption.
  • Information from multiple sources can be viewed simultaneously - Ability to manage, search, and filter lists of existing orders.

The Dashboard allows effective order management with a comprehensive operations view. The information displayed is a combination of text and graphical views, as:

  • Current number of orders being processed.
  • Current number of orders completed in the last 24 hrs.
  • Current number of orders in the Execution state.
  • Current number of orders error out in the last 24 hrs.
  • Current number of orders amended in the last 24 hrs.
  • Current number of suspended orders.
  • Current number of orders in Jeopardy.

OMS UI Auto-Refresh

The OMS UI includes an auto-refresh feature that keeps the bar charts and pie charts up-to-date in real time by refreshing them every 20 seconds. This feature ensures that you always view the most current data without requiring manual refreshes.

When you hover over the bar chart, the count or value appears, providing immediate context and detailed information about the data point.

You can also customize the auto-refresh interval to suit your requirements. Navigate to Order Management System UI > Authorization Server Configuration Properties and set the dashboardAutoRefresh property as per your requirements.

Charts

You can select the order date range from the dropdown options (such as 24 hours, 7 days, 15 days, and 30 days) below the Dashboard. By default, only 24 hours of data is fetched on the UI.

Click the vertical ellipsis icon , Charts, and then choose the desired charts from the box. The orders are shown in the following charts:

  • Current status of submitted orders
    Shows different status (such as Complete, Withdrawn) of the submitted orders

  • Proportion of orders with errors
    Shows the orders whose plan item statuses are in error or error handler state

When you hover over on an order chart, a query info icon shows the start date and end date of the order.

Pie chart calls to count only the number of orders with error and not the whole data. Thus loading time is reduced and any possible error for large plan items is avoided.

For bar chart, only Order Status, Submitted Date, and Order Id data is pulled instead of the whole data.

Find Orders

Here orders are displayed with their associated criteria such as Order ID, Plan ID, Status and so on.

You can select all the orders in one go by selecting the checkbox on the header row.

In this window, you can sort the orders to view them in an ascending or descending sequence of Order ID, Plan ID, Status and so on.

Note: The sorting is string-based and not the number-based.
Example of orders shown in an ascending manner:
1) 1
2) 125
3) 2
4) 7
The order Id 125 is placed on the second line, although its numeric value is greater than 2 and 7.

On the Find orders window, the following icons are present on the top-right corner:

Refresh icon: To refresh the page.

Work Tray icon: To navigate to the work tray.

Filter icon: To apply the search criteria by order level or plan level.

Vertical ellipsis icon: For settings

Click the vertical ellipsis icon , Column Picker, and then choose the desired columns from the box.

Note: The Order ID and Submitted date columns are mandatory columns and they are shown on the window even if you hide the rest all the columns.

You can sort the orders to view them in an ascending or descending sequence of Order ID, Plan ID, Status and so on.

You can select 10 or 20 from the Rows per page dropdown options.

Filters

Initially, the entire orders are displayed here. You can create filters by clicking the Filter orders icon.

You can search an Order ID by typing some part of the ID instead of the entire order ID. From the Operation dropdown list, select Like. Then type some part of the order ID in the Provide IDs field and search for the order. All the orders with the order ID that match the given text are shown in the result.

When you do not want to use this functionality, you can select In from the Operation dropdown list. Here, only the exact order ID can be typed in the Provide IDs field.

Note: Whenever a user logs in to the OMS UI again, the last used search criteria are displayed by default.

On the Filters window, you can toggle between Order and Plan level.

Order Level Search Criteria

The orders can be searched by using the following criteria:

Search By IDs
    Procedure
  1. From the Select Type dropdown list, choose Order ID, Order Ref, Customer ID, or Subscriber ID as per your requirement.

  2. Enter the details in the Provide IDs field.

    Note: You can add multiple IDs by clicking add icon .
  3. Click the APPLY FILTERS button.

    Note: When you use Search By IDs criteria, all other criteria are disabled.
ResultOrders are displayed with the applied filters on the Find orders window.
Search By Dates
    Procedure
  1. On the Select Start and End date, choose Today, Yesterday, This Week, Last Week, or any other available option there as per your requirement.

  2. Click the APPLY FILTERS button.

    Note: You can use Search By Dates and Filter By Order Status criteria in a combination and all other criteria are disabled.
    ResultOrders are displayed with the applied filters on the Find orders window.
Filter By Order Status
    Procedure
  1. On the Select order status, select the following checkboxes as per your requirement:

    • OPD

    • OPD Error

    • Execution

    • Completed

    • Suspending

    • Suspended

    • Canceled

    • Pre qualification failed

    • Feasibility

    • Blocked

  2. Click the APPLY FILTERS button.

    Note: You can use Search By Dates and Filter By Order Status criteria in a combination and all other criteria are disabled. You can also add multiple statuses in one filter criteria.
    ResultOrders are displayed with the applied filters on the Find orders window.
Search By Custom Headers
    Procedure
  1. On the Order Headers or Order Lines, enter the details in the Name and Value fields.

    Note: You can use either Order Headers or Order Lines at a time. You can add new rows of the headers by clicking the ADD  icon.
  2. Click the APPLY FILTERS button.

    Note: You can use Search By Dates and Filter By Order Status criteria in a combination and all other criteria are disabled.
    ResultOrders are displayed with the applied filters on the Find orders window.

Plan Level Search Criteria

The plans can be searched by using the following criteria:

Search By IDs
    Procedure
  1. From the Select Type dropdown list, choose Plan ID, Order ID, Order Ref, Process component ID, or Process component Name as per your requirement.

  2. Enter the details in the Provide IDs field.

    Note: You can add multiple IDs separated by comma in this field.
  3. Click the APPLY FILTERS button.

    Note: When you use Search By IDs criteria, all other criteria are disabled.
    ResultOrders are displayed with the applied filters on the Find orders window.
Search By Dates
    Procedure
  1. On the Select Start and End date, choose Today, Yesterday, This Week, Last Week, or any other available option there as per your requirement.

  2. Click the APPLY FILTERS button.

    Note: You can use Search By Dates and Filter By Status criteria in a combination and all other criteria are disabled.
    ResultOrders are displayed with the applied filters on the Find orders window.
Filter By Status
    Procedure
  1. Select the following Plan status or Plan item status checkboxes as per your requirement:

    Note: You can use either Plan status or Plan item status at a time.

    Plan Status

    • Execution

    • Completed

    • Suspending

    • Suspended

    • Canceled

    • Withdraw

    Plan Item Status

    • Pending

    • Execution

    • Completed

    • Suspended

    • Canceled

    • Error Handler

    • Error

  2. Click the APPLY FILTERS button.

    Note: You can use Search By Dates and Filter By Status criteria in a combination and all other criteria are disabled. You can also add multiple statuses in the search criteria.
    ResultOrders are displayed with the applied filters on the Find orders window.
Clearing and Saving a Search

To clear a search criteria, click the clear filters icon.

To save a search criteria, click the save search icon.

Note: While saving a search criteria, you can select the Private or Shared radio button. If you select Private, the search criteria are not visible to other users. If you select Shared, the search criteria are visible to other users.
Editing and Deleting Saved Search

    Procedure
  1. Click the Saved Searches tab on the left panel. A window opens showing all the saved search criteria.

  2. Click the edit icon to modify or the delete icon to remove a search criteria.

    Note: Only the owner of the created criteria can edit or delete a search criteria.

Work Tray

Whenever you select a non-final state order from the Find orders window, the order is displayed on Worktray. This indicates that you are working on that particular order. Similarly, you can clear an order from Worktray.

On the Worktray window, click CONTINUE. The orders are displayed in a new window.

The orders chosen in the Selected orders window are reflected in the comparison Donut charts on the right.

The Take an action button has dropdown options as Cancel, Resume, Suspend, Withdraw, and Retry. Expand the Take an Action dropdown menu from the top-right corner and select the desired bulk action.

Note: In the $OM_ HOME/seed-data/app-properties/ConfigValues_OMSUI.JSON file, you can set the operation.roles.amendOrder property, which is used to allow the types of user to perform amendment on Order Management System UI.

Click the refresh icon to synchronize the selected orders.

Once an action is applied, the action details can be viewed on the In progress jobs tab. The Job ID, Action, Job Details, and Orders fields are shown here.

From the In progress jobs tab, you can view order details of a particular order by clicking the Order IDs hyperlink.

Note: Select two or more orders to view the comparison Donut charts and to take actions on order or plan items.
Orders

When you click the Order ID hyperlink, a new window opens with all the details about that particular order.

Note: The hyperlinks are disabled for the orders which are in final state. The hyperlinks work only for active orders. Withdrawn orders do not appear on the OMSUI.

Order Homepage

The following information is available on the Order Homepage tab:

  • Basic info (order and plan)

  • Status (order and plan)

  • Location (invoice address and delivery address)

  • Dates (order and plan)

  • Custom headers

  • Plan

  • Amendments (all amendments with clickable links to navigate to the amended order)

You can edit a suspended order to apply various amendments to the same.

Note: Only the user roles those are set for the operation.roles.amendOrder property under the "Application Security" category in the $OM_HOME/seed-data\app-properties/ConfigValues_OMSUI.json file, can amend orders on the OMS UI.

When you open a suspended order, an edit button is shown on the top-right corner for the Order Homepage and Order Lines tabs. By clicking the edit button, you can perform various amendments to the orders.

On the Order Homepage tab, edit the Required by field on the Dates section and information on the Custom headers section. You can edit any one out of these two sections at a time and need to restore the same before doing any edit on the other section.

  • Add a new order line:

    On the Order Lines tab, click the edit button on the top-right corner. Click the add button, and then click the create button to create an order line or click the copy button to copy an existing order line.

    When you create an order line, initially a random line number is given to the order line. Fill all the required values in the Order line Details, Custom headers, and Location sections.

    When you copy an order line, the values in the Order line Details, Custom headers, and Location sections are pre-populated from the parent one. You can edit the fields with the required values.

    In the Order line Details section, you must provide a valid Product ID. You can click the VALIDATE button to check the validity of the product ID.

    In the Location section, select the Same as delivery address checkbox if both the delivery and invoice addresses are the same.

    After filling out all the required details, click the button. If there are some errors, those are shown as pop-up messages on the UI, and you can fix those.

    If there are no errors, the Preview Amendment window shows the old and new values. If there are no further changes, click the SAVE button and the new order line is added.

    If you do not want a particular order line, you can remove the same by clicking the Delete icon.

  • Edit an existing order line:

    On the Order Lines tab, click the edit button on the top-right corner. Click an existing order line that you want to edit.

    You can edit any one section from Order line Details or Custom headers at a time and need to restore the same before doing any edit on the other section.

    On the Order line Details section, you can update the Action and Require by fields only.

    After filling out all the required details, click the button. If there are some errors, those are shown as pop-up messages on the UI, and you can fix those.

    If there are no errors, the Preview Amendment window shows the old and new values. If there are no further changes, click the SAVE button and the changes are updated.

Order Lines

The following information is available on the Order Lines tab:

  • Order Line

  • Order Line Details

  • Custom headers

  • Location (invoice address and delivery address)

Click the settings icon and select the Pin Order Lines Table checkbox to make the order lines scrollable. By default, the order lines are shown across the pages. You can hide or show the desired columns from the Column Picker option.

You can search an order line by Line, Product ID, or Status on the search box.

Plan Items

The following information is available on the Plan Items tab:

  • Plan ID

  • Plan items Details

  • Process component information

  • Custom headers

  • Milestones (shows the dependencies if present)

Click the settings icon and select the Pin Plan Items table checkbox to make the plan items scrollable. By default, the plan items are shown across the pages. Similarly, you can select the Non executing plan items checkbox to show or hide the non-executing plan items. You can hide or show the desired columns from the Column Picker option.

You can search a plan item by ID, Plan Item Name, or Status on the search box.

You can take the Retry, Resume, or Complete action on the plan item with an error state.

Plan Items Dependencies

The Plan Items Dependencies tab shows the dependencies between milestones in a graphical representation.

You can choose the Grid view or Tree view by selecting the radio button on the top-right side. The Grid view is very helpful to show the dependencies efficiently if there are a large number of plan items.

You can click the link icon to see the dependent plan item. When you click a plan item tile, it expands and shows the milestones. Right-click on a plan item tile to open the Plan item details window, where it shows in-depth details.

Click the zoom-in or zoom-out button on the right side to view the page as per your requirements.

Note: The zooming functionality works best with the Google Chrome browser and there might be some issues with other browser.

Click the sort icon to sort the plan-items based on dependencies.

Click the help icon to view the legend for the milestones (for example, START, PENDING, EXECUTION) with color coding.

Right-click on a node to view the complete details about the item.

Click the download icon to save the dependency view as an image.

Click the settings icon to show or hide various options as per your requirements.

You can choose the page you need from the top. This makes it easier to manage large amounts of data.

Order Composition

The Order Composition tab shows how a particular order is decomposed into various items in a flow chart.

When there are multiple levels of order lines in a catalog hierarchy, it delays significantly to load all levels of order lines. To overcome this issue, only the first levels of order lines are loaded initially on the UI. To see the next level of order lines, click the expand button at the bottom of the first-level order lines. Similarly, you can continue expanding for all the levels of order lines. You can collapse a level of order line by clicking the collapse button at the top of that level order line.

The order planId is sent from the OMS UI to the AOPD server.

In AOPD services, from planId, the services fetch the plans and generate a hierarchical response for the particular order. The response is then used to create the order composition chart on the UI.

To Order Composition view uses the following endpoint of AOPD:

/v1/plan/product/hierarchy

HTTP POST method is used for this endpoint. In request body, it takes AOPD plan and generates a JSON response that has parent-child relationship. The output of this endpoint is used to draw the Order Composition tree.

You can click an item to view more details.

Plan Timeline

The Plan Timeline tab shows the timeline of a plan in a chart. You can choose the plan item display names from the settings icon.

Activity Log

The Activity Log tab shows various transitions of the order.

You can select or clear the checkboxes for Order, Orderline, Plan, Planitem, OrderAmendment, and Generic to view the related logs that you want. The log shows details such as Date & Time, Ref. ID, Type, Origin, and Message.

Pending Tasks

You can re-trigger any pending task for a non-final state orders through the Pending Tasks tab.

All the pending tasks are shown on this tab. Before re-triggering a pending task, you can select the required state from the Reply dropdown options.

Depending on the Pending Task, the Retrigger function and Reply dropdown options varies. The following table shows such pending tasks and their available options.

Pending Task Retrigger Reply Result
PLAN_ITEM_EXECUTE_REQUEST RE-TRIGGER

Complete

Error / Error Handler

In case of re-trigger option, the application sends planItemExecuteRequest again to the southbound system.

In case of reply option, plan item goes to complete state or error / error_handler state based on the selected option.

PLAN_ITEM_SUSPEND_REQUEST SUSPEND - Plan item goes to the suspended state.
PLAN_ITEM_ACTIVATE_REQUEST RE-TRIGGER

Complete

Error / Error Handler

In case of re-trigger option, application sends planItemExecuteRequest again to the southbound system.

In case of reply option, plan item goes to complete state or error / error_handler state based on the selected option.

PLAN_ITEM_FAILED_REQUEST RE-TRIGGER - In case of re-trigger, the application sends PLAN_ITEM_FAILED_REQUEST again.
ORDER_FEASIBILITY RE-TRIGGER - In case of re-trigger, the application sends ORDER_FEASIBILITY again.
AMEND_ORDER_FEASIBILITY RE-TRIGGER - In case of re-trigger, the application sends AMEND_ORDER_FEASIBILITY again.
MILESTONE_RELEASE_REQUEST RE-TRIGGER - In case of re-trigger, the application sends MILESTONE_RELEASE_REQUEST again.
PRE_QUALIFICATION_FAILED RE-TRIGGER - In case of re-trigger, the application sends PRE_QUALIFICATION_FAILED again.

You can hide or show the desired columns from the Column Picker option.

Plan items

Add non-final state orders in the Worktray from Find orders table and click CONTINUE.

On this window, all the plan items are displayed that are chosen on the Selected orders window.

Also, plan items can be searched with their order ID or plan ID on the search box.

You can select the checkboxes against the Show error based only component to view the plan items with error state. When plan items with error states are filtered out, the Take an action button is enabled with the dropdown options as Retry, Resume, and Complete. You can take an action as required.