Optional: Enabling Common UI

Common UI enables you to work with content from various sources in one user interface. It contains Workplace, which is an user interface application that runs on the Application Engine server and has an desktop configured in IBM Business Automation Navigator. To enable Workplace in the Common UI console, complete the following steps.

Procedure

  1. Prepare the required capabilities.
    1. To prepare Application Engine, see Preparing to install Application Engine.
    2. To save your custom Workplace settings on Application Engine, you must enable Application Engine data persistence. For example, custom settings include your task list table ordering, and page size. For more information, see Optional: Configuring Application Engine with data persistence.
    3. To prepare Business Automation Navigator, see Preparing to install Navigator.
  2. Update your IBM Cloud Pak® for Business Automation custom resource to add Business Teams Service, Application Engine, and Business Automation Navigator configuration:
    1. To configure Application Engine, see Configuring Application Engine. For Application Engine parameters, see Application Engine parameters.
    2. To configure Business Automation Navigator, see Configuring Business Automation Navigator. For Business Automation Navigator parameters, see Business Automation Navigator parameters.
    For example, after you have configured those components, your custom resource might look similar to the following:
    apiVersion: icp4a.ibm.com/v1
kind: ICP4ACluster
metadata:
  name: icp4deploy
spec:
  appVersion: 23.2.0
  ibm_license: accept
  bts_configuration: true
  application_engine_configuration:
  - name: workspace
    admin_user: "<Required>"
    data_persistence:
      enable: false
    database:
      host: "<Required>"
      name: "<Required>"
      port: "<Required>"
      type: "<Required>"
      enable_ssl: "<Required>"
      db_cert_secret_name: "<Required>"
  navigator_configuration:
    ban_secret_name: ibm-ban-secret
  datasource_configuration:
    dc_ssl_enabled: "<Required>"
    dc_icn_datasource:
      dc_database_type: "<Required>"
      dc_common_icn_datasource_name: "ECMClientDS"
      database_servername: "<Required>"
      database_port: "<Required>"
      database_name: "<Required>"
      database_ssl_secret_name: "<Required>"
      dc_oracle_icn_jdbc_url: "<Required>"
  3. Apply the custom resource and wait a few minutes for your resources to initiate.
  4. Run oc get icp4acluster -o yaml to make sure that Business Teams Service, IBM Business Automation Application, and Business Automation Navigator are ready. Make sure that the status of .status.components.prereq.rootCAStatus is ready and .status.components.prereq.rootCASecretName contains the correct secret name.
  5. Complete your Application Engine configuration by completing the steps in Completing post-installation tasks for Application Engine.
  6. Complete your Business Automation Navigator configuration by completing the steps in Completing post-installation tasks for Business Automation Navigator.
  7. Wait a few minutes for the Process Federation Server operator to create the Workplace <PFSCRName>-workplace-job job.
  8. Verify the Workplace desktop:
    1. Access the configuration maps from the OpenShift® web console by selecting Workloads > Config Maps.
    2. Find cp4ba-access-info and get the Business Automation Navigator URL from navigator-access-info.
    3. Access the Workplace desktop URL. For example:

      https://cpd_hostname/icn/navigator/?desktop=workplace

What to do next

Access your cluster Common UI console by completing the steps in Accessing your cluster by using the console .