3662076 - Best Practice: Use SAP Analytics Cloud Agent Survey Tool in Windows to Assist Support [How to]

When troubleshooting SAP Analytics Cloud Agent issues, support team and customers need to collect comprehensive diagnostic information including:

• Tomcat service configuration and installation details
• SAP Cloud Agent properties and configuration files
• System log files and error traces
• JDBC database drivers and connection configurations
• SAP Java Connector (JCo) files
• Database-specific SBO configuration files

Manual collection of this information is time-consuming, error-prone, and may result in incomplete data sets that delay issue resolution.

• SAP Analytics Cloud (SAC) Enterprise
• Microsoft Windows
• Apache Tomcat

Use the SAP Cloud Agent Survey Tool to automatically collect all necessary diagnostic information in a structured format.

This tool creates a comprehensive report and organizes all relevant files for efficient troubleshooting. 

Prerequisites:

• Windows Command Prompt or PowerShell access
• Administrative or appropriate user permissions to access Tomcat installation directory
• Only leave the tomcat which has cloud agent deployed running if have multiple tomcat installed
• SAP_CLOUD_AGENT_PROPERTIES_PATH environment variable configured (recommended)

1. Download and Prepare the Tool

1. 1. Save the SAP Cloud Agent Survey script as CloudAgentSurvey.zip
   2. Unzip and place the script in a directory where you have write permissions
   3. Ensure you have sufficient disk space (typically 50-200 MB depending on log file sizes)
2. Execute the Survey Tool
   1. Open Command Prompt as Administrator (recommended) or double click the script in the folder to run (step 2 & 3 can be skipped).
   2. Navigate to the directory containing the script
   3. Execute the command:

      CloudAgentSurvey.bat
      

3. Review and Accept Terms

• 1. Read the detailed disclaimer and terms of use
  2. Type Y to confirm consent and proceed with data collection
  3. Type N to cancel the operation

The tool will automatically:

• Detect running Tomcat processes and versions
• Locate Tomcat installation directory
• Extract Cloud Agent version information
• Copy configuration files and logs
• Identify and copy database drivers
• Generate comprehensive HTML report

Output Structure

The tool creates a Cloud Agent Survey folder containing:

Cloud Agent Survey/
├── SAP_Cloud_Agent_Survey_Report_[timestamp].html
├── [properties_file_name].properties
├── logs/
│   ├── *.log files
│   ├── *.trc files
│   ├── *.txt files
│   └── *.out files
├── JCo Drivers/
│   ├── sapjco3.jar
│   └── sapjco3.dll
├── JDBC Drivers/
│   └── *.jar files (database-specific)
└── SBO Files/
    └── *.sbo files (database-specific)

Generated Reports

HTML Report Sections:

1. Tomcat Information - Service status, version, installation path
2. Environment Variables - Properties file location and content
3. JDBC Drivers Information - Database driver analysis and file status
4. Logs Information - Complete log file inventory with file types
5. SAP JCo Files Information - Java Connector file verification
6. SBO Files Information - Database-specific configuration files

ZIP Archive:

• Automatically created using multiple compression methods
• Contains all collected files for easy sharing
• Filename format: Cloud_Agent_Validation_[timestamp].zip

Troubleshooting the Tool

Common Issues and Solutions:

Issue: "Tomcat not found"

• Solution: Ensure Tomcat service is running and verify process names match expected patterns

Issue: "Properties file not found"

• Solution: Set SAP_CLOUD_AGENT_PROPERTIES_PATH environment variable or manually locate the properties file

Issue: "ZIP creation failed"

• Solution: Tool will create individual files in the survey folder; manually compress the folder if needed

Issue: "Access denied errors"

• Solution: Run Command Prompt as Administrator or ensure user has appropriate file system permissions

Security and Privacy Considerations

⚠️ Important Security Notes:

• The collected data may contain sensitive configuration information
• Review all files before sharing with external parties
• Ensure compliance with your organization's data handling policies
• The tool operates in READ-ONLY mode and makes no system changes
• Remove or redact sensitive information (passwords, connection strings) before sharing

Best Practices

1. Before Running:

   • Stop any non-essential processes to ensure clean log capture
   • Verify sufficient disk space is available
   • Document any recent changes or error conditions

2. After Collection:

   • Review the HTML report for completeness
   • Verify all expected components are present
   • Test ZIP file integrity before sharing

3. For Support Cases:

   • Include the complete ZIP file with your support request
   • Reference this KBA in your case description
   • Provide additional context about the specific issue being investigated

Additional Information

Script Capabilities:

• Automatic Tomcat version detection and path resolution
• Intelligent database driver identification from properties file
• Comprehensive log file analysis with type categorization
• Multiple ZIP compression methods for maximum compatibility
• Detailed HTML reporting with visual status indicators

File Size Considerations:

• Log files can be large (10MB-1GB+) depending on system activity
• JDBC drivers typically range from 1-50MB per driver
• Complete validation package usually ranges from 1-200MB

3663088 - Best Practice: Use SAP Analytics Cloud Agent Survey Tool in Linux to Assist Support [How to]

KBA , LOD-ANA-AQU , Import Data Connections (Acquiring Data) , LOD-ANA-AQU-BW , Data Acquisition from BW , Problem