open-index/open-npm huggingface dataset:
npm package: @itentialopensource/pre-built-wizard
Description: This contains modular workflows that operate when integrated with the app-artifacts application that can be installed within IAP. Once installed teams will be able to quickly automate common manual tasks such as creating a Pre-Built artifact.json file mad
Author: Itential
Latest version: 2.0.7-2023.2.4

# Pre-Built Wizard

## Overview

This contains modular workflows that operate when integrated with the app-artifacts application that can be installed within IAP. Once installed teams will be able to quickly automate common manual tasks such as creating a Pre-Built artifact.json file made up of IAP components, saving a significant amount of time and effort. This library can be used as modular components with other libraries and automations to build comprehensive end-to-end orchestrated workflows with Itential's low-code platform.


## Workflows


<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Overview</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a href='https://gitlab.com/itentialopensource/pre-built-automations/prebuilt-wizard/-/blob/release/2023.2/documentation/Pre-Built Wizard.md' target='_blank'>Pre-Built Wizard</a></td>
      <td>Pre-Built Wizard provides the ability to create a Pre-Built that is installed into Admin Essentials in IAP made up of IAP components for a particular use case or automation.</td>
    </tr>    <tr>
      <td><a href='https://gitlab.com/itentialopensource/pre-built-automations/prebuilt-wizard/-/blob/release/2023.2/documentation/Pre-Built Wizard Re-Discovery.md' target='_blank'>Pre-Built Wizard Re-Discovery</a></td>
      <td>Pre-Built Wizard Re-Discovery provides the ability to update an existing Pre-Built in Admin Essentials with any new or removed IAP components for a particular use case or automation</td>
    </tr>
  </tbody>
</table>


## External Dependencies

<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>OS Version</th>
      <th>API Version</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>App-Artifacts</td>
      <td></td>
      <td>^6.5.5-2023.2.0</td>
    </tr>
  </tbody>
</table>

## Adapters

No adapters required to run this Workflow Project.
npm package: @itentialopensource/prebuilt-promotion
Description: Push pre-built to a specified version control service
Author: Itential
Latest version: 2.0.0-2023.1.7

# Prebuilt Promotion

## Overview

This Pre-Built Automation bundle contains several example use cases that are applicable when Itential Automation Platform is integrated with a git version control platform, i.e. Bitbucket Cloud, GitHub, or GitLab, using REST API. Because every environment is different, these use cases are fully functioning examples that can be easily modified to operate in your specific environment. These workflows have been written with modularity in mind to make them easy to understand and simple to modify to suit your needs.


## Workflows


<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Overview</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a href='https://gitlab.com/itentialopensource/pre-built-automations/prebuilt-promotion/-/blob/release/2023.1/documentation/Prebuilt Promotion.md' target='_blank'>Prebuilt Promotion</a></td>
      <td>Prebuilt Promotion takes a Pre-Built installed on IAP in Admin Essentials and creates a new repository or updates an existing repository by way of a merge or pull request in the specified git version control service i.e., GitLab, Github or Bitbucket Cloud. This repository contains the Pre-Built's IAP components as well as script and pipeline files to verify the Pre-Built's artifact.json file is generated correctly, increments the Pre-Built version, updates CHANGELOG of changes made to the Pre-Built, and optionally promotes the Pre-Built to another IAP environment.</td>
    </tr>
  </tbody>
</table>


## External Dependencies

<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>OS Version</th>
      <th>API Version</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Bitbucket</td>
      <td></td>
      <td></td>
    </tr>    <tr>
      <td>GitLab</td>
      <td></td>
      <td></td>
    </tr>    <tr>
      <td>App-Artifacts</td>
      <td></td>
      <td>^6.5.3-2023.1.5</td>
    </tr>    <tr>
      <td>GitHub</td>
      <td></td>
      <td></td>
    </tr>
  </tbody>
</table>

## Adapters

<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Version</th>
      <th>Configuration Notes</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a href="https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-gitlab">adapter-gitlab</a></td>
      <td>^0.13.5</td>
      <td></td>
    </tr>    <tr>
      <td><a href="https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-bitbucket">adapter-bitbucket</a></td>
      <td>^0.5.7</td>
      <td></td>
    </tr>    <tr>
      <td><a href="https://gitlab.com/itentialopensource/adapters/devops-netops/adapter-github">adapter-github</a></td>
      <td>^0.6.5</td>
      <td></td>
    </tr>
  </tbody>
