Versions Compared

Old Version 4

changes.mady.by.user Anastasiia Kovalinas

Saved on

compared with

New Version Current

changes.mady.by.user Andrii Zinchenko

Saved on

Key

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

...

To simplify the process, your deployment provides 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.

Panel
borderColor#FFBABA
bgColor#FFBABA
borderWidth2px
borderStylesolid

Image Added Warning

Do not edit default configuration at /opt/jerasoft/vcs/portal-backend/config/customer-params.default.json. If you need to change configuration parameters just add them to /opt/jerasoft/vcs-data/conf/cp-customer-params.json.

Per Reseller Configuration

...

Setting Name

Description

Example

amountOptions

Array of available amounts for a top-up in the list to select.

[5, 20, 50, 100]
billingUrlURL 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
currenciesId

Currency ID (as per your system configuration) for the payments received from the specific Payment Gateway. Required.

2
currencyCode

Currency code of the Payment Gateway to charge payments in (declared by the gateway itself).

USD

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.urlURL 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.urlURL 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"
paymentAccountsId

Payment Account’s ID as per your system configuration.

1

...

Setting Name

Description

Example

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

Date and Time Formatting

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

Date and Time Formatting [section: dateTimeConfig]

Setting Name

Description

Example

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

...

Setting Name

Description

Example

enabledDefines 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
sandboxDefines if the Sandbox mode is enabled. Allowed values: true, false
false
allowCustomDefines if the custom amount payments are allowed. Allowed values: true, false
true
clientId

PayPal Client ID

[email protected]
feesPayerDescribes who pays fees for the transaction. Allowed values: provider, client
provider
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"

...

Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning)   Attention

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

...

Setting Name

Description

Example

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

Section: Usage History / Detailed

...

Setting Name

Description

Example

queryOnOpenDefines if the report should be run right after section open. If set to false, the user will have to 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
additionalColumnscolumnsList of additional columns to display. Allowed values: origin, src_party_id origin, dt, accounts_name, cc_serial, clients_tags, accounts_tags, tags, code_country, code_name, code, src_code_country, src_code_name, src_code, volume, volume_billed, package_volume, package_credit, packages_id, packages_name, currencies_id, pay_setup, cost, rate, taxes, subscriber_host, subscriber_id, result_code, result_status, switch_code, start_time, connect_time, finish_time, pdd, scd, src_party_id, dst_party_id, src_party_id_ext, dst_party_id_ext, src_party_id_bill, dst_party_id_bill, voip_hosts_id, voip_hosts_name, voip_hosts_collectors_id, services_name, units_id, session_id, x_id, xdrs_id, uniq_id, custom, xdrs_extra, status
["origin", "src_party_id"]

...

Setting Name

Description

Example

queryOnOpenDefines if the report should be run right after section open. If set to false, the user will have to 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
columnsList of columns to display. Allowed values: origin, services_name, units_id, currencies_id, cost_total, pay_setup_cost, rate_avg, package_credit, volume_total, volume_billed, package_volume, records_total, records_notzero, records_success, records_busy, records_nochannel, records_error, asr_std, asr_cur, acd_std, acd_cur, pdd_avg, scd_avg
["origin", "services_name"]

Additional Settings

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

...