Page tree
Skip to end of metadata
Go to start of metadata

This page contains instructions on how to set up your online store.

Overview

All the required options are grouped into several tabs that can be accessed from the Setup → System Behaviour page. The Online Store is the default tab that opens when accessing the System Behaviour page. This is where you will be required to fill in the store details fully described below.

General preferences

  • Automation hostname/IP <IP>:<port>: Specify the IP address and the port of the server on which the Automation module is located. By default, the <IP> and <port> text boxes are empty; on focus, they get filled in with the values taken from the current URL. Allowed port values: 1 to 65,635.
  • Default currency: The charging default currency. Will be used all across the Automation module, as well as in the online store. Can only be changed until the first transaction is performed in Automation. Based on the currency set here, the exchange rate for the foreign currencies is computed in the Setup → Currency exchange section.
  • Assume default country when not detected: Select the country that will be used in the Automation interface. For example, when the administrator adds a new customer account, this will be default selected country.
  • Assume default language: Select the language that will be considered the default one for all the new customer accounts that will be added to the system.
  • Default system-wide language: Select the language pack that will be used by default in the Automation interface. You may choose between the already installed packs. By default, Automation is installed with the English language pack.

Online store preferences

Maintenance mode

Store is in maintenance mode: For maintenance operations such as upgrading the store, you need to enable this checkbox. Once the checkbox is enabled, you will be informed that the store is in maintenance.

Store settings

Time zone: Select the store's default time zone, according to your preferences.

Online store SQL connections

The store connects to the Automation database using a setup SQL user. Here are the connection configuration parameters:

The store is connecting to the Automation database using a setup SQL user. Please find below the connection configuration parameters.

  • Store connects from: In most cases, the store is installed on a different machine than VoipNow Automation. Specify the IP address of the machine the store is installed on.
  • Store MySQL username: Specify the MySQL username used by the online store to connect to the Automation database.
  • Store MySQL password: Change the password used by the online store to connect to the Automation database. Please note that at least 5 characters must be entered.
  • Confirm store MySQL password: Confirm the new password previously specified.

On the server where you've installed the online store, edit the following lines in config.php using your favorite editor:

'DB_NAME' => 'voipnow',
'DB_HOST' => '[your_domain]',
'DB_USER' => '[mysql_user]',
'DB_PASSWD' => '[mysql_pass]',
'DB_PORT' => '3306',

Where:

  • DB_NAME: The VoipNow Automation database name.
  • DB_HOST: The IP/Hostname of the server where the VoipNow Automation backend is installed.
  • DB_USER: The MySQL username used to connect to the DB_NAME (as defined in VoipNow Automation, for the Setup Behaviour Online Store Store MySQL username field).
  • DB_PASSWD: The MySQL password used to connect to the DB_NAME (as defined in VoipNow Automation, for the Setup Behaviour Online Store Store MySQL password field).
  • DB_PORT: The VoipNow Automation MySQL port number. The typical port number is 3306.

Online store presentation

In this area, you can customize the online store interface pictured here by defining the behavior and appearance options:

  • Link to Refund Policy {text} use link in store: Fill in the Refund Policy URL location. Enable the checkbox if you want the link to be displayed in the online store.
  • Link to SLA {text} use link in store: Fill in the SLA (Service Level Agreement) URL location. Enable the checkbox if you want the link to be displayed in the online store.
  • My website link: Fill in a link to a specific website, for example, the vendor's. This link will be accessible from the online store with just a simple click on the logo at the top of the page.

  • My online store name: Fill in the title of the online store page.

  • My online store link: Fill in the online store address. The link must have the following format: https://hostname/ IP/ folder/, where the presence of https and folder is required.
  • Show contact page {URL}: Fill in the contact page address that will be displayed in the online store page and enable the checkbox.

  • List contact phone: Specify the vendor's contact phone that will be displayed in the online store page and enable the checkbox. The customers will be able to call this number if they experience any issues regarding the store.

  • List email: Fill in the vendor's contact email address that will be displayed in the online store page and enable the checkbox. The customers will be able to use this email address if they experience any issues regarding the store.
  • Anti-spam email listing: When enabled, the vendor's email address is displayed in the following format: name AT domain dot com.
  • Show numeric values with {x} decimals: Fill the number of decimals used to display all the prices from the online store. The default value is 2 (e.g. 11.75 {currency}).
  • Make online store available in: Select the language used for the online store. If required, you can make the online store available in multiple languages by using the +/- icons.

