Configuring Authoring Assistant

 Technology preview  Install and configure the Authoring Assistant in a Business Automation Workflow on containers environment.

1. During the standard installation process of Business Automation Workflow Authoring on containers, run the baw-prerequisites script in property mode and select 1 for Business Automation Workflow on containers. Then from the optional components list, choose 5 to enable Authoring 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_AUTHORING_AGENT="<true>"
   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="false"
   
   ## Flag to run the (Preview) Authoring Assistant
   WFA.RUN_AUTHORING_AGENT="true"
   
   ## 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>"

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, the XML snippets that are required for the Authoring Assistant is embedded directly into the generated CR.
   If you opt for Authoring Assistant, then the section bastudio_custom_xml: automatically appears in the Custom Resource (CR) under bastudio_configuration.

   bastudio_custom_xml: |-
   <properties>
      <authoring-environment>
         <authoring-agent-endpoint merge="replace">
            <cpd_url>/agent
         </authoring-agent-endpoint>
      </authoring-environment>
   </properties>

   Note: Replace <cpd_url> with the actual CPD URL for your environment.

   A new section is also appended to the main CR file:

   workflow_assistant_configuration:
     run_authoring_agent: true
     run_workplace_agent: true