Configuring Business Automation Studio

If you select IBM Business Automation Application Designer as an optional component, before you complete the installation configure the custom resource YAML file for your IBM Business Automation Studio deployment.

Procedure

  1. Open the custom resource (CR) file that you created in Generating the custom resource.
  2. If you did not run the script to prepare databases and secrets, configure your database by setting the configuration parameters according to the database type. Update the bastudio_configuration sections of the custom resource YAML file. For more information, see Custom resource pattern templates For database configuration, set the configuration parameters according to the database type:
    • For Db2®:
      1. Business Automation Studio:
        1. Set bastudio_configuration.database.type to DB2.
        2. Enter your DB2® server hostname or IP into bastudio_configuration.database.host.
        3. Enter your DB2 server port into bastudio_configuration.database.port.
        4. Enter your Business Automation Studio database into bastudio_configuration.database.name.
        5. If you want to connect your database by SSL, set bastudio_configuration.database.ssl_enabled to true and enter your database secret into bastudio_configuration.database.certificate_secret_name.
        6. If you want to use your own JDBC driver, set bastudio_configuration.database.use_custom_jdbc_drivers to true and enter your PVC for JDBC driver into bastudio_configuration.database.custom_jdbc_pvc and JDBC driver files into bastudio_configuration.database.jdbc_driver_files. For more information, see Implementing storage.
      2. Application Engine playback server:
        1. Set bastudio_configuration.playback_server.database.type to DB2.
        2. Enter your DB2 server hostname or IP into bastudio_configuration.playback_server.database.host.
        3. Enter your DB2 server port into bastudio_configuration.playback_server.database.port.
        4. Enter your Application Engine playback server database into bastudio_configuration.playback_server.database.name.
        5. If you want to connect your database by SSL, set bastudio_configuration.playback_server.database.enable_ssl to true and enter your database secret into bastudio_configuration.playback_server.database.db_cert_secret_name.
        6. If you want to use your own JDBC driver, set bastudio_configuration.playback_server.use_custom_jdbc_drivers to true and enter your PVC for JDBC driver into bastudio_configuration.playback_server.database.custom_jdbc_pvc. For more information, see Implementing storage.
    • For Oracle:
      1. Business Automation Studio:
        1. Set bastudio_configuration.database.type to Oracle.
        2. Enter the Oracle connection URL in this format:
          jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=<your-oracle-database-hostname>)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=<your-oracle-database-service-name>)))
          into bastudio_configuration.database.jdbc_url.
        3. Set bastudio_configuration.database.use_custom_jdbc_drivers to true.
        4. Enter your PVC for Oracle JDBC driver into bastudio_configuration.database.custom_jdbc_pvc and the Oracle JDBC drive files into bastudio_configuration.database.jdbc_driver_files, like ojdbc8.jar. For more information, see Implementing storage.
        5. If you want to connect your database by SSL, set bastudio_configuration.database.ssl_enabled to true.
          • Update bastudio_configuration.database.jdbc_url (set in step ii) to use Oracle SSL URL in this format:
            jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=<your-oracle-database-hostname>)(PORT=2484))(CONNECT_DATA=(SERVICE_NAME=<your-oracle-database-service-name>)))
          • Enter your Database Server Wallet Secret into bastudio_configuration.database.certificate_secret_name. For more information, see Creating secrets to protect sensitive configuration data.
      2. Application Engine playback server:
        1. Set bastudio_configuration.playback_server.use_custom_jdbc_drivers to true.
        2. Set bastudio_configuration.playback_server.database.type to Oracle.
        3. Enter the Oracle connection URL in this format:
          (DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=<your-oracle-database-hostname>)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=<your-oracle-database-service-name>)))
          into bastudio_configuration.playback_server.database.oracle_url_without_wallet_directory.
        4. Enter your PVC for Oracle JDBC driver into bastudio_configuration.playback_server.database.custom_jdbc_pvc. For more information, see Implementing storage.
        5. If you want to connect your database by SSL, set bastudio_configuration.playback_server.database.enable_ssl to true.
          • Update
            bastudio_configuration.playback_server.database.oracle_url_without_wallet_directory
            (set in step iii) to use Oracle SSL URL in this format:
            DESCRIPTION=(ADDRESS=(PROTOCOL=TCPS)(HOST=<your-oracle-database-hostname>)(PORT=2484))(CONNECT_DATA=(SERVICE_NAME=<your-oracle-database-service-name>)))
          • Enter the Oracle SSL URL with the wallet path in this URL format:
            (DESCRIPTION=(ADDRESS=(PROTOCOL=tcps)(HOST=<your-oracle-database-hostname>)(PORT=2484))(CONNECT_DATA=(SERVICE_NAME=<your-oracle-database-service-name>))(SECURITY=(SSL_SERVER_DN_MATCH=FALSE)(MY_WALLET_DIRECTORY=/shared/resources/oracle/wallet)))
            into bastudio_configuration.playback_server.database.oracle_url_with_wallet_directory.
            Note: Do not change the path MY_WALLET_DIRECTORY=/shared/resources/oracle/wallet.
          • Enter your Database Server Wallet Secret into bastudio_configuration.playback_server.database.db_cert_secret_name, and your Database Server Wallet SSO Secret into bastudio_configuration.playback_server.database.oracle_sso_wallet_secret_name. For more information, see Creating secrets to protect sensitive configuration data.
    • For PostgreSQL:
      1. Business Automation Studio:
        1. Set bastudio_configuration.database.use_custom_jdbc_drivers to true.
        2. Set bastudio_configuration.database.type to PostgreSQL.
        3. Enter your PostgreSQL server hostname or IP into bastudio_configuration.database.host.
        4. Enter your PostgreSQL server port into bastudio_configuration.database.port.
        5. Enter your Business Automation Studio database into bastudio_configuration.database.name.
        6. Enter your PVC for PostgreSQL JDBC driver into bastudio_configuration.database.custom_jdbc_pvc. For more information, see Implementing storage.
        7. Enter the PostgreSQL JDBC driver files into bastudio_configuration.database.jdbc_driver_files, such as postgresql-42.2.16.jar.
        8. If you want to connect your database by SSL, set bastudio_configuration.database.ssl_enabled totrue and enter your database secret into bastudio_configuration.database.certificate_secret_name.
        9. The operator can now automatically provision an EDB Postgres instance upon request. To create a PostgreSQL database for Business Automation Studio, set bastudio_configuration.database.dc_use_postgres to true. If bastudio_configuration.database.dc_use_postgres is set to true, the operator uses the existing values of the EDB Postgres instance to automatically set the values of the following parameters:
          • bastudio_configuration.database.host
          • bastudio_configuration.database.port
          • bastudio_configuration.database.certificate_secret_name
          If you want the operator to automatically set the values of these parameters, ensure that the fields for host, port, and certificate_secret_name are left empty in the CR. You must also set bastudio_configuration.database.ssl_enabled to true.
          Note: If you selected to use EDB Postgres as your deployment database and you want to use EDB Postgres for Business Automation Studio, check that the datasource_configuration.dc_odm_datasource.dc_use_postgres parameter is set to true. If you do not want to use EDB Postgres for Business Automation Studio, set the values to false. Then, check the values of the external database parameters that you generated when you ran the cp4a-prerequisites.sh script.
      2. Application Engine playback server:
        1. Set bastudio_configuration.playback_server.use_custom_jdbc_drivers to true.
        2. Set bastudio_configuration.playback_server.database.type to PostgreSQL.
        3. Enter your PostgreSQL server hostname or IP into bastudio_configuration.playback_server.database.host.
        4. Enter your PostgreSQL server port into bastudio_configuration.playback_server.database.port.
        5. Enter your Application Engine database into bastudio_configuration.playback_server.database.name.
        6. Enter your PVC for PostgreSQL JDBC driver into bastudio_configuration.playback_server.database.custom_jdbc_pvc. For more information, see Implementing storage.
        7. If you want to connect your database by SSL, set bastudio_configuration.playback_server.database.enable_ssl to true and enter your database secret into bastudio_configuration.playback_server.database.db_cert_secret_name.
          Note: CN verification of Application Engine is enabled by default when PostgreSQL SSL is enabled. Therefore, you must prepare the database SSL certificate with the proper CN or SAN, and make sure that the database server hostname or IP address input matches the CN or the list of the SAN in the certificate.
        8. The operator can now automatically provision an EDB Postgres instance upon request. To create a PostgreSQL database for Application Engine playback server, set bastudio_configuration.playback_server.database.dc_use_postgres to true. If bastudio_configuration.playback_server.database.dc_use_postgres is set to true, the operator uses the existing values of the EDB Postgres instance to automatically set the values of the following parameters:
          • bastudio_configuration.playback_server.database.host
          • bastudio_configuration.playback_server.database.port
          • bastudio_configuration.playback_server.database.db_cert_secret_name
          If you want the operator to automatically set the values of these parameters, ensure that the fields for host, port, and db_cert_secret_name are left empty in the CR. You must also set bastudio_configuration.playback_server.database.enable_ssl to true.
    • For Microsoft SQL Server:
      1. Business Automation Studio:
        1. Set bastudio_configuration.database.use_custom_jdbc_drivers to true.
        2. Set bastudio_configuration.database.type to sqlserver.
        3. Enter your SQL Server hostname or IP into bastudio_configuration.database.host.
        4. Enter your SQL Server port into bastudio_configuration.database.port.
        5. Enter your Business Automation Studio into bastudio_configuration.database.name.
        6. Enter your PVC for SQL Server JDBC driver into bastudio_configuration.database.custom_jdbc_pvc, like operator-shared-pvc. For more information, see Implementing storage.
        7. Enter the SQL Server JDBC driver files into bastudio_configuration.database.jdbc_driver_files, such as mssql-jdbc-9.2.1.jre8.jar.
        8. If you want to connect your database by SSL, set bastudio_configuration.database.ssl_enabled totrue and enter your database secret into bastudio_configuration.database.certificate_secret_name.
      2. Application Engine playback server:
        1. Set bastudio_configuration.playback_server.use_custom_jdbc_drivers to true.
        2. Set bastudio_configuration.playback_server.database.type to sqlserver.
        3. Enter your SQL Server hostname or IP into bastudio_configuration.playback_server.database.host.
        4. Enter your SQL Server port into bastudio_configuration.playback_server.database.port.
        5. Enter your Application Engine database into bastudio_configuration.playback_server.database.name.
        6. Enter your PVC for SQL Server JDBC driver into bastudio_configuration.playback_server.database.custom_jdbc_pvc. For more information, see Implementing storage.
        7. If you want to connect your database by SSL, set bastudio_configuration.playback_server.database.enable_ssl to true and enter your database secret into bastudio_configuration.playback_server.database.db_cert_secret_name.
          Note: For SQL Server, you must prepare the database SSL certificate with the proper CN or SAN, and make sure that the database server hostname or IP address input matches the CN or the list of the SAN in the certificate.

What to do next

Continue to configure the other capabilities that are in your CR file, and make sure that you complete the last step Validating the YAML in your custom resource file before you deploy the CR.