Online store languages table

This area lists a table with the language(s) used in the interface of the online store.

  • S: Click this icon to change the status of the language: for enabled for disabled
  • Language: The language name.
  • Default: This field will display the following text: Default language:
    • Not allowed if either of these conditions are fulfilled;
    • Not all the items have presentations in that language (except for withdrawn items);
    • Not all categories have presentations in that language;
    • The language is not active.
    The default language cannot be deleted.

Orders & invoices

By reading this page, you will learn how to set up some important options with regard to item deployment and invoice behavior.

Orders

  • Require user to accept Refund Policy: When enabled, upon finalizing an order in the online store, customers will be asked to accept the Refund Policy terms and conditions. Please note that this setting is not available unless the Link to Refund Policy option is enabled from the Online Store tab.
  • Require User to Accept SLA: When enabled, upon finalizing an order in the online store, customers will be asked to accept the Service Level Agreement terms and conditions. Please note that this checkbox is not available unless the Link to SLA option is enabled from the Online Store tab. When the Require User to Accept Refund Policy and the Require User to Accept SLA options are enabled in the online store, customers will be asked to select the corresponding checkboxes before finalizing an order.
    This section is available in the Finalize Order page, after adding one or several items to the cart and after clicking the Checkout button.
  • Deploy Orders Automatically: If you want to schedule all ordered items for which the payment has been successfully received for deployment, you need to enable this checkbox. If this checkbox remains unselected, the administrator has to manually deploy the services. There are two ways to do this:
    • Access the Orders Management page by clicking the Orders link in the left navigation panel. Choose the desired order, then click the Choose link from the Operations column. The pop-up panel that will be displayed allows you to schedule for deployment all the services that have not yet been deployed by selecting the Fulfill now option. It's available only for paid orders in the New status.
    • Go to the Deployed Services page by clicking the Order deployment link in the left navigation panel. Choose the desired order, then click the Choose link from the Operations column. The pop-up panel that will be displayed allows you to command the service deployment by selecting the Activate option, available only for Pending items that belong to paid orders.

Invoices

  • Issue invoices on {x} every month: From the drop-down list, select the date you want the recurring invoices to be automatically issued.
  • Recurrent invoices tolerance interval {number} days: Fill in the text box with a time frame for the recurring invoice. In short, specify in {number} of days how often the fixed fee is invoiced. The first case describes the invoice generation process when the deployment is successfully fulfilled on the date of the purchase and when the tolerance interval is not exceeded.

     Click here to expand the first case.

    Purchase Date: 10th October
    Service charge between 10th October - 9th November
    Deployment Date: 10th October
    Tolerance interval: 10 days
    Issue invoice on: 3rd of every month
    Invoice Generation Date: 3rd November
    Charge for:
    Service between 10th November - 9th December
    Consumption between 10th October - 2nd November
    Invoice Generation Date: 3rd December
    Charge for:
    Service between 10th December - 9th January
    Consumption between 3rd November - 2nd December
    Invoice Generation Date: 3rd January
    Charge for:
    Service between 10th January - 9th February
    Consumption between 3rd December - 2nd January

    The second case describes the invoice generation process when the deployment is successfully fulfilled on the date of the purchase and when the tolerance interval is exceeded.

     Click here to expand the second case.

    Purchase Date: 10th October
    Service charge between 10th October - 9th November
    Deployment Date: 10th October
    Tolerance interval: 5 days
    Issue invoice on: 3rd of every month
    Invoice Generation Date: 3rd November
    No invoice is generated because on 3rd November
    we already have a number of days greater
    than the tolerance interval paid in advance.
    Next recurrent invoice is issued on 3rd December.
    Invoice Generation Date: 3rd December
    Charge for:
    Service between 10th November - 9th December
    Consumption between 10th October - 2nd December
    Invoice Generation Date: 3rd January
    Charge for:
    Service between 10th December - 9th January
    Consumption between 3rd December - 2nd January

  • Generated invoices are due in {x} days: Fill in the maximum amount of time allowed for the payment of a new invoice. At the end of the specified number of days, if the invoice is still unpaid, it will be considered overdue.
  • Maximum number of operation attempts: Fill in the text box with the maximum number of attempts that the application can make in order to complete an operation (deployment, suspension or termination) that failed due to a certain reason.

Payment preferences

In this area, customers can set up and configure payment plugins. Go to upper left menu, select System Setup >> Behaviour and click on the Payment Preferences tab.

