IPBrick Billing Guide

Transcription

1 IPBrick Billing Guide iportalmais September 10, Introduction Increasing acceptance of e-billing by consumers and the business community has made us aware of the need to implement a reliable electronic billing solution, we took that thought a step further and integrated it with iportaldoc, our document and workflow software. IPBrick Billing, is a call accounting and e-billing system software. It is suitable either to keep track of all your telecommunication expenditure or to charge client s for their phone calls (eg: an hotel). 2 Features As stated previously, this software runs in a close interaction with iportaldoc and of course, IPBrick. IPBrick Billing is very easy to configure. To start working, it s only necessary to configure which of the IPBrick s registered phones are to bill, and modify the default tariff. For more detailed billing, it also allows for the association of different tariffs to different phones. The tariffs are uploaded via.csv files. When modifying one phone/tariff association it is possible to recalculate all the phone s calls costs or start using the new tariff only on new calls. The Billing reports are generated through the iportaldoc software, ensuring an advanced and efficient archive of all the reports. 1

2 3 Scenario A - One IPBRICK.GT This scenario is applicable only in case of a single IPBrick.GT with the LDAP authentication configured by default as Master LDAP. 3.1 Installation procedure In order to activate the Billing module, it will be required that you install the ucoip4iportaldoc.deb package that is available at: It provides support for: 1. Call recording in MP3 or WAV in iportaldoc with automatic caller classification. 2. Saves automatically all received and sent fax and s and classifies the document. 3. Provides billing for operators or phones - Allows you to generate reports of the total call cost for any phone or customer SIP remote equipent that makes calls through the IPBrick. The costs are based on the duration of the call and on the dialed prefix Packages for IPBrick 5.1 To install the ucoip4iportaldoc_en-1.0_all.deb package it s required that: 1. all updates, up to 14, are installed. Please read the release notes and download them at: Note: Please bear in mind that you need to register at our eshop for the downloads section to be available. Downloads Software Updates IPBrick v5.1 2

3 2. Again, at our eshop: Downloads Software IPBrick Related Software IPBrick 5.1 UCoIP 4 iportaldoc 1.0 Download the package: ucoip4iportaldoc_en-1.0_all.deb 3. Install first the updates for IPBrick in order and then the ucoip4iportaldoc DEB at Advanced Configurations > IPBrick >Update. Follow the instalation instructions. 4. Apply Configurations Figure 1: Insert update Packages for IPBrick Download the ucoi4iportaldoc_v2.0_to_ipbrick5.2.deb package at: 3

4 Note: Please bear in mind that you need to register at our eshop for the downloads section to be available. Downloads Software IPBrick Related Software IPBrick 5.2 UCoIP 4 iportaldoc Install the downloaded DEB at IPBrick s web interface: Advanced Configurations > IPBrick > Update 3. Follow the instalation instructions and apply Configurations. 3.2 DNS configuration 4. If IPBrick is not your primary DNS server add the following entries to you DNS server, pointing to the IPBrick.GT IP: iportaldoc.yourdomain.com billing.yourdomain.com contacts.yourdomain.com 3.3 IPBrick License It will be necessary to update the iportaldoc license with the Billing option activated. 3.4 Billing Configuration for VoIP providers Provider configuration (IPBrick with billing) To configure Billing you ll need to make changes in the IPBrick s web interface, in the Billing website and in iportaldoc. 4

5 3.4.2 IPBrick configuration Access the Intranet IPBrick server s interface and create as many SIP accounts as needed, one per customer. If the phones to bill are local, create them in IPBrick.I > Machines management. If they are remote servers or phones insert them in: Advanced Configurations > Telephony > Registered Phones and they must be defined as remote. NOTE: If you don t want to associate your phones to the LDAP you may also use the same location in the IPBrick.GT server The login and password will be used to register the customer phones or remote SIP servers. Figure 2: Adding a new internal phone 5

6 Figure 3: Adding an external phone or server Create all Access Classes in: IPBrick.GT > VoIP > Functions > Outbound > Access Classes with the appropriate routes authorized for each customer and add their phone or server as a member of this access class. 6

7 Figure 4: Adding phone or servers to an access class When finished, please Apply Configurations Billing Configuration In this website you can define wich phones and servers should be billed and change the billing rates rates. Access the billing web interface at (replace yourdomain.com by the correct domain). 1. The login is: administrator 2. The default password for this user is: 123 You can authorize additional users and define different profiles in: Management > Users and Management > Groups. Fill the company information in Management > Company Data. 7

8 Figure 5: Update company information Define the currency, tax rate and outgoing prefixes in: Management > Program options The Exit dialing code will be replaced by the country dialing code and the international prefix will be striped when matching the billing rates. 8

9 Figure 6: Change options Replace the DEFAULT billing rate and add new ones as needed. The file with the rates must have.csv extension. Here is an example billing rate file: Code;Country;Price;Period;InitialPeriod;InitialPrice 0;DEFAULT; ;1;1; ;AFGHANISTAN; ;1;1; ;ALASKA; ;1;1; ;ALBANIE; ;1;60; In this example all calls are billed each second, except for the Albanie route where the first minute costs 0.05 and the following call length is billed in periods of one second. The two first lines are mandatory. The DEFAULT prefix is used when no other prefix is matched. The order of the prefixes in the CSV file is irrelevant, the prefixes are matched by length: the cost will be calculated from the prefix with longer length that matches the number to be billed. 9

10 It is possible to define an initial biling period (eg: in the first minute the call costs X) and from that period on each second will be billed. Each rate field is separated by ";" and its meaning is: 1. Code - Prefix in international format without the international prefix (without 00 by default). For example to match the number (Portuguese mobiles) the prefix should be Country - Country name or description of the rate. 3. Price - Cost of each Period. 4. Period - After the initial period defined in InitialPeriod the call cost is incremented by the Price value every Period. 5. InitialPeriod - How many seconds of the initial period. 6. InitialPrice - Cost of the initial period. Figure 7: Upload rates The cost of the call is calculated using the following formulas: 10

11 1. if call time lesser than or equal to InitialPeriod: TotalCost=InitialPeriod*InitialPrice 2. if call time greater than InitialPeriod: TotalCost=InitialPeriod*InitialPrice + Price*(Calltime-InitialPeriod)/Period After uploading the CSV files you can edit each of the values on the Billing web interface or replace the rate by uploading a new one. Figure 8: Add phones and servers To set which phones or servers are going to be billed, please access Management > Phones and click on Add phones. Select as many phones or servers as needed and select which billing rate will be used. You can also add servers by clicking on the option Add server. By adding servers or phones, in this way, the calls will be matched by the caller id. This also allows adding PBX phones if the caller s id sent by these phones is unique Contacts configuration Access the Contacts web interface at (replace yourdomain.com by the correct domain). 1. The login is: administrator 2. The default password for this user is:

12 Create a new entity type by clicking in Definitions > Entities Management, then Entity Types and Insert if you don t have any. Choose a name for the group of entities that are going to be billed. Figure 9: Add a new entity type Create a new entity by clicking on Definitions > Entities Management and then Insert. For billing the field IPBrick phone must be set. Fill also the other fields as you see fit. 12

13 Figure 10: Creating a new entity 13

14 3.4.5 iportaldoc Configuration Access the iportaldoc web interface at (replace yourdomain.com with the correct domain). 1. The login is: administrator 2. The default password for this user is: 123 Figure 11: Inserting a new billing document Insert a new document in the Billing directory. Choose the entity type and entity from the dropdown list. If you have defined the Location and a Contact for that entity, choose them from the respective dropdown lists. 14

15 After filling the required fields click on Edit document. Choose the period and the phones or servers of the entity and contacts to be billed. A list of all the calls made by these equipments in the selected period will appear as well as the total ammount. Insert the generated document and send it to the customer or print it. Figure 12: Choosing the calls to be billed 15

16 3.5 Customer configuration The Customer has an IPBrick 1. Access the customer s IPBrick web interface. 2. In IPBrick.GT > VoIP > Route management click on Insert a new Outbound route 3. Click on Advanced Options and fill the required fields: (a) Type SIP (b) Name Name of the route or description (c) Server address IPBrick s Public IP or domain (d) Server port 5090 (e) Authentication User/Password (f) Username login created in IPBrick for this SIP account (g) Authentication username login created in IPBrick for this SIP account (h) Password/Retype Password password for this login (i) Caller identifier login created in IPBrick for this SIP account (j) Registration Realm IPBrick s domain (k) Other fields by default 4. Click on Insert 5. In IPBrick.GT > VoIP > Route management click on the newly created route. 6. Insert one or more prefixes to route the calls to the IPBrick with Billing. both on Customer has a SIP Phone or a gateway with support for SIP 1. Register the phone or gateway with the following authentication: (a) Domain IPBrick s Public IP or domain eg: ipbrick.domain.com 16

