Importing workflows from the BlueCat public GitHub repository - Platform - BlueCat Gateway - 18.10.1

Gateway Administration Guide

prodname
BlueCat Gateway
version_custom
18.10.1

You can import workflows that are publically available through the BlueCat Labs public GitHub repository. BlueCat recommends this especially for new customers that need to get up and running with BlueCat Gateway quickly and easily.

CAUTION:
While using the GitHub import option, the following limitations apply:
  • You must have Internet access to perform this operation.
  • A single import operation pulls the Community and Example folders on GitHub; you cannot select specific folders or specific workflows within either folder. If you prefer to import folders or workflows individually, go to https://github.com/bluecatlabs/gateway-workflows.
  • The import operation will erase all content in the <bluecat_gateway>/workflows/Examples and <bluecat_gateway>/workflows/Community folders.
  • The system does not check if an existing workflow or an endpoint with the same name already exists. Ensure that any workflows or endpoints you wish to keep have unique names prior to importing workflows from GitHub.
  • The system always gets the latest workflows from the master GitHub repository. Ensure you are using the latest released BlueCat Gateway version before downloading.
  • Permissions set on any existing workflows will be inherited by the newly imported workflows from GitHub. If necessary, BlueCat recommends BlueCat Gateway administrators review permissions for Example and Community workflows after importing.
  • Community Workflows that may have been created for a specific earlier version of BlueCat Gateway may not be compatible with the latest version of BlueCat Gateway.

The workflows reside in 2 folders:

  • Examples—contains simple example workflows provided by BlueCat. These certified workflows serve as templates of the kind of workflow that can be built, and are also examples of BlueCat best practices for UI components and API usage. Each BlueCat Gateway release has a corresponding tag that can be used to download the version that is guaranteed to be compatible with that release.
  • Community—contains workflows provided by anyone from the the GitHub community that can be helpful as examples, and can also be used directly. Each workflow in this folder has a README.md file containing a brief description of the workflow, and the version this workflow was written against. Each workflow, when submitted, is reviewed by BlueCat team and verified that it does what it is intended to.
To import workflows from the BlueCat public GitHub repository:
  1. Log in to BlueCat Gateway.
  2. Click Workflow Export/Import.


  3. Click GITHUB IMPORT. A message displays informing you that the import session will override existing workflow folders.
  4. Click OK. A message displays, "GitHub loaded, refresh browser before use."