Customizing Business Automation Workflow properties

You can make Liberty and 100custom configuration changes to Business Automation Workflow deployment.

About this task

This task provides the generic methods for modifying Liberty and 100Custom configuration settings for Business Automation Workflow deployment. The usage is generally paired with other documentation pages, which might describe a specific Liberty or 100Custom configuration setting that needs to be modified.

In a production deployment of Workflow Runtime, you can customize the following properties:
  • baw_configuration[x].liberty_custom_xml to customize the Business Automation Workflow Liberty server. If the customization does not contain sensitive information, you can use this property to put the customization directly into the custom resource.
  • baw_configuration[x].custom_xml_secret_name to customize Business Automation Workflow Runtime 100custom.xml if the customization contains sensitive information
  • baw_configuration[x].lombardi_custom_xml_secret_name to customize the Workflow Server
Important: Put your Business Automation Workflow Liberty configuration settings either in baw_configuration[x].liberty_custom_xml or in baw_configuration[x].custom_xml_secret_name. Don't specify the same configuration value in both places.

To customize Workflow Authoring, see Customizing Business Automation Studio properties.

Procedure

  1. To customize Business Automation Workflow Liberty properties:
    • To use XML, add a plain XML snippet in the custom resource file in the liberty_custom_xml property. The settings will be merged into the Liberty settings for the component.
      The XML snippet must be in the <server> element, as shown in the following example.
      liberty_custom_xml: |+
  <server>
    <!-- custom properties here -->
  </server>
      For more information about Liberty customization, see Administering Liberty manually.
    • To use a secret, do the following steps.
      1. Create a customized XML file, such as custom.xml.
      2. Create a customized secret by running the following command:
        kubectl create secret generic custom-xml-secret-name --from-file=sensitiveCustomConfig=./custom.xml
      3. Set the custom_xml_secret_name (for Workflow Authoring) property to the secret name in the custom resource file.
  2. You can also modify Business Automation Workflow Runtime configuration properties in a 100Custom.xml file. For more information, see 100Custom.xml file, see Creating a 100Custom.xml configuration file.
    1. Create a 100Custom.xml file if you don't have one.
    2. Create a customized secret by running the following command: 
      kubectl create secret generic custom-xml-secret-name --from-file=sensitiveCustomConfig=./100custom.xml
    3. Set the lombardi_custom_xml_secret_name property to the secret name in the custom resource file.
  3. After you modify the custom resource file, you must update your deployment to have it take effect. Follow the instructions in Updating script-installed deployments.
    To verify the 100Custom.xml settings, check for the files on the server pods. For more information, see Location of 100Custom configuration files.