CallShop Administration Guide (version 1.5)
Thursday, 20 April 2006

Table of Contents

Basic Principles

Typically Callshop is a public facility available for making paid telephone calls. It may have one or more calling devices (phones, software phones) named as "booths" or "lines". Each line is independent from others and can be used to place outgoing calls. There is also Callshop Operator which controls operation of the Callshop: activates/deactivates Lines, collects deposits, pronts receipts and directs users to their appropriate calling Lines. In the scope of Arrow Billing, callshop is owned and opearted by Reseller or Agent. Therefore following hierarchies can be created:
  1. Service Provider -> Reseller (Owner of the Call shop) -> Enduser: In this case, the call shop is able to set its own rates because of the ownership of the Reseller.
  2. Service Provider -> Agent (Owner of the Call shop) -> Enduser: As the call shop is owned by Agent, it is not able to set its own rates.
  3. Service Provider -> Reseller -> Agent (Owner of the Call shop) -> Enduser: This is suitable for large call shop "chains". This means there can be many Resellers having their own calling rates assigned to their call shops. Shop itself is operated by Agent who is a subsidiary of Reseller.
Note following in above scenarios:
  1. Enduser is our final customer, walk-in person wishing to make call
  2. In Scenario 1 Callshop is able to set its own rates (because it is owned by Reseller)
  3. In Scenario 2 Callshop is NOT able to set its won rates (because it is owned by Agent)
  4. Scenario 3 is useful for large Callshop "chains", i.e. there can be many Resellers having their own calling rates assigned to their Callshops. Shop itself is operated by Agent who is subsidiary of Reseller.
show top

Setting Up Callshop

Time Synchonization

Current implementatation of system uses timestamps of calls and users check-in/ckeck-out both from Billing Server's clock and from timestamp received from NAS in radius packets. IT IS EXTREMELY IMPORTANT to synchronize time on Arrow Billing server with time on ALL NASs which will send radius (AAA) information to Arrow Billing.

show top

Before You Begin

Please make sure that Resellers and/or Agents are set up properly before continuing to Callshop setup. Refer to Reseller - Agent setup guide. Following should be noted additionally when creating Reseller or Agent for Callshop:
  1. It is advised that Reseller has some amount of credit (either Credit Limit or payment provided - Step 14 when creating Reseller). Otherwise entire Callshop will be blocked from making calls as Reseller balance is associated with Callshop balance.
  2. "Call Shop Interface - All Privileges" (Step 19 when creating Reseller) area must be granted for users who will work as Callshop Operators.




show top

Understanding Lines

In order to make any call there must be a valid Account in Arrow Billing. Thefore each "booth" should have Account associated with it. Note that there must be one Account per "booth". All requirements existing to Accounts also apply to "booths". Therefore there must be valid Username/Alias, Authentication Type, Credit Limit, Rate Table for each account. Due to the fact, that "booth" represents anonymous walk-in customer, we Do NOT assign ANY Company to (even not Reseller). instead we make Account to be owned by its Reseller or Agent. Below is an image of Account set up for Reseller who is operating according to Scenario 1 (Service Provider > Reseller > Enduser).

In above sample screen USD 5.00 credit limit applies to this particular Account (callshop line). It means that any walk-in user will be able to make maximum USD 5.00 calls before making any payment. Once the limit is reached, the user is requested to make payment to restore his/her balance.

show top

Enabling Callshop Function

Callshop function is not enabled by default. To enable it, please go to "Tools" > "Options" and check "Enable Call Shops" checkbox in "Call Shop" area. New Menu item "Call Shop" will apear on left hand side menu.

show top

Creating Callshops and Addning Lines

Click on "Call Shop" on the left navigation menu. Screen for adding /modifying Call Shops will appear. Please select Callshop owner (Reseller) and give a descriptive name to it.

After the Shop is created, click on the link "Edit" and add lines one by one. You will have to map Line numbers with actual accounts from Arrow Billling. Note that only accounts belonging to particular reseller will appear in list. Repeat this step as many times as there are "booths" in Callshop. Set line status to "Enabled" if you will be using it or "Disabled" if it is not to be used now.

Finally, upload template which will be used for printing receipts. Template must be in HTML format. Example is provided at the end of this document.



show top

Operating Callshop

Shop Attendants (Opeartors) Login

To login as shop attendant, use URL which has /callshop/ added to URL. For example, if you normally login as administrator to: 
http://192.168.0.1/billing/
then Callshop attendants URL is: 
http://192.168.0.1/billing/callshop/
Note that you should NOT login as root administrator. Use Reseller's login instead.

show top

Overview of Operating Sequence

Call Shop function cycle consists of following steps:
  1. New client arrives;
  2. Attendant assigns line (booth) number and optionally collects deposit;
  3. Attendant activates line;
  4. User proceeds to calling;
  5. When finished, Attendant provides Checkout.
  6. System calculates balance, Attendant collects payment/returns change and prints receipt.
show top

Screen Layout

Top of the screen contains navigation bar with main commands. On the right of commands there is total remaining credit indicator of Call Shop. Below it on right side there is Line monitor which displays status and properties of each line.

On right side of line number there are 4 fields (from top to bottom, left to right):

  1. Status, one off following:
    1. Idle: awaiting for client and available;
    2. Occupied: client already in the booth;
    3. Call In Progress: line is engaged by active call;
    4. Disabled: line disabled from Administrative interface and cannot be used;
  2. Action: possible action : Checkout.
  3. Ticket: unique identifier of client.
  4. Credit and balance – current balance of the line and credit limit. This is property of Line itself.
