1.13.1 Initial configuration

The onlineshop configuration is stored in text files located in the default installation folder i.e. at C:\inetpub\wwwroot\OnlineShop

The files are:

Database.config
AppSettings.config
Payments.config

Additional settings are in the VSM Settings/Online payments menu. They include:

Notifications
Payment descriptions
Charge amounts

Database

The database connection string is stored in the Database.config file. Below is an example of the file’s content:

<connectionStrings>

<clear />

<add name="ConnVoipSwitch"

connectionString="Server=192.168.1.2;

Database=voipswitch;

User Id=vpsuser;

Pwd=pass123;

Port=3306;

Connection Timeout=180;

Pooling=true;

Min Pool Size=0;

Max Pool Size=40;

Connection Lifetime=0;

Compress=false"/>

</connectionStrings>

Parameter	Description
Server	Address of the database server
Database	Database name, i.e. voipswitch.
User Id	Username used to connect to the database.
Pwd	Password to connect to the database.
Port	Port of the database server
Connection Timeout	Timeout when connecting to the database. Zero stands for unlimited.
Pooling	Method of creating and managing a pool of connections that are ready for use by any thread that needs them. To enable or disable, set true or false.
Min Pool Size	The minimum number of connections that are allowed in the pool. Zero (0) means no minimum connections are initially opened.
Max Pool Size	The maximum number of connections that are allowed in the pool.
Connection Lifetime	When a connection is returned to the pool, its creation time is compared with the current time, and the connection is broken if that time span (in seconds) exceeds the value specified by Connection Lifetime. Zero (0) causes polled connections to have a maximum timeout.
Compress	Turns on/off file compression on the disk.

Settings

The settings file is divided into sections containing key-values pairs allowing to configure different functionalities. An example of the AppSettings.config file:

<appSettings>

    <!--General settings-->

    <add key="Redirect" value=""/>

    <add key="LoggerPath" value=""/>

    <add key="UseResellerMerchant" value="false"/>

    <add key="UseFrameBypass" value="false"/>

     <add key="EnableBlocking" value="false"/>

    <!--Recharge login attempts blocking-->

    <add key="MaxBadLoginCount" value="10"/>

    <add key="BadLoginBlockTime" value="1"/> <!-- in minutes-->

     <!--TDefines priority in authorization during recharge.-->

    <add key="AuthorizationPriority" value="128;32;8" />

    <!-- Enables CreditCard data storage and charge using CC.ashx API -->

    <add key="UseCreditCardApi" value="false"/>

    <!-- Enables CC API over HTTP. (by default CC API can be used only over HTTPS) -->

    <add key="AllowUnsecureCreditCardApi" value="false"/>

    <!-- List of semicolon separated IPs. Subnet mask is allowed. -->

    <add key="CreditCardApiAllowedIPs" value=""/>

    <!-- Enables finalization methods in common.api -->

    <add key="UseFinalizationApi" value="false"/>

    <!-- Enables finalization methods in common.api API over HTTP. -->

    <add key="AllowUnsecureFinalizationApi" value="false"/>

    <!-- List of semicolon separated IPs. Subnet mask is allowed. -->

    <add key="FinalizationApiAllowedIPs" value=""/>

    <!-- Email address (or multiple addresses separated with ',') -->

    <!-- Important security informations will be sent to this address -->

    <add key="AdminEmailAddress" value=""/>

    <!-- Enables balance transfer -->

    <add key="UseBalanceTransfer" value="false"/>

    <!-- Enables balance transfer over HTTP. -->

    <add key="AllowUnsecureBalanceTransfer" value="false"/>

    <!-- List of semicolon separated IPs. Subnet mask is allowed. -->

    <add key="BalanceTransferAllowedIPs" value=""/>

    <!-- Enable/disable SureAddress address scrubbing system integration. -->

    <add key="UseSureAddress" value="false"/>

    <add key="SureAddressTestMode" value="true"/>

    <add key="SureAddressClientNumber" value=""/>

    <add key="SureAddressValidationKey" value=""/>

    <!-- Enable/disable SureTax tax calculator system integration. -->

    <add key="UseSureTax" value="false"/>

    <add key="SureTaxTestMode" value="true"/>

    <add key="SureTaxClientNumber" value=""/>

    <add key="SureTaxValidationKey" value=""/>

    <add key="SureTaxRegulatoryCode" value="99"/>

    <add key="SureTaxTransactionTypeCode" value="010101"/>

    <!-- Subscription API. -->

    <add key="UseSubscriptionApi" value="true"/>

    <add key="SubscriptionApiAllowedIPs" value=""/>

    <add key="AllowUnsecureSubscriptionApi" value="true"/>

