PaperCut Blackboard Interface Functionality Overview & Design This document outlines the functionality being delivered and gives interested organizations the opportunity to understand the PaperCut Blackboard interface prior to implementation. The aim is to provide administrators with the knowledge they need to make architecture decisions. The PaperCut Blackboard interface leverages the functionality delivered in the PaperCut payment gateway. Where possible the aim is to deliver choice and offer the same functions as found in other one card systems available in PaperCut such as CBORD, CardSmith and TouchNet. Key Feature Summary Automatic network level integration with Blackboard no mandatory hardware dependence. Different operation modes: o Pay-and-release via a release station (swipe hardware required) o End-user instigated transfer via a web interface o Automatic transfer on low/zero account balance o Combination thereof as set by administrator Ability to mix the integration methods - Some users (e.g. students) may have automatic payment on print, while guests use a pay-and-release station and anonymous cards. Full transaction auditing for both end-users and administrators. Ability to extract/import Blackboard card/account numbers out of Active Directory (if secure) and/or an external database table such as a student management system. Implementation does not compromise/replace standard PaperCut features such as free quotas, overdraft rules or the ability to add alternate payment types in the future (e.g. credit card services such as PayPal). Contents 1 Architecture... 2 2 End User Overview... 3 2.1 Mode 1: Manual Transfer Mode... 3 2.2 Mode 2 & 3: On-Demand Mode (Live or Batched Transfer)... 5 2.3 Mode 4: Pay-and-release Mode (Hardware required)... 6 3 Anonymous Guests without domain accounts... 8 4 Requirements for PaperCut Blackboard interface... 9 5 Contact... 10
1 Architecture The solution is designed with security as the number one objective. All communication with Blackboard (the external credit source) is done via the PaperCut Server. No client software is used. Communication with end-users is encrypted using SSL/TSL encryption. Copyright 2010 PaperCut Software International Pty. Ltd., All Rights Reserved 2 of 10
2 End User Overview The system may be configured in one of four operating modes. The operating modes offered to end users are configured by the administrator. Modes are not mutually exclusive. Administrators may choose to offer a combination of modes or have different modes for different user types (e.g. students vs. staff vs. guests). 2.1 Mode 1: Manual Transfer Mode In this mode users instigate a payment/transfer manually direct from their desktop using the PaperCut End-User Web interface. The interface and workflow will be based on the proven interface used for other payment gateway interfaces including other one card systems such as CBORD and popular online systems like PayPal and CyberSource systems used by many organizations. 1. The user logs into the standard PaperCut. 2. A new Add Credit link existing on the left (The link will appear after the module is installed. The name of the link can be changed). 3. The user clicks Add Credit and select the amount to transfer (the range of amounts can be defined by the administrators). 4. After clicking the form Submit button, the selected amount, if available, is placed in the user s account in real time. 5. The end-user can view and report on all details of their historic transactions via the web interface. These screen-shots show the workflow. Attributes such as visual design, link names, and instruction/help text can all be customized. Copyright 2010 PaperCut Software International Pty. Ltd., All Rights Reserved 3 of 10
Figure 1: Interface accessed via standard end-user PaperCut login (can be skinned to organization design) Figure 2: Extra option(s) above normal options after gateway is installed. Figure 3: Conducting a transfer: What the end-user sees. Interface options can be configured by administrator. Copyright 2010 PaperCut Software International Pty. Ltd., All Rights Reserved 4 of 10
2.2 Mode 2 & 3: On-Demand Mode (Live or Batched Transfer) In this mode, the system will automatically transfer funds from Blackboard to the user s PaperCut account on an as-need basis based on rules defined by the Administrator. For example, if a user performs printing when they have no PaperCut printing credit, the PaperCut Blackboard integration will automatically transfer a defined amount, or the cost of the job, into the user s PaperCut account to pay for the print job. By default only the amount required for the current print job is transferred. This leaves the user with a zero PaperCut balance after the cost of the print job is deducted. This is known as Live Mode where there is a one-to-one link between a print job requiring funds and a transaction in the Blackboard system. The other on-demand transfer mode is batched mode where a fixed pre-determined amount is transfer into the user s account as required (i.e. the user runs out of funds). The default transfer amount is defined by the administrator. Each on-demand mode offers different advantages and compromises. Live mode ensures funds never remain in the PaperCut account and hence could potentially be used elsewhere by the user. Batch mode on the other hand partly decouples PaperCut from the Blackboard system offering advantages around reliability and scalability: 1. Batch mode reduces the number of transactions sent to the Blackboard system. 2. If the Blackboard system or the network link is down, printing for most users can continue and downtime would only affect users who require Blackboard credit at this time. These modes are best illustrated by examples: Example of live mode: 1. User Betty only has $0.00 in her PaperCut printing account. 2. Betty prints a job that costs $3.50. 3. The PaperCut Blackboard gateway transfers the required $3.50 into Betty s PaperCut account. Example of batch mode with a $5.00 default transfer amount: 1. User Betty only has $0.50 in her PaperCut printing account. 2. Betty prints a job that costs $3.50. Copyright 2010 PaperCut Software International Pty. Ltd., All Rights Reserved 5 of 10
3. Because the print job costs more than the value currently in her account, the PaperCut Blackboard gateway transfers the default transfer amount of $5.00. 4. The job cost is deducted from the PaperCut account leaving Betty with $1.50 in her PaperCut account which may be used for future printing. The on-demand transfer mode is enabled and configured by the administrator. No end-user intervention is required. End users however have a full list of all transfers available from their End- User web interface. If using batch mode, sites should explain to users how the system works (e.g. default transfer amounts). Notes: On-demand mode can be configured to only apply to a group of users (e.g. Students and not staff) Any free quota allocated to users is used first before the Blackboard system is contacted for value. May be used to implement a predictable system where a fixed amount is transferred each time (e.g. $5 blocks). Or may be configured to simply transfer the value of each job on demand. If the user is out of Blackboard funds the inadequate credit message will propagate to the user as it normally does in PaperCut (options include popup message or email notification). Both Mode 1, or 2 and 3 (on-demand) can be enabled together offering a flexible hybrid system, or the group-level restrictions may be used to enable one mode for one group of users and another mode for another group. 2.3 Mode 4: Pay-and-release Mode (Hardware required) The pay-and-release mode works in conjunction with PaperCut Release Stations. It may be used in the following combinations: Anonymous mode (jobs and transactions are not logged at the user level) Secure mode (users need an account and authenticate all jobs and transactions are accounted for under the user s account) Combination mode (Guest login is an option, while users with accounts can login ensuring they have a record of their own jobs). With the pay-and-release mode, additional card reader hardware is required. The card reader needs to be compatible with the Blackboard card type. Usually this will take the form of a USB based magnetic swipe card reader (HID) that retail for around USD $50-$100. Copyright 2010 PaperCut Software International Pty. Ltd., All Rights Reserved 6 of 10
The workflow is as follows: Guest/Anonymous Mode 1. User walks up to a release station and swipes their card to login 2. The user selects their job 3. The user is asked to confirm the charge 4. The amount is removed from their Blackboard account and their job released. Secure Mode 1. The user walks up to a release station and logs in with username/password (or card swipe if card number is associated with the user account) 2. The user will only see their jobs. They select a job to release. 3. The cost of the job is charged from their online account, or if no funds are in their online account, then charge from the Blackboard system. Combination Mode: As above, however users are presented with the option of login as a guest, or as a registered user at the time of login. Registered users have the advantage that their jobs are recorded and they have access to their online funds e.g. funds from free quotas, deposited credit card funds, etc. Copyright 2010 PaperCut Software International Pty. Ltd., All Rights Reserved 7 of 10
3 Anonymous Guests without domain accounts Anonymous guests present a few extra complexities because of the lack of mapping between an identity and a network domain account. The following options should be considered: Set up release stations supporting anonymous pay-and-release. Special stations (say in the library) can be allocated to this task. Internal Users: PaperCut has an internal users feature. Pre-load the database with a batch of internal users with names such as guest-001 and random passwords and card numbers. Guest users can then use any print services the same as users with domain accounts. Copyright 2010 PaperCut Software International Pty. Ltd., All Rights Reserved 8 of 10
4 Requirements for PaperCut Blackboard interface PaperCut Version 10.1 or higher Server running either Mac, Windows, Novell or Linux On-Demand and Automatic Transfer Modes: The ability to map network domain usernames with Blackboard card/account numbers. This may be define from: o Fields in Active Directory o An external database table (via JDBC connection) e.g. student management system o A tab-delimited text file Pay-at-release Modes: Card readers able to read track two on the Blackboard card. Usually this will take the form of a USB based magnetic swipe card reader (HID) that retail for around USD $50-$100. Copyright 2010 PaperCut Software International Pty. Ltd., All Rights Reserved 9 of 10
5 Contact Please direct any questions through to coordinating developer, Chris Dance : chris.dance@papercut.com Copyright 2010 PaperCut Software International Pty. Ltd., All Rights Reserved 10 of 10