System Parameters List

IBM DataPower Operations Dashboard contains an extensive set of parameters that let administrators fine-tune the system's behavior to the installation requirements.
The following sections describe these parameters in detail.

The parameters are accessible through the System Parameters page: [Manage->System→System Parameters].

Appliance Maintenance

The Appliance Maintenance (Backup, Sync and Firmware upgrade) system parameters are listed on a separate page

Dashboards

Parameter	Category	Default Value	Description
IDG Transactions Page Columns	Dashboards	Service Name, Operation, Time, Device, Domain, Status, Transaction ID, Client IP, Global Transaction ID, Elapsed, Payload	Controls which columns will appear in the Investigate->Transactions Page, you can omit or reorder the columns. Any mistakes in the input will cause the display to revert to the default value. The Payload field will not appear to users that does not have authorization to view payloads Possible values (not case sensitive): Service Name, Operation, Time, Device, Domain, Status, Transaction ID, Client IP, Global Transaction ID, Elapsed, Payload
IDG Raw Message Page Columns	Dashboards	Device, Domain, Category, Severity, Time, Direction, Object Type, Object Name, Transaction ID, Client IP, Message Code, Message	Controls which columns will appear in the Investigate→Raw Messages Page, you can omit or reorder the columns. Any mistake in the input will cause the display to revert to the default value. Possible values (not case sensitive): Device, Domain, Category, Severity, Time, Direction, Object Type, Object Name, Transaction ID, Client IP, Message Code, Message, Global Transaction ID
APIC Transactions Page Columns	Dashboards	API Name, Time, Device, Catalog Name, Space Name, Operation ID, Client ID, OAuth Scope, Status, Transaction ID, Client IP, Global Transaction ID, Elapsed, Payload	Controls which columns will appear in the APIC Investigate->Transactions Page, you can omit or reorder the columns. Any mistakes in the input will cause the display to revert to the default value. The Payload field will not appear to users that does not have authorization to view payloads Possible values (not case sensitive): API Name, Time, Device, Catalog Name, Space Name, Operation ID, Client ID, OAuth Scope, Status, Transaction ID, Client IP, Global Transaction ID, Elapsed, Plan Name, Domain, Payload
Service URI Dashboard Percentiles (3 comma separated decimals)	Dashboards	90.0, 95.0, 99.0	Controls the percentiles shown in the rightmost columns of the Service URI Calls page and the API URI calls page, enter decimal values between 0-99.9
Service URL Dashboard Percentiles (3 comma separated decimals)	Dashboards	90.0, 95.0, 99.0	Controls the percentiles shown in the rightmost columns of the Service URL Calls page and the API URL calls page, enter decimal values between 0-99.9
APIC Recent Activity Page Latency Percentile	Dashboards	90.0	Controls the percentile shown in the APIC Recent Activity page, enter a decimal value between 0-99.9

Reports

The following parameters determine DPOD's reporting behavior.

Parameter	Category	Default Value	Description
Enable Reports Emails SMTP *	Reports	true	Enables sending reports via SMTP
Enable Reports Emails SMTP WS *	Reports	false	Enables sending reports via a Web-Service
Enable Reports Output File *	Reports	false	Enables writing reports to a local file-system. (Defaults to /data/reports)
Fields to ignore in ElasticSearch response	Reports	doc_count_error_upper_bound,sum_other_doc_count	For internal use, do not change unless instructed to do so by product support.

* Only one of the first three parameters should be set to true.

For more information see reports or configuring sending reports in mail.

When sending reports via SMTP or SMTP WS. the following parameters determine how those reports are sent.

When SMTP or SMTP-WS is selected as the reporting behavior, all parameters relating this behavior must be provided.

Parameter	Category	Default Value	Description
From Address	Email	from@example.com	The from address used for the report email.
SMTP Host	Email SMTP	smtp.example.com	Destination SMTP host
SMTP Password	Email SMTP	********	Password for logging in to the SMTP host. If no authentication required leave this field empty.
SMTP Port	Email SMTP	465	Destination SMTP host port
SMTP User	Email SMTP	mailer@example.com	Username for logging in to the SMTP host. If no authentication required leave this field empty.

