Configuring Business Automation Navigator

IBM Business Automation Navigator configuration settings are recorded and stored in the shared YAML file for operator deployment. After you prepare your environment, you add the values for your configuration settings to the YAML so that the operator can deploy your containers to match your environment.

Before you begin

Prepare your Business Automation Navigator environment. These procedures include setting up databases, LDAP, storage, and configuration files that are required for use and operation. You must complete all of the Preparing to install Business Automation Navigator before you are ready to deploy the container images. Collect the values for these environment components; you use them to configure your Business Automation Navigator container deployment.

Note: If you plan to use UMS integration with Business Automation Navigator, note that you might encounter registration failure errors during deployment. This can happen if the UMS deployment is not ready by the time the other containers come up. The situation resolves in the next operator loop, so the errors can be ignored.

Procedure

  1. Open the CR file that you created in Generating the custom resource or if you did it manually by using the Manually compiling the custom resource.
  2. Check the values to make sure that they are the values that you want to deploy. If you need more configuration parameters, then use the fully customizable Business Automation Navigator template to copy lines from and paste them into your CR file.
    Go to the descriptors/patterns folder to find all of the templates.

    If you chose to customize Business Automation Navigator from the outset by manually copying a fully customizable decisions template, then edit where necessary the default values for each Business Automation Navigator parameter in the CR file.

    Consider the following information as you record the values for your deployment environment in the CR file:
    Shared configuration settings

    Un-comment and update the values for the shared configuration, LDAP, datasource, monitoring, and logging parameters, as applicable.

    Remember: Set shared_configuration.sc_deployment_platform to other if you are deploying on a non-OpenShift certified Kubernetes platform.

    Use the secrets that you created for the root_ca_secret and trusted_certificate_list values.

    Remember: If you plan to use External Share with the 2 LDAP model for configuring external users, update the LDAP values in the ext_ldap_configuration section of the YAML file with the information about the directory server that you configured for external users. If you are not using the 2 LDAP model of external share, leave this section commented out.

    For more information about the shared parameters, see the following topics:

    Business Automation Navigator settings

    Use the navigator_configuration section of the custom YAML to provide values for the configuration of Business Automation Navigator. You provide details for configuration settings that you have already created, like the names of your persistent volume claims. You also provide names for pieces of your Business Automation Navigator environment, and tuning decisions for your runtime environment.

    In the Business Automation Navigator section, leave the enable_appcues setting with the default value, false.

    Tip: If UMS is included in your deployment, the SSO version of the Navigator image is required for your environment. If you specify the non-SSO Navigator image, the operator substitutes the SSO image at deployment time.
     New in 20.0.2  You can configure a Navigator desktop to make the Send Email context menu option available to end users. Use the java_mail settings to configure Send Email for your Navigator deployment. For example:
    navigator_configuration:
       java_mail:
           host: "my_exchange1.com"
           port: "123"
           sender: "MailAdmin@myexchange.com"
           ssl_enabled: false

    If you do not want to include Send Mail in your deployment, ensure that the java_mail parameter section is commented out.

    For more information about the settings, see Business Automation Navigator parameters.

    Initialization settings

    If you are using the Navigator component with the FileNet® Content Manager components, you can use the initialize_configuration section of the custom YAML to provide values for the automatic initialization and setup of Content Platform Engine and Business Automation Navigator. The initialization container creates required configuration of IBM Business Automation Navigator and Content Platform Engine. You also make decisions for your runtime environment.

    You can edit the YAML to configure more than one of the available pieces in your automatically initialized environment. For example, if you want to create an additional Business Automation Navigator repository, you copy the stanza for the repository settings, paste it below the original, and add the new values for your additional repository:

    #   icn_repos:
     #   - add_repo_id: "demo_repo1"
     #     add_repo_ce_wsi_url: "http://{{ meta.name }}-cpe-svc:9080/wsi/FNCEWS40MTOM/"
     #     add_repo_os_sym_name: "OS01"
     #     add_repo_os_dis_name: "OS01"
     #     add_repo_workflow_enable: false
     #     add_repo_work_conn_pnt: "pe_conn_os1:1"
     #     add_repo_protocol: "FileNetP8WSI"
    

    You can also create additional Business Automation Navigator repositories and desktops.

    For more information about the settings, see Initialization parameters

    Verification settings

    If you are using the Navigator component with the FileNet Content Manager components, you can use the verify_configuration section of the custom YAML to provide values for the automatic verification of your Content Platform Engine and Business Automation Navigator. The verify container works in conjunction with the automatic setup of the initialize container. You can accept most of the default settings for the verification. However, compare the settings with the values that you supply for the initialization settings. Specific settings like object store names and the Content Platform Engine connection point must match between these two configuration sections.

    For more information about the settings, see Verify parameters.

What to do next

Return to Checking and completing your custom resource to configure other components, then complete the deployment with the operator.
Important: After you deploy the containers, complete your setup steps: Completing post-deployment tasks for Business Automation Navigator