Driven Administrator Guide

If not using the default hosted Driven Server, the Driven Plugin must be configured to connect to your own installation of the Driven Server.

Either configure the cascading-service.properties file:

Or set the environment variable:

The following properties control the Driven Plugin’s behavior as it attempts to communicate with the Driven Server.

Set the initial retry wait time using the following property:

This property has a default value of 400 milliseconds, which means that the Driven Plugin will wait 400 milliseconds for a response from the server before retrying. With subsequent retries, it will gradually increase the wait time using a progressive back-off strategy until it reaches the maximum default wait time of 4000 milliseconds. To change the default maximum wait time, use the following property:

Once the interval between retries reaches the value of cascading.management.document.service.max.retry.millis, the Driven Plugin will retry at an interval equal to that value. To set the Driven Plugin to stop retrying after a certain number of milliseconds, use the following property:

By default, this property is turned off (set to "-1").

In case of failed connections, the Driven Plugin keeps a backlog of the batched items until they can be sent, with a default of 100000 items. To change the default, use the following property:

By default, the Driven Plugin will attempt to connect to the Driven Server an indefinite number of times while continuing to record data. To set a maximum number at which the Driven Plugin stops retries (and stops recording data), give the following property a positive integer value (default value is "-1"):

When the value you set is reached, the Driven Plugin stops retrying the Driven Server (and stops recording data).

API keys map to teams in Driven. An application that is associated with an API key is searchable by members of the team that own the key. See Configuring Teams for Collaboration in the User Guide for more information.

Either configure the cascading-service.properties file:

Or set the environment variable:

As part of the Driven Plugin configuration, you can specify a tag or group of tags to associate with all applications that run with the plugin. See Managing Applications with Tags in the User Guide for best practices with tags and for how to apply tags on particular applications.

In the following lines, replace CATEGORY:INSTANCE1 with your real tag. It is recommended to use the "category label:specific value" capability of tags, which requires using the colon as a separator. To specify multiple tags, enter them as comma-separated values.

Either configure the cascading-service.properties file:

Or set the environment variable:

Once an application JVM is running and initial data is sent by the Driven Plugin, then an application heartbeat signal is sent by the Driven Plugin to the Driven Server. To set the frequency (or interval, in milliseconds) of this signal, use the following property:

Slice data transmission can be suppressed or resumed by setting a configuration parameter. The default setting of this parameter is false, which means slice data is transmitted unless you change the setting. Setting this property to true overrides a server-side configuration for slice-data transmission.

Either configure the cascading-service.properties file:

Or configure the environment variable:

A configuration parameter can be set to send or to not send data when the slice state changes to completed. The default setting for this parameter is true, which means data is sent only when the slice state reaches completed state.

Either configure the cascading-service.properties file:

Or set the environment variable:

You can suppress the command-line arguments used to launch the Cascading job by setting the parameter for Java command suppression to true. This property overrides any server-side configuration for Java command suppression. The default setting for this parameter is false.

Either configure the cascading-service.properties file:

Or set the environment variable:

The Driven Plugin can be run in archive mode. If archive mode is enabled, all records that are sent to the Driven Server are written to disk even if the server is unreachable. This can be useful if the Driven Server is not available or unreachable as the archive can later be replayed when the server is reachable.

Either configure the cascading-service.properties file:

Or set the environment variable:

To prevent the plugin from uploading the on-disk data to the Driven server, also set the following property:

Or set the environment variable:

When cascading.management.document.service.archive.only is true, the plugin will save records locally, allowing you to view plugin data during initial testing or troubleshooting situations when sending to the Driven server isn’t possible or required.

By default, a flow that has FAILED status does not automatically set the end state of the application to FAILED. You can configure Driven so that an application is put in FAILED state when a flow fails by setting the following parameter to true.

Configure the cascading-service.properties file:

By default, if an application finishes running but still has a flow that has PENDING status, the end state of the application is SUCCESSFUL. You can configure Driven so that an application is put in FAILED state when a flow remains in PENDING state by setting the following parameter to true.

Configure the cascading-service.properties file:

By default, the Driven Plugin logs events. To disable all Driven Plugin logging, set the following property:

Or set the environment variable:

To enable the Driven Plugin debug logging, set the following property:

Or set the environment variable:

To force the Driven Plugin to log INFO messages, set the following property:

To disable the Driven Plugin while leaving it installed, set the following property:

Or set the environment variable: