Configuring Workplace Assistant

Install and configure the Workplace Assistant in a Business Automation Workflow on containers environment.

1. During the standard installation of Business Automation Workflow on containers, run the baw-prerequisites script in property mode, and select either 1 for Business Automation Workflow Authoring or 2 for Business Automation Workflow Runtime. Then, from the optional components list, choose 4 to enable Workplace Assistant.
2. In the generated property file, fill out the required fields as shown:

   WFA.WATSONX_API_KEY="<Required>"
   WFA.WATSONX_URL="<Required>"
   WFA.RUN_WORKPLACE_AGENT="<false>"
   WFA.WATSONX_PROJECT_ID="<Required>"

   IBM SaaS credentials, which appear by default:

   ###################################################
   ## USER Property for Workflow Assistant ##
   ###################################################
   ## Provide the API Key for WatsonX
   WFA.WATSONX_API_KEY="<Required>"
   
   ## Provide the Project ID of WatsonX
   WFA.WATSONX_PROJECT_ID="<Required>"
   
   ## Provide the URL of WatsonX
   WFA.WATSONX_URL="<Required>"
   
   ## Flag to run the Workplace Assistant
   WFA.RUN_WORKPLACE_AGENT="true"
   
   ## Flag to run the (Preview) Authoring Assistant
   WFA.RUN_AUTHORING_AGENT="false"
   
   ## Provide the CP4D user name.
   WFA.WATSONX_USERNAME="<Optional>"
   
   ## Provide the CP4D token.
   WFA.WATSONX_TOKEN="<Optional>"
   
   ## Provide the CP4D instance ID.
   WFA.WATSONX_INSTANCE_ID="<Optional>"
   
   ## Provide the CP4D version.
   WFA.WATSONX_VERSION="<Optional>"
   
   ## Optional - Only required if WATSONX_API_KEY is not set.
   WFA.WATSONX_PASSWORD="<Optional>"
   
   ## Optional - The ID of the LLM model to use. Default set to meta-llama/llama-3-3-70b-instruct.
   WFA.WATSONX_MODEL_ID="<Optional>"
   
   ## Optional - Only required if a custom deployment LLM model is being used. If set, will override WATSONX_MODEL_ID value.
   WFA.RUNTIME_AGENT_WATSONX_MODEL_ID ="<Optional>"
   WFA.AUTHORING_AGENT_WATSONX_MODEL_ID ="<Optional>"

   For more information about property values, see Enabling generative AI.
3. Run the prerequisite script in generate mode and, when it completes, a Kubernetes secret named ibm-workflow-assistant-secrets is created, using the values that you provided.
4. For the deployment that you chose, when the deployment script completes running, a lombardi-custom-xml-secret secret is generated, which contains the XML snippets that are required for the Workplace Assistant, and is referenced in the generated custom resource (CR) file.
   Note: If the secret lombardi-custom-xml-secret is already present, it is deleted and the old contents are stored as a backup XML file in the same location.
   Additionally, a new section is appended to the main CR file:

   workflow_assistant_configuration:
     run_authoring_agent: true
     run_workplace_agent: true
     

   In Workplace Assistant, the Workplace basic URL chat is automatically enabled.
   Important: In a federated environment, you must enable Workplace Assistant only on the Business Automation Workflow instance that hosts the federated Workplace.
5. Optional: To disable the Workplace chat, in the main CR file mentioned in step 4 earlier, set run_workplace_agent to false.
6. Optional: To enable Content Assistant features for content search, querying, and summarization, see the following configuration topic for setup instructions and prerequisites.