@itentialopensource/as-built-documentation v0.0.6-2023.1.1

As Built Documentation

Table of Contents

• Overview
• Installation Prerequisites
• Requirements
• Features
• How to Install
• How to Run

Overview

The As Built Documentation pre-built takes an Admin Essentials installed Pre-Built and creates a document in markdown format that includes each component of the pre-built, as well as the relationships between the components. Optionally, a full As Built template will be provided that can easily be filled in with the appropriate data.

Installation Prerequisites

Users must satisfy the following pre-requisites:

• Itential Automation Platform
  • ^2023.1.x
• App-Artifacts
  • 6.5.1-2023.1.0

Requirements

This Pre-Built requires the following:

• Pre-Built installed in Admin Essentials

Features

The main benefits and features of the artifact are outlined below.

• Creates an As-Built document with a Pre-Built's components shown in a heirarchical format
• Renders As-Built document in markdown format
• User can fill in additional information using the optional provided template

How to Install

To install this pre-built:

• Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Requirements section.
• The artifact can be installed from within App-Admin_Essential. Simply search for the name of your desired Pre-Built and click the install button (as shown below).

How to Run

Use the following to run the artifact:

1. In Operations Manager, find the As Built Documentation entry.
2. In the form, choose the Pre-Built you wish to create an As Built Document for and select provide full template if desired.
3. Run the automation and work any manual tasks in the workflow.
4. The final manual task will provide the As-Built markdown document that can be copied and pasted to the user's final destination.