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
- Open the custom resource (CR) file that you created in Generating the custom resource.
-
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®:
- Business Automation
Studio:
- Set
bastudio_configuration.database.type
toDB2
. - Enter your DB2® server hostname or IP into
bastudio_configuration.database.host
. - Enter your DB2 server port into
bastudio_configuration.database.port
. - Enter your Business Automation
Studio
database into
bastudio_configuration.database.name
. - If you want to connect your database by SSL, set
bastudio_configuration.database.ssl_enabled
totrue
and enter your database secret intobastudio_configuration.database.certificate_secret_name
. - If you want to use your own JDBC driver, set
bastudio_configuration.database.use_custom_jdbc_drivers
totrue
and enter your PVC for JDBC driver intobastudio_configuration.database.custom_jdbc_pvc
and JDBC driver files intobastudio_configuration.database.jdbc_driver_files
. For more information, see Implementing storage.
- Set
- Application
Engine
playback server:
- Set
bastudio_configuration.playback_server.database.type
toDB2
. - Enter your DB2 server hostname or IP into
bastudio_configuration.playback_server.database.host
. - Enter your DB2 server port into
bastudio_configuration.playback_server.database.port
. - Enter your Application
Engine
playback server database into
bastudio_configuration.playback_server.database.name
. - If you want to connect your database by SSL, set
bastudio_configuration.playback_server.database.enable_ssl
totrue
and enter your database secret intobastudio_configuration.playback_server.database.db_cert_secret_name
. - If you want to use your own JDBC driver, set
bastudio_configuration.playback_server.use_custom_jdbc_drivers
totrue
and enter your PVC for JDBC driver intobastudio_configuration.playback_server.database.custom_jdbc_pvc
. For more information, see Implementing storage.
- Set
- Business Automation
Studio:
- For Oracle:
- Business Automation
Studio:
- Set
bastudio_configuration.database.type
toOracle
. - Enter the Oracle connection URL in this format:
intojdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=<your-oracle-database-hostname>)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=<your-oracle-database-service-name>)))
bastudio_configuration.database.jdbc_url
. - Set
bastudio_configuration.database.use_custom_jdbc_drivers
totrue
. - Enter your PVC for Oracle JDBC driver into
bastudio_configuration.database.custom_jdbc_pvc
and the Oracle JDBC drive files intobastudio_configuration.database.jdbc_driver_files
, like ojdbc8.jar. For more information, see Implementing storage. - If you want to connect your database by SSL, set
bastudio_configuration.database.ssl_enabled
totrue
.- 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.
- Update
- Set
- Application
Engine
playback server:
- Set
bastudio_configuration.playback_server.use_custom_jdbc_drivers
totrue
. - Set
bastudio_configuration.playback_server.database.type
toOracle
. - Enter the Oracle connection URL in this format:
into(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=<your-oracle-database-hostname>)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=<your-oracle-database-service-name>)))
bastudio_configuration.playback_server.database.oracle_url_without_wallet_directory
. - Enter your PVC for Oracle JDBC driver into
bastudio_configuration.playback_server.database.custom_jdbc_pvc
. For more information, see Implementing storage. - If you want to connect your database by SSL, set
bastudio_configuration.playback_server.database.enable_ssl
totrue
.- Update
(set in step iii) to use Oracle SSL URL in this format:bastudio_configuration.playback_server.database.oracle_url_without_wallet_directory
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:
into(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)))
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 intobastudio_configuration.playback_server.database.oracle_sso_wallet_secret_name
. For more information, see Creating secrets to protect sensitive configuration data.
- Update
- Set
- Business Automation
Studio:
- For PostgreSQL:
- Business Automation
Studio:
- Set
bastudio_configuration.database.use_custom_jdbc_drivers
totrue
. - Set
bastudio_configuration.database.type
toPostgreSQL
. - Enter your PostgreSQL
server hostname or IP into
bastudio_configuration.database.host
. - Enter your PostgreSQL
server port into
bastudio_configuration.database.port
. - Enter your Business Automation
Studio
database into
bastudio_configuration.database.name
. - Enter your PVC for PostgreSQL JDBC driver into
bastudio_configuration.database.custom_jdbc_pvc
. For more information, see Implementing storage. - Enter the PostgreSQL
JDBC driver files into
bastudio_configuration.database.jdbc_driver_files
, such as postgresql-42.2.16.jar. - If you want to connect your database by SSL, set
bastudio_configuration.database.ssl_enabled
totrue
and enter your database secret intobastudio_configuration.database.certificate_secret_name
. - 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. Ifbastudio_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
host
,port
, andcertificate_secret_name
are left empty in the CR. You must also setbastudio_configuration.database.ssl_enabled
totrue
.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 thedatasource_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 thecp4a-prerequisites.sh
script.
- Set
- Application
Engine playback
server:
- Set
bastudio_configuration.playback_server.use_custom_jdbc_drivers
totrue
. - Set
bastudio_configuration.playback_server.database.type
toPostgreSQL
. - Enter your PostgreSQL
server hostname or IP into
bastudio_configuration.playback_server.database.host
. - Enter your PostgreSQL
server port into
bastudio_configuration.playback_server.database.port
. - Enter your Application
Engine
database into
bastudio_configuration.playback_server.database.name
. - Enter your PVC for PostgreSQL JDBC driver into
bastudio_configuration.playback_server.database.custom_jdbc_pvc
. For more information, see Implementing storage. - If you want to connect your database by SSL, set
bastudio_configuration.playback_server.database.enable_ssl
totrue
and enter your database secret intobastudio_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. - 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. Ifbastudio_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
host
,port
, anddb_cert_secret_name
are left empty in the CR. You must also setbastudio_configuration.playback_server.database.enable_ssl
totrue
.
- Set
- Business Automation
Studio:
- For Microsoft SQL Server:
- Business Automation
Studio:
- Set
bastudio_configuration.database.use_custom_jdbc_drivers
totrue
. - Set
bastudio_configuration.database.type
tosqlserver
. - Enter your SQL Server
hostname or IP into
bastudio_configuration.database.host
. - Enter your SQL Server
port into
bastudio_configuration.database.port
. - Enter your Business Automation
Studio into
bastudio_configuration.database.name
. - 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. - Enter the SQL Server
JDBC driver files into
bastudio_configuration.database.jdbc_driver_files
, such asmssql-jdbc-9.2.1.jre8.jar
. - If you want to connect your database by SSL, set
bastudio_configuration.database.ssl_enabled
totrue
and enter your database secret intobastudio_configuration.database.certificate_secret_name
.
- Set
- Application
Engine playback
server:
- Set
bastudio_configuration.playback_server.use_custom_jdbc_drivers
totrue
. - Set
bastudio_configuration.playback_server.database.type
tosqlserver
. - Enter your SQL Server
hostname or IP into
bastudio_configuration.playback_server.database.host
. - Enter your SQL Server
port into
bastudio_configuration.playback_server.database.port
. - Enter your Application
Engine
database into
bastudio_configuration.playback_server.database.name
. - Enter your PVC for SQL Server JDBC driver into
bastudio_configuration.playback_server.database.custom_jdbc_pvc
. For more information, see Implementing storage. - If you want to connect your database by SSL, set
bastudio_configuration.playback_server.database.enable_ssl
totrue
and enter your database secret intobastudio_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.
- Set
- Business Automation
Studio:
For a full list of parameters, see IBM Business Automation Studio configuration parameters. - For Db2®:
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.