npm package: @itentialopensource/batfish-enterprise-change-review-results
Description: This Pre-Built automation contains a workflow designed to summarize pass/fail indicators for tests and policies within a Change Review in Batfish Enterprise.
Author: Itential Artifacts
Latest version: 0.0.8-2023.1.0


# Batfish Enterprise Change Review Results

## Table of Contents

* [Overview](#overview)
  * [Automation Catalog and JSON-Form](#automation-catalog-and-json-form)
* [Requirements](#requirements)
* [How to Install](#how-to-install)
* [How to Run](#how-to-run)
* [Additional Information](#additional-information)

## Overview

The Batfish Enterprise Change Review Results Pre-Built automation can be used to verify that all pass/fail indicators associated with tests and policies within a Change Review have been completed summarizes the results from [Batfish Enterprise](https://www.intentionet.com/product/batfish-enterprise/). 

The Pre-Built consists of a JSON Form, Operations Manager Automation and Workflow to retrieve the Change Review data; verify all tests have completed; review the status of each policy; and provide the results to the user. 

### Automation Catalog and JSON-Form
This workflow has an [Automations item](./bundles/automations/Batfish%20Enterprise%20Change%20Review%20Results.json) that calls a workflow. The Automation item uses a JSON-Form to specify the Change Review ID and Network Name within Batfish Enterprise. 

<table><tr><td>
  <img src="./images/autostudio_batfish_enterprise_change_review_results.png" alt="workflow" width="800px">
</td></tr></table>

<table><tr><td>
  <img src="./images/autocat_batfish_enterprise_change_review_results.png" alt="workflow" width="800px">
</td></tr></table>

_Estimated Run Time_: 1min

## Installation Prerequisites

Users must satisfy the following pre-requisites:

* Itential Automation Platform
  * `^2021.2`
  * [Batfish Enterprise Adapter](https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-batfish)

## Requirements

This Pre-Built requires the following:

* [Batfish Enterprise Adapter](https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-batfish) configured with credentials and IP Address of your Batfish Enterprise Instance.

## How to Install

To install the Pre-Built:

* Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the [Requirements](#requirements) section in order to install the Pre-Built. 
* The Pre-Built 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).

<!-- REPLACE BELOW WITH IMAGE OF YOUR PUBLISHED PRE-BUILT -->
<!--
<table><tr><td>
  <img src="./images/install.png" alt="install" width="600px">
</td></tr></table>
-->
<!-- REPLACE ABOVE WITH IMAGE OF YOUR PUBLISHED PRE-BUILT -->

<!-- OPTIONAL - Explain if external components are required outside of IAP -->
<!-- Ex.: The Ansible roles required for this Pre-Built can be found in the repository located at https://gitlab.com/itentialopensource/pre-built-automations/hello-world -->

## How to Run

Use the following to run the Pre-Built:

* Run the Automation Catalog item `Batfish Enterprise Change Review Results` or call [Batfish Enterprise Change Review Results](./bundles/automations/Batfish%20Enterprise%20Change%20Review%20Results.json) from your workflow as a child job.


### Input Variables
_Example_

```json
{
	"changeId": “1”,
	"networkName": “My-Network”
}
```


## Additional Information

Please use your Itential Customer Success account if you need support when using this Pre-Built.