17 (b) Proxy domain and port IPBrick s Public IP or domain Port 5090 eg: :5090 (c) Username login created in IPBrick for this SIP account (d) Authentication username login created in IPBrick for this SIP account (e) Password password for this login 4 Scenario B - Two IPBRICKS This scenario has two IPBricks, one IPBrick.I with iportaldoc already installed and that in terms of authentication is behaving as Master LDAP; and one IPBrick.GT that should be already configured as in LDAP client mode or even Slave. NOTE: The ucoip4iportaldoc package must be installed in the IPBrick.GT AND in IPBrick.I, even if there s already an iportaldoc installed on that IPBrick.I. 4.1 Basic Procedure Overview Please install the UCoIP package both on the IPBrick.GT and on the machine with iportaldoc; Update the iportaldoc License (obviously on the machine installed with it) in order to activate the Billing module; Configure the DNS server in a way that the Billing service will point to the IPBrick.GT machine; Configure the DNS in a way that the Contacts and iportaldoc services point to the machine installed with iportaldoc. 4.2 Installation Procedure As in the previous Scenario, in order to activate the Billing module, you will need to install the ucoip4iportaldoc.deb package that is available at: It provides support for: 17

18 1. Call recording in MP3 or WAV in iportaldoc with automatic caller classification. 2. Saves automatically all received and sent fax and s and classifies the document. 3. Provides billing for operators or phones - Allows you to generate reports of the total call cost for any phone or customer SIP remote equipent that makes calls through the IPBrick. The costs are based on the duration of the call and on the dialed prefix Packages for IPBrick 5.1 To install the ucoip4iportaldoc_en-1.0_all.deb package it s required that: 1. all updates, up to 14, are installed. Please read the release notes and download them at: NOTE: Please bear in mind that you need to register at our eshop for the downloads section to be available. Downloads Software Updates IPBrick v Again, at our eshop: Downloads Software IPBrick Related Software IPBrick 5.1 UCoIP 4 iportaldoc 1.0 Download the package: ucoip4iportaldoc_en-1.0_all.deb 3. Install first the updates for IPBrick in order and then the ucoip4iportaldoc DEB at Advanced Configurations > IPBrick >Update. Follow the instalation instructions. 4. Apply Configurations 18

19 Figure 13: Insert update Packages for IPBrick Download the ucoi4iportaldoc_v2.0_to_ipbrick5.2.deb package at: NOTE: Please bear in mind that you need to register at our eshop for the downloads section to be available. Downloads Software IPBrick Related Software IPBrick 5.2 UCoIP 4 iportaldoc Install the downloaded DEB at IPBrick s GT web interface: Advanced Configurations > IPBrick > Update 3. Follow the instalation instructions and Apply Configurations. 19

20 4.3 DNS configuration If IPBrick.I is the primary DNS server change the entry billing.yourdomain.com to IPBrick.GT IP; If IPBrick is not your primary DNS server add the following entries to you DNS server: iportaldoc.yourdomain.com pointing to IPBrick.I IP contacts.yourdomain.com pointing to IPBrick.I IP billing.yourdomain.com pointing to IPBrick.GT IP 4.4 iportaldoc s License Activation of the iportaldoc s License with the Billing option activated ONLY at the IPBrick.I server 4.5 Billing Configuration for VoIP providers Provider configuration (IPBrick with Billing) To configure Billing you ll need to make changes in the IPBricks web interface, in the Billing website and in iportaldoc. On the IPBrick.GT with Billing installed access the web interface and create as many SIP accounts as needed, one per customer. If the phones to bill are local, create them in IPBrick.I > Machines management. If they are remote servers or phones insert them in: Advanced Configurations > IPBrick > Update and they must be defined as remote. The login and password will be used to register the customer phones or remote SIP servers. 20

21 Figure 14: Adding a new internal phone Figure 15: Adding an external phone or server Create an access class in: 21

22 IPBrick.GT > VoIP > Functions > Outbound > Access Classes with the appropriate routes authorized for each customer and add their phone or server as a member of this access class. Figure 16: Adding phone or servers to an access class When finished, please Apply Configurations IPBrick configuration Access the Intranet IPBrick server s interface and create as many SIP accounts as needed, one per customer. If the phones to bill are local, create them in IPBrick.I > Machines management. If there are remote servers or phones you will need to change the Local default value to Remote at the IPBrick.GT server in: Advanced Configurations > Telephony > Registered Phones and they must be defined as remote. NOTE: If you don t want to associate your phones to the LDAP you may create them at the same above location in the IPBrick.GT server. 22

23 The login and password will be used to register the customer phones or remote SIP servers. Figure 17: Adding a new internal phone 23

24 Figure 18: Adding an external phone or server All Access Classes shall also be created at the IPBrick.GT server. To create an access class go to: IPBrick.GT > VoIP > Functions > Outbound > Access Classes with the appropriate routes authorized for each customer and add their phone or server as a member of this access class. 24

25 Figure 19: Adding phone or servers to an access class When finished, please Apply Configurations Billing Configuration In this website you can define wich phones and servers should be billed and change the billing rates rates. Access the billing web interface at (replace yourdomain.com by the correct domain). 1. The login is: administrator 2. The default password for this user is: 123 You can authorize additional users and define different profiles in: Management > Users and Management > Groups. Fill the company information in Management > Company Data. 25

