Key features of the reporting module within ReadyWorks

• Data Source Selection in ReadyWorks Report Builder

  Data Source Selection is the cornerstone of report creation in ReadyWorks Report Builder. This critical first step determines the scope and structure of your report, serving as the foundation for all subsequent data analysis and presentation.

   

  

   

  When initiating a new report, you'll be prompted to choose a primary data source from options such as:

  • Computer
  • User
  • Application
  • Network Device
  • Custom asset types (if configured in your ReadyWorks instance)

   

  Your selection defines the main entity around which your report will be built. For example, if you're overseeing a large-scale Windows servicing project, you'd likely choose 'Computer' as your primary data source. This allows you to report on:

  • Computer-related attributes (OS versions, hardware specifications)
  • Data from linked assets (users, installed applications)

   

  The choice of primary data source influences which linked asset data you can include in your report. ReadyWorks uses a relational data model, meaning assets are interconnected. When you select 'Computer' as your primary source, you gain access to:

  • All computer fields
  • Fields from directly related assets (Users, Applications)

   

  This linked asset access is powerful but requires careful consideration. While it enables rich, multidimensional reporting, it can impact report generation time and system load, especially with assets having large data volumes or complex relationships.

   

  Consider a scenario where you need to report on software distribution across your environment. Choosing 'Application' as your primary data source would allow you to see:

  • Which applications are installed across different computers
  • Potential links with user information for a comprehensive view of software usage and distribution

   

  It's crucial to plan your data source selection carefully, as it cannot be changed once the report is created without starting over. Consider:

  • The primary focus of your report
  • Which data points are essential
  • The relationships between different asset types in your environment

   

  By thoughtfully selecting your data source, you lay the groundwork for creating efficient, insightful reports that directly support your operational needs. Remember, the goal is to strike a balance between comprehensive data inclusion and report performance, ensuring that your reports provide valuable insights without unnecessary complexity or system strain.

  See more

• Column Customization in ReadyWorks Report Builder

  Column Customization is a key feature of ReadyWorks Report Builder that allows you to tailor the data displayed in your reports. This functionality enables you to select specific fields, create calculated columns, and implement custom statuses, ensuring your reports contain precisely the information needed for your operational tasks.

  

   

  When customizing columns, you have several options:

  • Data Columns
  • Calculation Columns
  • Custom Status Columns
  • Overall Status Columns

   

  Data Columns are the most straightforward type. These represent direct fields from your chosen data source and linked assets. For instance, if your primary data source is 'Computer', you might add columns such as:

  • Computer Name
  • IP Address
  • Operating System
  • Last Login Date

  

   

  To add a data column, simply select it from the available fields list. Remember that the fields available depend on your primary data source selection and its linked assets.

   

  

   

  Calculation Columns allow you to perform count-related functions. A common use case is counting the number of applications installed on each computer. To create a calculation column:

   

  

  1. Select 'Add Column' and choose 'Calculation Column'
  2. Name your column (e.g., "User Count")
  3. Select the asset type to count (in this case, 'User')
  4. Choose the calculation type (Sum)

  

   

  Custom Status Columns are particularly useful for creating visual indicators of asset status or readiness. These often use a Red/Amber/Green (RAG) system to quickly convey information. For example, you might create a custom status column for "Windows 11 Upgrade Readiness" with the following logic:

  • Green: Meets all upgrade requirements
  • Amber: Meets some requirements, needs further investigation
  • Red: Does not meet upgrade requirements

  

   

  To create a custom status column, you'll need to:

  1. Define the status options in the ReadyWorks configuration
  2. Add a Custom Status Column to your report
  3. Set up the logic that determines each status

   

  

   

  Overall Status Columns aggregate multiple custom statuses into a single column. This is valuable for providing a high-level view of asset readiness or health. The overall status typically reflects the "worst" status of its component columns. For instance, if an asset has multiple custom statuses and any one of them is Red, the overall status would be Red.

   

   

   

  When customizing columns, consider the following best practices:

  • Include only necessary columns to keep reports focused and performant
  • Use meaningful names for calculated and custom columns
  • Arrange columns in a logical order, typically with identifying information first
  • Consider adding hyperlinks to key fields (like Computer Name) for easy navigation to asset details

   

  

   

  See more

• Working with Custom SQL Columns in ReadyWorks Report Builder

  Custom SQL columns are a powerful tool in the Report Builder arsenal, designed for users who need to push beyond standard reporting capabilities. Here's what you need to know:

  • Purpose and Access:
    • Inject SQL directly into report queries for advanced customization
    • Access by clicking "Custom SQL Column" when adding a new column

   

  Let's dive into the key components:

  • Essential Elements:
    • SELECT statement (required): The core of your custom column
    • Optional clauses: JOIN, WHERE, and GROUP BY for fine-tuning

   

  These elements allow you to craft precise, tailored columns that fit your exact needs. But where does this feature truly shine?

  • Strategic Applications:
    • Bypass asset linking restrictions: Access data from indirectly linked assets
    • Create complex calculated fields: Leverage full SQL function capabilities
    • Derive new data points: Generate insights without modifying asset structure

   

  Imagine calculating "Days Since Last Logon" or performing intricate date manipulations - all possible with custom SQL columns. However, with great power comes great responsibility:

  • Best Practices:
    • Avoid redundancy: Skip additional SELECT statements and reimporting fields
    • Maintain efficiency: Don't rejoin already connected tables
    • Optimize performance: Craft your SQL with report speed in mind

   

  As you work with custom SQL columns, remember:

  • Implementation Tips:
    • Write SQL directly in the provided fields
    • Use the "Report Query" button to view the full report SQL
    • Start simple and build complexity as needed

   

  While custom SQL columns offer unparalleled flexibility, they're not for the faint of heart:

  • Considerations:
    • Requires solid SQL knowledge
    • Advanced feature - use judiciously
    • Can impact report performance if not optimized

   

  In essence, custom SQL columns bridge the gap between the user-friendly Report Builder interface and the raw power of SQL. They're your secret weapon for creating reports that deliver precisely the data you need, in exactly the format you want. Whether you're a data wizard or an ambitious analyst, mastering custom SQL columns can elevate your reporting game to new heights.

   

  By effectively using Column Customization, you can create reports that provide clear, actionable insights tailored to your specific operational needs. Whether you're tracking upgrade readiness, monitoring compliance, or managing software deployments, thoughtful column selection and customization are key to generating valuable reports.

  See more

• Filtering and Sorting of Columns in ReadyWorks Report Builder

  Filtering and Sorting are essential features in ReadyWorks Report Builder that allow you to refine and organize your data effectively. These tools help you focus on specific subsets of your data and arrange it in a meaningful order, making it easier to identify trends, locate specific information, and make informed decisions.

   

  Filtering in Report Builder offers several levels of granularity:

  • Global WHERE Clauses
  • Top-Level Filters
  • Column-Specific Filters

   

  Global WHERE Clauses are applied to the entire report and act as a baseline filter. For example, you might want to exclude all decommissioned computers from your report. To set up a global WHERE clause:

  1. Navigate to the Report Settings
  2. Select 'Apply Global WHERE Clause'
  3. Choose the field (e.g., 'Lifecycle Status')
  4. Set the condition (e.g., 'Does not equal')
  5. Enter the value (e.g., 'Decommissioned')

  

   

  This ensures that regardless of other filters applied, decommissioned computers will never appear in your report.

   

  Top-Level Filters are dynamic filters that appear above your report data. These are particularly useful for fields that you frequently filter on, such as Location or Department. To create a top-level filter:

  1. Click on the column settings for your chosen field
  2. Select 'Top-Level Filter'

   

  Once set up, users can easily filter the report without needing to modify its underlying structure.

   

  

   

  Column-Specific Filters are available on each column in your report. These allow for on-the-fly filtering as you work with your data. The type of filter available depends on the data type of the column:

  • Text fields: Allow for text searches and pattern matching
  • Numeric fields: Provide options for greater than, less than, equal to, etc.
  • Date fields: Enable filtering by specific dates or date ranges
  • Lookup fields: Offer selection from predefined values

   

  

   

  Sorting in Report Builder helps you organize your data in a meaningful order. You can set default sort orders for your report, ensuring that data is always presented in a consistent, logical manner. To set a default sort:

  1. Go to Report Settings
  2. Select 'Column Sort Order'
  3. Choose the primary column to sort by and the sort direction (ascending or descending)
  4. Add additional sort columns if needed

   

   

   

  Users can also sort columns on-the-fly by clicking on column headers. This doesn't change the report's default sort order but allows for quick data exploration.

   

  When implementing filtering and sorting, consider these best practices:

  • Use global WHERE clauses for filters that should always apply
  • Set up top-level filters for commonly used filtering criteria
  • Choose a default sort order that makes sense for most use cases of the report
  • Be mindful of performance impacts when filtering or sorting on columns from linked assets

   

  

   

  

   

  Effective use of filtering and sorting can significantly enhance the usability and value of your reports. For instance, in a Windows servicing project, you might create a report with:

  • A global WHERE clause to exclude virtual machines
  • Top-level filters for Location and Department
  • Column filters for OS Version and Last Login Date
  • Default sorting by Computer Name

   

  This setup allows operators to quickly drill down to specific subsets of computers, such as all Windows 10 machines in the Finance department that have been logged into within the last 30 days, sorted alphabetically by name.

   

  By mastering these features, you can create dynamic, responsive reports that allow for efficient data analysis and support rapid decision-making in your IT operations.

   

  See more

• Action Buttons and Forms in ReadyWorks Report Builder

  Action Buttons and Forms are powerful features in ReadyWorks Report Builder that transform static reports into interactive tools for data manipulation and workflow initiation. These features allow operators to take immediate action based on report data, streamlining processes and reducing the need to switch between multiple interfaces.
  

  Action Buttons

  Action Buttons are customizable elements that can be added to your reports to trigger specific actions or workflows. These buttons appear at the top of your report and become active when one or more rows are selected. Common use cases for Action Buttons include:

  • Adding assets to a deployment wave
  • Initiating a software installation
  • Updating asset status
  • Generating tickets in an integrated ITSM system

   

  To add an Action Button to your report:

  1. Navigate to the Admin section and select 'Action Buttons'
  2. Choose 'New Action Button' or select from existing templates
  3. Configure the button's behavior using the provided scripting interface
  4. Add the button to your report in the Report Builder interface using the ‘Assign Buttons’ form

   

  

   

   

   

  Action Buttons can be as simple or complex as needed. For example, a basic button might update a single field on selected assets, while a more advanced button could trigger a multi-step workflow involving several systems.

   

  Forms

  Forms in ReadyWorks allow for direct data entry or modification from within a report. They provide a structured way to update asset information without navigating away from the report context. Key aspects of Forms include:

  • Custom field selection: Choose which fields to include in the form
  • Field validation: Ensure data integrity by setting required fields and data formats
  • Conditional logic: Show or hide fields based on user inputs

   

  To create a Form:

  1. Go to the Admin section and select 'Form Builder'
  2. Choose 'New Form' and select the asset type it will modify
  3. Add and configure the desired fields
  4. Save the form and add it to your report using the 'Assign Buttons' form

   

  

   

   

   

  A practical example of combining Action Buttons and Forms might be a "Update Readiness Status" button that, when clicked, opens a form allowing the operator to input:

  • Readiness status (dropdown)
  • Comments (text area)
  • Next review date (date picker)

  This information would then be saved directly to the selected assets.

   

  Best Practices for Action Buttons and Forms

  • Keep actions focused: Each button should perform a specific, well-defined task
  • Use clear naming conventions: Button labels should clearly indicate their function
  • Implement error handling: Ensure your actions gracefully handle unexpected scenarios
  • Consider permissions: Restrict access to sensitive actions as needed
  • Test thoroughly: Validate that actions and forms behave correctly with various data scenarios
  • Provide user feedback: Use pop-up messages to confirm successful actions or explain errors

   

  When implementing Action Buttons and Forms, consider the workflow implications. For instance, in a Windows servicing project, you might create:

  1. An "Add to Wave" button that allows operators to add selected computers to a specific deployment wave
  2. An "Update Hardware Status" form that lets operators quickly update information about a computer's hardware readiness

   

  These interactive elements can significantly reduce the time and effort required to manage large-scale IT operations. By bringing actionable capabilities directly into your reports, you enable operators to work more efficiently, reducing the risk of errors that can occur when switching between multiple systems or interfaces.

   

  Remember, while Action Buttons and Forms are powerful tools, they should be implemented judiciously. Overloading a report with too many interactive elements can make it cluttered and confusing. Aim for a balance that enhances usability without overwhelming the user.

   

   

  See more

• RAG Status Configuration in ReadyWorks Report Builder

  RAG (Red, Amber, Green) Status Configuration is a critical feature in ReadyWorks Report Builder that enables visual representation of asset status or readiness. This feature is particularly useful for quickly assessing the state of assets across large environments, making it invaluable for operators managing complex IT landscapes.

   

  RAG statuses are typically used to indicate:

  • Red: Critical issues or not ready
  • Amber: Warnings or partially ready
  • Green: No issues or fully ready

   

  To implement RAG Status Configuration:

   

  1 - Define RAG Statuses:

  First, you need to create the RAG statuses in the ReadyWorks configuration. Navigate to the admin section and locate the RAG Status configuration area. Here, you can define statuses such as:

  • Sufficient Disk Space (Green)
  • Insufficient Disk Space (Red)
  • Memory Meets Requirements (Green)
  • Memory Below Requirements (Red)
  • OS Version Compatible (Green)
  • OS Version Incompatible (Red)

   

  For each status, you'll specify a name, color (by hexadecimal value), and whether it contributes to a "Ready" or "Not ready" overall roll-up status.

   

  

   

  

   

  2 - Create Custom Status Columns

  In your report, add custom status columns that use these RAG statuses. For each column:

  • Select the field it's based on (e.g., 'Disk Space')
  • Map field values to your defined RAG statuses
  • Configure how null or unexpected values should be handled

   

  3 - Implement Overall Status

  Create an overall status column that aggregates multiple custom status columns. This provides a high-level view of asset readiness. Typically, an asset's overall status is determined by its "worst" individual status (e.g., if any status is Red, the overall status is Red).

   

  

   

  RAG Status Configuration is particularly powerful when combined with filtering and sorting features. For example, you can quickly filter to show all assets with a Red overall status, allowing you to focus on critical issues first.

   

  Best Practices for RAG Status Configuration:

  • Keep it simple: Use clear, consistent criteria for each status
  • Align with business needs: Ensure your RAG criteria reflect actual operational requirements
  • Update regularly: Review and adjust RAG criteria as project needs evolve
  • Document thoroughly: Maintain clear documentation of what each status means
  • Use meaningful colors: Stick to standard color meanings (Red for issues, Green for good) to avoid confusion
  • Consider accessibility: Ensure your color choices are distinguishable for color-blind users

   

  By effectively implementing RAG Status Configuration, you create reports that allow for rapid assessment of your IT environment. This visual approach to data presentation enables operators to quickly identify areas requiring attention, prioritize actions, and track progress on large-scale projects.

   

  Remember, while RAG statuses are powerful, they're a simplification of complex data. Always ensure that detailed information is available for drill-down when needed, allowing operators to understand the specifics behind each status indicator.

   

   

  See more

• Report Preview & Deployment in ReadyWorks Report Builder

  Report Preview and Publishing are essential features in ReadyWorks Report Builder that allow you to validate your report's appearance and functionality, and then make it available to other users. These features ensure that your reports are accurate, effective, and accessible to the right audience.
  

  Report Preview

  The Preview function allows you to see how your report will look and behave before finalizing it. To use the preview feature:

  1. Click the 'Preview' button while building or editing your report
  2. Review the report layout, including all columns, filters, and action buttons
  3. Test interactive elements like filters and sorting to ensure they work as expected
  4. Verify that data is displaying correctly and RAG statuses are accurate

   

  When previewing, pay attention to:

  • Column order and width: Ensure the most important information is easily visible
  • Filter functionality: Test top-level and column filters to confirm they return expected results
  • Action button behavior: Verify that buttons are active when appropriate and perform the correct actions
  • Data accuracy: Cross-check a sample of data against source systems to ensure correctness

   

  Use the preview function iteratively as you build your report. It's often helpful to preview after each major change, rather than waiting until the end of the report-building process.

   

  Deploying your Report

  Once your report is finalized and tested, you can deploy it to make it available to other users. The deployment process involves several considerations:

   

  1 - Access Control:

  Determine who should have access to reports. ReadyWorks allows you to restrict access to reporting based on user roles or groups. Consider:

  • Which teams need this report?
  • Should access be read-only or include edit rights?
  • Are there any sensitive data elements that require additional restrictions?

  2 - Naming Convention:

  Use a clear, consistent naming convention for organizing your reports. This might include:

  • A prefix indicating the report type or project
  • A brief description of the report's purpose
  • A version number or date, if appropriate

  3 - Documentation:

  Provide context for your report users. This might include:

  • A brief description of the report's purpose and contents
  • Explanations of any custom calculations or statuses
  • Guidelines for using interactive elements like action buttons

  4 - Schedule and Distribution:

  Consider whether the report should be:

  • Available on-demand in the ReadyWorks interface via:
    • The ReadyWorks reporting tab, which requires a ReadyWorks login to view the report
    • Publishing the report to create a shareable URL, which does not require a ReadyWorks login to view the report
  • Automatically generated and distributed via e-mail attachment on a regular schedule via the report builder ‘Subscribe Recipients to Report’ module.

  

  • Exported to other systems or formats (e.g., CSV, PDF)

   

  To Deploy your Report

  1. From the Report Builder interface, select 'Create Report'
  2. Configure access permissions (binary only – access to all or none)
  3. Set the report location and name
  4. Add any necessary documentation or instructions
  5. Configure any automated scheduling or distribution

   

  Best Practices for Report Preview & Publishing

  • Plan Permissions: Understand that access to Reports are a binary selection – you grant access to all reports or no reports. ReadyWorks does not currently support granular Permissioning.
  • Test thoroughly: Use the preview function extensively before publishing
  • Seek feedback: Have other team members review the report before wide release
  • Start small: Consider a phased rollout for complex reports
  • Monitor usage: Track how often the report is used and by whom to ensure it's meeting needs
  • Maintain and update: Regularly review published reports to ensure they remain relevant and accurate

   

  By effectively using the Preview and Publishing features, you ensure that your reports are not only accurate and functional but also readily available to those who need them. This supports efficient decision-making and operations across your IT environment.

   

  Remember, a well-designed and properly deployed report can become a key tool for your team, providing crucial insights and enabling swift action. Take the time to get it right, and you'll create a valuable asset for your entire IT operation.

  See more