Billing To Do Dashboard

This portal provides a high-level summary of To Do Entry counts by various criteria. It is intended for supervisor To Do users. An implementation may introduce additional zones to this portal as needed.

The To Do Entry counts are retrieved from statistics snapshots. Refer to the following statistics snapshot business objects in the application, for more information:
  • C1-NCToDoPerBillCycleSnapshot - Non-Complete To Dos Per Bill Cycle Snapshot
  • C1-NCToDoPerMessageSnapshot - Non-Complete To Dos Per Message Snapshot
For information about capturing statistics, refer to Capturing Statistics

The zones display the counts of To Do Entries of To Do Types with the 'Billing' To Do Type Category (F1-TDCAT) predefined characteristic. The base product provides the C1BILL characteristic value, for this purpose.

Use Main Menu > To Do > Billing To Do Dashboard to navigate to the portal.

Note: The Billing To Do Dashboard Configuration master configuration can be optionally configured with settings that control how the statistics are shown on this portal - i.e. maximum number of open bill cycles to retrieve, display mode (messages vs. message groups), message groups (list), maximum number of messages to retrieve and maximum number of messages groups to retrieve. This master configuration is optional. If not configured, the statistics snapshots will run with the assumed defaults. Refer to the master configuration's embedded help, for more information.

The following zones may appear as part of the portal's Main tab page:

  • Non-Complete To Dos Per Bill Cycle. This zone contains a table/grid that summarizes To Do entry counts by To Do Role and bill cycle Window End Date. It displays the count for each open bill cycle and a single count for To Dos associated with closed bill cycles (i.e., under the Past Due column). Use the filters, to further restrict the counts shown.
    • The statistics are restricted by the To Do characteristics: Account (C1-ACCT) and Bill Cycle (C1-BILCY).
    • The maximum number of open bill cycles to retrieve is configurable in the Billing To Do Dashboard master configuration. If not configured, the assumed default is ten (10) open bill cycles.
    • Refer to the Calculate Non-Complete To Dos Per Bill Cycle (C1CALCTDBC) algorithm, for more information.
    • Selecting a count from this zone will navigate to the Details tab page, where the To Do Entries for that count are listed, using the Bill Cycle query.
  • Non-Complete To Dos Per Message. This zone contains a row chart that summarizes To Do entry counts by either message category and message number, or by message group (if applicable). Use the filters, to further restrict the counts shown.
    • The Display Mode in the Billing To Do Dashboard master configuration controls how the statistics are shown on this zone. If the master configuration does not exist, the assumed display mode is by message category and message number.
    • The Message Groups display mode is useful when the volume of billing-related To Do message numbers is large. One or more message groups can be defined in the master configuration. Each message group defines one or more related message numbers.
    • The maximum number of messages to retrieve is configurable. If not configured, the assumed limit is 50 message numbers.
    • The maximum number of message groups to retrieve is configurable. If not configured, the assumed limit is 25 message groups.
    • Refer to the Calculate Non-Complete To Dos Per Message (C1CALCTDMSG) algorithm, for more information.
    • Selecting a count (bar) from the chart will navigate to the Details tab page, where the To Do Entries for that count are listed, using the Message query.

Billing To Do Details

The Details multi-query zone allows you to view the To Do entry list for a selected statistics count (from the Main tab), and to perform actions on selected records. Each query supports the unique information that each statistics snapshot contains:
  • Search by Bill Cycle. This query is used when navigating from the Non-Complete To Dos Per Bill Cycle zone. It includes filters for: Bill Cycle and Window End Date (date range).
  • Search by Message. This query is used when navigating from the Non-Complete To Dos Per Message zone. It includes filters for: Message Category, Message Number and Message Group. The display mode controls filter visibility.

The following sections describe the features of this tab page portal.

Search By Bill Cycle - Filters

The following table describes each of the query filters.

Search Filter Description
To Do Type