</appSettings>

Key name	Description
Redirect	URL of the redirection after transaction is completed
loggerPath	Local path for storing log files. By default the logs are stored in the logs folder in the Onlineshop directory
UseFrameBypass	Allows to open the onlineshop in new frame
UseResellerMerchant	TODO
enableBlocking	Enable if you want to use the Black list feature
MaxBadLoginCount	Number of wrong login attempts
BadLoginBlockTime	Time in minutes, that user has to wait after unsuccessful login attempt
AuthorizationPriority	Authentication priorities list, the client types separated by semicolons (128 - PBX Clients, 32 - Retail Clients, 0 - Wholesale Clients)
UseCreditCardApi	Enables credit card details storage and recharge using cc.ashx API
AllowUnsecureCreditCardApi	Enables CC API over HTTP (by default CC API can be used only over HTTPS)
CreditCardApiAllowedIPs	List of semicolon separated IP addresses from which the cc.aspx API is allowed
UseFinalizationApi	Enables finalization methods in common.api
AllowUnsecureFinalizationApi	Enables finalization methods in common.api API over HTTP.
FinalizationApiAllowedIPs	List of semicolon separated IP addresses from which the finalization API is allowed. Subnet mask is allowed.
AdminEmailAddress	Email address (or multiple addresses separated with ',') to which the security information will be sent
UseBalanceTransfer	Enables balance transfer function (common api)
AllowUnsecureBalanceTransfer	Enables balance transfer over HTTP
BalanceTransferAllowedIPs	List of semicolon separated IP addresses from where the balance transfer method is allowed
UseSubscriptionApi	Enables the API methods required for subscription payment model
SubscriptionApiAllowedIPs	IP addresses allowed to use the subscription API
AllowUnsecureSubscriptionApi	Allows for using HTTP instead of default HTTPS when connecting to the subscription API

Notifications

The VSM Settings/Online payments/Notifications menu contains configuration for transactions related notifications. The menu is divided into two panels:

Email notifications
SMS notifications

The platform can send notification when a transaction changes its status. The body of the message and its title can differ depending on the following parameters:

Recipient type – available types: Client, Reseller, Administrator;
Client type – available types: Retail, Wholesale, UC/PBX, Reseller I; this is the type of the entity who made the transaction, besides the clients also resellers level I can initiate transactions.
Transaction status – available types: Approved, Pending, Canceled, Not processed
Transaction type – available types: Top up

For a combination of each of the above parameters you can set different message body.

Via email

An email can be sent as a plain text or in html format. If Use HTML checkbox is selected click on the Choose file button in order to pick an HTML template file. The body text and the mail’s subject should be entered in the relevant input fields. Clicking on the menu buttons next to the fields opens the dropdown list with available variables which can be used in the text. The variables will be replaced by actual values every time when a notification is sent.

The SMTP settings allow to configure an outbound email server that will be used by the platform for sending notifications. Below are the SMTP settings which have to be provided:

Sender email - an e-mail address that will be used as sender address;
Server address - IP address or domain name of the SMTP server;
Port - port used by the SMTP server;
User name – SMPT account username, all emails will be sent through that account;
User password
Use SSL – enables Secure Sockets Layer;
Server requires authorization – depends on the SMTP server configuration, in most cases the option should be enabled

Via SMS

Notifications via SMS use own configuration, separate from the email notification settings. Similarly, you can define criteria on when the message is sent and what will be its content.

The body field contains the SMS text. Click on the menu button to choose variables which will be replaced by values when a notification is generated.

The SMS provider settings section allows to add an SMS gateway credentials. The gateway will be used for sending notifications.

SMS sender – sender ID presented to the recipient of the SMS;
SMS API Url - link to the VSServices/SendSms.ashx file. By default the Url is:
http://YOURDOMAIN/VSServices/SendSms.ashx

