Versions Compared

Key

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

...

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.

General Settings

Setting Name

Description

Example

billingUriURL 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.uriURL 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.uriURL 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 Core API service and Management API
"api-client-portal"
managementApi.passwordPassword of the user used for the integration
"aqGW31oxHag8"

Output Formatting

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 1 to 1000
10
roundRatesQuantity of digits after decimal point for display of rates
Allowed values: integer 0 to 16
4
roundAmountsQuantity of digits after decimal point for display of amounts
Allowed values: integer 0 to 16
2

Date and Time Formatting

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 display of "Month Year" strings
"F Y"
dateFormat
Format string for display of dates
"m/d/Y"
dateTimeFormat
Format string for display of dates with time
"m/d/Y, h:i A"

Payment Gateways: PayPal

Following settings are located under "paymentGateways.paypal" key of the configuration file. 

...

Check your Authorize.Net panel for the required parameters. Get more details.


Setting Name

Description

Example

enabledIs payment gateway enabled
Allowed values: true, false
Do not forget to enable gateway in the respective section of the billing system
true
sandboxIs Sandbox mode enabled
Allowed values: true, false
false
allowCustomIs custom amount payments 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 Panel Deployment guideline to get more information.

Section: Charges History & Payments History 

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 1 to 90
30


Section: Usage History / Detailed

...