Troubleshooting Guidelines

Overview

This document outlines best practices for managing long-running reports, addressing report failures, and efficiently utilizing ad-hoc reporting in SCI. Adhering to these guidelines will help maintain optimal system performance.

Long-Running Reports

A long-running report takes more time than expected to execute.

General Guidelines to avoid long-running reports (interactive and scheduled)

• Understand user requirements: Focus on key metrics/KPIs to avoid unnecessary data, minimizing processing time.
• Limit data retrieval:
  • Implement filtering options to restrict the volume of data processed and displayed.
  • Enable users to select specific time periods and other necessary prompts before running the report.
• Use summary reports: Instead of detailed reports, create summary reports that provide high-level insights without processing more data.
• Break down complex reports: If a report is complex, consider splitting it into smaller, more manageable reports/sections based on the use case.
• Optimize data sources: After applying the other recommendations and if the report is still slow, connect with MA services to verify the indexes.

Scheduled Reports

• Schedule during off-peak hours: Whenever possible, schedule long-running reports during off-peak hours when system usage is lower. Also, pay attention to the frequency of scheduling.

Failed Reports

Follow the recommendations below to minimize the failures.

• Review error messages: Verify the error message and resolve the issue if the failure is self-explanatory.

• Attempt to re-run the report: If the failure was possibly a one-time issue, try executing the report again after a brief wait.

• Verify data sources: Ensure all required data sources are accessible from the Cognos admin console.

• Check report logic: Review any filters, calculations, and joins for potential issues that may cause failures.

• Document the failure: Keep a record of the failure, including error codes and any relevant details of the resolution, for future reference.

Ad-Hoc Reports

Ad-hoc reports are generated on a need basis to meet specific business requirements quickly. They allow users to analyze data flexibly and dynamically.

• Leverage existing reports: Before creating a new ad-hoc report, check if an existing report can be adjusted to meet the business needs.
• Limit data scope: Focus on specific datasets relevant to the use case to improve performance and reduce execution time.
• Understand the purpose: Clearly define what is needed from the ad-hoc report to avoid unnecessary complexity.
• Avoid excessive runs: Be mindful of the number of ad-hoc report executions within a short timeframe, as it may affect overall system performance.
• Utilize report parameters: Use prompts effectively to customize reports without creating multiple versions of the same report.

Operational Documents

Operational documents are reports that offer insights into the performance, status, and tracking of various supply chain operations. SCI should not be used for creating or running operational document reports, such as Bills of Lading, Packing Slips, Worksheets, or Manifests.

Multiple Users Running the Same Report

Follow the below recommendations:

• Schedule reports: Encourage users to schedule reports to avoid simultaneous, on-demand generation.
• Use prompts and filters: Implement dynamic prompts and filters to tailor reports to individual user needs.
• Consolidate and standardize reports: Minimize redundancy and ensure that users are running the latest versions of reports.
• Leverage report bursting: Use bursting to generate personalized reports and distribute them automatically.