Application Guide for Oracle Self-Service E-Billing (Business Edition) > Using Hierarchies >

Managing a Hierarchy


This topic describes the user interface for managing a hierarchy and the behavior of associated actions. Table 66 lists and describes the use case functions.

Table 66. Managing a Hierarchy
Function
Description

Name

Managing a Hierarchy

Users

Business administrator user and business manager user

Trigger

  • My Account tab: Hierarchy tab
  • Manage subtab

Form Elements

Top Pane: Hierarchy Context and Search Criteria

(If there is no user-specified default hierarchy type and hierarchy name, Oracle Self-Service E-Billing uses the first billing hierarchy in the hit list as the default.)

Form elements include:

  • Hierarchy Type (Required. Default: Current Context or user's Default Hierarchy for start of session. If no default is specified then the list is populated with Billing.)

    Options:

    • Billing (Default)
    • Organization (Replace business with organization to make it visually different from billing to reduce confusion.)
  • Hierarchy Name (Required. Default: Current context or user's default hierarchy for start of session. If no default is specified then the list is populated with Select.)

    List is populated with hierarchy names stored in Oracle Self-Service E-Billing based on the current hierarchy type.

  • Period (Required: Default: Current context default: Current month):
    • List Options: (monthly, up to 12 periods, configurable for more or fewer periods).
    • The text string 'Unpublished' is displayed in the period list for unpublished hierarchies.
  • Element: (Optional: Default: Select). Types of elements that can be assigned to the hierarchy.

    List Options:

    • When Billing Hierarchy Type is selected:
      • Company
      • Accounts
      • Service Agreements
      • Users
    • When Organization Type is selected:
      • Groups
      • Service Agreements
      • Users

Form Elements

      • Groups
      • Accounts
      • Users
  • Status: (Optional: Default: Select - Required if element type is specified). Status of elements that can be assigned to the hierarchy.

    List Options:

    • When Company or Groups Element is selected: Assigned only.
    • When Users Element is selected: Assigned, Unassigned, Authorized, and Unauthorized.
    • When Accounts or Services Elements are selected: Assigned, Unassigned.
  • Attribute: (Optional. Default: Select). Selections in this list repopulate dependent upon what attributes are available for Element chosen.

    List Option:

    • When Element is specified, the list of Attributes is updated to display all attributes both standard and custom to be used in filtering the hierarchy search values
  • Keyword: (Optional. Default: Blank). Freeform text field that enable further filtering of search results. The list is queried with a default exact match search. Wildcard might be used to create other searches:
    • Exact match. String (no wildcards)
    • Starts with. String* (wildcard at the end)
    • Ends with. *String (wildcard at the beginning)
    • Contains. *string* (wildcard at both the beginning and end)
  • Search Radio buttons. (Default: From Current Location). Specifies the scope of the search, entire hierarchy or from the current position and below.

    Options:

    • From Current Location (Default)
    • Entire Hierarchy
  • Instructional text: Please select hierarchy criteria.

Form Elements

Bottom Left Pane

  • Hierarchy Tree View tab
    • Set Position Action. The set position action allows the current context whether it is the root node or some lower position to be set for use in other parts of the application such as payment or analytics.
    • Hierarchy displayed matches the hierarchy context including hierarchy type, hierarchy name, and period.
    • The Hierarchy is displayed with the root node and the elements one level below.
      • If the number of nodes in the current group is more than a threshold amount, the result set is paged allowing the user to navigate to the next group or previous group of nodes.
      • If the node is a grouping node such as Company, Account, Cost Center, or Group and the object has at least one child an expand option icon is displayed (+).
      • If the object has been expanded the collapse icon is displayed (-)
      • If the object does not contain any children no expand or collapse icon is shown.

Form Elements

  • Preferences tab
    • About
      • Create Date
      • Created By
      • Modified Date. This is the date last modified.
      • Modified By. This is the name of the user that made the last modification.
    • Set Default. The user can set his or her default hierarchy for one of the following areas:
      • Billing. Hierarchy type and name. This is the default value.
      • Payment. Hierarchy type and name.
      • Reporting. Hierarchy type and name
    • Set Attributes. Specify the hierarchy attribute display and sort order.
      • A checkbox for the display or hide attribute. The default is the Display Name).
      • A list for up to three attributes. Only Display Name is selected in the first drop-down.
      • A radio button for ascending or descending sort order. The default is ascending.
    • Hierarchy settings.
      • Number of items in a group that triggers paging. The default is 50.
      • Number of items in a page. The default is 10.

Form Elements

Bottom Right Pane: Details Subtab

(All fields are pre-populated with previously stored information.)

  • List of Attributes and values that correspond to the selected link target object in the hierarchy tree view. The attributes contain both default and custom fields.
    • The Attribute Labels included in the list contain both standard and custom attributes.
    • If the labels for the attributes are fixed then the default attribute label will be 'Custom 1', 'Custom 2', and so on.
    • If the labels are customizable then the customer specified label will be displayed in place of the default labels.
  • Attribute values might be displayed as (The editing method is configurable on an individual link target object and attribute level):
    • Text. The value is fixed and might not be changed by the user (Default).
    • Text entry box. The value might be changed by the user by erasing and entering a new value or editing the current value. The Submit action writes the changes to the database.
    • List. The value might only contain predefined values that are displayed as a list.

Form Elements

Bottom Right Pane: Elements Subtab

  • Results header (start to end-of-total) 1 - 50 of 1000.
    • The number of displayed results of the total of all results that match the search criteria.
    • When changing the page the results update (51 - 100 of 1000).
    • If the search results in more than a threshold number of results, the user is notified that there are only first 1000 records that match the criteria and prompted to refine the search criteria to reduce the number of records in the result set. 1000 is a configurable number.
  • Page number of total pages: Page | |< 1 of 20 >| >>|.
    • First page: |
    • Previous page: |<
    • Next page: >|
    • Last page: >>|
  • Check Box (header row).
    • Selects all records on the result set, not just the current page.
    • Uncheck deselects all records in the current result set.
  • Check Box (record row).
    • Selects and individual record, which is persisted when paging.
    • Uncheck deselects the individual row
  • Row record displays.
    • Element display name.
    • Location of the element in the current hierarchy.
      • Location is the display name of the parent node
      • Location might be displayed as root if the current node is the root node (therefore it does not have a parent)
      • Location might be unassigned if it is not current part of the current hierarchy
      • Location might be a virtual node display name
    • Link to Search page for more information.

Form Elements

Bottom Right Pane: Move Subtab

  • Displays an identical tree view compared with the left pane except the nodes have a checkbox next to each element.
  • Checkbox (group or cost center node).
    • Selects the current node and all the child nodes below it.
    • Uncheck deselects the current node and all the child nodes below it.
  • Checkbox (child branch).
    • Selects the individual child node.
    • Uncheck deselects the individual child node.

Bottom Right Pane: Create Subtab (New)

  • Displays a list to select the object to be created.
  • The group or folder only exists in the current hierarchy.

    NOTE:  Since group is the only object in the preconfigured application the list is suppressed. The Billing and Payment application can be customized to enable any number of objects that might be interactively created such as cost centers.

  • When an object type has been selected, the pane below lists the attributes and the entry widgets (group).
    • Display name
    • Description
    • Attribute 1 through attribute 5

Report Content

Results Fields Details Subtab

  • Name (Display name of element type).
  • Attributes of the current element (Default: the root node of the current hierarchy).

Note

A cost center, location, and region are optional link-target types similar to the default group element.

Business Rules

General

  • When the user selects the Manage tab, the current hierarchy context is displayed at the top with the Tree View and Details panes blank. The user must select submit before Oracle Self-Service E-Billing retrieves the data.
  • The current position including the hierarchy type, hierarchy name, period, and position are not carried throughout the session The user must select the Set Position action to store the hierarchy context for other parts of the application. The set position is reset to the defaults each time the hierarchy context is changed.
  • Hierarchy Access Control: Users can only view hierarchies to which they have been assigned and positions at or below the positions to which they have been assigned. Users cannot view hierarchy nodes to which they have not been granted view access privileges.

Bottom Left Pane: Tree View of Hierarchy

  • If the hierarchy is modified, the fields Last Modified and Modified By are updated.
  • If a position is selected, the position is highlighted and set to the current hierarchy focus for actions.
  • If the expand or collapse icon is selected, the position is highlighted and set to the current hierarchy focus and the group expands or collapses opposite action to the status when selected.
  • If a node is empty, there will be no expand or collapse arrow next to the node.

Bottom Right Pane: Details, Element, Move, Create Subtabs

  • If the user selects the checkbox in the row of the column headers of the search results, all items of the search results become selected.
  • If the user selects the checkbox next to a node in the Move subtab, all elements below it are selected.
  • If Element is unassigned, it can be added to the hierarchy.
  • If Element is assigned, it can be removed from the hierarchy.
  • If Element is a Group type (created using the Create function in Hierarchy) the Delete action is available. For all other elements, the Remove action is available because billing elements might not be deleted from Oracle Self-Service E-Billing. Instead, billing elements can only be removed from the current organizational hierarchy.
  • If text field box exists (or a list presented), the attribute is editable otherwise the field is fixed and can only be update through billing data or attribute data load files. Results field for the search criteria specified is updated according to action performed.

Main Path for Managing a Hierarchy

The following path describes the Managing a Hierarchy use case:

1 The user selects Manage subtab.
  1. Oracle Self-Service E-Billing returns a page displaying:
    • Top Pane: The current hierarchy context or default context.
    • Bottom Left Pane: The blank tree view.
    • Bottom Right Pane: The blank details tab.
  2. The user is prompted to submit the hierarchy context to populate tree view and details.

Alternate Paths for Managing a Hierarchy

Alternate paths can occur in this use case.

The user changes the Hierarchy Type in the drop-down
1 The user changes the current Hierarchy Type selection.
  1. Oracle Self-Service E-Billing prompts the user to select a name for that type, makes all other context and search boxes unselectable, makes the lower left Tree View and lower right Detail panes blank, and disables the Submit button.
  2. The user must complete the context name and period.
  3. Reset restores the previous context and the user clicks Submit.
The user changes the Hierarchy Name in the drop-down
1 The user changes the current Hierarchy Name selection.
  1. If the list of names for the type is less than or equal to 50, then Oracle Self-Service E-Billing displays the selection in a drop-down.
  2. If the list of names for the type is greater than 50, Oracle Self-Service E-Billing opens a selection page listing the name and some attributes (created by, status (published or unpublished) with a radio button to select a hierarchy name.
  3. Oracle Self-Service E-Billing prompts the user to select a period for that hierarchy, makes all other context and search boxes unselectable, makes the lower left Tree View and lower right panes blank, and disables the Submit button.
  4. The user must complete the context (Period) before selecting submit to display the results.
  5. Reset restores the previous context and enables the Submit button.
The user changes the Period in the drop-down
1 The user changes the current Period selection.
  1. Oracle Self-Service E-Billing enables the Element selection list and makes all other search boxes unselectable, and makes the lower left Tree View and lower right panes blank and Submit is enabled.
  2. The user selects submit to display the results (with or without selecting an Element).
  3. Reset restores the previous context, which enables the Submit button. The user submits the new hierarchy context and resets any previous set position context values to the root of the new hierarchy context.
  4. Oracle Self-Service E-Billing updates the lower left Tree view and displays the Details for the default node.
The user changes an element from the drop-down
1 The user changes the Element type from the drop-down.
  1. Oracle Self-Service E-Billing clears the values in the status, attribute, and keyword search, makes them unselectable, and makes the lower right Element pane blank - lower left Tree View pane is unchanged.
  2. The user selects an element from the drop-down.
  3. Oracle Self-Service E-Billing enables the status drop-down.
  4. The user must select both an element and status before submitting to display the element results. Reset restores the previous context and enables the Submit button.
The user changes a status from the drop-down
1 The user changes the Status from the list based on the status values for the current Element selection.
  1. Oracle Self-Service E-Billing makes the lower right Elements pane blank - lower left Tree View pane is unchanged.
  2. The user selects a status from the list and Oracle Self-Service E-Billing enables the Attribute list and the Submit button.
  3. The user selects submit to display the results. Reset restores the previous context and enables the Submit button.
  4. Oracle Self-Service E-Billing displays the results in the Elements tab list.
The user changes the Attribute name from the drop-down
1 The user changes the Attribute from the list based on the list available for the current Element selection.
  1. Oracle Self-Service E-Billing clears the key word field and makes the lower right Elements pane blank - lower left Tree View pane is unchanged.
  2. The user selects Submit to display the results.
  3. Oracle Self-Service E-Billing displays the results in the Elements tab list.
The user enters or edits a Key Word in the text box
1 The user enters or edits the key word in the text box.
  1. The user selects Submit to display the results.
  2. Oracle Self-Service E-Billing displays the results in the Elements tab list.
The user selects entire hierarchy search or current position
1 Default setting is Element search from the current position in the hierarchy and below.
  1. The user might specify an entire hierarchy to execute Element searches from either the root node of the hierarchy or the highest node in the hierarchy the user has access to (including virtual nodes).
The user selects Set Position
1 The current hierarchy context is stored for use in other areas of the E-Billing application such as statement, payment, or reporting.
  1. The set position is reset when a user either changes the hierarchy context or selects set position again within the same hierarchy.

    Only one set position is stored for a user session.

The user selects link of the display name in the Elements subtab

Oracle Self-Service E-Billing returns the user to the Details subtab displaying attributes and values for the selected link target or user.

The user selects link of a position in the Elements subtab

Oracle Self-Service E-Billing highlights the position of the selected item in the Tree View of the hierarchy and sets the node as the current hierarchy focus. If the position is Unassigned and the Display Unassigned in Hierarchy checkbox is not checked, the Unassigned position is not linkable.

The user expands and collapses the hierarchy branch by selecting on the arrow in the graphical view of the current hierarchy

Oracle Self-Service E-Billing invokes Collapse and Expand Hierarchy use case.

User pages the hierarchy Tree View by selecting next or previous page icon

Oracle Self-Service E-Billing updates the display showing the requested page.

The user selects the Create subtab

Oracle Self-Service E-Billing invokes Create Element use case.

The user selects the Details subtab

Oracle Self-Service E-Billing returns the user to the Details subtab displaying attributes for the link target or user that is the current hierarchy focus in the Tree view

The user selects Delete or Remove action in the Details or Element subtabs
1 Oracle Self-Service E-Billing invokes Remove Element use case.
  1. Alternate Paths: The user modifies attributes in the Details subtab:
  2. Oracle Self-Service E-Billing saves changes when the user clicks Submit.
Oracle Self-Service E-Billing invokes the Modify Element Attributes use case. The user selects Add action in the Element subtab

Oracle Self-Service E-Billing invokes the Add Element use case.

The user selects column header links in the Element subtab

Oracle Self-Service E-Billing invokes the Sorting use case.

The user selects Move subtab

Oracle Self-Service E-Billing invokes Move use case.

The user selects Reset action

Oracle Self-Service E-Billing clears entries or selection and restores the previous values or context.

Exceptions

Exceptions can occur with this use case.

The user encounters a validation error

Oracle Self-Service E-Billing invokes the Validation error message use case.

The user encounters a server system error

Oracle Self-Service E-Billing invokes the error message use case.

Application Guide for Oracle Self-Service E-Billing (Business Edition) Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices.