Troubleshooting Reports and Report Builder

Running into trouble with your reporting? Check here first.

  • Common Issues and Solutions with Reporting and Using Report Builder

    When troubleshooting issues in ReadyWorks Report Builder, it's important to approach the problem systematically. Here are some common issues you may encounter, along with strategies for resolving them:

     

    1 - Report fails to load or loads incompletely:

    This issue often relates to data volume or complexity.

    • Check the report's data source and filters:
      • Ensure that the primary data source is appropriate for the report's purpose.
      • Verify that global WHERE clauses and filters are not overly restrictive.
    • Review calculated columns:
      • Look for complex calculations that might be causing performance issues.
      • Consider simplifying calculations or pre-calculating values where possible.
    • Examine linked asset data:
      • Reduce the number of fields pulled from linked assets if not all are necessary.
    • Consult with your ReadyWorks administrator:
      • They may need to optimize database indexes or increase server resources.

     

    2 – Inconsistent or unexpected data:

    When report data doesn’t match expectations, consider these steps:

    • Verify data refresh timing:
      • Check when the last data import occurred.
      • Ensure that refresh rates are appropriate for the data’s volatility.
    • Cross-check with source systems:
      • Compare a sample of data points with the original data sources.
      • Look for any discrepancies in data mapping or transformation.
    • Review calculation logic:
      • Double-check the formulas used in calculated columns.
      • Ensure that RAG status criteria are correctly defined.
    • Examine filters and WHERE clauses:
      • Verify that filters are not inadvertently excluding relevant data.
      • Check for any conflicting filter conditions.

     

    3 - Action buttons or forms not working as expected:

    If interactive elements are malfunctioning:

    • Check user permissions:
      • Ensure that users have the necessary rights to perform the actions.
      • Verify that the report itself has the correct permissions set.
    • Review action button configuration:
      • Check the action button's script for errors.
      • Ensure that any conditions for button activation are correctly set.
    • Test form functionality:
      • Verify that all form fields are correctly mapped to asset attributes.
      • Check for any validation rules that might be preventing form submission.

     

    4 - Report performance degradation over time:

    If a previously well-performing report becomes slow:

    • Analyze recent changes:
      • Review any modifications made to the report structure or calculations.
      • Check if data volume has significantly increased recently.
    • Examine usage patterns:
      • Look for an increase in concurrent users or frequency of report runs.
      • Consider implementing staggered refresh times for heavy reports.
    • Consult system logs:
      • Work with your ReadyWorks administrator to review system logs for any anomalies.
      • Look for patterns in when performance issues occur.

     

    5 - Discrepancies between preview and published report:

    If the preview doesn't match the published version:

    • Check for unsaved changes:
      • Ensure all modifications have been saved before publishing.
      • Re-publish the report if necessary.
    • Review user-specific settings:
      • Verify if any discrepancies are due to user-specific filters or permissions.
    • Clear cache and cookies:
      • Instruct users to clear their browser cache and cookies.
      • Test the report in an incognito/private browsing window.

     

    When troubleshooting, always approach the problem methodically:

    1. Clearly define the issue.
    2. Gather relevant information (error messages, affected users, recent changes).
    3. Test in a controlled environment if possible.
    4. Apply potential solutions one at a time, testing after each change.
    5. Document the problem and solution for future reference.
    See more
  • Troubleshooting Performance Issues with Reports

    Performance issues can significantly impact the usability and effectiveness of your reports. When dealing with performance problems, consider the following approaches:

     

    1 - Identify the bottleneck:

    Determine where the performance issue is occurring:

    • Data retrieval: Slow query execution from the database
    • Data processing: Complex calculations or large data volumes
    • Rendering: Issues with displaying large amounts of data in the browser

     

    2 - Analyze query performance:

    Work with your ReadyWorks administrator to examine database queries:

    • Use query execution plans to identify slow-running queries
    • Look for opportunities to optimize WHERE clauses or JOINs
    • Consider adding appropriate indexes to frequently queried columns

     

    Picture39.png

    Picture40.png

     

    3 - Optimize data volume:

    Reduce the amount of data being processed:

    • Implement more restrictive filters or WHERE clauses
    • Use data sampling for large datasets where appropriate
    • Consider aggregating data at a higher level (e.g., daily instead of hourly)

     

    4 - Review calculated columns:

    Examine any custom calculations in your report:

    • Simplify complex calculations where possible
    • Consider pre-calculating frequently used metrics and storing the results
    • Use incremental calculations for time-based metrics rather than recalculating from scratch

     

    Remember, performance optimization is often an iterative process. Make changes incrementally and test thoroughly after each modification to ensure you're moving in the right direction.

    See more
  • Data Discepancies in Reporting

    When you encounter data discrepancies in your reports, it's crucial to investigate and resolve them promptly to maintain trust in your reporting system. Here's how to approach this issue:

     

    1 - Verify data sources:

    Ensure that your report is pulling data from the correct sources:

    • Check data source configurations in ReadyWorks
    • Confirm that any integrations or data imports are functioning correctly
    • Verify that the correct version or instance of a data source is being used
    • Cross-check with original data:

    2 - Compare report data with the original source:

    • Use a sample of records to manually verify data accuracy
    • Look for any patterns in discrepancies (e.g., specific fields, date ranges, or asset types affected)
    • Review data transformations:

    3 - Examine any data transformations or calculations:

    • Check the logic of calculated fields
    • Verify that data type conversions are handled correctly
    • Ensure that null or empty values are treated appropriately
    • Investigate timing issues:

    4 - Consider whether timing could be causing discrepancies:

    • Check data refresh schedules and ensure they align with reporting needs
    • Look for any time zone discrepancies in date/time fields
    • Verify that report generation times align with data update times
    • Examine filtering and aggregation:

    5 - Review how data is being filtered and aggregated:

    • Check that filters are not inadvertently excluding relevant data
    • Verify that aggregations (sums, averages, etc.) are calculated correctly
    • Ensure that the grain of aggregation matches report requirements
    • Check for data quality issues:

    6 - Look for underlying data quality problems:

    • Investigate any duplicate records or missing data
    • Check for inconsistent data formats or units of measurement
    • Verify that data validation rules are being applied correctly
    • Document and communicate:

    7 - When you identify and resolve discrepancies:

    • Document the issue, its cause, and the resolution
    • Communicate with affected users about the discrepancy and its resolution
    • Update any relevant documentation or data dictionaries
    • Implement ongoing monitoring:

    8 - Set up processes to catch future discrepancies early:

    • Implement automated data quality checks
    • Regularly sample and verify report data
    • Encourage users to report any suspected inaccuracies promptly

     

    Remember, if you're unable to resolve an issue, don't hesitate to reach out to ReadyWorks support. They can provide expert assistance and may be aware of known issues or best practices that can help resolve your problem efficiently.

     

    See more