---
title: "OneAdmin™"
type: OpenSpec
status: Draft
---
# OneAdmin™

## Overview

1. OneAdmin™ is a browser-based application framework based on which all OLS administration screen functions are implemented.
2. This section describes the admin screen functions in general.
3. OneAdmin™ provides the screen functions such as the following for users to administer OLS:

|  |  |
| --- | --- |
| * 1. Application parameters and campaign management | * 1. Creating and reviewing customer information through menus |
| * 1. Viewing and Posting of transactions for award, redeems and adjusts | * 1. Requesting for generation and viewing of reports. |
| * 1. Creating and reviewing catalogue information. | * 1. Generic Ledger management |
| * 1. Creating and reviewing merchant information | * 1. Posting of transaction testing for award, redeem and adjusts. |

1. Maintenance actions supported include:
   1. “**Add**”, to add a new record in the module or function. See section 3.6 for an illustration of the [Add](#_Add_Form) form for adding a record.
   2. “**Edit**”, to modify an existing record on the module or function. See section [Edit](#_Edit_Form) for an illustration of the Edit form for editing a record.
   3. “**Copy**”, where user can add a new record with the contents of a currently selected record: user will be prompted to change key values which are not allowed to be replicated across records. See section [Record Copy](#_Record_Copy) for an illustration of the record copy screen.
   4. “**History**” tab brings up a display of previous versions of this record. See section [History](#_Record_History) for an illustration of the History screen.
   5. “**Save**” will save the record displayed in the edit form to the database (whether it’s a new record or changes made to an existing record).
   6. “**Cancel**” will cancel the action.
   7. “**Approve**”, to accept the change of the record in the module or function.
   8. “**Reject**”, to reject the change of the record in the modue or function.
   9. “**Save as Draft**”, to temporary save the record in the module or function without publishing it.
   10. “**Save as Template**”, to save the record displayed in the form to re-use in the furture as a template.
2. When first “saved”, the record is stored with its Status set to “Pending”.
3. It has to be selected (by click on the “Pending” tab to locate records with Status = “Pending”), then clicking on the record to view and/or approve it.
4. Upon approval, the record status is set to “Active”.
5. See section [Approve](#_Approve_Pending_Record) for the process to “**Approve**” pending records.
6. “**Delete**” marks the record being displayed as deleted or “inactive”.
7. The record will be copied into a new record with its status set to “Pending”, and the original record will be left intact.
8. A user with the necessary “Approval” rights must approve the deletion for the record to be deleted and blocked from further use.
9. All updates posted through OneAdmin™ are reflected in the database immediately on approval.

## Types of Screen Layouts

1. OLS admin screen functions are generally made up of 3 types of screen layouts, each corresponding to the screen function
2. The first is the **Home Page** – there is only one of this. This screen is displayed after a successful log in.
3. The second is the **Listing** **Page**:
   1. This class of screens is displayed when module in the navigation panel (Menu) is clicked.
   2. It generally displays a default list of records that can be accessed through the module.
4. The third type of screens is the “**Details Page**” layout:
   1. This is the page displayed after a record in the Summary Listing page has been selected.
   2. It shows the details of the selected record at the field level
   3. In some cases, access to child records of the record on display is provided as tabs in the screen.
5. The general features of each type of screen layout are described in the following sub-sections.

## Home Page

1. The following figure illustrates the Home Page screen:

Main Menu

1. The left panel (navigation panel) lists the module and functions to which user has access. The actual functions available in the navigation panel vary depending on the access rights of the user id that is used to log into the system. Only the functions to which the user has access will be displayed.
2. The main display area shows charts of key statistics, pre-configured at time of deployment.
3. Each of the listed modules in the navigation panel expands when clicked to show the functions available under that module.

[Image Removed]

Figure: The “Campaign Managemetn” module in illustrates this expanded view.

This module has 07 functions – “Campaign Insight”, “Campaign”, “Campaign Rule”, “Pool Definition”, “Pool Conversion Rate”, “Counter Definition”, and “Account Type Group”.

The total number of pending records on each module is displayed on the right side of the module name.

1. Clicking on a function will bring up the summary listing page for that function: see section 3.4.

## Summary Listing Screens

1. When a function in the navigation menu is clicked, the main display area will typically show the summary listing page for that function.
2. The typical layout is illustrated in the following:

[Image Removed]

Sample Summary Listing Screen Layout

1. In the following table, the row numbers correspond to the display areas enclosed in red boxes with the same number:

| Box | Description |
| --- | --- |
|  | The name and the path of the function are displayed at the top left corner of the main display area, in this case “Campaign Management > Pool List” – i.e. the function for maintaining “Pool Definition” records. |
|  | The top right conner of the screen displays the language, with an icon of the language and language name.  To change the display language, click on the icon to choose another language. |
|  | The top right corner of the screen displays the user id and an icon of the user, with a description of the user’s access rights, i.e. the actions to which the user has access.  To leave this screen simply click on the destination module and function in the navigation menu. |
|  | The module name |
|  | The area labelled in red displays the quick search form. It contains input boxes for filtering the records to be displayed.  There are two modes of search – the **Quick search**  mode and **Filter** mode:   * The **Quick Search** mode search involves searching by key word:   + Provides users with a fast and efficient way to access search functionality without navigating through multiple pages with the selection record status in the area 7.   + Entering keyword on the text box.   + By click on the  icon or press “Enter” key to get result. The system will display the list of records where the keyword is found in any column on the listing page except date time data type coulmn, in the area labeled as box number 9.   + The search uses the "Contains" operator in a case-insensitive manner to find the matching record |
|  | The area labelled 4 in red displays the link to the advanced filter form where multiple fields can be set up as part of the search/filter criteria.   * The advanced mode involves clicking on the “**Filter**” link. * When click on the “Filter” button the advanced filter form that appears is illustrated as following:   [Image Removed]  Figure 1 – Example of the Advanced Filter Form   * When click to “Add” button the form that appears as illustrated in red box in area 2 as following:   [Image Removed]  Figure 2 – Example of the Advanced Filter when add any filter  In the red box, which represents the Advance Filter form (area 2):   * + Three purple boxes appear in the adjacent areas: area 4, area 5, and area 6.   + In the area 4, there is the “Search Field” drop-down a data field name by which to search. The system list all available **field in the listing page by the default, except “Action” and “Status” field.** * Some specific modules will need include custom filter field, that are not displayed on the listing page such as: “Customer Profile” and “Transacion History” screen. See more on its section. * Users can choose from the available data fields to narrow down their search.   + In the area 5, there is the “Search Operator”. For each data type‘s search filed then the system provides a set of “Operator” options that users can apply. These operator allow the user to specific how the field should be applied to the selected filter field.   All available operator according on each data type’s search field are described on the following table:   |  |  |  | | --- | --- | --- | | **Index** | **Data Type** | **Operator** | |  | Character | A drop dow to select following values:   * Equal * Not Equal * Empty * Not Empty * Contains * Not Contains * In * Not In | |  | Number | A drop dow to select following values:   * Equal * Not Equal * Greater Than * Less Than * Greater than Or Equal to * Less than or Equal to * Between | |  | Boolean | A drop dow to select following values:   * Equal | |  | Datetime | A drop down to select following values:   * Equal * Not Equal * Greather Than or Equal To * Less than or Equal to * Between |  * + In the area 6, there is the “Value Field”. This field can be of two types: Text box or Drop-Down. The type of value fields (text box or drop-down) displayed to users depends on the selected operator and searched field as following: * “Empty” and “Not Empty” operator should not require a value input field. * “Between” operator of Date/Time search field should require 2 value input fields with date/ time picker to allow the users to specific the range of date /time to be used in the filter query. * “Between” operator of number search field should require 2 text boxes with number format to allow user to specific the range of number to be used in the filter query. * “In” /”Not In” operator of character search field may present a drop-down list when search field is a lookup value field on that screen, meaning it is a field that fetches data from other tables in the system . The drop-donw list all active records of the search field and allow user select multiple value to be used in the filter query. * “In”/”Not In” operator of character search field may present a text box when search field is not a lookup value field on that screen. This text box should allow the user to enter multiple values, separated by input tag. * “Contain”/”Not Contain” operator of character search field shoud present a text box. This text box should allow the user to enter multiple values, separated by input tag. They system uses “\*” to match zero or more occurrences of the preceding subexpression. * All remaining operators may present a text box input filed to allow the users to enter a filter value. The system should validate the user-entered value based on the data type of the search field. * There is no sensitive case for character search fields. * All selected fields are used in an “AND” search. * On clicking the “Adanced Search” button, the list of records found to have the matching value would be displayed in area in box number 9. * Searching by “Filter” and “Status” be done together as an AND condition. * On clicking the “Reset” button, the system delete all filter field and return all records by the slection status. |
|  | This are contains three distinct tabs, each representing a different record status: Active, Pending and Rejected.  On the “Pending” tab the system show the total number of pending records next to the tab label. |
|  | This area contains the pagination control links – to page forward, backward or to navigate directly to a numbered page with the number of records displayed and the number of record in total. |
|  | This is the main display area listing the first N records within the function selected, where N defaults to a system parameter. N can be changed in drop-down box in area 8.  The top row contains the column headings, with up to N numbered rows below it.  The right-most column in are 10, inclues the actions for viewing, editing, deleting and approval the record in each row. |
|  | This area shows the number of records displayed and the number of record in total. |
|  | This is the Add button which when clicked brings up the edit form described in section 3.6, for adding a new record in the system. |

## Detail View

1. When the View icon for a row is clicked in the Summary List page as described in section 3.4, the details of the record in that row is displayed as illustrated in the following:

[Image Removed]

Figure 3 – Sample Record View Screen with Labelled Areas

[Image Removed]

Figure 4 – Sample Record History

|  |  |
| --- | --- |
| Box | Description (Refer to figure 3 and figure 4) |
|  | * This area display the name of the module with the record status and record primary key. |
|  | * Clicking on the “Copy” button brings up the view described in section 3.10. This feature provides a convenient means by which to create new records by changing existing records. The “Copy” feature is provided only for selected functions where a “Copy” action is practical. * Clicking on the “Edit” button, the fields are displayed with details of the record in that row, awaiting user input to amend the details. * Clicking on the “Delete” button brings up the pop-up to user confirm the deleted action. |
|  | * The function accessed is displayed as a tab. * If the function has data which can be categorised separately in a logical way, each category is displayed as a different tab. * This area shows the tabs available and clicking on the tab brings up the display for that category of data. |
|  | * This area shows the details of the record. |
|  | * The panel on the right/bottom displays supplementary data relating to the record in the main display area (area 5). The details in the right panel vary depending on the function. |
| 7 | * Clicking on the “Back” button brings the view back to the Summary Listing page. |
| 8 | This area shows when the record was last changed, and by whom.   * Every time a record is updated or approved, the user id that last made the change and the user id that last approved a change are logged with the record, together with the date and time of the action. * This information is always shown at the bottom of the record details screen display. * Only records with Status = “A” for Active are taken into account during transaction processing: if a record status is not active it will not be taken into account for any transaction processing. * The “Last Updated By” field shows the user id of the user who last updated this record. If the record is updated by a batch process, this field will contain the Batch Id. * The “Last Updated Date” field shows the date and time when the record was last updated. * The “Last Approved By” field shows the user id of the user who last approved this record. For updates by programs (batch processes and online transactions), this field is empty. * The “Last Approved Date” field shows the date and time when the record was last Approved. For updates by programs (batch processes and online transactions), this field is empty. |
| 9 | This area shows when the action records may can be changed   * Clicking on the “History” records will bring up the display described as in area 4. * By choose the 2 version and clicking the “Compare” button will bring up the display described in section 3.8: Record History. Feature allows for easy browsing of the changes made to the record |

## Add/ Edit Screen

1. When the Edit /add for a row is clicked in the Summary List page, the details of the record in that row is displayed in the edit form for editing, as illustrated in the following:

[Image Removed]

Figure 3 – Sample Record Edit Form with Labelled Areas

1. Each row in the following describes the correspondingly numbered area in Figure 3:

|  |  |
| --- | --- |
| Box | Description (Refer to Figure 3) |
|  | This area shows the function for which the edit form is being displayed. |
|  | This is the main edit form.   * Mandatory input fields have a coloured border on the left. * If the edit form is displayed as a result of the “Add” button being clicked in the previous screen, the fields will be displayed empty, awaiting user input * If the edit form is displayed as a result of the “Edit” button being clicked in the previous screen, the fields are displayed with details of the record in that row, awaiting user input to amend the details. |
|  | * The “Create”/”Update” button will save the changes or in the case of the “Add” action, the input data, in the database as a new record with record Status = “Pending”. Note that the record being changed (“original record”) will remain unchanged. |
|  | * The Cancel button causes any input or change made to be discarded and the display will return to the previous summary listing page. |

## Approve Pending Record

1. When a new record is first added, or when an existing record is “Changed” or “Deleted”, the new or modified record is inserted in the database with a Status set to “Pending”.
2. The original record remains active.
3. The “Pending” records must first be “Approved” by a user who has the rights to the “Approve” action for that function before the change becomes effective.
4. To “Approve” a record, the record must first be located by clicking for records with the “Pending ” tab as illustrated here:

[Image Removed]

Figure 4 – Search for Pending Records

[Image Removed]

Figure 5– Pending Record Listing

1. In change mode, the record values with and without the change are both displayed for comparison.The previous value (before change) and the modified value,that pending approval are displayed side by side, with modified fields displayed in a font of a different color, as illustrated:

* Red text highlights changes of the active record, ~~Red text~~ highlight with strikethrough effect for the deteled data.
* Green text highlights changes of the pending record.
* **Black text** denotes unchanged information in both record versions.

[Image Removed]

Figure 6 – Pending Record Displayed Side-by-side with Currently “Active” Record

1. At this point, it is possible to click on the Modify button to edit the record and save it back into the Pending list. The user who edits the record will not be able to “Approve” the change.
2. Click on the “Approve” button to put the record into active use.
3. Click on the “Reject” button to return the record to the Reject list for follow-up and correction.
4. Users can “Approve/Reject” record from detail view mode or by clicking on the “Approve/Reject” button from listing page.

## Record History

1. The “History” feature is for scanning through historical versions of a record.
2. When in the Record Detail view, clicking on the “History” Tab will bring up the all version of the record.
3. When the “Compare” button is clicked, the display will show details of two chosen version as following:

[Image Removed]

Figure 7 – Sample Display of a Record’s History

|  |  |
| --- | --- |
| Box | Description (Figure 7) |
|  | Drop-down lisitng all history version inclues currently version.  Users can change version to compare by select the verion to compare. |
|  | Details displayed in the change history of two selected versions by the version in the drop-down list in area 1.   * Red text highlights changes of the record in the red drop-down in the area 1. * Green text highlights changes of the redcoed in the green drop-down in the area 1. * **Black text** denotes unchanged information in both record versions. |