Troubleshooting
Problem
The purpose of this document is to provide guidance with troubleshooting the Planning Analytics Administration Agent.
Diagnosing The Problem
Generic:
- Ensure the PAA Agent is updated to match the version of PA Workspace in use. If not, then download the newer PAA Agent .zip file from PA Workspace administration UI.
- Review \paa_agent\wlp\usr\servers\kate-agent\bootstrap.properties for PAA Agent configuration errors
- In \paa_agent\wlp\usr\servers\kate-agent\bootstrap.properties verify SERVERS_DIR points to the parent folder of the TM1 data directories, not directly to one specific data directory.
- Review \paa_agent\wlp\usr\servers\kate-agent\server.xml for WLP-related errors
- Review \paa_agent\wlp\usr\servers\kate-agent\logs\ for errors
- Review \pa_workspace_install\logs\monitor\ for errors
*The monitor service is what the PA Workspace Administration page uses to communicate with the PAA Agent - Review \pa_workspace_install\config\paw.env (or paw.ps1) file
Connectivity-Related Errors:
- Ensure that the IBM Planning Analytics Administration Agent service is running
- Ensure that the IBM Planning Analytics Administration Agent service account is configured with english locale
- Verify that the PAA Agent URL is accessible in a web browser where PAA Agent is installed (ignore the SSL certificate warning)
URL: https://localhost:9012
If available, PAA Agent just responds "NOT FOUND The application or context root for this request has not been found"
*PAA Agent runs on Port 9012 and uses SSL by default - Verify that PAA Agent is accessible from inside the docker virtual network of PA Workspace. Open Powershell and run these commands:
docker exec -it monitor Powershell cd curl* cd bin .\curl -v telnet://paa_agent_servername ipaddress:9012
- In the web browser, verify that the SSL Certificate is valid
See: https://www.ibm.com/support/pages/node/6562425 - Verify that the PAA Agent URL is also accessible through the Planning Analytics Workspace host by using browser or curl command
URL: https://paa_agent_servername:9012 - Verify that PAA Agent is listening on port 9012: from Windows start menu, run "resmon.exe", select "Listening Ports", and verify "javaw.exe" is listening on port 9012
- In Planning Analytics Administration Tool page, verify the IP addresses returned for the Admin Host and TM1 Server
URL: http://workspace_servername:8888 - Does your PAA Agent bootstrap.properties file contain a AGENT_API_KEY setting?
- Does Workspace paw.env / paw.ps1 file have AdminAgentAPIKey set?
See: https://www.ibm.com/support/pages/whats-coming-next-ibm-planning-analytics-workspace-2060
- Does Workspace paw.env / paw.ps1 file have AdminAgentAPIKey set?
- Does your PAA Agent use custom SSL?
- Were the certificates imported into Workspace?
See: https://www.ibm.com/docs/en/planning-analytics/2.0.0?topic=ctas-configure-tls-between-planning-analytics-workspace-local-other-servers
- Were the certificates imported into Workspace?
- Does your TM1 Admin Server and TM1 Server use custom SSL?
- Were the certificates imported into the PAA Agent keystore?
Other problems encountered with the PAA Agent might require extra debugging to be enabled for review.
Enable PAA Agent Debug Logging:
- Stop the IBM Planning Analytics Administration Agent service
- Update the \paa_agent\wlp\usr\servers\kate-agent\bootstrap.properties file to include
- com.ibm.ws.logging.trace.specification="*\=audit\:com.ibm.pa.kate.agent.*\=all"
- com.ibm.ws.logging.console.log.level=ERROR
- Start the IBM Planning Analytics Administration Agent service
- Replicate the problem as required
- Review the files in \paa_agent\wlp\usr\servers\kate-agent\logs\
Resolving The Problem
If additional assistance is required, then provide the following to Support:
- Basic description of the problem
- Is it a new installation?
- Was this working previously? What changed?
- Is the problem consistent or intermittent? Limited to certain users?
- Version details for TM1 Server, PAA Agent, and PA Workspace
- Operating System details for TM1 Server, PAA Agent, and PA Workspace
- Screenshots or output of the Connectivity Related checks
- Copy of the \paa_agent\ directory
- It results in a larger file; nevertheless, it ensures that we have all PAA Agent files at our disposal
- If limiting scope, you must gather:
- \paa_agent\wlp\usr\servers\kate-agent\bootstrap.properties
- \paa_agent\wlp\usr\servers\kate-agent\server.xml
- Copy of \paa_agent\wlp\usr\servers\kate-agent\logs\ directory with Debug Logging enabled
- Copy of \pa_workspace_install\logs\
*We are primarily interested in monitor service; however, we might need other logs to review - Copy of \pa_workspace_install\config\paw.env (or paw.ps1) file
- TM1S.cfg from any TM1 instances (if related)
- Any additional relevant details
Document Location
Worldwide
[{"Type":"MASTER","Line of Business":{"code":"LOB10","label":"Data and AI"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSCTEW","label":"IBM Planning Analytics Local"},"ARM Category":[{"code":"a8m50000000KzL5AAK","label":"Planning Analytics-\u003EPlanning Analytics Workspace-\u003EAdministration"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]
Was this topic helpful?
Document Information
Modified date:
28 September 2022
UID
ibm16562439