SMTP WS Endpoint URI	Email SMTP WS	/SMTPSender	Destination URI for sending reports via Web-Service
SMTP WS Host	Email SMTP WS	localhost	Destination hostname for sending reports via Web-Service
SMTP WS Port	Email SMTP WS	8080	Destination port for sending reports via Web-Service
SMTP WS Protocol	Email SMTP WS	HTTP	Protocol for accessing the Web-Service host Valid values: HTTP / HTTPS
SMTP WS User	Email SMTP WS	user	User used for sending reports via Web-Service. This value is sent using HTTP Basic Authentication.
SMTP WS Password	Email SMTP WS	********	Password used for sending reports via Web-Service. This value is sent using HTTP Basic Authentication.

See reports for more information

LDAP

The following parameters control configuration and connection to LDAP, used for role-based security.

All parameters below are mandatory when enabling LDAP role-based security (by switching on the Enable LDAP parameter).
If LDAP RBM is disabled, all these parameters should be left blank.

Parameter	Category	Default Value	Description
LDAP Connection Name (DN)	LDAP		Username for connecting to the LDAP server (sometimes called “bind user”)
LDAP Connection PASSWORD	LDAP		Password for connecting to the LDAP server
LDAP Connection URL (ldap://IP:Port)	LDAP		Connection URL to connect to the LDAP server
Enable LDAP	LDAP	false	Whether the LDAP RBM is enabled. Valid Values: true / false
LDAP Group Base Entry (e.g. OU)	LDAP		The top-most level of the LDAP hierarchy. Searching for LDAP groups starts from this point downward. Ensure the user configured above is authorized to connect to this point in the LDAP hierarchy.
LDAP Group Name Attribute	LDAP		LDAP Group Name Attribute
LDAP Group Search Filter ({0} - Authenticated User Name, {1} - Authenticated User DN)	LDAP		The LDAP filter expression to use when searching for a group's directory entry
LDAP Referral (ignore/follow)	LDAP	ignore	Define handling of JNDI referrals (see javax.naming.Context.REFERRAL for more information). Valid values are: ignore follow throw Microsoft Active Directory often returns referrals. Set this parameter to follow If your installation is required to follow them. Caution: if your DNS is not part of AD, the LDAP client lib might try to resolve your domain name in DNS to find another LDAP server.
LDAP User Base Entry (e.g. OU)	LDAP		The top-most level of the LDAP hierarchy. Searching for LDAP users starts from this point downward. Ensure the user configured above is authorized to connect to this point in the LDAP hierarchy.
LDAP User Search Filter ({0} - User Name)	LDAP		The LDAP filter expression to use when searching for a user's directory entry

For more information regarding DPOD and LDAP configuration, consult the sections under Configuring LDAP in the Admin Guide.

Monitored Devices Authentication

The following parameters control authentication of monitored DataPower Gateways.
When DPOD collects data from monitored devices, it verifies that these are the correct devices using TLS; The DataPower certificate is authenticated against DPOD’s CA trust store, specified below.

Parameter	Category	Default Value	Description
Local User Registry Enabled	Security	false (for new installations v1.0.7+) true (when upgrading from v1.0.6)	When disabled, DPOD will not store any new user details in local repository to comply with Security complaince requirements (DPOD will not automatically delete any existing user details after changing the value of this parameter)
TLS Level (TLSv1/TLSv1.1/TLSv1.2)	Security	TLSv1.2	TLS level used to perform authentication
CA Trusted Keystore Password	Security		Trust store password
CA Trusted Keystore Full Path and Filename	Security	/app/java/jre/lib/security/cacerts	Trust store full path
CA Trusted Keystore Type (JKS/PKCS12)	Security	JKS	Trust store type

TLS configuration information can be found in LDAP Configuration Script.

Configuration changes tracking

DPOD collects data about DataPower configuration changes from its monitored devices. It does this by pulling the complete configuration from the device, and comparing it to the last collected configuration. The parameters below control this mechanism.

Parameter

Category

Default Value

Description

Interval time to extract all service configuration and compare to last version; In Seconds;

ServiceConfig

1800

Determines how often monitored devices configuration is collected and compared to the last version.

Recommended nterval is at least 900 (15 minutes).

Interval number to compress Configuration Table since massive update and delete occurs. Once a day

ServiceConfig

50

For internal use, do not change unless instructed to do so by product support.

Consult the table on System Services Management for more information about the types of agents in DPOD and the information they collect.

Console UI Appearance

These parameters control the way data is displayed in DPOD's Console UI.

Parameter	Category	Default	Description
Default Full Date Format	Style	MM/dd/yyyy HH:mm:ss.SSS	Full date format
Default Date Format with no Millis	Style	MM/dd/yyyy HH:mm:ss	Full date format, without milliseconds
Default Date Format with no Year	Style	MM/dd HH:mm:ss.SSS	Full date format, without year
Default Short Date Format	Style	MM/dd/yyyy	Short date format
Default Theme (light/dark)	Style	Light	Light or dark theme of the console UI screens

Internal Health

Changes to the following parameters will take affect only after restarting the keepalive service via app-util.sh

Parameter	Category	Default	Description
Internal Alerts - Check Agents Interval in Seconds	Health	300	How often to check whether DPOD's syslog and WS-M agents are up and working
Internal Alerts - Check Derby Interval in Seconds	Health	300	How often to check whether DPOD's internal database is up and working
Internal Alerts - Check Dropped Syslogs Interval in Seconds	Health	600	How often to check whether DPOD's syslog agents lost incoming messages
Internal Alerts - Check Dropped WS-M Messages Interval in Seconds	Health	600	How often to check whether DPOD's WS-M agents lost incoming payloads
Internal Alerts - Check ES Interval in Seconds	Health	300	How often to check whether DPOD's big data component is up and working
Internal Alerts - Check File System Interval in Seconds	Health	300	How often to check whether DPOD's filesystem is out of space
Internal Alerts - Check Retention Interval in Seconds	Health	300	How often to check whether DPOD's internal big data retention process is working
Internal Alerts - Send Email on Alert	Health	false	Whether or not to send an Email when a problem was detected by the internal health monitoring
Internal Alerts - Email Destination Address for Alerts	Health	No Default	Destination Email address for sending internal health alerts
Internal Alerts - Send Syslog on Alert	Health	false	Whether or not to send a Syslog message when a problem was detected by the internal health monitoring
Interval in Seconds to Sample Logging Targets	Health	300	How often to sample DPOD's log targets in the monitored devices
Interval in Seconds to Sample Nodes Health Statistics	Health	300	How often to collect statistics on DPOD's big data nodes
Interval in Seconds to Monitor Objects Status	Health	300	How often to monitor enabled but down objects in the monitored devices
Object Status Monitor Should Only Check Common Object Classes	Health	true	By default, the Failed Objects dashboard (under the "explore" menu) displays only common object classes, set this option to false to make it sample all object classes in the monitored devices
Interval in Seconds to Sample WSM Agents Statistics	Health	300	How often to sample WS-M Agents in the monitored devices

Auto-Generated Service Wiki

DPOD automatically creates a service configuration wiki for all monitored devices. DPOD collects configuration and transactional data, and when a configuration change was made (e.g. a new service was created) it sends a JSON file with all its configuration details to a wiki update service.
The parameters below determine where JSON requests are sent and some of their data.

Parameter	Category	Default	Description
Wiki Default New Service Contact Mail	Wiki	changeme@example.com	This value is configured as the service contact email when a new service is created
Wiki Default New Service Contact Name	Wiki	Contact Name	This value is configured as the service contact name when a new service is created
Wiki Default New Service Contact Phone	Wiki	+0-(000)-000-0000	This value is configured as the service contact phone number when a new service is created
Wiki Push REST Password	Wiki		Password for logging in to the REST service which updates the wiki
Wiki Push REST User	Wiki	MS	Username for logging in to the REST service which updates the wiki
Wiki Push REST API Version	Wiki	v1	Determines the WS request format version of the requests sent to the wiki portal. Manipulating this value can be used for backwards compatibility, in cases when DPOD was updated but you still want to receive the older version format. Note: This is for future use - Currently only v1 applies.
Wiki URL	Wiki	https://127.0.0.2/wiki/	URL of the wiki update service

Consult Update Wiki service JSON (Deprecated) and its sub-sections JSON fields and JSON sample for detailed information about the wiki and JSON usage.

DevOps Portal Parameters

Parameter	Category	Default	Description
Path and Name of Local WSDL Analyze Script	ServicesPortal	/app/custom/scripts/download_wsdl_artifacts_sample.py	The path and name of the user configurable python script for analyzing local WSDL
Path and Name of Local WSDL Replace Script	ServicesPortal	/app/custom/scripts/replace_wsdl_references_sample.py	The path and name of the user configurable python script for replacing local WSDL references
Enable Services Portal Operations for non-Admin Users	ServicesPortal	true	Enable or disable access of non-admin users to DevOps portal actions
Temporary Device Name for WSDL Validations Operations	ServicesPortal	(no default)	Device name that will be used to create temporary services for WSDL validations, the device must be monitored by DPOD
Temporary Domain Name for WSDL Validations Operations	ServicesPortal	(no default)	Temporary domain name that will be used to create temporary services for WSDL validations The domain needs to exist, DPOD will not create it
Local WSDL Files Max Upload Size in KB	ServicesPortal	300	Upload size limit for each WSDL or XSD file used in Local WSDL Validation/Promotion. Change will take effect after hitting refresh in the browser's window.

Custom/Logical Transaction

Parameter	Category	Default	Description
Show Custom Transaction View Selection	Transactions	false	Whether or not the "Custom TX View" checkbox will be displayed in the Product Views
Default Transactions Source (syslog/logical)	Transactions	syslog	If the "Custom TX View" is displayed, what will be the default for users on their first sign in.
Logical Transaction, Custom String 1 Table Header	Transactions	Custom String 1	The Table Header and Filter names for "Custom String 1" in the transactions page
Logical Transaction, Custom String 2 Table Header	Transactions	Custom String 2	The Table Header and Filter names for "Custom String 2" in the transactions page
Transaction Analysis Level - User Override Path	Transactions	(blank)	Where to take the user override file for the syslog analysis message groups, no value (blank) means there is no override file
Transaction Analysis Level - Max TPS	Transactions	Core, MemoryReqRes, B2B, error	The message group names and log level for the Max TPS analysis level, The last parameter must be a valid log level name (debug, info, notice, warn. error, critic). The values must be comma separated, lower, upper or mixed case are allowed.
Transaction Analysis Level - More TPS	Transactions	Core, MemoryReqRes, B2B, notice	The message group names and log level for the More TPS analysis level, The last parameter must be a valid log level name (debug, info, notice, warn. error, critic). The values must be comma separated, lower, upper or mixed case are allowed.
Transaction Analysis Level - Balanced	Transactions	Core, MemoryReqRes, B2B, MemActionLevel, notice	The message group names and log level for the Balanced analysis level, The last parameter must be a valid log level name (debug, info, notice, warn. error, critic). The values must be comma separated, lower, upper or mixed case are allowed.
Transaction Analysis Level - More Data	Transactions	Core, MemoryReqRes, B2B, MemActionLevel, ReqPayloadSize, ExtLatency, info	The message group names and log level for the More Data analysis level, The last parameter must be a valid log level name (debug, info, notice, warn. error, critic). The values must be comma separated, lower, upper or mixed case are allowed.
Transaction Analysis Level - Max Data	Transactions	Core, MemoryReqRes, B2B, MemActionLevel, ReqPayloadSize, ExtLatency, Sidecalls, info	The message group names and log level for the Max Data analysis level, The last parameter must be a valid log level name (debug, info, notice, warn. error, critic). The values must be comma separated, lower, upper or mixed case are allowed.
Deprecated Extended Transaction Enabled	Transactions	false	If true system will show by defaut the Deprecated Extended Transaction page.

Miscellaneous Parameters

The following parameters control various other functions.

Parameter	Category	Default Value	Description
Enable agents management	Agents	true	Set to true, unless using an External Self Service Console installation, in which case it should be false.
Certificate monitoring duration in days	Certificate Monitoring	60	DataPower Gateways are able to send an alert a configurable number of days before certificates are about to expire. DPOD leverages this ability in the certificate monitoring screens. When a new monitored device is added to DPOD, the value in this parameter is copied to the corresponding parameter on the device. This value does not affect already-monitored devices. If you wish to change this in previously added devices, you need to do so manually.
Default duration of WS-M in minutes	WSM	5	This determines how long a WS-M subscription remains enabled after being activated. The value is in minutes, with a maximum of 60.
Time to Keep WS-M Payloads (1d, 1w, blank)	WSM	(blank)	Automatically delete WS-M payloads from store, possible values are 1d = one day, 1w = one week, no value = don't delete automatically