TELCOware 2.9.1 Setup Guide © 2003 - 2012 Bicom Systems
I
TELCOware 2.9.1 Setup Guide
Table of Contents Foreword
0
Part I Introduction
1
Part II Setup Wizard
1
1 EULA ................................................................................................................................... 1 2 Server ................................................................................................................................... Details 1 3 Administrator ................................................................................................................................... Details 2 4 Licensing ................................................................................................................................... 2 5 Currency ................................................................................................................................... 3 6 Payment ................................................................................................................................... Methods 3 7 Payment ................................................................................................................................... Settings 3 8 Company ................................................................................................................................... Details 4 9 Bank ................................................................................................................................... Account 5 10 Taxes ................................................................................................................................... 6 11 Telephony ................................................................................................................................... Switch 6 12 Measurement ................................................................................................................................... Units 6 13 Confirm ................................................................................................................................... 6
7
Part III Configuring TELCOware
1 Login ................................................................................................................................... Into Administrator GUI 7 2 Company ................................................................................................................................... Contact and Bank Account Details 7 3 Website ................................................................................................................................... Content 7 Hom e ......................................................................................................................................................... 8 My Account......................................................................................................................................................... 8 New Account .................................................................................................................................................. Registration Message 8 Allow /Disallow .................................................................................................................................................. New Account Registration 9 Unsupported .................................................................................................................................................. Domains 9 Shop ......................................................................................................................................................... 9 Product & .................................................................................................................................................. Services 10 Phone Lines ........................................................................................................................................... 10 IP Phones ........................................................................................................................................... 11 Call Credit ........................................................................................................................................... 12 Shop page.................................................................................................................................................. 14
4 Add ................................................................................................................................... PBXware Switch 14 5 Create ................................................................................................................................... Service Plan 15 6 Create ................................................................................................................................... Packages 15 7 Subscribe ................................................................................................................................... To Service 16
© 2003 - 2012 Bicom Systems
Contents
Index
© 2003 - 2012 Bicom Systems
II
0
1
1
TELCOware 2.9.1 Setup Guide
Introduction
Presuming that TELCOware is already installed and accessible over known URL or IP address this setup guide covers in details all steps required from the Setup Wizard to make it fully working and operational including brief explanation about how to configure TELCOware for telephony services and recurrent telephony billing. There are few steps to be completed before generating recurrent invoices for the first time. In these steps we will configure several application to complete this task including setting products and services as well as shopping cart. Shopping cart allows customer to buy telephony service. Also, this guide cover steps about how easy to integrate TELCOware with PBXware and provision telephony service.
2
Setup Wizard Setup Wizard is designed to collect essential data in order to get TELCOware up and running. After the setup wizard has finished the system should be fully licensed, fully operational and ready for use. In order to login into the setup wizard please point your browser to the TELCOware IP address, example https://192.168.1.2:82 NOTE: Make sure to use https and port 82.
2.1
EULA EULA (end user license agreement) is the first setup wizard step. Please read the EULA, if You agree with end user license agreement type I agree and click on Confirm button to proceed. If You do not agree with EULA, please remove the installation media, remove system software and return license issued.
2.2
Server Details These are system and network fields necessary for proper system operation. Root Password (field): TELCOware prompts for this password during the system/ssh login and when accessing
© 2003 - 2012 Bicom Systems
Setup Wizard
2
system services through interface, example when you want to update the system. Confirm Password (field): Re-type the root password entered in the field above. Timezone (select box): Select the appropriate time zone, where TELCOware is located. Hostname (field): The name given to machine which will identify the system on the network, example: mainhost. Default URL (field): Enter default domain name for TELCOware, example: www.mydomain.com.
2.3
Administrator Details Provide details of user who will administer TELCOware. These values are used when login into the TELCOware GUI. E-mail (field): Provide a valid email address, make sure you enter e-mail address correctly. This e-mail address is used as a username for logging into TELCOware GUI. Password (field): Provided password that is used for logging into system Confirm Password (field): Re-type password entered in the field above.
2.4
Licensing Licensing offers entering of a valid non active license and displays MAC address to which license will be valid with. If the system has more then one network adapter all found MACs will be shown for selection. Licence Type (select box): By default only option available and selected is Requested License. License Number (field): Enter the TELCOware license number. MAC (radio box): If there is just one MAC address it will be selected already. If there is more than one MAC address present select appropriate one. NOTE: System must have access to fully operational Internet connection in order to be licensed. Click Next to register the TELCOware.
© 2003 - 2012 Bicom Systems
3
2.5
TELCOware 2.9.1 Setup Guide
Currency Default currency settings are defined here, use one of the predefined currencies or setup your own currency. Select predefined currency (select box): Select default TELCOware currency from the predefined currencies. Available currencies Canadian dollar Euro Pound sterling United States dollar or enter currency details (group): Use this to add custom currency if required. Added custom currency will become default system currency. Name (field): Enter name for the custom currency. Code (field): Enter custom currency code. Symbol (field): Enter custom symbol. Position (radio box): Define currency symbol in regard to the value, example Left $ 0.00 or Right 0.00 $
2.6
Payment Methods Define allowed type of payments and allowed credit/debit cards. Select payment types you want to allow in shop: Click on check boxes for corresponding payment method you want to accept in the shopping cart. Select type of credit/debit cards you want to accept: Click on check boxes for credit/debit cards you accept to be used for payments with PayPal, Moneybookers, LinkPoint, Authorize.net or Payflow pro.
2.7
Payment Settings PayPal Account (field): Enter your paypal account e-mail address.
© 2003 - 2012 Bicom Systems
Setup Wizard
4
PayPal currency (select box): Select your paypal account default currency. PayPal Test mode (check box): Check this box if you require to test TELCOware with PayPal. Transaction executed will be only for testing purpose. PayPal header background color (field): It is possible to change PayPal header background color, enter hexadecimal color value example for red FF0000.
2.8
Company Details Enter company details here. Name (field): Enter company name. Address (field): Enter company address. Country (select box): Select appropriate country. State (select box): If applicable for selected country select appropriate state. City (select box): If applicable for selected country and selected state select appropriate city. Post Code/Zip (field): Enter post Code/Zip. Telephone (field): Enter phone number. Fax (field): Enter fax number. Email (field): Enter email address.
© 2003 - 2012 Bicom Systems
5
2.9
TELCOware 2.9.1 Setup Guide
Bank Account Enter company bank account details. Bank Name (field): Enter company bank name. Bank Address (field): Enter bank address. Bank Address 2 (field): If required use this field to enter additional bank address details. Country (select box): Select appropriate bank country. State (select box): If applicable for selected country select appropriate bank state. City (select box): If applicable for selected country and state select appropriate bank city. Bank Post Code/Zip (field): Enter bank post Code/Zip. Account Name (field): Enter company account name in the bank. Account no (field): Enter company bank account number. Sort code (field): Enter company bank sort code. Swift number (field): Enter company swift number. IBAN (field): Enter your company bank IBAN code. Additional Instructions (field): If required enter here additional bank account details.
© 2003 - 2012 Bicom Systems
Setup Wizard
2.10
6
Taxes Define taxes for services and products as per your company physical location or presence. If your company is not part of the European Union or USA you should select Nothing above. I will add taxes later. option.
2.11
Telephony Switch Connect TELCOware with telephony switch. If you require to add more telephony switches login into TELCOware GUI after you finish setup wizard and add more. PBX name (field): Enter PBXware name. Host (field): Enter PBX host address, example pbxware.bicomsystems.com. PBXware API Key (field): Ask PBXware administrator for API key and enter it in this field.
2.12
Measurement Units Define your TELCOware measurement unit which will be used for defining shipping packages sizes. Measurement units (select box): Select one of the available measurement units. Available units: Metric units USA units UK units
2.13
Confirm Finally, the confirmation step allows for all values to be revised and to either finish the wizard or start all over from the beginning. If Confirm and finalize button s clicked on, setup wizard will finish and browser will be redirected to system GUI login screen. Repeat the wizard (button): All provided details will be reset and started again from the step one click this button to repeat the wizard. Confirm and finalize (button): All provided details will be applied and setup wizard will redirect to TELCOware login screen Confirm the date provided in the setup wizard and finalize the installation.
© 2003 - 2012 Bicom Systems
7
3
TELCOware 2.9.1 Setup Guide
Configuring TELCOware -
3.1
Login Into Administrator GUI Company Details and Bank Account Details Website Content Add PBXware Switch Create Service Plan Create Packages Subscribe To Service
Login Into Administrator GUI In order to login into the Administrator GUI point your browser to: http://IPADDRESS/ admin/ example: http://192.168.1.2/admin or your website domain name example: http://www.yourdomain.com/admin.
3.2
Company Contact and Bank Account Details Although company and bank account details are collected from the process through which you pass in TELCOware Setup Wizard make sure to check for valid company and bank account details because these will be used when your clients contact you and when they make payment for services and products that you sell. 1. Click on Contacts tab in the top navigation menu. If you just installed TELCOware and passed trough the Setup Wizard here you'll see only one line with the company and bank account details. 2. Click on Edit button on the right side to edit company and bank account details. 3. Check entered details and make changes if required, for description about fields, select boxex or radio boxes please refer to our TELCOware Administration Manual. 4. Click on Save changes button when you finish. 5. On your website check the contact page content. Below image shows TELCOware default website design and Contact us page with company contact details.
3.3
Website Content Once installed, after Setup Wizard has been completed TELCOware is up and running but needs some website content to be filled in. There are already four web pages created and displayed on the website. This TELCOware Setup Guide will help you to configure following web pages: - Home - My Account - Shop
© 2003 - 2012 Bicom Systems
Configuring TELCOware
3.3.1
8
Home Basically website Home page can contain anything but the most common content we encounter on the websites each day we surf the internet is something like a welcome message or advertisement for products and services sold on the website. 1. Click on CMS tab in the top navigation menu. By default Home page is already selected and there is already one content block which contains simple text Welcome To TELCOware, which is already displayed on the website home page. 2. Click on Edit button in the content block to edit already existing content. 3. You can change the content using HTML editor but usually it is easier to change the content via content editor, click on Edit via editor button at the bottom. 4. Content editor provides all tools needed for the content formatting. 5. Fill in your content and make it look the way you want. 6. Click on Save icon at the top of the content editor, content editor window will close. 7. Click on Save changes button at the bottom of the HTML editor. 8. Below image shows Home page content box filled with the content. 9. Below image shows Home page on the website with the content.
3.3.2
My Account By default My Account page on the website is ready for new account registration with the default account settings. However, if required these are common things that are adjusted according to the needs of the TELCOware owner: - New Account Registration Message - Allow/Disallow New Account Registration - Unsupported Domains
3.3.2.1
New Account Registration Message
New account registration message may be useful to attract interested and potential buyers to register. 1. Click on Accounts tab in the top navigation menu then click on Settings in the left navigation menu. 2. Enter a message into the New Account field, example: Register TODAY and get 5% discount for all orders!!!.
© 2003 - 2012 Bicom Systems
9
TELCOware 2.9.1 Setup Guide
3. Click on Save button. 4. Below image shows My Account page on the website with the new account message. 3.3.2.2
Allow/Disallow New Account Registration
1. Click on Accounts tab in the top navigation menu then click on Settings in the left navigation menu. 2. By default new account registration is allowed, if you want to disallow new account registration click on the Hide New Account button check box and click on Save button. 3. When new account registration is disallowed New Account button will disappear from the My Account page on the website, only already existing accounts (registered user) will be able to login into their account page as shown on the image below. 3.3.2.3
Unsupported Domains
Sometimes the administrator wants to not allow registration of new account with the email address using particular domain name, such as free addresses from hotmail.com, yahoo.com, google.com etc. 1. Click on Accounts tab in the top navigation menu then click on Settings in the left navigation menu. 2. Enter domain names that you want to disallow from being used as the account email address when new user try to register a new account, example: hotmail.com, google. com, make sure to enter a comma after each domain name and click on Save button.
3.3.3
Shop This TELCOware Setup Guide will help you to configure basic content for the Shop page to display few products and services on the website. By default TELCOware Product and Services application contains the data you can adapt to your needs and requirements. Also, by default already existing data is displayed on the Shop page on the website as shown in the picture below. Product & Services Check out how configure product and services items that are most common in shopping cart (on Shop page): Shop page Once product and services items are created decide which to display on Shop page on your website.
© 2003 - 2012 Bicom Systems
Configuring TELCOware 3.3.3.1
10
Product & Services
Check out how configure product and services items that are most common in shopping cart (on Shop page): - Phone Lines - IP Phones - Call Credit 3.3.3.1.1 Phone Lines
1. Click on Products & Services tab in the top navigation menu. 2. Click on the + sign left to the directory icon to expand Business Phone Lines directory then click on bizLINE item. 3. When you edit bizLINE item there will be a warning message saying that product (item) does not have price set. Click on Pricing & Ordering button. 4. When Pricing & Ordering pop up window appear click on New price button to add a new price for this product (item). 5. Price pop up window. Cost price: Enter your purchase price. Min price: Enter your minimum selling price. This will prevent you selling the product to your customers for the price lower than your purchase price when you set other price types and price discounts or referral commissions. Net profit: This only calculates how much is the net profit. End user group Price: Enter end user price. Minimum price for end user or any other type of user is the price set in the Min. price field above. Referral Commission: This field is used if you wan to in calculate referral commission for the end user price. Net profit: This only calculates how much is the net profit after referral commission is applied. Setup fee: Enter your setup fee price here.
© 2003 - 2012 Bicom Systems
11
TELCOware 2.9.1 Setup Guide
Quantity: By default minimum quantity is set to 1 and maximum quantity to 5 for this type of product, in this example we changed that to unlimited. You should set whatever is appropriate for you. Show price: By default this is set to Show price radio box, it means that the price will be shown on the website to all visitors. Account discount: By default this box is checked, that means if there is a discount created it will apply to the end users. 6. If required click on Show other price types button to enter prices for other user types (Commercial, Public Sector, Reseller, Wholesale, Distributor). Please note that you can also create your own user type. 7. Click on Save changes button. PLEASE NOTE: You can repeat above for voIPLINE item in Residential Phone Lines directory or any other item that you create/add into both directories. 3.3.3.1.2 IP Phones
1. Click on Products & Services tab in the top navigation menu. 2. Click on the + sign left to the directory icon to expand IP Phones directory then Cisco directory then click on Cisco 7940G item. 3. When you edit Cisco 7940G item there will be a warning message saying that product (item) does not have price set. Click on Pricing & Ordering button. 4. When Pricing & Ordering pop up window appear click on New price button to add a new price for this product (item). 5. Price pop up window. Cost price: Enter your purchase price. Min price: Enter your minimum selling price. This will prevent you selling the product to your customers for the price lower than your purchase price when you set other price types and price discounts or referral commissions. Net profit: This only calculates how much is the net profit. End user group
© 2003 - 2012 Bicom Systems
Configuring TELCOware
12
Price: Enter end user price. Minimum price for end user or any other type of user is the price set in the Min. price field above. Referral Commission: This field is used if you wan to in calculate referral commission for the end user price. Net profit: This only calculates how much is the net profit after referral commission is applied. Setup fee: Enter your setup fee price here. Quantity: By default minimum quantity is set to 1 and maximum quantity to 5 for this type of product, in this example we changed that to unlimited. You should set whatever is appropriate for you. Show price: By default this is set to Show price radio box, it means that the price will be shown on the website to all visitors. Account discount: By default this box is checked, that means if there is a discount created it will apply to the end users. 6. If required click on Show other price types button to enter prices for other user types (Commercial, Public Sector, Reseller, Wholesale, Distributor). Please note that you can also create your own user type. 7. Click on Save changes button. PLEASE NOTE: You can repeat above for any item in IP Phones directory and subdirectory or any other item that you create/add. 3.3.3.1.3 Call Credit
1. Click on Products & Services tab in the top navigation menu. 2. Click on Add new Item button. 3. Enter name and select category for the new item. Name: Enter a name for the new item, example Call Credit. Category: Select Call Credits category for the new item.
© 2003 - 2012 Bicom Systems
13
TELCOware 2.9.1 Setup Guide
4. Click on Save changes button. 5. When the item is created there will be a warning message saying that product (item) does not have price and tax set. Click on Taxes button. 6. Make sure to select appropriate taxes settings for your item and click on Save changes button. 7. Click on Pricing & Ordering button. 8. When Pricing & Ordering pop up window appear click on New price button to add a new price for this product (item). 9. Price pop up window. Cost price: Enter your purchase price. Min price: Enter your minimum selling price. This will prevent you selling the product to your customers for the price lower than your purchase price when you set other price types and price discounts or referral commissions. Net profit: This only calculates how much is the net profit. End user group Price: Enter end user price. Minimum price for end user or any other type of user is the price set in the Min. price field above. Referral Commission: This field is used if you wan to in calculate referral commission for the end user price. Net profit: This only calculates how much is the net profit after referral commission is applied. Setup fee: Enter your setup fee price here. Quantity: By default minimum quantity is set to 1 and maximum quantity to 5 for this type of product, in this example we changed that to unlimited. You should set whatever is appropriate for you. Show price: By default this is set to Show price radio box, it means that the price will be shown on
© 2003 - 2012 Bicom Systems
Configuring TELCOware
14
the website to all visitors. Account discount: By default this box is checked, that means if there is a discount created it will apply to the end users. 6. If required click on Show other price types button to enter prices for other user types (Commercial, Public Sector, Reseller, Wholesale, Distributor). Please note that you can also create your own user type. 7. Click on Save changes button. PLEASE NOTE: You can repeat above, create and add new item into Call Credits directory. 3.3.3.2
Shop page
As mentioned previously TELCOware comes with already existing data in Product & Services application in form of categories and items, therefore, after you finish managing product and services you should make only these items displayed on Shop page on the website. 1. Click on CMS tab in the top navigation menu and select Shop page, once Shop page content box is displayed click on Edit button. 2. Make sure to select categories containing items you want to display on Shop page on the website and click on Save changes button. 3. Below image shows items displayed on Sop page on the website.
3.4
Add PBXware Switch 1. Click on Billing tab in the top navigation menu then on Telephony: PBX Switches in left navigation menu. 2. Click on Add button and fill in required details then click on Save button. PBX name: Enter PBXware switch name, example Bicom Systems Demo PBXware. Host: Enter host for the PBXware switch. PBXware API Key: Make sure to obtain valid API Key from the PBXware switch administrator, then enter the API key in this field. Enable: Make sure this box is checked if you want to enable this PBXware switch for use.
© 2003 - 2012 Bicom Systems
15
3.5
TELCOware 2.9.1 Setup Guide
Create Service Plan 1. Click on Billing tab in top navigation menu then on Subscriptions: Service Plans in left navigation menu. 2. Click on Add Service Plan button, fill in required details then click on Save button. Name: (field) Enter a name for new service plan, example: End User Plan. US Dollar: (select box) Select one of the available service plan, example: Standard. Service plans available are located in PBXware. 3. Click on Save button to finish. 4. Below image shows new created service plan listed.
3.6
Create Packages 1. Click on Billing tab in top navigation menu then on Subscriptions: Packages in left navigation menu. 2. Click on Add Package button, fill in required details then click on Save button. Package Name: (field) Enter package name, example: End User Standard. Description: (button) Click on Description button, a pop up window will appear, enter some description for the package, then click on save icon. Service plan: (select box) Select Service Plan, example: End User Plan. See here how to Create Service Plan. Recurrent service charges Click on Add Item button, browse trough little pop up window find and add appropriate item, example: Directory: Residential Phone Lines / Item: voipLINE. 3. Click on Save button to finish. 4. Below image shows new created package listed.
© 2003 - 2012 Bicom Systems
Configuring TELCOware
3.7
16
Subscribe To Service 1. Click on Accounts tab in top navigation menu. 2. Click on account name or edit button to edit an account in order to subscribe that account to available services. 3. Navigate to Subscription Services in left navigation menu then click on Add button. 4. Fill in required details. Package (select box): Select a package, example: End User Standard. See here how to Create Package. Tel. Number(s): Enter telephony number you want assign to edited account and click on button. 5. Click on Save button to finish. 6. Below image shows new created package listed.
© 2003 - 2012 Bicom Systems
