Solution properties

You set solution properties to configure the behavior and characteristics of agents at solution level.

Solution properties are set in the solution_properties.xml file or by using the solutionManager setproperty command. You can also manage these properties by using the SolutionsPropertiesMXBean: com.ibm.ia.runtime.management.SolutionsPropertiesMXBean. For more information, see SolutionsMXBean.

A solution property can be applied to the entire solution, to a named agent, or a named aggregate. For example, the eventAggregateMaxHorizon property can be set for all solution aggregates or for a specific aggregate, and the maxHorizon property can be set for a solution or for a specific rule agent. When a property is set, it is fixed and maintained after a server restart.

To set a property for a specific global aggregate, use the form <property>_defvar<global_aggregate> for the property name. For example, to set the eventAggregateValueSaveInterval property for a global aggregate that is named TotalSessionRatings, you can use the following command:

solutionManager set eventAggregateValueSaveInterval_defvarTotalSessionRatings=4000 --username=tester --password=tester

The following table lists solution settings that are determined by the value of the solution properties.

Table 1. Properties that can be set at the solution level.
Property	Description	Default value
clearDBCount	Specifies a minimum number of events that can be removed from the grid before all events that exceed the `maxHorizon` are removed from the database. With the `clearDBCount` property, you can periodically remove events from your backup database.	10000
defaultJobTimeout	The elapsed time before a batch job stops running. You must specify a value of at least 0. You might set a value for this property if some batch jobs are taking too long to run and you want to restrict the time they take. A low value causes a job to immediately time out instead of running. Therefore, a minimum practical value is probably about 2000 milliseconds, and might be higher.	0 milliseconds (no timeout)
eventAggregateAggregationEngineCheckpointFrequency	Specifies how many partial results are processed before the aggregate engine state of a global event aggregate is saved. The aggregate engine combines the partial results. Its state reflects the value of a global event aggregate. A value of 1 means to save after every event, 2 means to save after every second event, and so on. A low value can degrade performance but can improve the accuracy of the value more rapidly when a server restarts after an outage. A high value can be set if failover is not important. If you do not want to save the engine state after partial results are processed, specify -1.	1000
eventAggregateMaxHorizon	Defines an ISO 8601 time duration that determines how long events are retained in memory for all aggregates or for a specific aggregate. The value of the property consists of a letter and number combination that designates a time unit as defined by the ISO 8601 specification. P (period): The first letter in the time value, for example, P30D is 30 days. Y (year): Time in years, for example, P1Y is one year. M (month): Time in months, for example, P6M is six months. D (day): Time in days, for example, P1D is 1 day. T (time): This letter indicates that the time includes hours, minutes, or seconds, for example, P1DT12H is one day plus 12 hours. H (hours): Time in hours, for example, PT36H is thirty-six hours. M (minutes): Time in minutes, which must be preceded by the T designator, for example, PT6M is six minutes. S (seconds): Time in seconds, for example, PT30S is thirty seconds.	P1D
eventCacheDuration	Defines an ISO 8601 time duration that defines the maximum amount of time that Decision Server Insights keeps an event in memory after the event is processed. To reduce the time that events are kept in memory, the `eventCacheDuration` value must be less than the `maxHorizon` value. To keep events resident in memory, set `eventCacheDuration` to be equal to `maxHorizon`. P (period): The first letter in the time value, for example, P30D is 30 days. Y (year): Time in years, for example, P1Y is one year. M (month): Time in months, for example, P6M is six months. D (day): Time in days, for example, P1D is one day. T (time): This letter indicates that the time includes hours, minutes, or seconds, for example, P1DT12H is one day plus 12 hours. H (hours): Time in hours, for example, PT36H is thirty-six hours. M (minutes): Time in minutes, which must be preceded by the T designator, for example, PT6M is six minutes. S (seconds): Time in seconds, for example, PT30S is thirty seconds.	P1Y
eventAggregateValueSaveInterval	Specifies in milliseconds how often global event aggregation values are saved to the grid for disaster recovery. You must specify a value of at least 1. A low value can degrade performance but can improve the accuracy of the value more rapidly when a server restarts after an outage. A high value can be set if failover is not important.	20000 milliseconds
maxHorizon	Defines an ISO 8601 time duration that determines how long events are retained in memory for a solution or for a specific rule agent. The value of the property consists of a letter and number combination that designates a time unit as defined by the ISO 8601 specification. P (period): The first letter in the time value, for example, P30D is 30 days. Y (year): Time in years, for example, P1Y is 1 year. M (month): Time in months, for example, P6M is 6 months. D (day): Time in days, for example, P1D is 1 day. T (time): This letter indicates that the time includes hours, minutes, or seconds, for example, P1DT12H is 1 day plus 12 hours. H (hours): Time in hours, for example, PT36H is 36 hours. M (minutes): Time in minutes, which must be preceded by the T designator, for example, PT6M is 6 minutes. S (seconds): Time in seconds, for example, PT30S is 30 seconds. Note: Events are retained in memory for the shortest possible duration. The duration is set by the smallest value from the maxHorizon of the solution and the horizon that is configured in the rule agent descriptor (if any). If maxHorizon is not defined, then the default of 1 year is used as the horizon of the solution.	P1Y
override_required	Returns null for a property unless that property was set by an administrator.	False
saveEventAggregateEngineStateByTimer	A Boolean value that determines whether to save the event aggregate engine state at the rate specified by the eventAggregateValueSaveInterval property.	True
testEpoch	Specifies a value to set the start of the test to a point in the past. This point in time must be equal to, or before, the time stamp of the earliest event that you want to test. For example: `testDriver.setTestEpoch("2015-01-05T14:30:00Z")`
x2020DisableSSLHostnameVerification	Set it to true if you want to eliminate the requirement for the SmartCloud Analytics server to present a public certificate that contains a matching host name value.
x2020HostPort	Host and Port to connect to SmartCloud Analytics. If you include the port number, the number must be preceded by the colon character (:) to separate it from the host name.
x2020Password	Password to connect to SmartCloud Analytics
x2020UserName	Username to connect to SmartCloud Analytics