26 Figure 20: Update company information Define the currency, tax rate and outgoing prefixes in: Management > Program options The Exit dialing code will be replaced by the country dialing code and the international prefix will be striped when matching the billing rates. 26

27 Figure 21: Change options Replace the DEFAULT billing rate and add new ones as needed. The file with the rates must have.csv extension. Here is an example billing rate file: Code;Country;Price;Period;InitialPeriod;InitialPrice 0;DEFAULT; ;1;1; ;AFGHANISTAN; ;1;1; ;ALASKA; ;1;1; ;ALBANIE; ;1;60; In this example all calls are billed each second, except for the Albanie route where the first minute costs 0.05 and the following call length is billed in periods of one second. The two first lines are mandatory. The DEFAULT prefix is used when no other prefix is matched. The order of the prefixes in the CSV file is irrelevant, the prefixes are matched by length: the cost will be calculated from the prefix with longer length that matches the number to be billed. 27

28 It is possible to define an initial biling period (eg: in the first minute the call costs X) and from that period on each second will be billed. Each rate field is separated by ";" and its meaning is: 1. Code - Prefix in international format without the international prefix (without 00 by default). For example to match the number (Portuguese mobiles) the prefix should be Country - Country name or description of the rate. 3. Price - Cost of each Period. 4. Period - After the initial period defined in InitialPeriod the call cost is incremented by the Price value every Period. 5. InitialPeriod - How many seconds of the initial period. 6. InitialPrice - Cost of the initial period. Figure 22: Upload rates The cost of the call is calculated using the following formulas: 28

29 1. if call time lesser than or equal to InitialPeriod: TotalCost=InitialPeriod*InitialPrice 2. if call time greater than InitialPeriod: TotalCost=InitialPeriod*InitialPrice + Price*(Calltime-InitialPeriod)/Period After uploading the CSV files you can edit each of the values on the Billing web interface or replace the rate by uploading a new one. Figure 23: Add phones and servers To set which phones or servers are going to be billed, please access Management > Phones and click on Add phones. Select as many phones or servers as needed and select which billing rate will be used. You can also add servers by clicking on the option Add server. By adding servers or phones, in this way, the calls will be matched by the caller id. This also allows adding PBX phones if the caller s id sent by these phones is unique Contacts configuration Access the Contacts web interface at (replace yourdomain.com by the correct domain). 1. The login is: administrator 29

30 2. The default password for this user is: 123 Create a new entity type by clicking in Definitions > Entities Management, then Entity Types and Insert if you don t have any. Choose a name for the group of entities that are going to be billed. Figure 24: Add a new entity type Create a new entity by clicking on Definitions > Entities Management and then Insert. For billing the field IPBrick phone must be set. Fill also the other fields as you see fit. 30

31 Figure 25: Creating a new entity 31

32 4.5.5 iportaldoc Configuration Access the iportaldoc web interface at (replace yourdomain.com with the correct domain). 1. The login is: administrator 2. The default password for this user is: 123 Figure 26: Inserting a new billing document Insert a new document in the Billing directory. Choose the entity type and entity from the dropdown list. If you have defined the Location and a Contact for that entity, choose them from the respective dropdown lists. 32

33 After filling the required fields click on Edit document. Choose the period and the phones or servers of the entity and contacts to be billed. A list of all the calls made by these equipments in the selected period will appear as well as the total ammount. Insert the generated document and send it to the customer or print it. Figure 27: Choosing the calls to be billed 33

34 4.6 Customer configuration The Customer has an IPBrick 1. Access the customer s IPBrick web interface. 2. In IPBrick.GT > VoIP > Route management click on Insert a new Outbound route 3. Click on Advanced Options and fill the required fields: (a) Type SIP (b) Name Name of the route or description (c) Server address IPBrick s Public IP or domain (d) Server port 5090 (e) Authentication User/Password (f) Username login created in IPBrick for this SIP account (g) Authentication username login created in IPBrick for this SIP account (h) Password/Retype Password password for this login (i) Caller identifier login created in IPBrick for this SIP account (j) Registration Realm IPBrick s domain (k) Other fields by default 4. Click on Insert 5. In IPBrick.GT > VoIP > Route management click on the newly created route. 6. Insert one or more prefixes to route the calls to the IPBrick with Billing Customer has a SIP Phone or a gateway with support for SIP 1. Register the phone or gateway with the following authentication: (a) Domain IPBrick s Public IP or domain eg: ipbrick.domain.com (b) Proxy domain and port IPBrick s Public IP or domain Port 5090 eg: :5090 (c) Username login created in IPBrick for this SIP account 34

35 (d) Authentication username login created in IPBrick for this SIP account (e) Password password for this login 35