Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The next step is to tune Client Panel settings. If you are using default deployment, the configuration is located at /opt/jerasoft/vcs-data/conf/cp-customer-params.json. If you are moving the panel to the other host, the file should be located in <YOUR-PATH>/portal-backend/config/customer-params.json.

During the installation process, the file is pre-created with all general settings like billing credentials, tokens, etc. At the same time there is a set of parameters that can be configured like:

  • Payment gateway credentials
  • Default locale and output settings
  • Date and time formatting options
  • Rates and costs rounding

In order to To simplify the process, your deployment provides file the /opt/jerasoft/vcs/portal-backend/config/customer-params.default.json file. This file has all the available settings with their default values. You do not need to change this file, it is provided as a reference.

Per Reseller Configuration

The structure of the your configuration file allows you to have different settings for different Resellers in the system. By default the file contains a single section called "default" with all custom settings. If you want to have multiple Client Panels (for example, separated by domain names), you need to add another section with a simple distinguishable name and put all related settings in this section. The name may consist of latin charactersLatin characters, numbers, minus and underscore characters. 

After that you need to pass this name from your web-server to the panel using FastCGI parameter called "CONFIG_ID". It will tell panel which part of config to read in order to display a related Client Panel. If you are using nginx as your web server, use the following statement to pass the parameters:

Code Block
languagebash
titleNginx Config
fastcgi_param CONFIG_ID "special";

Configuration Options

As mentioned above, you can use /opt/jerasoft/vcs/portal-backend/config/customer-params.default.json file as a reference for all available parameters. The table below describes each of them. Please put all settings into your config file and do not change customer-params.default.json as it will be overwritten on the system update.

...

Setting Name

Description

Example

billingUribillingUrlURL of the billing system
. As it is accessible from the Client Panel host
"https://127.0.0.1"
companiesIdID of the Reseller for the Client Panel
3

logFile

Path to the Client Panel log file

"/opt/jerasoft/vcs-data/log/cp.log"
openedEndpoint

URL of the Client Panel (without "/" at the end)
. This URL will be used to return clients to after processing of the payment by the Payment Gateways

"http://127.0.0.1"
coreApi.uriurlURL of the Core API service
"http://127.0.0.1:3080"
coreApi.authTokenAuthorization token for the Core API service
. You can get this token in the "System/Users" section
"PW2Ln6PSS3vpmmZrCQBV5of2NO7jJbcU"
managementApi.uriurlURL of the Management API
"https://127.0.0.1/jsonrpc"
managementApi.loginLogin of the user used for the integration
. You need to have a dedicated user for the integration, use the same user for the Core API service and Management API
"api-client-portal"
managementApi.passwordPassword of the user used for the integration
"aqGW31oxHag8"

Output Formatting

Following The following settings are located under "defaults" key of the configuration file.

...

Setting Name

Description

Example

localeDefault locale to start with
. Available settings: en, ru
"en"
perPageQuantity of rows to display per page
. Allowed values: integer from 1 to 1000
10
roundRatesQuantity of digits after decimal point for display of rates
. Allowed values: integer from 0 to 16
4
roundAmountsQuantity of digits after decimal point for display of amounts
. Allowed values: integer from 0 to 16
2

Date and Time Formatting

Following The following settings are located under "dateTimeConfig" key of the configuration file. Please refer to the following guide for list of possible values.

...

Date and Time Formatting [section: dateTimeConfig]

Setting Name

Description

Example

monthFormat
Format string for to display of "Month Year" strings
"F Y"
dateFormat
Format string for to display of dates
"m/d/Y"
dateTimeFormat
Format string for to display of dates with time
"m/d/Y, h:i A"

Payment Gateways: PayPal

Following The following settings are located under "paymentGateways.paypal" key of the configuration file. Check your PayPal panel for the required parameters. Get more details.

Setting Name

Description

Example

enabledIs Defines if the payment gateway is enabled
. Allowed values: true, false
. Do not forget to enable gateway in the respective section of the billing system
true
sandboxIs Defines if the Sandbox mode s enabled
. Allowed values: true, false
false
allowCustomIs Defines if the custom amount payments are allowed
. Allowed values: true, false
true
clientId

PayPal Client ID

[email protected]
clientSecret

PayPal Client Secret Key


itemNameItem name displayed in the PayPal order
"Credit Your Balance Item"
orderDescriptionOrder description displayed in the PayPal
"Credit Your Balance"


Payment Gateways: Authorize.Net

Following The following settings are located under "paymentGateways.authorizenet" key of the configuration file. Check your Authorize.Net panel for the required parameters. Get more details.

Setting Name

Description

Example

enabledIs Defines if the payment gateway is enabled
. Allowed values: true, false
. Do not forget to enable gateway in the respective section of the billing system
true
sandboxIs Defines if the Sandbox mode is enabled
. Allowed values: true, false
false
allowCustomIs Defines if the custom amount payments are allowed
. Allowed values: true, false
true
apiLoginId

Authorize.Net API Login ID


apiTransactionKey

Authorize.Net API Transaction Key


apiSignatureKey
Authorize.Net API Signature Key


Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning)   Attention

Payment Gateways integration requires proper domain name and real SSL certificate. Please check the Panel Deployment guideline to get more information.

Section: Charges History & Payments History 

Following The following settings are located under "modules.transactionList" key of the configuration file. 

Setting Name

Description

Example

dateRangeDefault
Default dates range in the filter, in days
. Allowed values: integer from 1 to 90
30


Section: Usage History / Detailed

Following The following settings are located under "modules.reportXdrs" key of the configuration file. 

Setting Name

Description

Example

queryOnOpenIf Defines if the report should be run right after section open. If set to "false" , the user will have to press "hit Query" to get the report. Use this option if you have plenty of data to load.
Allowed values: true, false
true
dateRangeDefaultDefault dates range in the filter, in days
. Allowed values: integer 1 to 90
3
additionalColumnsList of additional columns to display
. Allowed values: origin, src_party_id
["origin", "src_party_id"]


Section: Usage History / Summary

Following The following settings are located under "modules.reportSummary" key of the configuration file. 

Setting Name

Description

Example

queryOnOpenIf Defines if the report should be run right after section open. If set to "false" , the user will have to press "hit Query" to get the report. Use this option if you have plenty of data to load.
Allowed values: true, false
true
dateRangeDefault
Default dates range in the filter, in days
. Allowed values: integer 1 to 180
90

Additional Settings

Following The following settings are located at the top level of the configuration section.

Setting Name

Description

Example

redisMain.hostnameThe hostname or ip IP address to use for connecting to the redis Redis server.
"localhost"
redisMain.portThe port to use for connecting to the redis Redis server.
6379 
redisMain.databaseThe redis Redis database to use.
1
redisCache.hostnameThe hostname or ip IP address to use for connecting to the redis Redis server.
"localhost"
redisCache.portThe port to use for connecting to the redis Redis server.
6379 
redisCache.databaseThe redis Redis database to use.
2