Use this filter to restrict the search to To Do entries of a specific type. Only To Do Types where the user is a member of at least one valid role for the type will be available for selection.

To Do Role

This is defaulted to the selected To Do Role (from the Non-Complete To Dos Per Bill Cycle zone). Only To Do Roles where the user is a member of will be available for selection.

Bill Cycle

Use this filter to restrict the search to To Do entries of a specific Bill Cycle.

From Window End Date, To Window End Date

Use this filter to restrict the search to To Do entries of a specific Window End Date range.

CIS Division

Use this filter to restrict the search to To Do entries of a specific CIS Division.

Customer Class

Use this filter to restrict the search to To Do entries of a specific Customer Class.

Status

Use this filter to restrict the search to To Do entries with a status of Open , Assigned, In Progress or On Hold. If you choose Assigned, then it includes the To Do entries that are In Progress and On Hold. Note that the underlying query excludes completed To Do entries.

Days Old

This option lists the To Do Summary age ranges as set up for the user. Select a specific age range to restrict the search to To Do entries whose age falls within the given range in days.

Priority

Use this filter to restrict the search to To Do entries with a specific priority.

Key Value

Use this filter to restrict the search to To Do entries with a sort key value containing the entered value.

Assign To User

Use this filter to restrict the search to To Do entries assigned to a particular user. This filter only appears if the current user has To Do supervisor access.

Message

Use this filter to restrict the search to To Do entries with a specific message. This filter appears after the To Do Type filter has been populated and shows a list of the message texts from all non closed To Do entries of the selected To Do Type.

Characteristic

Use these filters to restrict the search to To Do entries with a specific Characteristic Type and value. Up to five characteristic type and value pairs may be entered. For manual To Do types, the list of characteristic types will be restricted to the characteristic types defined for the To Do Type. For automated To Do Types, if valid To Do characteristic types are configured for the To Do type, only those are shown; otherwise, all valid characteristic types for the To Do Entry entity are shown.

Search By Message - Filters

The following table describes each of the query filters.

Search Filter Description
To Do Type

Use this filter to restrict the search to To Do entries of a specific type. Only To Do Types where the user is a member of at least one valid role for the type will be available for selection.

To Do Role

Use this filter to restrict the search to To Do entries of a specific To Do Role. Only To Do Roles where the user is a member of will be available for selection.

Message Category, Message Number

Use this filter to restrict the search to To Do entries of a Message Category and Message Number. These filters are available when the Display Mode is Messages (either specified in Billing To Do Dashboard Configuration master configuration or the assumed default in effect).

Message Group

Use this filter to restrict the search to To Do entries of a specific Message Group. This filter is available when the Display Mode is Message Groups that is configured in the Billing To Do Dashboard Configuration master configuration.

CIS Division

Use this filter to restrict the search to To Do entries of a specific CIS Division.

Customer Class

Use this filter to restrict the search to To Do entries of a specific Customer Class.

Status

Use this filter to restrict the search to To Do entries with a status of Open , Assigned, In Progress or On Hold. If you choose Assigned, then it includes the To Do entries that are In Progress and On Hold. Note that the underlying query excludes completed To Do entries.

Days Old

This option lists the To Do Summary age ranges as set up for the user. Select a specific age range to restrict the search to To Do entries whose age falls within the given range in days.

Priority

Use this filter to restrict the search to To Do entries with a specific priority.

Key Value

Use this filter to restrict the search to To Do entries with a sort key value containing the entered value.

Assign To User

Use this filter to restrict the search to To Do entries assigned to a particular user. This filter only appears if the current user has To Do supervisor access.

Characteristic

Use these filters to restrict the search to To Do entries with a specific Characteristic Type and value. Up to five characteristic type and value pairs may be entered. For manual To Do types, the list of characteristic types will be restricted to the characteristic types defined for the To Do Type. For automated To Do Types, if valid To Do characteristic types are configured for the To Do Type, only those are shown; otherwise, all valid characteristic types for the To Do Entry entity are shown.

