When a request is sent from Planning Analytics Workspace to a local agent, an
authentication token is also sent. This token is created using a key that must be set to the same
value in both the bootstrap.properties file for the local agent and Planning
Analytics Workspace Local configuration file.
Procedure
- Open the Windows Services desktop application.
- Stop the IBM Planning Analytics Administration Agent service if it
is running.
-
Open the bootstrap.properties file for the local agent.
The default location of bootstrap.properties is C:\Program
Files\ibm\cognos\tm1_64\paa_agent\wlp\usr\servers\kate-agent\.
- Add the AGENT_API_KEY property to
bootstrap.properties and set the key property value to any plain text string of
your choice.
Important: Take note of the string you enter. You'll need it when you add the
AdminAgentAPIKey parameter to the Planning Analytics Workspace Local
configuration file in Step 8.
- Save and close the bootstrap.properties file.
- Restart the IBM Planning Analytics Administration Agent
service.
After the agent starts, the key property value you entered is encoded. The
AGENT_API_KEY property is removed from
bootstrap.properties and replaced with the
AGENT_API_KEY_ENCODED property, which is set to the encoded version of the key
property value you entered.
If you want to change the key value, you must again add the AGENT_API_KEY
property to the bootstrap.properties file. The
AGENT_API_KEY_ENCODED property will then be updated to contain the encoded key.
- Open the Planning Analytics Workspace Local configuration file.
The configuration file is located in the
<planning_analytics_install_dir>\config directory and is named
paw.ps1 (Windows) or paw.env (Linux).
- Add the AdminAgentAPIKey parameter to the Planning Analytics Workspace Local configuration file and
set the parameter value to match the AGENT_API_KEY plain text property value
that you entered in Step 4.
- Save the configuration file.
- Run ./scripts/paw.ps1 (Windows) or
./scripts/paw.sh to apply the configuration changes.