Cartridge Payload Property Definitions

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 define a Git repository when creating an application or when signing up, the PCA will commit the changes.	true - for a manager in a clustered setup false - for a standalone setup
`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	URL of registry database.	jdbc:mysql://172.17.8.1:3306/registry_44x
`CONFIG_PARAM_REGISTRY_DB_USER_NAME`	Yes	Yes	No	Username of registry database.	root
`CONFIG_PARAM_REGISTRY_DB_PASSWORD`	Yes	Yes	No	Password of registry database.	root
`CONFIG_PARAM_REGISTRY_DB_DRIVER`	Yes	Yes	No	Driver class name used in the data source.	com.mysql.jdbc.Driver
`CONFIG_PARAM_CONFIG_DB_URL`	Yes	Yes	No	URL of the config database.	jdbc:mysql://172.17.8.1:3306/config_db_as_530
`CONFIG_PARAM_CONFIG_DB_USER_NAME`	Yes	Yes	No	Username of the config database.	root
`CONFIG_PARAM_CONFIG_DB_PASSWORD`	Yes	Yes	No	Password of the config database.	root
`CONFIG_PARAM_CONFIG_DB_DRIVER`	Yes	Yes	No	Driver class name used in the data source.	com.mysql.jdbc.Driver
`CONFIG_PARAM_USER_MGT_DB_URL, CONFIG_PARAM_UM_DB_URL`	Yes	Yes	No	URL of the user management database.	jdbc:mysql://172.17.8.1:3306/userstore_44x
`CONFIG_PARAM_USER_MGT_DB_USER_NAME`	Yes	Yes	No	Username of the user management database.	root
`CONFIG_PARAM_USER_MGT_DB_PASSWORD`	Yes	Yes	No	Password of the user management database.	root
`CONFIG_PARAM_USER_MGT_DB_DRIVER`	Yes	Yes	No	Driver class name used in the data source.	com.mysql.jdbc.Driver
`CONFIG_PARAM_PROFILE`	Yes	Yes	Yes	Defines the profile name used in the WSO2 product. The configurations vary based on this profile name. 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	Hostname of the worker node or default node.	as.wso2.com
`APPLICATION_PATH`	No	No	Yes	The application path that is used to clone the Git artifacts.	/var/www
`CONFIG_PARAM_PORT_OFFSET`	Yes	Yes	Yes	This allows you to run multiple WSO2 products, multiple instances of a WSO2 product, or multiple WSO2 product clusters on the same server or virtual machine (VM). The port offset defines the number by which all ports defined in the runtime such as the HTTP/S ports will be offset. For example, if the HTTP port is defined as 9763 and the portOffset is 1, the effective HTTP port will be 9764. Therefore, for each additional WSO2 product, instance, or cluster you add to a server, set the port offset to a unique value (the default is 0).	1

AM specific payload properties

Property Name	Clustered Setup	Standalone Setup	Description	Example Values
`CONFIG_PARAM_APIMGT_DB_URL`	Yes	Yes	URL of the API_Mgt related database.	jdbc:mysql://172.17.42.1:3306/apimgtdb
`CONFIG_PARAM_APIMGT_DB_USER_NAME`	No	Yes	Username of the API_Mgt database.	root
`CONFIG_PARAM_APIMGT_DB_PASSWORD`	No	Yes	Password of the API_Mgt database.	root
`CONFIG_PARAM_KEYVALIDATORCLIENTTYPE`	Yes	No	Key validator client type used in API Manager.	WSClient
`CONFIG_PARAM_DOMAIN`	Yes	No	Domain name to be used in the deployment.	wso2.pub.store.domain

DAS cartridge specific payload properties

Property Name	Standalone Setup	Description	Example Values
`CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_URL`	Yes	URL of the `WSO2_ANALYTICS_FS` DB. This is used for the file system.	jdbc:mysql://192.168.52.203:3306/ANALYTICS_FS_DB?autoReconnect=true
`CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_USER_NAME`	Yes	Username of the `WSO2_ANALYTICS_FS` DB.	root
`CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_PASSWORD`	Yes	Password of the `WSO2_ANALYTICS_FS` DB.	root
`CONFIG_PARAM_WSO2_ANALYTICS_WSO2_ANALYTICS_FS_DB_DRIVER`	Yes	Driver class name used in the data source.	com.mysql.jdbc.Driver
`CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_URL`	Yes	URL of the `WSO2_ANALYTICS_EVENT_STORE` DB. This is used for event store.	jdbc:mysql://192.168.52.203:3306/ANALYTICS_EVENT_STORE?autoReconnect=true
`CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_USER_NAME`	Yes	Username of the `WSO2_ANALYTICS_EVENT_STORE` DB.	root
`CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_PASSWORD`	Yes	Password of the `WSO2_ANALYTICS_EVENT_STORE` DB.	root
`CONFIG_PARAM_WSO2_ANALYTICS_EVENT_STORE_DB_DRIVER`	Yes	Driver class name used in the data source.	com.mysql.jdbc.Driver
`CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_URL`	Yes	URL of the `WSO2_ANALYTICS_PROCESSED_DATA_STORE` DB. This is used to manage processed data.	jdbc:mysql://192.168.52.203:3306/ANALYTICS_PROCESSED_DATA_STORE?autoReconnect=true
`CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_USER_NAME`	Yes	Username of the `WSO2_ANALYTICS_PROCESSED_DATA_STORE` DB.	root
`CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_PASSWORD`	Yes	Password of the `WSO2_ANALYTICS_PROCESSED_DATA_STORE` DB.	root
`CONFIG_PARAM_WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB_DRIVER`	Yes	Driver class name used in the data source	com.mysql.jdbc.Driver

MB cartridge specific payload properties

Property Name	Standalone Setup	Description	Example Values
`CONFIG_PARAM_MB_METRICS_DB_URL`	Yes	URL of the `MB_METRICS` DB.	jdbc:mysql://192.168.52.203:3306/MB_METRICS?autoReconnect=true
`CONFIG_PARAM_MB_METRICS_DB_USERNAME`	Yes	Username of the `MB_METRICS` DB.	root
`CONFIG_PARAM_MB_METRICS_DB_PASSWORD`	Yes	Password of the `MB_METRICS` DB.	root
`CONFIG_PARAM_MB_STORE_DB_URL`	Yes	URL of the `MB_STORE` DB.	jdbc:mysql://192.168.52.203:3306/MB_STORE?autoReconnect=true
`CONFIG_PARAM_MB_STORE_DB_USER_NAME`	Yes	Username of the `MB_STORE` DB.	root
`CONFIG_PARAM_MB_STORE_DB_PASSWORD`	Yes	Password of the `MB_STORE` DB.	root
`CONFIG_PARAM_MB_STORE_DB_DRIVER`	Yes	Driver class name used in the data source.	com.mysql.jdbc.Driver

CEP cartridge specific payload properties

Property Name	Clustered Setup	Standalone Setup	Description	Example Values
`CONFIG_PARAM_PRESENTER_ENABLE`	Yes	No	Enable Presenter mode in CEP.	true
`CONFIG_PARAM_WORKER_ENABLE`	Yes	No	Enable Worker mode in CEP.	true

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)