The system shows the total number of To Do entries displayed and the total number that satisfy your search criteria immediately below the set of results.

Note: For performance reasons, the search zone is configured to restrict the number of rows retrieved by the query. The 'Total Records' number will indicate whether there are more To Do entries that meet the criteria than can be displayed.

Search Results

The zone will display all To Do entries that meet the search criteria, up to the limit defined as a parameter to the zone. The following columns are displayed initially:

  • The Action column includes the Work button. Click this button to drill into the page on which the entry’s respective object is displayed. If the To Do type has been configured to associate a script with this To Do entry's message number, then instead of being taken to the respective page, the associated script is launched. Refer to What Happens When You Work A To Do Entry for more information.

    Important: Automatic Assignment When you click the Work button for an open entry, the system changes the status of the entry to Assigned / In Progress and assigns it to you. It also causes this To Do entry to be your current To Do. Refer to Working On A To Do for more information.
    Note: Work List. This column has a Work List icon. Clicking this icon populates the Work List zone with the results. Clicking on entries in the Work List zone performs all the logic described here when clicking the Work button for one entry. It will drill into the related object or launch a script, if configured. It will make this To Do the 'current' To Do, it will assign it to you if it is Open and update it to In Progress.
    Note: Only 1 In Progress To Do entry. If you had a different To Do entry in progress before clicking the Work button, the other To Do entry will be put On Hold.
  • Entries are sorted by their Priority. Highest in priority are listed first.

  • Days Old is the number of days since the To Do entry was created by the system. Entries are sorted from youngest to oldest within priority.

  • Status is the current status of the To Do entry. If the assignment substatus is populated, that value is displayed, otherwise the To Do entry status is displayed.

  • Assign To User is the user currently assigned to the To Do entry.

  • Message is the message associated with the To Do entry.

  • Related displays a count of entries that are potentially related to the current entry based on having the same foreign key characteristic values. Click the hyperlink to navigate to the To Do Search page with the current entry as the Related To Do Filter value.

  • Note displays a Comment icon Comments icon if there are either comments or a log entry of type Forwarded, Sent Back or User Details on the To Do Entry. Click the icon to open a pop-up window which displays the To Do entry information, message, comments and logs.

  • Characteristics displays the characteristic types and values for the entry as a concatenated string.

  • Related Entity displays the information for the object related to this entry. The information string allows you to navigate to the page on which the entry's respective object is displayed.

  • To Do ID is the system generated key of the entry. Click the hyperlink to navigate to the To Do Entry page to view or maintain the current entry.

Click the Column Configuration icon Compass in the zone header to show the Column Configuration Area in which additional columns can be added to the results. The additional columns include the following:

  • Create Date/Time contains the date and time the To Do entry was created by the system.

  • Key 1 to Key 5 contain the first five sort key values for the entry.

Actions

The zone provides the ability to perform certain actions on one or more selected To Do Entries.

Click the check box in the results list heading to select all entries displayed in the grid or click the box in a row to select a specific entry. The following actions are available:

  • Use the Update button to open a pop-up window in which you can update the priority and/or add a User Details log entry to the selected To Do entries.

  • Use the Assign button to assign a user to the selected To Do entries. Supervisors will be presented with a pop-up window in which they can choose the assignee from a list of users who are members of at least one role for the To Do Type. The user search includes information about the number of To Do entries already assigned to each user. For users without supervisor access, the current user is assumed to be the assignee and the window is not displayed. Note that the system does not allow a non supervisor to assign themselves a To Do that is assigned to another user.

  • Use the Unassign button to reopen the selected To Do entries and remove the assignee. Note that the system does not allow non supervisors to reopen a To Do that is assigned to another user.

  • Use the Complete button to complete the selected To Do entries. Both supervisors and non supervisors may complete any To Do entry, including those assigned to other users.