Page History

...

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
billingUri	URL of the billing system As it is accessible from the Client Panel host	"https://127.0.0.1"
companiesId	ID 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.uri	URL of the Core API service	"http://127.0.0.1:3080"
coreApi.authToken	Authorization token for the Core API service You can get this token in the "System / Users" section	"PW2Ln6PSS3vpmmZrCQBV5of2NO7jJbcU"
managementApi.uri	URL of the Management API	"https://127.0.0.1/jsonrpc"
managementApi.login	Login 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.password	Password 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
locale	Default locale to start with Available settings: en, ru	"en"
perPage	Quantity of rows to display per page Allowed values: integer 1 to 1000	10
roundRates	Quantity of digits after decimal point for display of rates Allowed values: integer 0 to 16	4
roundAmounts	Quantity 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 Please refer to the following guide for list of possible values	"F Y"
dateFormat	Format string for display of dates Please refer to the following guide for list of possible values	"m/d/Y"
dateTimeFormat	Format string for display of dates with time Please refer to the following guide for list of possible values	"m/d/Y, h:i A"

customer-params.default.json

Setting Name

Description

Example

redisMain.hostnameThe hostname or ip address to use for connecting to the redis server.

"localhost"

redisMain.portThe port to use for connecting to the redis server.

redisMain.databaseThe redis database to use.

redisCache.hostnameThe hostname or ip address to use for connecting to the redis server.

"localhost"

redisCache.portThe port to use for connecting to the redis server.

redisCache.databaseThe redis database to use.

Payment Gateways: PayPal

Check your PayPal panel for the required parameters. Get more details.

Payment Gateways: PayPal

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

paypal.

Setting Name	Description	Example
enabled	Is payment gateway enabled Allowed values: true, false Do not forget to enable gateway in the respective section of the billing system	true
sandbox	Is Sandbox mode enabled Allowed values: true, false	false
allowCustom	Is custom amount payments allowed Allowed values: true, false	true

clientId

PayPal Client ID

paypal

test@example.org
clientSecret	PayPal Client Secret Key

paypal.sandboxDefines PayPal working mode. Default working mode is livefalse


itemName	Item name displayed in the PayPal order	"Credit Your Balance Item"
orderDescription	Order description displayed in the PayPal	"Credit Your Balance"

Payment Gateways: Authorize

...

.Net

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

authorizenet.


enabled	Is payment gateway enabled Allowed values: true, false Do not forget to enable gateway in the respective section of the billing system	true
sandbox	Is Sandbox mode enabled Allowed values: true, false	false
allowCustom	Is custom amount payments allowed Allowed values: true, false	true
apiLoginId	Authorize.Net API Login ID

authorizenet.


apiTransactionKey	Authorize.Net API Transaction Key

authorizenet.


apiSignatureKey	Authorize.Net API Signature Key

authorizenet.sandbox

Defines Authorize.Net working mode. Default working mode is live

false

Panel

borderColor	#ffffb3
bgColor	#ffffb3
borderWidth	2px

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

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

Setting Name	Description	Example
queryOnOpen	If report should be run right after section open. If set to "false" user will have to press "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 90	3
additionalColumns	List of additional columns to display Allowed values: origin, src_party_id	["origin", "src_party_id"]

Section: Usage History / Summary

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

Setting Name	Description	Example
queryOnOpen	If report should be run right after section open. If set to "false" user will have to press "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 settings are located at the top level of the configuration section.

Setting Name	Description	Example
redisMain.hostname	The hostname or ip address to use for connecting to the redis server.	"localhost"
redisMain.port	The port to use for connecting to the redis server.	6379
redisMain.database	The redis database to use.	1
redisCache.hostname	The hostname or ip address to use for connecting to the redis server.	"localhost"
redisCache.port	The port to use for connecting to the redis server.	6379
redisCache.database	The redis database to use.	2

Versions Compared

Old Version 2

New Version 3

Key

General Settings

Output Formatting

Date and Time Formatting

Payment Gateways: PayPal

Payment Gateways: PayPal

Payment Gateways: Authorize

.Net

Section: Charges History & Payments History

Section: Usage History / Detailed

Section: Usage History / Summary

Additional Settings