Client pays – if enabled, the client that receives SMS notifications will bear their costs according to the tariff assigned to his account. Alternatively, you can choose another client account to incur charges – for example if you want to have a single account to control the notifications costs
SMS limit - max amount of SMSes that can be sent in one session.

Variables

The below variables can be used in both SMS and email notification’s templates:

[AMOUNT] - money that has been added to the client account;
[OPERATION] - transaction type;
[DATE] - date of the transaction;
[LOGIN] - customer's login;
[PASSWORD] - customer's password;
[NAME] - customer's name;
[CONFLINK] - transaction confirmation link (deprecated);

Following variables can be used for credit card transaction through providers’ APIs:

[PAYMENTDESCRIPTION] - payment description;
[RESULTDESCRIPTION] - result description;
[TRANSACTIONREFERENCE] - transaction reference;
[RESULTCODE] - result code;
[TRANID] - transaction id (merchant token);

Payment descriptions

The Payments descriptions menu in the VSM Settings/Online payments allows to define payment labels. The descriptions are used in two places:

When a payment request is sent to a payment provider, the description is sent as a parameter so that it can be displayed on the provider’s web payment form and/or in its billing records.
In the payments table in voipswitch database. The descriptions are shown to the client in the self-care VUP and in the VSM reports

Different descriptions can be set for different combinations of the following parameters:

client type: retail, UC/PBX, wholesale and callshop
payment type: recharge, IMTU, balance transfer
client’s country

TODO zmienic na Add to invoice - defines if the description should be added to invoice or not. CZY to tak dziala?

The following variables can be used in the description field:

[LOGIN]
[PASSWORD]
[NAME]
[LASTNAME]
[AMOUNT]
[OPERATION]
[DATE]
[PAYMENTCODE]
[SMSCODE]
[CONFLINK]
[ERRMSG]
[TRANID]
[EXCEPTION]
[RESULTCODE]
[RESULTDESCRIPTION]
[PAYMENTDESCRIPTION]
[AUTHORIZATIONCODE]
[PHONE]
[MOBILEPHONE]
[REFERRALKEY]
[CURRENCYNAME]
[CURRENCYSYMBOL]
[PROVIDERNAME]

Examples of use:

[NAME] [LASTNAME] - your account has been recharged.
[NAME] [LASTNAME] - your account has been recharged with [AMOUNT]

Balance transfer variables:

[PAYING_NAME] --> PayingClient.PersonalData.Name
[PAYING_LASTNAME] --> PayingClient.PersonalData.LastName
[PAYING_PHONE] --> PayingClient.PersonalData.Phone
[TARGET_NAME] --> TargetClient.PersonalData.Name
[TARGET_LASTNAME] --> TargetClient.PersonalData.LastName
[TARGET_PHONE] --> TargetClient.PersonalData.Phone
[PAYING_NAME] = [P_NAME] --> PayingClient.PersonalData.Name
[PAYING_LASTNAME] = [P_LASTNAME] --> PayingClient.PersonalData.LastName
[PAYING_PHONE] = [P_PHONE] --> PayingClient.PersonalData.Phone
[PAYING_MOBILEPHONE] = [P_MPHONE] --> PayingClient.PersonalData.MobilePhone
[TARGET_NAME] = [T_NAME] --> TargetClient.PersonalData.Name
[TARGET_LASTNAME] = [T_LASTNAME] --> TargetClient.PersonalData.LastName
[TARGET_PHONE] = [T_PHONE] --> TargetClient.PersonalData.Phone
[TARGET_MOBILEPHONE] = [T_MPHONE] --> TargetClient.PersonalData.MobilePhone
[PAYING_EMAIL] = [P_EMAIL] --> PayingClient.PersonalData.EMail
[TARGET_EMAIL] = [T_EMAIL] --> TargetClient.PersonalData.EMail

Charge amounts

The VSM Settings/Online payments/Charge amounts menu lets you define the amounts which will be shown to clients when making top up from the mobile softphones or the VUP. A client can select only one of the available amounts. Besides the limit in the GUI, the onlineshop checks the requested amount before executing payment transaction. If the requested amount is different from the defined ones the request will be rejected.

You can define different charge amounts for different client types.

Voipswitch documentation