</table>
npm package: @itentialopensource/regex-match
Description: Native JS replacement for match
Author: Itential Artifacts
Latest version: 0.0.8-2023.1.0

<!-- This is a comment in md (Markdown) format, it will not be visible to the end user -->

<!-- Update the below line with your artifact name -->
# Regex Match

<!-- Leave TOC intact unless you've added or removed headers -->
## Table of Contents

* [Overview](#overview)
* [Installation Prerequisites](#installation-prerequisites)
* [Requirements](#requirements)
* [Features](#features)
* [Future Enhancements](#future-enhancements)
* [How to Install](#how-to-install)
* [How to Run](#how-to-run)

## Overview
This Pre-Built Transformation retrieves the result of matching a string and returns an array containing all of the matches, including capturing groups, or `null` if no match is found.
<!-- Write a few sentences about the artifact and explain the use case(s) -->
<!-- Ex.: The Migration Wizard enables IAP users to conveniently move their automation use cases between different IAP environments -->
<!-- (e.g. from Dev to Pre-Production or from Lab to Production). -->

<!-- Workflow(s) Image Placeholder - TO BE ADDED DIRECTLY TO GitLab -->
<!-- REPLACE COMMENT BELOW WITH IMAGE OF YOUR MAIN WORKFLOW -->
<!--
<table><tr><td>
  <img src="./images/workflow.png" alt="workflow" width="800px">
</td></tr></table>
-->
<!-- REPLACE COMMENT ABOVE WITH IMAGE OF YOUR MAIN WORKFLOW -->

<!-- ADD ESTIMATED RUN TIME HERE -->

## Installation Prerequisites

Users must satisfy the following pre-requisites:

<!-- Include any other required apps or adapters in this list -->
<!-- Ex.: EC2 Adapter -->
* Itential Automation Platform
  * `^2022.1`


## How to Install

To install the artifact:

* 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 artifact. 
* The artifact can be installed from within App-Admin_Essential. Simply search for the name of your desired artifact and click the install button (as shown below).

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

<!-- OPTIONAL - Explain if external components are required outside of IAP -->
<!-- Ex.: The Ansible roles required for this artifact 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 artifact:
1. Once the JST is installed as outlined in the How to Install section above, navigate to the workflow where you would like to use `match` and add a JSON Transformation task.
2. Inside the Transformation task, search for and select `match`.
3. Save your input and the task is ready to run inside of IAP.
<!-- Explain the main entrypoint(s) for this artifact: Automation Catalog item, Workflow, Postman, etc. -->
npm package: @itentialopensource/regex-replace
Description: Native JS Replace but with working regex
Author: Itential Artifacts
Latest version: 0.0.8-2023.1.0

<!-- This is a comment in md (Markdown) format, it will not be visible to the end user -->

<!-- Update the below line with your artifact name -->
# Regex Replace

<!-- Leave TOC intact unless you've added or removed headers -->
## Table of Contents

* [Overview](#overview)
* [Installation Prerequisites](#installation-prerequisites)
* [Requirements](#requirements)
* [Features](#features)
* [Future Enhancements](#future-enhancements)
* [How to Install](#how-to-install)
* [How to Run](#how-to-run)

## Overview

This Pre-Built Transformation enables users to execute a search for a match in a string, and replaces the matched substring with a replacement substring. It closesly emulates the functionality of the [native JS String replace method](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace). The only noticeable difference is that one must specify whether a Regex or String is used as the identifier (where string is the default). If a string is selected as the identifier, then only the first match is replaced (similar to the native method).



## Installation Prerequisites

Users must satisfy the following pre-requisites:

<!-- Include any other required apps or adapters in this list -->
<!-- Ex.: EC2 Adapter -->
Itential Automation Platform
* ^2022.1


## How to Install

To install the artifact:

* 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 artifact. 
* The artifact can be installed from within App-Admin_Essential. Simply search for the name of your desired artifact and click the install button (as shown below).

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

<!-- OPTIONAL - Explain if external components are required outside of IAP -->
<!-- Ex.: The Ansible roles required for this artifact 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 Transformation:

1. Once the JST is installed as outlined in the [How to Install](#how-to-install) section above, navigate to the workflow where you would like to use `replace` and add a `JSON Transformation` task. 
2. Inside the `Transformation` task, search for and select `replace`.
<!-- Explain the main entrypoint(s) for this artifact: Automation Catalog item, Workflow, Postman, etc. -->
npm package: @itentialopensource/regex-search
Description: Replaces native JS replace with regex
Author: Itential Artifacts
Latest version: 0.0.8-2023.1.0

<!-- This is a comment in md (Markdown) format, it will not be visible to the end user -->

<!-- Update the below line with your artifact name -->
# Regex Search 

<!-- Leave TOC intact unless you've added or removed headers -->
## Table of Contents

* [Overview](#overview)
* [Installation Prerequisites](#installation-prerequisites)
* [Requirements](#requirements)
* [Features](#features)
* [Future Enhancements](#future-enhancements)
* [How to Install](#how-to-install)
* [How to Run](#how-to-run)

## Overview
This Pre-Built Transformation enables users to execute a search for a match between a regular expression and a string object. The return is the index of the match, or -1 if the search fails.
<!-- Write a few sentences about the artifact and explain the use case(s) -->
<!-- Ex.: The Migration Wizard enables IAP users to conveniently move their automation use cases between different IAP environments -->
<!-- (e.g. from Dev to Pre-Production or from Lab to Production). -->

<!-- Workflow(s) Image Placeholder - TO BE ADDED DIRECTLY TO GitLab -->
<!-- REPLACE COMMENT BELOW WITH IMAGE OF YOUR MAIN WORKFLOW -->
<!--
<table><tr><td>
  <img src="./images/workflow.png" alt="workflow" width="800px">
</td></tr></table>
-->
<!-- REPLACE COMMENT ABOVE WITH IMAGE OF YOUR MAIN WORKFLOW -->

<!-- ADD ESTIMATED RUN TIME HERE -->
<!-- e.g. Estimated Run Time: 34 min. -->
_Estimated Run Time_:

## Installation Prerequisites

Users must satisfy the following pre-requisites:

<!-- Include any other required apps or adapters in this list -->
<!-- Ex.: EC2 Adapter -->
* Itential Automation Platform
  * `^2022.1`


## How to Install

To install the artifact:

* 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 artifact. 
* The artifact can be installed from within App-Admin_Essential. Simply search for the name of your desired artifact and click the install button (as shown below).

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

<!-- OPTIONAL - Explain if external components are required outside of IAP -->
<!-- Ex.: The Ansible roles required for this artifact 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 artifact:
1. Once the JST is installed as outlined in the How to Install section above, navigate to the workflow where you would like to use `search` and add a JSON Transformation task.
2. Inside the Transformation task, search for and select `search`.
3. Save your input and the task is ready to run inside of IAP.

  
<!-- Explain the main entrypoint(s) for this artifact: Automation Catalog item, Workflow, Postman, etc. -->
npm package: @itentialopensource/regex-test
Description: Native JS Replacement for Test using Regex
Author: Itential Artifacts
Latest version: 0.0.8-2023.1.0

<!-- This is a comment in md (Markdown) format, it will not be visible to the end user -->

<!-- Update the below line with your artifact name -->
# Regex Test

<!-- Leave TOC intact unless you've added or removed headers -->
## Table of Contents

* [Overview](#overview)
* [Installation Prerequisites](#installation-prerequisites)
* [Requirements](#requirements)
* [Features](#features)
* [Future Enhancements](#future-enhancements)
* [How to Install](#how-to-install)
* [How to Run](#how-to-run)

## Overview
This Pre-Built Transformation enables users to execute a search for a match between a regular expression and a specified string. If there is a match between the regular expression and the string, it will return `true` Otherwise, the Transformation will return `false`.
<!-- Write a few sentences about the artifact and explain the use case(s) -->
<!-- Ex.: The Migration Wizard enables IAP users to conveniently move their automation use cases between different IAP environments -->
<!-- (e.g. from Dev to Pre-Production or from Lab to Production). -->

<!-- Workflow(s) Image Placeholder - TO BE ADDED DIRECTLY TO GitLab -->
<!-- REPLACE COMMENT BELOW WITH IMAGE OF YOUR MAIN WORKFLOW -->
<!--
<table><tr><td>
  <img src="./images/workflow.png" alt="workflow" width="800px">
</td></tr></table>
-->
<!-- REPLACE COMMENT ABOVE WITH IMAGE OF YOUR MAIN WORKFLOW -->

<!-- ADD ESTIMATED RUN TIME HERE -->
<!-- e.g. Estimated Run Time: 34 min. -->


## Installation Prerequisites

Users must satisfy the following pre-requisites:

<!-- Include any other required apps or adapters in this list -->
<!-- Ex.: EC2 Adapter -->
* Itential Automation Platform
  * `^2022.1`

## How to Install

To install the artifact:

* 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 artifact. 
* The artifact can be installed from within App-Admin_Essential. Simply search for the name of your desired artifact and click the install button (as shown below).

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

<!-- OPTIONAL - Explain if external components are required outside of IAP -->
<!-- Ex.: The Ansible roles required for this artifact 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 artifact:
1. Once the JST is installed as outlined in the How to Install section above, navigate to the workflow where you would like to use `test` and add a JSON Transformation task.
2. Inside the Transformation task, search for and select `test`.
3. Save your input and the task is ready to run inside of IAP.
<!-- Explain the main entrypoint(s) for this artifact: Automation Catalog item, Workflow, Postman, etc. -->
npm package: @itentialopensource/service-provisioning
Description: [Deprecated] Demo of end-to-end usage of the Service Management workflow tasks in IAP.
Author: Itential Artifacts
Latest version: 0.4.4-2021.2.1

## _Deprecation Notice_
This Pre-Built has been deprecated as of 05-02-2024 and will be end of life on 05-02-2025. The capabilities of this Pre-Built have been replaced by the [Cisco - NSO](https://gitlab.com/itentialopensource/pre-built-automations/cisco-nso)

# Service Provisioning

## Table of Contents

* [Overview](#overview)
* [Installation Prerequisites](#installation-prerequisites)
* [How to Install](#how-to-install)
* [How to Run](#how-to-run)

## Overview

The Service Provisioning pre-built demonstrates an end-to-end usage of the Service Management workflow tasks in the Itential Automation Platform (IAP).

This pre-built allows the user to run the workflow in either **Demo**, **Normal**, **Verbose** or **Zero touch** modes.

For **Demo** mode, this pre-built has no prerequisites, and all south-bound system integrations have been replaced with hard-coded values in the flow.

For running this pre-built in any of the other modes, please follow the list of prerequisites first:

* Cisco NSO installation 
* Cisco IOS NED installed
* Itential-Tools (NSO package) installed
* Connected IAP NSO adapter with both device and service brokers assignment. (follow <a href="http://docs.itential.io/admin/Itential%20Automation%20Platform/Integrations/Network%20Adapters/#nso" target="_blank">THIS</a> link for configuration examples)
* A Cisco-IOS device (or a Network Simulated device also known as "netsim"): must be on-boarded and in-sync with NSO
* Itential-demo-port-turn-up service model compiled and loaded in NSO (service model can be found <a href="https://gitlab.com/itentialopensource/pre-built-automations/service-provisioning/-/tree/master/assets/service-model" target="_blank">HERE</a>)

## Installation Prerequisites

Users must satisfy the following prerequisites:

* Itential Automation Platform: `^2021.2`

## 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 [Prerequisites](#installation-prerequisites) section. 
* 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.

## How to run

Use the following steps to run the pre-built:
1. Once the pre-built is installed as outlined in the [How to Install](#how-to-install) section above, go to `Operations Manager` and run the `Service Provisioning` automation. 
2. In the `Modes` dropdown which is the only input as part of the JSON form, choose either `Demo`, `Normal`, `Verbose` or `Zero Touch`.
npm package: @itentialopensource/servicenow-incident-creation
Description: ServiceNow Incident Creation
Author: Itential Automation Platform
Latest version: 0.0.20-2021.2.1

<!-- This is a comment in md (Markdown) format, it will not be visible to the end user -->

<!-- Update the below line with your Pre-Built name -->
# ServiceNow Incident Creation

<!-- Leave TOC intact unless you've added or removed headers -->
## Table of Contents

- [ServiceNow Incident Creation](#servicenow-incident-creation)
  - [Table of Contents](#table-of-contents)
  - [Overview](#overview)
  - [Installation Prerequisites](#installation-prerequisites)
  - [Requirements](#requirements)
  - [Features](#features)
  - [How to Install](#how-to-install)
  - [How to Run](#how-to-run)
    - [Input Variables](#input-variables)
  - [Additional Information](#additional-information)

## Overview
This Pre-Built integrates with the ServiceNow Open Source Adapter to create an incident in the `incident` table in ServiceNow.

## Installation Prerequisites

Users must satisfy the following pre-requisites:

- Itential Automation Platform
  - `^2021.2`
- [ServiceNow Open Source Adapter](https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-servicenow)
  - `^2.2.0`

## Requirements

This Pre-Built requires the following:

- A [ServiceNow Open Source Adapter](https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-servicenow).
- A ServiceNow account that has write access to the `incident` table.

## Features

The main benefits and features of the Pre-Built are outlined below.
* Provide the fields required to create a ServiceNow Incident.

## 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.

## How to Run

Use the following to run the Pre-Built:

* Run the Operations Manager Automation `ServiceNow Incident Creation` or call workflow `ServiceNow Incident Creation` from your workflow in a childJob task.

### Input Variables
_Example_

```json
{
  "incidentSummary": "The summary of the Incident",
  "shortDescription": "The description of the Incident",
  "comments": "Additional comments on the Incident"
}
```

## Additional Information

Please use your Itential Customer Success account if you need support when using this Pre-Built.
npm package: @itentialopensource/slack-notification
Description: Send Slack Notification
Author: Itential Automation Platform
Latest version: 0.0.19-2022.1.1

<!-- This is a comment in md (Markdown) format, it will not be visible to the end user -->

<!-- Update the below line with your Pre-Built name -->
# Slack Notification

<!-- Leave TOC intact unless you've added or removed headers -->
## Table of Contents

* [Overview](#overview)
  * [Automation Catalog and JSON-Form](#automation-catalog-and-json-form)
* [Installation Prerequisites](#installation-prerequisites)
* [Requirements](#requirements)
* [Features](#features)
* [How to Install](#how-to-install)
* [How to Run](#how-to-run)
  * [Input Variables](#input-variables)
* [Additional Information](#additional-information)

## Overview
This Pre-Built integrates with the [Slack Open Source Adapter](https://gitlab.com/itentialopensource/adapters/notification-messaging/adapter-slack) to send a notification within Slack.

## Automation Catalog and JSON-Form

This workflow has an [Automation Catalog (AC) Item](./bundles/ac_agenda_jobs/Slack%20Notification.json) that calls a workflow. The AC Item uses a JSON-Form to specify common fields populated when an issue is created. The workflow the AC item calls queries data from the formData job variable.

<table>
  <tr>
    <td>
      <img src="./images/slack_notification_ac_form.png" alt="form" width="800px">
    </td>
  </tr>
  <tr>
    <td>
      <img src="./images/slack_notification_canvas.png" alt="form" width="800px">
    </td>
  </tr>
</table>

## Installation Prerequisites

Users must satisfy the following pre-requisites:

- Itential Automation Platform
  - `^2022.1`
- [Slack Open Source Adapter](https://gitlab.com/itentialopensource/adapters/notification-messaging/adapter-slack)
  - `^2.5.2`

## Requirements

This Pre-Built requires the following:

- [Slack Open Source Adapter](https://gitlab.com/itentialopensource/adapters/notification-messaging/adapter-slack) that is configured with a Slack server

## Features

The main benefits and features of the Pre-Built are outlined below.

* Allows a user to send a notification to a specific Slack channel

## 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.

## How to Run

Use the following to run the Pre-Built:

* Run the Automation Catalog Item `Slack Notification` or call [Slack Notification API](./bundles/workflows/Slack%20Notification%20API.json) from your workflow as a child job.

### Input Variables
_Example_

```json
{
  "channelName": "Specific Slack channel in which to send the notification",
  "message": "The notification message to be sent"
}
```

## Additional Information

Please use your Itential Customer Success account if you need support when using this Pre-Built.
npm package: @itentialopensource/split-string-to-array
Description: [Deprecated] JST that emulates String's split
Author: Itential Artifacts
Latest version: 0.0.15-2023.1.1

<!-- This is a comment in md (Markdown) format, it will not be visible to the end user -->
## _Deprecation Notice_
This Pre-Built has been deprecated as of 01-15-2024 and will be end of life on 01-15-2025. The capabilities of this Pre-Built have been replaced by the [IAP - Data Manipulation](https://gitlab.com/itentialopensource/pre-built-automations/iap-data-manipulation)

# Split String to Array

## Table of Contents

* [Overview](#overview)
* [Installation Prerequisites](#installation-prerequisites)
* [How to Install](#how-to-install)
* [How to Run](#how-to-run)

## Overview

This JST allows IAP users to use native JS String's split inside of their IAP instance with a Regex or a String. It closesly emulates the functionality of the [native JS String split method](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split). The only noticeable difference is that one must specify whether a Regex or String is used as a separator (where string is the default). See [How to Run](#how-to-run) for more details.

## Installation Prerequisites

Users must satisfy the following prerequisites:

<!-- Include any other required apps or adapters in this list -->
<!-- Ex.: EC2 Adapter -->
* Itential Automation Platform
  * `^2022.1.x`

## How to Install

To install the pre-build:

* Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the [Prerequisites](#installation-prerequisites) section. 
* The pre-build can be installed from within `App-Admin_Essential`. Simply search for the name of your desired pre-build and click the install button.

## How to Run

Use the following to run the pre-build:

1. Once the JST is installed as outlined in the [How to Install](#how-to-install) section above, navigate to the workflow where you would like to use `String split()` and add a `JSON Transformation` task. 

2. Inside the `Transformation` task, search for and select `split` (the name of the internal JST).

3. The inputs to the JST are the same as `String split`; however, instead of one separator field, there are two: `separatorString` and `separatorRegex`. They correspond to whether a String or Regex should be used as a separator. If both are included, `separatorString` is used by default and the Regex is ignored.

4. Save your input and the task is ready to run inside of IAP.
npm package: @itentialopensource/velocloud-sd-wan
Description: VeloCloud
Author: Itential Artifacts
Latest version: 0.0.8-2023.1.0

<!-- This is a comment in md (Markdown) format, it will not be visible to the end user -->

<!-- Update the below line with your artifact name -->
# VeloCloud SD-WAN Management

<!-- Leave TOC intact unless you've added or removed headers -->
## Table of Contents

* [Overview](#overview)
* [Features](#features)
* [Requirements](#requirements)
* [How to Install](#how-to-install)
* [How to Run](#how-to-run)

## Overview

<!-- Write a few sentences about the artifact and explain the use case(s) -->
The VeloCloud SD-WAN artifact creates VeloCloud Enterprises and provisions a list of VeloCloud Edges at corresponding locations.

<!-- Workflow(s) Image Placeholder - TO BE ADDED DIRECTLY TO GitLab -->
<!-- REPLACE COMMENT BELOW WITH IMAGE OF YOUR MAIN WORKFLOW -->
<table><tr><td>
  <img src="images/workflow.png" alt="workflow" width="800px">
</td></tr></table>

<!-- REPLACE COMMENT ABOVE WITH IMAGE OF YOUR MAIN WORKFLOW -->

## Features

<!-- Unordered list highlighting the most exciting features of the artifact -->
 * Validates that the Enterprise name is unique.
 * Creates the Enterprise Network
 * Supports provisioning of multiple edges 
 * Displays edge activation key to the user

## Requirements

In order to use this artifact, users will have to satisfy the following pre-requisites:

* Itential Automation Platform
* app-artifacts
* adapter-velocloudOrchestrator


## How to Install

Please ensure that 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 artifact. If you do not currently have App-Artifacts installed on your server, please download the installer from your Nexus repository. Please refer to the instructions included in the App-Artifacts README to install it.

The artifact can be installed from within App-Artifacts. Simply search for the name of your desired artifact and click the install button as shown below:

<!-- REPLACE BELOW WITH IMAGE OF YOUR PUBLISHED ARTIFACT -->

<table><tr><td>
<img  src="./images/install.gif"  alt="install"  width="1000px">
</td></tr></table>
<!-- REPLACE ABOVE WITH IMAGE OF YOUR PUBLISHED ARTIFACT -->

Alternatively, you may clone this repository and run `npm pack` to create a tarball which can then be installed via the offline installer in App-Artifacts. Please consult the documentation for App-Artifacts for further information.

VeloCloud API docs: https://code.vmware.com/apis/556/velocloud-sdwan-vco-api 

## How to Run

Go to Automation Studio and run "SD-WAN using Velocloud Orchestration"
It comes with pre-fill form data.
<table><tr><td>
  <img src="images/vco-order-form.png" alt="workflow" width="300px">
</td></tr></table>
<table><tr><td>
  <img src="images/form-2.png" alt="workflow" width="600px">
</td></tr></table>
<table><tr><td>
  <img src="images/edge-keys.png" alt="workflow" width="300px">
</td></tr></table>
<table><tr><td>
  <img src="images/vco-edges.png" alt="workflow" width="300px">
</td></tr></table>