Documentation

Overview

As Built Report is an open source configuration document framework which utilises Windows PowerShell to produce as-built documentation in multiple document formats for multiple vendors and technologies. The framework allows users to easily generate clear and consistent documentation, for any environment which supports Windows PowerShell and/or a RESTful API.

Features

As Built Report provides the following features;

  • Modular design enables contributors a simple way to develop new reports.
  • Install and update the entire report library or each report individually, via the PowerShell Gallery.
  • Generate and output reports in one or more document formats, including DOCX, HTML, XML and Text.
  • Configure the detail level for each section of a report. You have the choice of producing a summarised report, a fully comprehensive report or something in between.
  • Support for custom styling. Set page orientation, text and table formatting with fonts, colours, borders and highlighted cells and rows.
  • Enable health checks to highlight configuration issues within a report. Toggle individual health checks on or off as required.
  • Append the time and date to reports to maintain records.
  • Attach and send reports via email to one or more recipients.

Components

As Built Report components are as follows;

  • As Built Report Configuration – a JSON configuration file used to store information relating to Author’s name, Company information & SMTP mail server configuration. Individual configuration files can be saved and specified also.
  • Reports Configuration – the report configuration is a JSON file which stores information specific to the related report. It holds information such as the report name, version, and release status. The report configuration can also provide functionality such as configurable report options, health checks and granular information levels.
  • Reports Module – the report module is specific to each vendor and/or technology and is used to extract information from the specific environment. The report module will be written to utilise PowerShell modules or RESTful APIs which the vendor/technology provides.
  • Styles Script (.ps1) – the styles script sets the default layout, fonts, colours and sizes used within the report. Style scripts can be used to layout cover pages, table of contents and other unique tables or sections.