show top

Actions During Client Check-In

When new client comes to shop, Attendant should click on "New Client" link from top menu. Screen will open which will assign "ticket" number for caller, and allow collect deposit (or it can be left blank if no deposit) and assign to which Line user is instructed to go – it will be one of lines in Idle state. It is possible to print receipt at this stage if deposit was received. Then Attendant should click "Activate client" button. Client can go in to booth and use service. Line will show "Occupied" sign. Line balance will increase if deposit was received.

To get current status of lines, Attendant has to click "Refresh Screen" link.

show top

Actions During Client Check-Out

When client has finished all calls, Attendant should click "Check Out" on the line where user was speaking. Now new screan will appear which will automatically calculate balance for call and prompt to enter final amount. Once entered, Attendant should click grey Checkout button. After that there is link which allows to print receipt. Line will become idle again. If amount received is properly entered, balance should return to same value as it was before calls. IMPORTANT: Please note that normally operator should NOT click "checkout" when call is in progress. In such situation last call may not be billed.

show top

Other Options

Other links on top menu are:
  1. "Call Rates" - operator can tell user calling rates for any destination
  2. "Call Report" - call detail report for this shop
  3. "Refresh Screen" - it should be used to check actual status of lines, i.e. if user is speaking now or not.
  4. "Logout" - closes Attendant work session.
show top

Receipt Format

Specification

In order to print receipt, you have to upload Receipt template. Each shop can have individual template. Template is HTML file which alllows following specific tags: 
<tmpl_var name=link_comp_name> - company name (Shop owner)
<tmpl_var name=pay_amount_1> - amount to pay before call (deposit)
<tmpl_var name=currency_name_1> - deposit currency name
<tmpl_var name=pay_amount_2> -  amount to pay before call (deposit, at checkout)
<tmpl_var name=currency_name_2> - deposit currency name
<tmpl_var name=usage_amount> - consumed amount 
<tmpl_var name=u_currency_name> - consumed amount currency name
<tmpl_var name=topay_amount> - amount to pay at checkout
<tmpl_var name=topay_currency_name> - currency name to pay at checkout
<tmpl_var name=timestamp> - current timestamp
<tmpl_var name=ticket_number> - ticket number 
<tmpl_var name=line_number> - Line number
The following tags should be put in loop as there can be more than one call per receipt printed: 
<tmpl_var name=called_number> - Called Number 
<tmpl_var name=call_time_hms> - Call Duration 
<tmpl_var name=call_amount> - Call Amount 
<tmpl_var name=call_currency> - Call Currency
Loop start tag: 
<tmpl_loop>
Loop end tag: 
</tmpl_loop>
show top

Sample Receipt Template

Below is simple receipt template sample. Select the text below, copy and paste to new file. Then save it with .html extension and upload via Administrative inteface: 
-- cut here start --

<table width="300">
 <tr>
  <td align="left" nowrap><font face="Verdana" size="2"><tmpl_var name=link_comp_name></font></td><td> </td>
 </tr>
 <tr>
  <td align="left" nowrap><font face="Verdana" size="2">Company Address</font></td><td> </td>
 </tr>
 <tr>
  <td align="left" nowrap><font face="Verdana" size="2">Paid</font></td><td nowrap><font face="Verdana" size="2"><tmpl_var name=pay_amount_1> <tmpl_var name=currency_name_1></font></td>
 </tr>
 <tr>
  <td align="left" nowrap><font face="Verdana" size="2"> </font></td><td nowrap><font face="Verdana" size="2"><tmpl_var name=pay_amount_2> <tmpl_var name=currency_name_2></font></td>
 </tr>
 <tr>
  <td align="left" nowrap><font face="Verdana" size="2">Consumed</font></td><td nowrap><font face="Verdana" size="2"><tmpl_var name=usage_amount> <tmpl_var name=u_currency_name></font></td>
 </tr>
 <tr>
  <td align="left" nowrap><font face="Verdana" size="2">To Pay/Change</font></td><td nowrap><font face="Verdana" size="2"><tmpl_var name=topay_amount> <tmpl_var name=topay_currency_name></font></td>
 </tr>
 <tr>
  <td align="left"><font face="Verdana" size="2">Date</font></td><td nowrap><font face="Verdana" size="2"><tmpl_var name=timestamp></font></td>
 </tr>
 <tr>
  <td align="left"><font face="Verdana" size="2">Ticket</font></td><td nowrap><font face="Verdana" size="2"><tmpl_var name=ticket_number></font></td>
 </tr>
 <tr>
  <td align="left"><font face="Verdana" size="2">Booth Number</font></td><td nowrap><font face="Verdana" size="2"><tmpl_var name=line_number></font></td>
 </tr>
 <tr>
  <td colspan="2" align="left" nowrap><font face="Verdana" size="2">-----------------------------</font>
  </td>
 </tr>
 <tr>
  <td>
   <table width=100%>
   <tmpl_loop>
    <tr>
     <td align="left" colspan="2"><font face="Verdana" size="2"><tmpl_var name=called_number></font></td>
    </tr>
    <tr>
     <td align="left"><font face="Verdana" size="2"><tmpl_var name=call_time_hms></font></td>
     <td align="left"><font face="Verdana" size="2"><tmpl_var name=call_amount> <tmpl_var name=call_currency></font></td>
    </tr>
   </tmpl_loop>
   </table>
  </td>
 </tr>
</table>

-- cut here end --
show top



Digg!Del.icio.us!Slashdot!Technorati!Free social bookmarking plugins and extensions for Joomla! websites! title=
 
[ Back ]