Payload Property Definitions Cartridge

The following are the definitions of the payload parameters passed the cartridge JSON:

General payload property definitions

Property Name	Clustered Setup		Standalone Setup	Description	Example Values
Property Name	Manager	Worker	Standalone Setup	Description	Example Values
`COMMIT_ENABLED`	Yes	No	No	This enables auto commit in Python Cartridge Agent (PCA). Once you give a git repository when creating an application or when signing up, PCA will commit the changes.	true
`CONFIG_PARAM_CLUSTERING`	Yes	Yes	Yes	To enable clustering in WSO2 Products	true - for a clustered setup false - for a standalone setup
`CONFIG_PARAM_LB_IP, LB_IP`	Yes	Yes	No	Defines the load balancer IP which is fronted by the cartridge.	127.0.0.1
`CONFIG_PARAM_REGISTRY_DB_URL, CONFIG_PARAM_REG_DB_URL`	Yes	Yes	No	Registry database url	jdbc:mysql://172.17.8.1:3306/registry_44x
`CONFIG_PARAM_REGISTRY_DB_USER_NAME`	Yes	Yes	No	Registry database username	root
`CONFIG_PARAM_REGISTRY_DB_PASSWORD`	Yes	Yes	No	Registry database password	root
`CONFIG_PARAM_REGISTRY_DB_DRIVER`	Yes	Yes	No	Driver class name used in data source	com.mysql.jdbc.Driver
`CONFIG_PARAM_CONFIG_DB_URL`	Yes	Yes	No	Config database url	jdbc:mysql://172.17.8.1:3306/config_db_as_530
`CONFIG_PARAM_CONFIG_DB_USER_NAME`	Yes	Yes	No	Config database username	root
`CONFIG_PARAM_CONFIG_DB_PASSWORD`	Yes	Yes	No	Config database password	root
`CONFIG_PARAM_CONFIG_DB_DRIVER`	Yes	Yes	No	Driver class name used in data source	com.mysql.jdbc.Driver
`CONFIG_PARAM_USER_MGT_DB_URL, CONFIG_PARAM_UM_DB_URL`	Yes	Yes	No	User Management database url	jdbc:mysql://172.17.8.1:3306/userstore_44x
`CONFIG_PARAM_USER_MGT_DB_USER_NAME`	Yes	Yes	No	User Management database username	root
`CONFIG_PARAM_USER_MGT_DB_PASSWORD`	Yes	Yes	No	User Management database password	root
`CONFIG_PARAM_USER_MGT_DB_DRIVER`	Yes	Yes	No	Driver class name used in data source	com.mysql.jdbc.Driver
`CONFIG_PARAM_PROFILE`	Yes	Yes	Yes	Defines the profile name used in WSO2 product. Based on the profile name, there are configuration changes. This payload parameter is only common for the AM and DAS cartridges.	Gateway-Manager, Gateway-Worker, default
`CONFIG_PARAM_MEMBERSHIP_SCHEME`	No	No	Yes	Membership scheme name used for cluster discovery	private-paas, wka
`CONFIG_PARAM_WORKER_HOST_NAME`	No	No	Yes	Host name of the worker node or default node	as.wso2.com
`APPLICATION_PATH`	No	No	Yes	Application path which is used to clone the git artifacts.	/var/www

AM specific payload properties

Property Name	Clustered Setup		Standalone Setup	Description	Example Values
Property Name	Manager	Worker	Standalone Setup	Description	Example Values
`CONFIG_PARAM_APIMGT_DB_URL`	Yes	Yes	Yes	API_Mgt related database url
`CONFIG_PARAM_APIMGT_DB_USER_NAME`	No	No	Yes	API_Mgt database username	root
`CONFIG_PARAM_APIMGT_DB_PASSWORD`	No	No	Yes	API_Mgt database password	root
`CONFIG_PARAM_KEYVALIDATORCLIENTTYPE`	Yes	Yes	No	Key validator client type used in API Manager	WSClient
`CONFIG_PARAM_DOMAIN`	Yes	Yes	No	Domain name to be used in the deployment

DAS cartridge specific payload properties

Property Name	Description	Example Values
`CONFIG_PARAM_MEMBERSHIP_SCHEME`	Membership scheme name used for cluster discovery	private-paas
`CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_URL`	URL of the `WSO2_ANALYTICS_FS` DB. This is used for file system.
`CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_USER_NAME`	Username of `WSO2_ANALYTICS_FS` DB.	root
`CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_PASSWORD`	Password of `WSO2_ANALYTICS_FS` DB.	root
`CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_DRIVER`	Driver class name used in data source	com.mysql.jdbc.Driver
`CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_URL`	URL of the WSO2_ANALYTICS_EVENT_STORE. This is used for event store.
`CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_USER_NAME`	Username of the WSO2_ANALYTICS_EVENT_STORE	root
`CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_PASSWORD`	Password of the WSO2_ANALYTICS_EVENT_STORE	root
`CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_DRIVER`	Driver class name used in data source	com.mysql.jdbc.Driver
`CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_URL`	URL of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB. This is used for managing processed data.
`CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_USER_NAME`	Username of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB.	root
`CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_PASSWORD`	Password of the WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB.	root
`CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_DRIVER`	Driver class name used in data source	com.mysql.jdbc.Driver

MB cartridge specific payload properties

Property Name	Standalone Setup	Description
`CONFIG_PARAM_MB_METRICS_DB_URL`	Yes	URL of the MB_METRICS_DB.
`CONFIG_PARAM_MB_METRICS_DB_USERNAME`	Yes	Username of the MB_METRICS_DB.
`CONFIG_PARAM_MB_METRICS_DB_PASSWORD`	Yes	Password of the MB_METRICS_DB.
`CONFIG_PARAM_MB_STORE_DB_URL`	Yes	URL of the MB_STORE_DB.
`CONFIG_PARAM_MB_STORE_DB_USER_NAME`	Yes	Username of the MB_STORE_DB.
`CONFIG_PARAM_MB_STORE_DB_PASSWORD`	Yes	Password of the MB_STORE_DB.
`CONFIG_PARAM_MB_STORE_DB_DRIVER`	Yes	Driver class name used in data source

There are not cartridge specific payload parameters for the following cartridges:

Application Server (AS)	Business Process Server (BPS)	Business Rules Server (BRS)
Governance Registry (GREG)	Identity Server (IS)