As Built Report is an open source configuration document framework which utilises Microsoft 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 Microsoft PowerShell and/or a RESTful API.
Note
Due to time constraints and limited access to development environments and resources for current contributors, development and support for AsBuiltReport has slowed, with some report modules now falling behind on support for current vendor technology versions.
However, this is an open source project, and we encourage users to contribute to help keep it going.
Your contributions, whether through code, bug reports, or documentation, are crucial to its success!
Use the discussion board to share ideas, ask for help, or collaborate with others. Together, we can keep improving AsBuiltReport for everyone!
| 📝 Multiple Document Formats | 🔬 Granular Information Level | 🎨 Customised Styling |
| Generate reports in one or more document formats, including DOCX, HTML, and Text. | Configure the information level for each report section. You can create a summary report, a fully comprehensive report, or something in between. | Use the default style or create your own to match your corporate identity. Set page orientation, text and table formatting with fonts, colours, borders and highlighted cells and rows. |
| 📦 Modular Architecture | 📧 Email Reports | |
| The modular architecture and core framework enables users to use the same in-built commands to generate as-built configuration reports from a library of technology vendors. | Enable health checks to highlight configuration issues within a report. Toggle individual health checks on or off as required. | Attach and send reports via email to one or more recipients. |
| 📦 Core Module | 📦 Reports Module |
| The core module provides the framework for each individual report module. It provides the base commands and default style script used to generate each individual report. | 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. |
| ⚙️ Core Module Configuration | ⚙️ Reports Module Configuration |
| The core module configuration is a JSON file which stores information relating to the author’s name, company information & SMTP mail server configuration. Individual core module configuration files can be saved and specified when generating reports. |
The reports module 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. Individual report module configuration files can be saved and specified when generating reports. |
| 🖌️ Styles Script | |
| 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. Custom style scripts can be created to format reports to match your corporate identity. |
Click each vendor logo to view available report modules and associated documentation.
 |
 |
 |
 |
 |
 |
 |
 |
Please refer to the AsBuiltReport website for additional information and resources related to this project.