Pcounter Web Administrator User Guide - v2014-09-08 Pcounter Web Administrator User Guide Version 1.0
Table of Contents Table of Contents... 2 Overview... 3 Installation Prerequisites and Requirements... 3 Accessing the application... 3 Authentication... 3 Session Timeout... 3 Access Levels... 4 Locale... 4 General UI Operation... 5 Application Modules... 5 Cashier Module... 6 Card\PIN Management Module... 9 Client Code Module... 11 Browse Network Module... 13 System Settings... 15 Troubleshooting... 16 Errors reported by the Server... 16 PWA error logging to the Browser Console... 16 Pcounter Web Administrator User Guide 2
Overview This document describes the operating instructions for Pcounter Web Administrator (PWA) a web based application for administration of the Pcounter server settings and users. Installation Prerequisites and Requirements PWA is included in the main Pcounter installer and is hosted by the Pcounter Data Server service. The Pcounter Data Server supports an internal http\https server, and the PWA application is accessed from a URL hosted by the Data Server service. Accessing the application The Application URL endpoint is formed using the Data Server IP address or DNS name, the configured Port number and the /pwa application route, for example, the default URL running on the local server will be :- http://127.0.0.1:6442/pwa The port number for both HTTP and HTTPS connections are adjustable in the Pcounter Services and Ports settings in PControl :- Authentication The PWA application authenticates users against the local server or Domain. By default the local server Administrator account is added as the PWA Super User when the Pcounter Data service is first installed and run. To start using PWA and to configure other user accounts, you must access the application using the local server Administrator account and Windows password. After successful login with the Super User account, you may configure additional accounts to access specific functionality within the system. See section xx for more details. Session Timeout After a period of inactivity the PWA client application will automatically invalidate the current session and log out the user. This setting is global to all PWA client sessions and is configurable in the System Settings. Pcounter Web Administrator User Guide Overview 3
Access Levels PWA 1.x supports 4 basic levels of access :- 1. Super User 2. Administrators 3. User Managers 4. Cashiers Super User The Super User is by default the local Administrator account on the server running the Pcounter Data Service. There is only one Super User per PWA server, and this user cannot be modified or deleted. Administrators Administrative users have the same rights as the Super User account, however these accounts can be modified or deleted. User Managers User Manager Accounts have access to the modules that permit the modification of user settings within Pcounter, i.e. client codes, auto client code, balances and Card\PIN information. User Manager Accounts do not have access to system settings or the ability to modify System logins. Cashiers Cashier Accounts have access to the Cashier Module. Cashier Accounts do not have access to other User information, System Settings or the Ability to modify System logins. Locale PWA 1.x allows the user to select their chosen locale and language from the login screen. Supported languages are :- English French German Español The chosen language is stored in local browser storage, therefore the setting is remembered across different browser sessions on the same client PC and browser version. Pcounter Web Administrator User Guide Overview 4
General UI Operation The PWA environment is built upon a web desktop UI. Each module supported by the application is launched via the desktop shortcut, or via the launch toolbar. Module windows can be resized, and maximised\minimized to the toolbar using the window control options on the top right of the window header. Module Shortcuts PWA Web Desktop Module Launch toolbar Application Modules The PWA web client is a modular application environment. The application supports several different modules that deliver the functionality supported by the Pcounter Administrator tool into the browser environment. Additionally, there are some generic widget applications that support functionality shared by several modules, for example searching and browsing for user accounts. PWA supports a System Settings widget, which is accessible by Administrative Accounts or Super User account. The following section describes the functionality of each module, and their access level. Pcounter Web Administrator User Guide Application Modules 5
Cashier Module The Cashier module is designed to manage accounting operations on user accounts. Access Level: Cashiers, User Managers, Administrators, Super User The Cashier Module is a Wizard style module that enabled the user to select and account, and perform a balance operation on either the main balance or the Free Quota account of the selected user. Once the operation is complete the user has the option to produce a receipt. The first step is to select a user account on which to perform the balance operation. There are 2 methods available to select an account from the Pcounter server 1. Live Search In the Live search box, start typing the name of the user. The application will search for the user after the 4 th character has been entered. All user accounts matching the entered characters will be displayed in the drop down box, and the appropriate account can be selected. Pcounter Web Administrator User Guide Application Modules 6
2. Browse Network Clicking the search button on the live search box will launch the Browse Network widget. The browse network widget will allow the user to browse through the network users by selecting the appropriate container on the left treeview, and selecting a user account from that container in the main display grid. To select a user double click on the row in the grid, or highlight a user and click the select button. After a user account has been selected, clicking Next allows the selection of the Account type, the balance operation and the Amount. Clicking next after making a valid selection shows a confirmation screen Pcounter Web Administrator User Guide Application Modules 7
Upon confirmation, the user account is updated in Pcounter and the user has an option to print a receipt for the transaction. Pcounter Web Administrator User Guide Application Modules 8
Card\PIN Management Module The Card\PIN management module allows the adjustment of Card ID and PIN information for a user. Access Level: User Managers, Administrators, Super User To review or change Card\PIN information for a user you must first select a user. There are 2 methods available to select an account from the Pcounter server 1. Live Search In the Live search box, start typing the name of the user. The application will search for the user after the 4 th character has been entered. All user accounts matching the entered characters will be displayed in the drop down box, and the appropriate account can bel selected. Pcounter Web Administrator User Guide Application Modules 9
2. Browse Network Clicking the search button on the live search box will launch the Browse Network widget. The browse network widget will allow the user to browse through the network users by selecting the appropriate container on the left treeview, and selecting a user account from that container in the main display grid. To select a user double click on the row in the grid, or highlight a user and click the select button. After a user has been selected, their Card details will be shown. If the card details are blank, then there are no Card ID numbers set for this user. NOTE: PIN numbers will not be shown for security reasons. To modify the Card or PIN details for an account, click the Assign Card-Pin button. To remove the Card or PIN details for an account, click the Delete Card-Pin button. Pcounter Web Administrator User Guide Application Modules 10
Client Code Module This module allows the user to manage the list of client and sub codes available on the Pcounter Server. Access Level: User Managers, Administrators, Super User Adding a Client Code Click the Add button, and enter the client code and description fields. Both fields are mandatory. Press the Return key when finished editing to save changes to the Pcounter Server. Editing a Client Code Double click the row in the client code list to bring up the editor. Modify the client code details as required and press the return key, or click the Update button to save changes to the Pcounter Server. Deleting a Client Code Pcounter Web Administrator User Guide Application Modules 11
Select the row in the list and click the delete button. The Client code will be removed from the Pcounter Server. Viewing or Editing Sub Codes Click the client code in the list and then select the Show Sub Codes button. A new window will be shown with the sub codes for the selected client code. If the selected client code has no sub codes the list will be empty. The functionality for Adding\Editing\Deleting sub codes is identical to that of the main client code list. Pcounter Web Administrator User Guide Application Modules 12
Browse Network Module This module allows the user to browse the network containers, view users details and also quick launch the Cashier, Client Code and Card-Pin modules from the context (right-click) menu. Access Level: User Managers, Administrators, Super User NOTE: The Browse Network module window is maximised by default. Use the tree panel on the left hand side of the view to expand the network container. As each container expands the content view on the right will load any users contained within the selected node of the tree. Quick launch options. From the toolbar menu, it is possible to quick launch a module for the selected user in the grid. The options are also available by right-click on the user in the grid. Deposit, Charge, Set Balance, Manage Card-Pin These options will launch the Cashier or Card-Pin defaulted to the selected user, meaning that the select user step is not required on the module screen. Pcounter Web Administrator User Guide Application Modules 13
Associated Client Codes This option will launch the Client Codes module for Client Code Associations. A full list of client codes will appear on the left hand side list. Any codes associated with this user will appear on the right hand side list, codes can be moved between the associated and un-associated lists using the left and right arrow buttons. When all codes have been assigned, click Save to update the Pcounter Server. Auto Code This option will launch the Client Codes module for Auto Codes. You may enter free text for the Auto Client Coded, or select an existing Client code from the drop down list. To assign the Auto code click Save, to remove an existing Auto Code click Remove Auto Code. Pcounter Web Administrator User Guide Application Modules 14
System Settings The system settings module contains PWA specific settings values, and also manages the user accounts. Access Level: Administrators, Super User Security Tab The security tab is used to add and edit PWA user accounts. The PWA application authenticates users against the local server or Domain. By default the local server Administrator account is added as the PWA Super User when the Pcounter Data service is first installed and run. This account cannot be modified or deleted. All user names added to PWA must match the simple username of a Windows account. Set the section entitled Access Levels for a description of the Group values used by PWA to categorize users. System Settings This tab holds PWA specific settings that are stored centrally on the Pcounter server. These settings are Global to the PWA application. Pcounter Web Administrator User Guide Application Modules 15
Troubleshooting Errors reported by the Server The PWA client application reports errors from the server via pop up messages :- Server errors have a descriptive message and an error code []. PWA error logging to the Browser Console PWA records any unexpected error information to the Browser console. The Browser console is a feature supported by most modern browsers, and is accessed by pressing F12 when the browser window has mouse or keyboard input focus. Please check the documentation for your browser on how to access the console window for more details. Pcounter Web Administrator User Guide Troubleshooting 16