Event processing parameters

Provide the appropriate values to configure how events are processed.

Note:
  • Configuration parameters for IBM Cloud Pak® for Business Automation custom resources start with the spec.bai_configuration. prefix.
    spec:
    ...
      bai_configuration:
        bpmn:
           force_elasticsearch_timeseries: true
       ...
  • For Business Automation Insights parameters that inherit their default value from shared parameters, the values that are passed in the bai_configuration section of the custom resource take precedence over the values passed in the shared_configuration section.

BPEL event processing

The following table lists the parameters for configuring how IBM Business Automation Workflow BPEL events are processed.
Table 1. BPEL events
Parameter Description Default value
bawadv.install Whether to install or uninstall BPEL event processing. false
bawadv.image.repository The name of the Docker image for BPEL event processing Inherits the default value of the bai_configuration.image_credentials.registry parameter if this parameter is present in the custom resource. If it is not present, the bawadv.image.repository parameter inherits the base registry from the shared_configuration.sc_image_repository parameter.
bawadv.image.tag The tag of the Docker image Inherits the default value of the shared_configuration.sc_image_tag parameter. If that value is not set, the image digest that is predefined by the ICP4BA operator image is used instead.
bawadv.recovery_path The path to the savepoint or checkpoint from which a job recovers. If the job fails, you can use this path to restart it from a previous state. To use the default workflow of the job, leave this option empty. None
bawadv.parallelism The number of parallel instances (task managers) to use for running the processing job. 2
bawadv.resources.requests.cpu The minimum amount of CPU required to start the bawadv pod. 200m
bawadv.resources.requests.memory The minimum memory required, including JVM heap and file system cache, to start the bawadv pod. 350Mi
bawadv.resources.requests.ephemeral_storage The minimum amount of ephemeral_storage required to start the bawadv pod. 500Mi
bawadv.resources.limits.cpu The maximum amount of CPU required to allocate to the bawadv pod. 300m
bawadv.resources.limits.memory The maximum memory, including JVM heap and file system cache, to allocate to the bawadv pod. 500Mi
bawadv.resources.limits.ephemeral_storage The maximum ephemeral_storage required to allocate to the bawadv pod. 500Mi

BPMN event processing

The following table lists the parameters for configuring how IBM Business Automation Workflow BPMN events are processed.
Table 2. BPMN events
Parameter Description Default value
bpmn.install Whether to install BPMN event processing. false
bpmn.image.repository The name of the Docker image for BPMN event processing Inherits the default value of the bai_configuration.image_credentials.registry parameter if this parameter is present in the custom resource. If it is not present, the bpmn.image.repository parameter inherits the base registry from the shared_configuration.sc_image_repository parameter.
bpmn.image.tag The tag of the Docker image Inherits the default value of the shared_configuration.sc_image_tag parameter. If that value is not set, the image digest that is predefined by the ICP4BA operator image is used instead.
bpmn.recovery_path The path to the savepoint or checkpoint from which a job recovers. If the job fails, you can use this path to restart it from a previous state. To use the default workflow of the job, leave this option empty. None
bpmn.end_aggregation_delay The delay in milliseconds before the Flink states that are used for summary transformation are cleared. This value cannot be set to 0 nor be greater than 30 minutes. Otherwise, the default value applies instead. 10000
bpmn.parallelism The number of parallel instances (task slots) to use for running the processing job. 2
bpmn.force_elasticsearch_timeseries Set this parameter to true if you want time series to be written to OpenSearch indices.

Also set this parameter to true to enable Workforce Insights events to be processed by Business Automation Insights.

false
bpmn.resources.requests.cpu The minimum amount of CPU required to start the bpmn pod. 200m
bpmn.resources.requests.memory The minimum memory required, including JVM heap and file system cache, to start the bpmn pod. 350Mi
bpmn.resources.requests.ephemeral_storage The minimum amount of ephemeral_storage required to start the bpmn pod. 500Mi
bpmn.resources.limits.cpu The maximum amount of CPU required to allocate to the bpmn pod. 300m
bpmn.resources.limits.memory The maximum memory, including JVM heap and file system cache, to allocate to the bpmn pod. 500Mi
bpmn.resources.limits.ephemeral_storage The maximum ephemeral_storage required to allocate to the bpmn pod. 500Mi

