Optional: Enabling Common UI

Common UI enables you to work with content from various sources in one user interface. It contains Workplace, which in this context is a stand-alone user interface application that runs on the Application Engine server and has a desktop configured in IBM® Business Automation Navigator.

To enable Workplace in the Common UI console, complete the following steps. This procedure deploys a standalone instance of the Workplace UI for use with the Process Federation Server federated servers.

  1. Prepare the capabilities.
    1. To prepare Application Engine, see Preparing to install Application Engine External link opens a new window or tab .
    2. To save your custom Workplace on Application Engine, you must enable Application Engine data persistence. For example, custom settings include your task list table ordering, and page size. See Optional: Configuring Application Engine with data persistence External link opens a new window or tab .
    3. To prepare Business Automation Navigator, see Preparing to install Navigator External link opens a new window or tab.
  2. Update your Business Automation Workflow custom resource (CR) to add Resource Registry, Application Engine, and Business Automation Navigator configuration:
    1. To configure Application Engine, see Configuring Application Engine External link opens a new window or tab . For Application Engine parameters, see Application Engine parameters External link opens a new window or tab .
    2. To configure Business Automation Navigator, see Configuring Business Automation Navigator External link opens a new window or tab . For Business Automation Navigator parameters, see IBM Business Automation Navigator parameters External link opens a new window or tab .
    For example, after you configure those components, your custom resource might look similar to:
    apiVersion: icp4a.ibm.com/v1
    kind: ICP4ACluster
    metadata:
      name: icp4deploy
    spec:
      appVersion: 2.5.0.0
      ibm_license: accept
      bts_configuration: true
      resource_registry_configuration:
        replica_size: 1
      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 CR and wait a few minutes for your resources to initiate.
  4. Run kubectl get icp4acluster -o yaml to make sure that Resource Registry, IBM Business Automation Application, and Business Automation Navigator are ready. Make sure that the status of .status.components.prereq.rootCAStatus is ready, .status.components.prereq.rootCASecretName contains the correct secret name, and .status.endpoints["Resource Registry"] appears in the endpoints list.
  5. Complete your Application Engine configuration by completing the steps in Completing post-installation tasks for Application Engine External link opens a new window or tab.
  6. Complete your Business Automation Navigator configuration by completing the steps in Completing post-installation tasks for Business Automation Navigator External link opens a new window or tab.
  7. Wait a few minutes for the Process Federation Server operator to create the Workplace <PFSCRName>-workplace-job job.