Business Automation Workflow on containers authoring parameters

Shared configuration parameters

See Shared configuration parameters . The pattern configuration parameters, LDAP configuration parameters, and all mandatory shared configuration parameters (including sc_deployment_baw_license) are required.

Business Automation Navigator configuration parameters

See IBM® Business Automation Navigator configuration parameters .

FileNet Content Manager configuration parameters

See IBM FileNet Content Manager configuration parameters .

Business Automation Studio configuration parameters

See IBM Business Automation Studio configuration parameters .

Business Automation Workflow Authoring configuration parameters

Provide the details that are relevant to your Business Automation Workflow environment and your decisions for the deployment of the container.

The following table lists the parameters for configuring Workflow Authoring. The Required column shows the parameters that are required.

Table 1. Workflow Authoring configuration parameters: spec.workflow_authoring_configuration

Parameter name	Description	Example values	Required
image.repository	Workflow Authoring image repository URL. By default, the path points to the URL and location in the IBM Entitled Registry. The default value is <path>/workflow-authoring where <path> is cp.icr.io/cp/cp4a/baw/. If sc_image_repository has a value, the path is that value.	<path>/workflow-authoring	No
image.tag	Image tag for Workflow Authoring container. If you want to use a specific image version, you can override the default tag or digest.	25.0.0	No
image.pullPolicy	Pull policy for Workflow Authoring container. The default value is IfNotPresent. Possible values are IfNotPresent and Always.	IfNotPresent	No
upgrade_job.repository	Workflow Authoring database handling image repository URL. The default value is <path>/workflow-server-dbhandling where <path> is cp.icr.io/cp/cp4a/baw/. If sc_image_repository has a value, the path is that value.	<path>/workflow-server-dbhandling	No
upgrade_job.tag	Workflow Authoring database handling image repository tag. If you want to use a specific image version, you can override the default tag or digest.	25.0.0	No
upgrade_job.pullPolicy	Pull policy for database handling. The default value is IfNotPresent. Possible values are IfNotPresent and Always.	IfNotPresent, Always	No
bas_auto_import_job.repository	Workflow Authoring Business Automation Studio toolkit init image repository URL. The default value is <path>/toolkit_installer where <path> is cp.icr.io/cp/cp4a/baw/. If sc_image_repository has a value, the path is that value.	<path>/toolkit_installer	No
bas_auto_import_job.tag	Workflow Authoring Business Automation Studio toolkit init image repository tag. If you want to use a specific image version, you can override the default tag or digest.	25.0.0	No
bas_auto_import_job.pullPolicy	Pull policy for Business Automation Studio toolkit init image.		No
ibm_workplace_job.repository	IBM Workplace deployment image repository URL. The default value is <path>/iaws-ibm-workplace where <path> is cp.icr.io/cp/cp4a/baw/. If sc_image_repository is configured, <path> is the same value.	<path>/iaws-ibm-workplace
ibm_workplace_job.tag	IBM Workplace deployment image repository tag. If you want to use a specific image version, you can override the default tag or digest. The default value is 25.0.0.	25.0.0
ibm_workplace_job.pull_policy	Pull policy for the IBM Workplace deployment image.
content_integration.init_job_image.repository	Image name for content integration container. By default, the path points to the URL and location in the IBM Entitled Registry. The default value is <path>/iaws-ps-content-integration where <path> is cp.icr.io/cp/cp4a/baw/. If sc_image_repository has a value, the path is that value.	<path>/iaws-ps-content-integration	No
content_integration.init_job_image.tag	Image tag for content integration container. If you want to use a specific image version, you can override the default tag or digest.	25.0.0	No
content_integration.init_job_image.pull_policy	Pull policy for content integration container. The default value is IfNotPresent.	IfNotPresent	No
content_integration.domain_name	Domain name for content integration. The value must be the same as initialize_configuration.ic_domain_creation.domain_name. The default value is BAWDOCS.	BAWDOCS	No
content_integration.object_store_name	Object Store name for content integration.		No
content_integration.cpe_admin_secret	Admin secret for connecting to Content Platform Engine (CPE). If not set, it will autodetect CPE's admin secret in the same namespace.		No
case.init_job_image.repository	Image name for CASE init job container. By default, the path points to the URL and location in the IBM Entitled Registry. The default value is <path>/workflow-server-case-initialization where <path> is cp.icr.io/cp/cp4a/baw/. If sc_image_repository has a value, the path is that value.	<path>/workflow-server-case-initialization	No
case.init_job_image.tag	Image tag for CASE init job container. If you want to use a specific image version, you can override the default tag or digest.	25.0.0	No
case.init_job_image.pull_policy	Pull policy for CASE init job container. The default value is IfNotPresent.	IfNotPresent	No
case.domain_name	Domain name for CASE. The value must be the same as initialize_configuration.ic_domain_creation.domain_name. The default value is P8DOMAIN.	P8DOMAIN	No
case.object_store_name_dos	Design object store name of CASE. The value must be the same as the oc_cpe_obj_store_symb_name value of one of the object stores defined in initialize_configuration.ic_obj_store_creation.object_stores. The default value is BAWDOS.	BAWDOS	No
case.tos_list[*].object_store_name	Target object store name of CASE. The value must be the same as the oc_cpe_obj_store_symb_name value of one of the object stores defined in initialize_configuration.ic_obj_store_creation.object_stores. The default value is BAWTOS Note: tos_list is a list of the target object stores. .	BAWTOS	No
case.tos_list[*].connection_point_name	Connection point name for target object store. See initialize_configuration.ic_obj_store_creation.object_stores[x].oc_cpe_obj_store_workflow_pe_conn_point_name. If oc_cpe_obj_store_workflow_pe_conn_point_name is not specified explicitly, the default value is pe_conn_<target object store>.oc_cpe_obj_store_conn.dc_os_datasource_name. For example, pe_conn_BAWTOS.	pe_conn_<TOS_database_name>	Required if the Target Object Store does not exist in initialize_configuration.ic_obj_store_creation.object_stores.
case.tos_list[*].target_environment_name	Name of the target environment or project area to register with the case components and associate with an IBM Content Navigator desktop. The default value is dev_env_connection_definition.	dev_env_connection_definition	No
case.tos_list[*].desktop_id	Navigator desktop name for target object store. The default value is baw.	baw	No
case.tos_list[*].is_default	Whether to use the target object store as the default target object store. The default value is true if there is only one target object store.	true	No
case.network_shared_directory_pvc	Persistent volume claim (PVC) name for case network shared directory. If navigator_configuration.datavolume.existing_pvc_for_icn_pluginstore is not specified explicitly, the default value is icn-pluginstore. See IBM Business Automation Navigator configuration parameters .	icn_pluginstore	No
case.custom_package_names	Custom package names for installing custom packages, where the value format is similar to package1.zip, package2.zip.		No
case.custom_extension_names	Custom extension names for installing custom packages, where the value format is similar to extension1.zip, extension2.zip.		No
case.cpe_metadata_cache_time_to_live	Number of seconds before a newly added or modified asset will take effect in the Case Client. The value must be an integer. A default value is used at run time if this parameter is not set.	100	No
storage.use_dynamic_provisioning	Set to true to use dynamic storage provisioning. If set to false, you must set existing_pvc_for_logstore and existing_pvc_for_dumpstore. The default value is true.	true	No
storage.existing_pvc_for_filestore	PVC for files. This includes temporary files that are created by the SQL integration facility. See .		No
storage.size_for_filestore	Minimum size of the PV that is mounted as the file store. The default value is 1Gi.	1Gi	No
environment_config.csrf.origin_allowlist	Security-hardening property that protects against Cross-Site Request Forgery (CSRF) attacks. Specify the values that are acceptable in the origin header field of an incoming request. The value of this property must be a comma-separated list of prefixes.	https://example.com, http://example2.com:8080	No
environment_config.csrf.referer_allowlist	Security-hardening property that protects against CSRF attacks. Specify the values that are acceptable in the referer header field of an incoming request. The value of this property must be a comma-separated list of fully qualified host names.	example1.com, example2.com	No
environment_config.csrf.user_agent_keyword_allow_list_for_old_restapi_csrf_check	Comma-separated list of user agents. For the REST API requests with the path pattern /rest/bpm/wle/v1/* that is sent by the agents in the list, the server will not validate the XSRF-TOKEN cookie. The value of this property must be a comma-separated list, for example, agentkeyworkd1, agentkeyworkd2.	java,wink client,httpclient,curl,jersey,httpurlconnection	No
environment_config.csrf.check_xsrf_for_old_restapi	Whether to validate the XSRF-TOKEN cookie against incoming REST API requests (POST/PUT/DELETE) with the path pattern /rest/bpm/wle/v1/*. The default value is true.	true	No
environment_config.content_security_policy_additional_default_src	Content security policy additional directive for default-src. It accepts array list inputs as shown in the example.	["https://hostname1", "https://hostname2"]	No
environment_config.content_security_policy_additional_script_src	Content security policy additional directive for script-src. It accepts array list inputs as shown in the example.	["https://hostname1", "https://hostname2"]	No
environment_config.content_security_policy_additional_frame_src	Content security policy additional directive for frame-src. It accepts array list inputs as shown in the example.	["https://hostname1", "https://hostname2"]	No
environment_config.content_security_policy_additional_object_src	Content security policy additional directive for object-src. It accepts array list inputs as shown in the example.	["https://hostname1", "https://hostname2"]	No
environment_config.content_security_policy_additional_connect_src	Content security policy additional directive for connect-src. It accepts array list inputs as shown in the example.	["https://hostname1", "https://hostname2"]	No
environment_config.content_security_policy_additional_frame_ancestor	Content security policy additional directive for frame-ancestor. It accepts array list inputs as shown in the example.	["https://hostname1", "https://hostname2"]	No
environment_config.content_security_policy_additional_img_src	Content security policy additional directive for img-src. It accepts array list inputs as shown in the example.	["https://hostname1", "https://hostname2"]	No
environment_config.content_security_policy_additional_font_src	Content security policy additional directive for font-src. It accepts array list inputs as shown in the example.	["https://hostname1", "https://hostname2"]	No
environment_config.content_security_policy_additional_style_src	Content security policy additional directive for style-src. It accepts array list inputs as shown in the example.	["https://hostname1", "https://hostname2"]	No
environment_config.content_security_policy_additional_all	Content security policy additional directive for all folders. It accepts array list inputs as shown in the example.	["https://hostname1", "https://hostname2"]	No
federation_config.workflow_server.index_number_of_shards	Number of primary shards of the Elasticsearch index used to store Workflow Authoring data. The default value is 3.	3	No
federation_config.workflow_server.index_number_of_replicas	Number of shard replicas of the Elasticsearch index used to store Workflow Authoring data. The default value is 1.	1	No
federation_config.case_manager[x].object_store_name	Case Manager object store name. The default value is BAWTOS.	BAWTOS	No
federation_config.case_manager[x].index_number_of_shards	Number of primary shards of the Elasticsearch index used to store Case Manager object store data. The default value is 3.	3	No
federation_config.case_manager[x].index_number_of_replicas	Number of shard replicas of the Elasticsearch index used to store Case Manager object store data. The default value is 1.	1	No
jvm_customize_options	JVM options separated with spaces, for example: -Dtest1=test -Dtest2=test2.		No
liberty_custom_xml	Workflow Authoring custom plain XML snippet. The custom_xml_secret_name is also used for Workflow Server customization. Put your configuration values either in liberty_custom_xml or custom_xml_secret_name. Do not set the same configuration value in both places.		No
custom_xml_secret_name	Workflow Authoring custom XML secret name. The liberty_custom_xml is also used for Workflow Server customization. Put your configuration values either in liberty_custom_xml or custom_xml_secret_name. Do not set the same configuration value in both places.		No
lombardi_custom_xml_secret_name	Workflow Authoring Lombardi custom XML secret name.		No

BPM event emitter configuration parameters

The following table lists the parameters for configuring BPM event emitter. All parameters are optional.

Table 2. BPM event emitter configuration parameters: spec.workflow_authoring_configuration

Parameter name	Description	Example values
business_event.enable	Whether to enable event monitoring for Dynamic Event Framework events for the Workflow Authoring container. If Business Automation Insights and the Machine Learning Server parameters are configured, this parameter must be set to true. The default value is false.	false
business_event.enable_task_api	Whether to record additional task information in generated events. If Business Automation Insights and the Machine Learning Server parameters are configured, this parameter must be set to true. This parameter is equivalent to the enable_task_api_def parameter. The default value is false.	false
business_event.enable_task_record	Whether to enable the task record in generated events. This optional parameter is equivalent to the task-record-enabled parameter. The default value is true.	true
business_event.subscription	List of the subscription configurations. Each subscription attribute is listed in the rest of this table. [{'app_name': '*','version': '*','component_type': '*','component_name': '*','element_type': '*','element_name': '*','nature': '*'}] See Event point key and filter .
business_event.subscription[x].app_name	Name of the source application that has events to monitor. The default value is *, which means all applications are monitored.
business_event.subscription[x].component_name	Name of the component to monitor. The default value is *, which means all components are monitored.
business_event.subscription[x].component_type	Type of the component to monitor. The default value is *, which means all component types are monitored.
business_event.subscription[x].element_name	Name of the element to monitor. The default value is *, which means all elements are monitored.
business_event.subscription[x].element_type	Type of the element to monitor. BPMN types include PROCESS, ACTIVITY, EVENT, and GATEWAY. The default value is *, which means all element types are monitored.
business_event.subscription[x].nature	Status of the event to monitor. Elements can send events of various statuses. The BPMN status types include STARTED, COMPLETED, TERMINATED, DELETED, FAILED, CAUGHT, THROWN, EXPECTED, ACTIVE, READY, RESOURCE_ASSIGNED, ACTIVE, LOOP_CONDITION_TRUE, LOOP_CONDITION_FALSE, and MULTIPLE_INSTANCES_STARTED. The default value is *, which means all status types are monitored.
business_event.subscription[x].version	Version of the source application that has events to monitor. The default value is *, which means all versions are monitored.

workflow_authoring_configuration:
    - name: instance1
      business_event:
	#The main switch
        enable: true
	#Performance tuning switches. You must set these to true so the task-related events can be monitored.
        enable_task_api: true
        enable_task_record: true
	#Subscription related settings
        subscription:
        - app_name: '*'
          component_name: '*'
          component_type: '*'
          element_name: '*'
          element_type: '*'
          nature: '*'
          version: '*'

Case event emitter configuration parameters

The following table lists the parameters for configuring Case event emitter. By default, the Case event emitter is not enabled. If you enable it, the case.event_emitter.logical_unique_id parameter is required. Otherwise, all parameters are optional.

event_emitter:
- tos_name: BAWTOS
  connection_point_name: pe_conn_target
  date_sql: 20231122T002840Z
  logical_unique_id: bawaut
  solution_list: SampleSolution1,SampleSolution2

Case History emitter configuration parameters

The following table lists the parameters for configuring Case history emitter.

case_history_emitter:
        enable: true
        case_history_store_schema_name: CHSCHEMA
        dc_common_cpe_datasource_name: CASEHISTORYDS

Intelligent Task Prioritization configuration parameters

bai_configuration:
    bpmn:
      install: true

amd64

- key: kubernetes.io/hostname
  operator: In
  values:
    - worker0
    - worker1
    - worker3

# ┌───────────── minute (0 - 59)
# │ ┌───────────── hour (0 - 23)
# │ │ ┌───────────── day of month (1 - 31)
# │ │ │ ┌───────────── month (1 - 12)
# │ │ │ │ ┌───────────── day of week (0 - 6) (Sunday to Saturday)
# │ │ │ │ │
# │ │ │ │ │
# │ │ │ │ │
# * * * * * 

*/30 * * * * 

* 3 * * *

Workforce Insights configuration parameters

bai_configuration:
    bpmn:
      install: true
      force_elasticsearch_timeseries: true

- key: kubernetes.io/hostname
  operator: In
  values:
    - worker0
    - worker1
    - worker3

External Elasticsearch or OpenSearch configuration parameters

These parameters are for using external Elasticsearch or OpenSearch for data collection and data indexing. The first parameter is required if you want to use external Elasticsearch or OpenSearch.

Rolling update configuration for Business Automation Studio