Case event processing

The following table lists the parameters for configuring how IBM Business Automation Workflow Case events are processed.
Table 3. Case events
Parameter Description Default value
icm.install Whether to install Case event processing. false
icm.image.repository The name of the Docker image for Case event processing Inherits the default value of the bai_configuration.image_credentials.registry parameter if this parameter is present in the custom resource. If it is not present, the icm.image.repository parameter inherits the base registry from the shared_configuration.sc_image_repository parameter.
icm.image.tag The tag of the Docker image Inherits the default value of the shared_configuration.sc_image_tag parameter. If that value is not set, the image digest that is predefined by the ICP4BA operator image is used instead.
icm.recovery_path The path to the savepoint or checkpoint from which a job recovers. If the job fails, you can use this path to restart it from a previous state. To use the default workflow of the job, leave this option empty. None
icm.parallelism The number of parallel instances (task slots) to use for running the processing job. 2
icm.process_events_after_completion Set this parameter to true if you need the Case bai-icm Flink job to process the events that are generated on a case after the case is closed.
Restriction: This parameter is not available for a non-Kubernetes deployment of Business Automation Insights.
false
icm.force_elasticsearch_timeseries Set this parameter to true if you want time series to be written to OpenSearch indices.
Restriction: This parameter is not available for a non-Kubernetes deployment of Business Automation Insights.
false
icm.resources.requests.cpu The minimum amount of CPU required to start the icm pod. 200m
icm.resources.requests.memory The minimum memory required, including JVM heap and file system cache, to start the icm pod. 350Mi
icm.resources.requests.ephemeral_storage The minimum amount of ephemeral_storage required to start the icm pod. 500Mi
icm.resources.limits.cpu The maximum amount of CPU required to allocate to the icm pod. 300m
icm.resources.limits.memory The maximum memory, including JVM heap and file system cache, to allocate to the icm pod. 500Mi
icm.resources.limits.ephemeral_storage The maximum ephemeral_storage required to allocate to the icm pod. 500Mi

Decisions event processing

The following table lists the parameters for configuring how Operational Decision Manager Decisions events are processed.
Table 4. Decisions events
Parameter Description Default value
odm.install Whether to install Decisions event processing. false
odm.image.repository The name of the Docker image for Decisions event processing Inherits the default value of the bai_configuration.image_credentials.registry parameter if this parameter is present in the custom resource. If it is not present, the odm.image.repository parameter inherits the base registry from the shared_configuration.sc_image_repository parameter.
odm.image.tag The tag of the Docker image Inherits the default value of the shared_configuration.sc_image_tag parameter. If that value is not set, the image digest that is predefined by the ICP4BA operator image is used instead.
odm.parallelism The number of parallel instances (task slots) to use for running the processing job. 2
odm.resources.requests.cpu The minimum amount of CPU required to start the odm pod. 200m
odm.resources.requests.memory The minimum memory required, including JVM heap and file system cache, to start the odm pod. 350Mi
odm.resources.requests.ephemeral_storage The minimum amount of ephemeral_storage required to start the odm pod. 500Mi
odm.resources.limits.cpu The maximum amount of CPU required to allocate to the odm pod. 300m
odm.resources.limits.memory The maximum memory, including JVM heap and file system cache, to allocate to the odm pod. 500Mi
odm.resources.limits.ephemeral_storage The maximum ephemeral_storage required to allocate to the odm pod. 500Mi
Important:
Do not prefix the savepoint path with file://.
Do not specify the savepoint path for the ODM Flink job.

Automation Decisions Services event processing

