Configuring Documentation URL for TechDocs Migration

Products

• Automic Automation
• Automic SaaS
• CA Automic One Automation
• CA Automic Workload Automation - Automation Engine

Issue/Introduction

Broadcom has migrated product documentation from docs.automic.com to techdocs.broadcom.com. As a result of this transition, help files can no longer be downloaded for on-premise hosting. All users must have network access to techdocs.broadcom.com to view documentation.

Scope (Classic Help vs. ICE):

These configuration settings apply to Classic Online Help (external help opened in a browser window) and when IPCE (In-Product Content Experience / Inline Help) is turned off.

When IPCE is enabled (default in modern versions), AWI uses the embedded inline help sidebar connecting directly to Broadcom's IPCE service.

Resolution

AWI Configuration

To update the documentation base URL on an existing Automic Web Interface (AWI) installation, update the configuration.properties file with the following keys. A service restart is not required; simply log out and log back into the AWI after saving changes.

• helpUrl.pattern: https://techdocs.broadcom.com/us/en/ca-enterprise-software/intelligent-automation/automic-automation/{1}/automic-automation/Content-_Common-Welcome-CommonWelcomeImageMaps.html
• helpUrl.version: Use the following values based on your product version:
  • Version 24: 24-4
  • Version 26: 26-0

Note: As new product versions are released, updated values for helpUrl.version will become available.

Example entries:

helpUrl.pattern=https://techdocs.broadcom.com/us/en/ca-enterprise-software/intelligent-automation/automic-automation/{1}/automic-automation/Content-_Common-Welcome-CommonWelcomeImageMaps.html
helpUrl.version=26-0

AAKE Configuration

For Automic Automation Kubernetes Edition (AAKE), configure the following environment variables:

• AUTOMIC_HELPURL_PATTERN: Use the URL provided in the AWI Configuration section above.
• AUTOMIC_HELPURL_VERSION: Use the corresponding version value (e.g., 24-4 or 26-0).

These changes take effect immediately upon log out and re-login; no AWI restart is required.

Additional Information

Please be advised that this is a temporary, interim configuration. Deep-linking to specific help topics based on your current screen is not currently available. Every "Help" action will land on the general Automic Automation Welcome page on techdocs.broadcom.com rather than the specific topic for the screen you are accessing.