How to: Promote Recipes Using the Integration Gateway

Estimated Reading Time:  5 minutes

Overview

The Integration Gateway lets you integrate with over 700 systems across enterprise applications, databases, and legacy on-premise infrastructure—in the cloud or on-premise. After creating recipes in your non-production environment levels, you can promote them to Production. Following this promotion process lets you develop more efficiently and ensures your integrations work correctly in all your environment levels.

TIP  To learn more about Unqork environment levels and promotion stages, view our Unqork Promotions Order article.

This process involves setting up your recipe package, or manifest, in a non-production environment level and downloading it to your computer. Then, you'll access your Production environment level and upload it. It's important to note that you do not have to promote your recipes and connections at every Unqork environment level. If you create your manifest in any non-production environment (Staging, QA, or UAT), it's available in the other non-production environment levels. So, you only need to promote your manifest to your Production environment.

IMPORTANT  For Creators Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. with a Pre-Production environment level, the Integration Gateway considers it to be a production environment level. If you promote your manifest to your Production environment level, it's also available in your Pre-Production environment level.

TIP  To learn how to access the Integration Gateway, view our Integration Administration article.

What You'll Learn

In this how-to guide, you'll learn how to export your existing recipes from one environment level and import them to another.

Exporting a Manifest

After accessing the Integration Gateway, you'll use the Promote tab to create a recipe package that you can export from your non-production environment levels. When you navigate to this section of the Integration Gateway, the default view is the Export tab. From this tab, you can create an export manifest or view and select an existing one.

A static image displaying the selection of the Promote tab in the Integrations Gateway.

Creating an Export Manifest

The first step is to create an export manifest using the Export tab. You'll select the folder storing all your recipe and connection assets and include it in the manifest.

To create an export manifest:

1. Navigate to the Promote tab.
2. Click New Manifest.
3. In the Manifest Name* field, enter a name for your manifest.
4. From the Source Folder* menu, select the project folder whose assets you want to include.

A static image displaying the Create Manifest modal where you enter a manifest name and select a folder to whose assets you can include in it.

5. Click Next.
6. Select all assets you want to include in the manifest. You can also choose to select test cases created when testing your recipe.

NOTE  By default, all assets are selected. Deselect those you want to exclude from the manifest.

A static image displaying the Create Manifest modal where you can select the assets you want included in the manifest.

7. Click Create Manifest. The details of your export manifest display.

Viewing the Export Manifest Details

After creating or accessing an existing manifest, you can view its details and take various actions on the manifest.

A static image displaying the Manifest Details and the actions you can take on a manifest.

  Attribute Description

1

Manifest Content

This tab displays the assets contained in the manifest.

2

Export History

A static image displaying the Export History tab where you can see previous builds and download them.

Every time you build a manifest package, it stores in Export History. Use this tab to view all the built packages and when they were built. You can also download the packages as a ZIP file onto your computer.

3

Build and Export Package

Lets you build a manifest package and download it as a ZIP file onto your computer. All builds display in the Export History tab.

4

Edit Manifest

Lets you update the manifest's assets. After making your changes, click Update Manifest.

5

Source Folder

The folder and subfolders added to the manifest.

6

Your Manifest Contains

The recipes and connections included in the manifest.

7

Latest Activity

The date and time the manifest was created or modified.

Building and Exporting a Manifest

The final step of the exporting process is to build and export your manifest. The Integration Gateway builds your manifest as a ZIP file so you can download it onto your computer. Then, you'll import that file for use in your Production environment level.

To build and export your manifest:

1. Access your export manifest from the Integration Gateway's Export tab.
2. At the top right, click Build and Export Package.
3. Click Download. Your file is now available in your computer's downloads folder with the file name of {manifest-name}-unqork-qa-nonprod.zip.

With your file downloaded, you're ready to use it in the import process to promote it to your Production environment level.

Importing Assets

After accessing the Integration Gateway, you'll use the Promote tab to import a recipe package to a production environment level. After navigating to this section of the Integration Gateway, click the Import tab. From this tab, you can create an import manifest to store the assets you exported and downloaded from your non-production environment level.

A static image displaying the selection of the Promote and Import tabs in the Integrations Gateway.

Creating an Import Manifest

Before you import your non-production assets, you must create an import manifest to store them.

To create an import manifest:

1. Navigate to the Promote tab.
2. Click Import.
3. Click Import Package to a New Folder.
4. In the Select ZIP File* field, browse for or drag and drop your non-production asset file.

IMPORTANT  This field only supports ZIP files.

5. From the Target Folder* drop-down, select the project folder and subfolders where you want to store the manifest.

A static image displaying the uploaded asset file and the project folder where it will be stored.

6. Click Next.
7. Review your assets to ensure you have the correct file.
8. Click Next. You assets import into the Integration Gateway.
9. After the import is complete, click Finish.

Your imported file now displays in the project folder of your production environment level and are ready for use. Inside your project folder, import other assets by clicking Import a New Package to This Folder.

A static image displaying the imported file in your production environment level's project folder.

Resources