The following table lists the parameters for configuring how Automation Decisions Services events are processed.
Table 5. Automation Decisions Services events
Parameter Description Default value
ads.install Whether to install Automation Decisions Services event processing. false
ads.image.repository The name of the Docker image for Automation Decisions Services event processing Inherits the default value of the bai_configuration.image_credentials.registry parameter if this parameter is present in the custom resource. If it is not present, the ads.image.repository parameter inherits the base registry from the shared_configuration.sc_image_repository parameter.
ads.image.tag The tag of the Docker image Inherits the default value of the shared_configuration.sc_image_tag parameter. If that value is not set, the image digest that is predefined by the ICP4BA operator image is used instead.
ads.recovery_path The path to the savepoint or checkpoint from which a job recovers. If the job fails, you can use this path to restart it from a previous state. To use the default workflow of the job, leave this option empty. None
ads.parallelism The number of parallel instances (task slots) to use for running the processing job. 2
ads.resources.requests.cpu The minimum amount of CPU required to start the ads pod. 200m
ads.resources.requests.memory The minimum memory required, including JVM heap and file system cache, to start the ads pod. 350Mi
ads.resources.requests.ephemeral_storage The minimum amount of ephemeral_storage required to start the ads pod. 500Mi
ads.resources.limits.cpu The maximum amount of CPU required to allocate to the ads pod. 300m
ads.resources.limits.memory The maximum memory, including JVM heap and file system cache, to allocate to the ads pod. 500Mi
ads.resources.limits.ephemeral_storage The maximum ephemeral_storage required to allocate to the ads pod. 500Mi

Content event processing

The following table lists the parameters for configuring how Business Automation Insights Content events are processed.
Table 6. Content events
Parameter Description Default value
content.install Whether to install Content event processing. false
content.image.repository The name of the Docker image for Content event processing. Inherits the default value of the bai_configuration.image_credentials.registry parameter if this parameter is present in the custom resource. If it is not present, the content.image.repository parameter inherits the base registry from the shared_configuration.sc_image_repository parameter.
content.image.tag The tag of the Docker image Inherits the default value of the shared_configuration.sc_image_tag parameter. If that value is not set, the image digest that is predefined by the ICP4BA operator image is used instead.
content.recovery_path The path to the savepoint or checkpoint from which a job recovers. If the job fails, you can use this path to restart it from a previous state. To use the default workflow of the job, leave this option empty. None
content.parallelism The number of parallel instances (task managers) to use for running the processing job. 2
content.resources.requests.cpu The minimum amount of CPU required to start the content pod. 200m
content.resources.requests.memory The minimum memory required, including JVM heap and file system cache, to start the content pod. 350Mi
content.resources.requests.ephemeral_storage The minimum amount of ephemeral_storage required to start the content pod. 500Mi
content.resources.limits.cpu The maximum amount of CPU required to allocate to the content pod. 300m
content.resources.limits.memory The maximum memory, including JVM heap and file system cache, to allocate to the content pod. 500Mi
content.resources.limits.ephemeral_storage The maximum ephemeral_storage required to allocate to the content pod. 500Mi

Navigator event processing

The following table lists the parameters for configuring how Business Automation Insights Navigator events are processed.
Table 7. Navigator events
Parameter Description Default value
navigator.install Whether to install Navigator event processing. false
navigator.image.repository The name of the Docker image for Navigator event processing. Inherits the default value of the bai_configuration.image_credentials.registry parameter if this parameter is present in the custom resource. If it is not present, the navigator.image.repository parameter inherits the base registry from the shared_configuration.sc_image_repository parameter.
navigator.image.tag The tag of the Docker image Inherits the default value of the shared_configuration.sc_image_tag parameter. If that value is not set, the image digest that is predefined by the ICP4BA operator image is used instead.
navigator.recovery_path The path to the savepoint or checkpoint from which a job recovers. If the job fails, you can use this path to restart it from a previous state. To use the default workflow of the job, leave this option empty. None
navigator.parallelism The number of parallel instances (task managers) to use for running the processing job. 2
navigator.resources.requests.cpu The minimum amount of CPU required to start the navigator pod. 200m
navigator.resources.requests.memory The minimum memory required, including JVM heap and file system cache, to start the navigator pod. 350Mi
navigator.resources.requests.ephemeral_storage The minimum amount of ephemeral_storage required to start the navigator pod. 500Mi
navigator.resources.limits.cpu The maximum amount of CPU required to allocate to the navigator pod. 300m
navigator.resources.limits.memory The maximum memory, including JVM heap and file system cache, to allocate to the navigator pod. 500Mi
navigator.resources.limits.ephemeral_storage The maximum ephemeral_storage required to allocate to the navigator pod. 500Mi