Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This section describes the different properties that you can use to configure ECs.

  • For Private Cloud and AWS, the properties are stored in the values.yaml file, where you define the systemProperties or in the EC Deployment web interface to configure ECs.

Aggregation Properties

You can set the properties listed in the Advanced tab of the Aggregation profile in your EC. This will override the values that were originally set in the profile, including the default values. 

The following properties are applicable when using file storage for aggregation.

Common Properties

Property

Description

mz

pico.

aggregation

rcp.

storage

platform.

maxneedssync

host

Default value: ""

Example value:

5000

192.168.0.190

This property

defines when updated aggregation sessions shall be moved from cache to the file system. When the number of cached aggregation sessions reaches this value, the sessions are written to disk.

This property shall be set to a value lower than "Max Cached Sessions", configured in the Aggregation agent. If the property is set to a higher value, the used value will be "Max Cached Sessions" minus 1. For example, if "Max Cached Sessions" is "6000" and this property is set to "6500", the value "5999" will be used instead.

For performance reasons, this property should be given a reasonably high value, but consider the risk of a server restart. If this happens, the cached data might be lost.

mz.aggregation.storage.profile_session_cache

Default value: false

This property is used to speed up the start of workflows that run on the EC. Set the property to true to keep aggregation cache in memory for up to 10 minutes after a workflow has stopped.

mz.aggregation.timeout.threads

Default value: 0

This property is used to enable Multithreading in Aggregation workflows, that is, to use a thread pool for the timeout function block in the Aggregation agent. Use a value larger than 0, for example, 4 to use four threads in the thread pool.

For more information about how to use these properties to tune the performance of the Aggregation agent, see Aggregation Agent (2.3).

EC Specific Properties

...

Property

...

Description

...

ec.webserver.port

Default value: 9090

This property specifies the listening port for the platform to determine the status of the EC.

Couchbase Properties

...

Property

...

Description

...

mz.cb.statistics.flush.period.in.seconds

...

Default value: 60

If you have enabled the log to file functionality in the Advanced tab of the Couchbase profile, you can determine how often in seconds you want to flush this file by modifying the value.

Database Properties

...

Property

...

Description

...

max.cached.prepared.statements

Default value: 15

If you want to change the number of preparedStatements that are cached between connections, you can use this property to specify a different number than the default.

If you are using SAP HANA as a database type in a Database profile, used by Database agents, this value has to be set to 0.

...

connectionpool.strict.pool.size

...

 Default value: false

If you enable this property, the database pool enables the Blocking Queue implementation where there is a strict restriction to the maximum number of connections.

When the property is set to false, then the database connection pool will create additional temporary connections. When the pool is full, these connections are closed as soon as the workflow thread returns the connection to the pool.

This property is general for all supported databases. It is enabled per each EC separately. If enabled the connection pool for the particular EC have a strict maximum limit. The maximum limit can be set in the Database profile agents "Properties tab" explained here: Database (2.3).

...

connectionpool.wait.timeout.milliseconds

...

 Default value: 5000

This property can only be used if the connectionpool.strict.pool.size property is set to true.

This property is used to configure the amount of time a thread should remain in the  blocked queue until it tries for a new connection. If a connection is made available before this time, the thread's waiting time is interrupted.

Diameter Properties

...

Property

...

Description

...

mz.diameter.tls.accept_all

...

Default value: false

If the property is set to false (default), the Diameter Stack agent does not accept any non-trusted certificates. If it is set to true, the Diameter Stack agent accepts any certificate. In either case, any unrecognized certificate will be logged in an entry in the System Log (in PEM format).

...

mz.workflow.decoderqueue.max_threads

...

Default value: 10

This property specifies the maximum number of threads used by the Diameter Stack agent for decoding messages. Setting a lower value than the default may enhance performance if the host machine has a low number of CPU cores and the active workflows are complex. On the other hand, the decoding may constitute a bottleneck when performing simple processing on a host machine with a high number of CPU cores. In this case, setting a higher value may provide better performance.

Inter Workflow Properties

...

Property

...

Description

...

mz.iwf.max_size_block

...

Default value: ""

By setting this property (in Bytes) on the EC that runs the Inter Workflow storage, it is possible to restrict memory consumption. If the agent wants to allocate more memory than the given property value during collection, the collection will abort instead of suffering a possible "out of memory".

Note that the minimum value is 32000 bytes, and even if a lower value is configured, 32000 will be used.

Table Lookup Service Properties

...

mz.inmemory_table.table_strategy

...

Default value: Object

This property defines how shared tables are kept in memory. The possible values are:

Object - The shared tables are stored as Java objects on the JVM heap. If this value is chosen the mz.inmemory_table.index_strategy property will have no effect.

On-heap - The shared tables are stored in a compact format on the JVM heap.

Unsafe - The shared tables are stored in a compact format outside the JVM heap. The API java.misc.Unsafe is used for the format and is only supported on Oracles JVM.

...

mz.inmemory_table.index_strategy

...

Default value: Object

This property defines how the index for shared tables are kept in memory. The possible values are:

Object - The index is stored as Java objects on the JVM heap.

Pointer - The index is stored as pointers to the table data.

...

mz.inmemory_table.fixed_width

...

Default value: true

This property defines if the varchar data fields are stored with a fixed or variable width. The possible values are:

true - The varchar data fields will have a fixed width.

false - The varchar data fields will have a variable width which will reduce the memory usage for large columns.

...

specifies the IP address or the hostname of the Platform to be used by other pico instances such as Execution Contexts, Service Contexts, or Command Line.

If a failover occurs and you have entered a hostname as property value, the hostname is retrieved from the DNS enabling reconnection. If you have entered a static IP address as property value, reconnection issues may occur after a failover, if the IP address has changed.

pico.rcp.platform.port

Default value: 6790

This property specifies the port for connecting the Execution Contexts to the Platform.

pico.rcp.server.host

Default value: ""

This property specifies the IP address or hostname of the pico instances. It is used to determine the interface that the pico instances must bind to and the IP address/hostname to be used by connecting processes.

If a failover occurs and you have entered a hostname as property value, the hostname is retrieved from the DNS enabling reconnection. If you have entered a static IP address as property value, reconnection issues may occur after a failover, if the IP address has changed.

When the value of this property is left blank, the pico instance binds to all IP addresses of the host. This means that the pico listens for inbound network traffic on all network interfaces, and may attempt to use any local IP address for outbound network traffic.

Note

Note!

If the host has more than one IP address, this property has to be set with the correct IP address. Make sure to set the property if you use IPv6, or if a high availability environment is configured. For information about high availability, see High Availability.

mz.webserver.port

Default value: "9000"

This property specifies the port for connecting to the Desktop.

Config Properties

Property

Description

mz.name

Default value: DR

This property specifies the name of the Image Added deployment.

Execution Context Properties - Not Used in Platform Only Installations

Property

Description

mz.eclist

Default value: ec1

This property specifies the EC(s) to be installed. Only applicable if install.types includes ec.

ec.backlog.dir

Default value:

$MZ_HOME

${mz.home}/tmp

This property

is applicable for ECs and determines whether you want events and error messages occurring when the contact is lost to be logged in a backlog or not. If the property is not present, events and messages will not be logged. The value of this property specifies where the backlog resides.

ec.shutdown.time

Default value: 60000

This property specifies the maximum time (in milliseconds) the EC will wait before a real-time workflow stops after a shutdown has been initiated. This is to enable the workflow to stop all input and drain all UDRs in the workflow before shutting down.

The wait time is initially set to 60 seconds. If this value is set to 0 all draining is ignored and the workflow will stop immediately.

pico.bootstrapclass

Default value: ""

This property specifies the bootstrap classes that are required by some components.

pico.ec.do_graceful_shutdown

Default value: true

This property determines the behavior of the mzsh command shutdown. When you have set the value of this property to false and run the command, it will cause ECs to shut down without forcing the workflows to stop first.

pico.rcp.server.port

Default value: ""

This property specifies the port that is used for EC to EC communication. If no port is set, a dynamic port will be used and the port number will change each time an EC is restarted. 

mz.use.drdateformat

Default value: true

The date syntax used in the APL functions dateToString and strToDate conforms to the Java class SimpleDateFormat in Java 6.

Even though the syntax conforms to SimpleDateFormat, it is not directly based on this class.

You can enable date format handling based on the SimpleDateFormat class in the installed Java version by setting this property to false. This enables use of additional patterns that are available in the installed Java version. For more information about the functions dateToString and strToDate, see the APL Reference Guide.

mz.use.date.timezone

Default value: false

Setting this property to true will instruct Usage Engine to use the attached time zone when SQL input originates from a date object.

In most cases, the property should be set in the pico configuration of ECs . However, in case of audit processing, the property should also be set in the pico configuration of the Platform.

If the mz.use.date.timezone property is used for setting dates with another time zone, there will be no way of keeping track of the actual time zone in the database, and you may have to manually convert the date during selection. To keep track of the time zone in an Oracle database, use the data type TIMESTAMP WITH TIME ZONE.

pico.type

Default value: ""

This property specifies the type of pico instance used for the EC. You can only define the value EC

specifies the directory where ECs can store their backlogged events. If this parameter is removed, the EC's events are not logged. Only applicable if install.types includes ec.

ec.webserver.enabled

Default value: true

This property specifies if the web server of the Execution Contexts should be active. Only applicable if install.types includes ec.

ec.webserver.port

Default value: 9090

This property specifies the EC web server port. Only applicable if install.types includes ec.

Note

Note!

You are required to set the EC properties in topo configuration file using the mzsh topo command.

When there are multiple ECs being used, the topo configuration file needs to be modified to use separate ports for each EC once the installation is complete.