The customer account is able to use all the payment methods set up here in the online store;

If no payment plug-ins are defined, a message will be displayed informing you that "No payment plug-in is in use. The online store payments are unavailable". The single virtual payment plug-in available is PayPal Billing Agreement.

Payment plug-ins

By default, VoipNow Automation provides the following gateway payment plug-ins:

  • Authorize
  • CyberSource
  • PsiGate
  • PayPal
  • Realex
  • Quantum
  • PayPal PayFlow Pro
  • PayPal Billing Agreement

Two offline payment plug-ins are also available:

  • Check payment
  • Wire transfer

Payment methods

  • Credit card orocessor: From the drop-down list, select the credit card processor that will be used in the online store; This option is not available unless the credit card gateway payment plug-in has been configured first; The line will not be displayed if the payment plug-ins have not been configured.
  • Accept check payments: This option allows check payments to be accepted as a valid payment method in the online store.
  • Accept wire payments: This option allows wire transfers to be accepted as a valid payment method in the online store.

Payment settings

  • Automatic payment: This option allows customer accounts to be automatically charged for all their new orders, using existing payment subscriptions.
  • Connection timeout for the credit card processor {x} seconds: Fill in the number of seconds the application waits for an answer from the credit card processor.
  • The maximum number of automatic payment attempts: Fill in the number of times the application will try to charge the customer account's subscription if the first attempt fails.

Payment plug-ins

To configure a payment plug-in, simply click the Configure now link available in the Name column. To have a complete view on the process, here are the steps that must be followed in order to configure the PayPal payment plug-in:

  1. Navigate to the Plug-in configuration page.
  2. Click the Configure now link corresponding to the paypal UID.
  3. Set the Payment Plug-in. The PayPal Payment Plug-in configuration page provides all the details that must be set up before the plug-in becomes functional in the online store; you can find them detailed down the page;
  4. Save your settings.
  5. Click OK to set up the plug-in or Cancel to go back to the previous page without saving these settings. The Payment Plug-in information that you can customize is grouped under two sections.

Plug-in information

The information displayed here is available for all the payment plug-ins.

Here is an overview of the fields that must be filled in:

  • Select plug-in: The plug-in's Unique Identifier, which cannot be changed.
  • Friendly name: Fill in the plug-in's name that will be displayed in the online store and that will be visible to the customers.
  • Refund in maximum {x} days: Fill in the number of days until the invoice becomes overdue.
  • Log requests: Enable this option if you want VoipNow Automation to keep a log of all the packages exchanged with the payment processor.

VoipNow Automation does not store credit card numbers or any other information of this kind!

Plug-in configuration example

This section contains the configuration information, specific to each payment plug-in.

Here is an overview of the fields that must be filled in for the Cyber Source payment plug-in:

  • Cyber source schema: Fill in the link to the Cyber Source syntax. The link provided in this example is the default one available when configuring the plug-in.
  • API username: The username required to connect to the Cyber Source's API.
  • API password: The password required to connect to the Cyber Source's API.
  • Currencies: From all the currencies supported by this payment processor, you can select the ones to be used in the online store.

If you have configured a plug-in and you want to reset it to the factory settings, you can enable its corresponding checkbox and click the Reset configured plug-ins link. You will be asked to confirm the action.

A plug-in can be reset if:

  • It is not a wire or a check plug-in (wire and check plug-ins are identified after their UID);
  • It was not setup in Preferences → Behaviour → Payment methods tab as one of the accepted payment methods;
  • There are no pending/completed payments registered for that gateway.

Vendor information

In this page, you can modify the vendor's contact and payment details that will be used by all the online store's customers. Here is an example of what the Vendor Information tab looks like.

The Vendor Information section includes all contact and payment details related to the vendor.

 Click here to expand them.
OptionDetails
CompanyThe name of the vendor's company.
EmailThe vendor's contact email address.
PhoneThe vendor's contact telephone number;
FaxThe vendor's contact fax number;
Street address

The vendor's complete address;

CityThe vendor's home city;
Postal/ZIP code

The vendor's postal code;

CountryUse the drop-down list to select the vendor's country;
State/ProvinceUse the drop-down list to select the vendor's province; the list displays all the provinces that correspond to the chosen country;
Bank accountThe bank account number;
Bank nameThe vendor's bank name;
Tax account noThe company's tax account number, if available;



  • No labels

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.