Creating and Managing Template Catalogs

A catalog is a collection of SoR YAML templates stored in a version control system. SGNL currently supports adding GIT repositories as catalogs through the SGNL console. Therefore, any GIT service provider that supports the GIT protocol over HTTPS can be added to SGNL as a SoR Catalog.

To successfully add a repository of SoR YAML templates to the SGNL Console, SGNL expects the following:

  1. The repository name could be any string allowed by the GIT service provider
  2. The SoR YAML templates must be stored in the top level directory in the repository.
  3. The SoR YAML templates must have the following extension: .sgnl.yaml, or .sgnl.yml
    • E.g., azure-ad.sgnl.yaml
    • Any files that do not have the .sgnl.yaml extension are ignored. For example,
    • YAML templates stored in a directory are ignored
  4. The GIT repository must be versioned using GIT tags and the tag names must follow Semantic Versioning 2.0. E.g., v1.2.3

Catalogs can be added to the SGNL Console through the Admin panel. Your client will come bootstrapped with a SGNL Managed Catalog, which will include templates for the most common Systems of Record. We are continuously adding support for new Systems of Record, and each release will be tagged with a new version number and will include feature additions to existing templates or support for new SoRs.

The GIT repository for a catalog can be either public or private. Private repositories may be added to SGNL, but will require Personal Access Tokens created and specified when adding the catalog for SGNL to be able to read and pull templates from the repository. SGNL only needs repository level content-only read permissions. Please follow the instructions below for your GIT service provider:

SGNL Managed Template Catalog

SGNL maintains a SGNL-managed catalog backed by a Github repository that contains templates for common SaaS SoRs such as Salesforce, Azure Active Directory, ServiceNow, etc.

If you need to add the SGNL Catalog to your environment:

  1. Navigate to Admin->SoR Template Catalogs
  2. Select Add Catalog
  3. Enter a Display Name (e.g. SGNL Managed Catalog) and optionally a Description
  4. The Git Repository URL for the SGNL Managed Catalog is
  5. The SGNL Template Repo does not require authentication, so simply click Retrieve Tags
  6. Choose the tag with the highest version (this should be selected automatically), unless you have a need to use an older version of a catalog
  7. Save the Configuration

Adding a Custom Template Catalog

  1. Login to SGNL Console
  2. From the Navigation on the left, select Admin

SGNL - Admin View

  1. Click on “SoR Template Catalog”, which will take you to the list of Catalogs.

SGNL - List of Catalogs

  1. SGNL SoR Catalog is a SGNL managed catalog that is available to all clients. Click on the “+ Add Catalog” button at the top next to “SoR Template Catalogs”

  2. Enter the following information:

  • Catalog Display Name: To help you identify the catalog
  • Optional description
  • GIT Repository URL: The HTTPS GIT URL for the repository
  • Select an Authentication Method. Select “No Authentication” if the repository is public.
  • If Basic or Auth Token is selected, enter the credentials.

SGNL - Add Catalog Details

  1. Click on “Retrieve Tags”, which will display a list of GIT tags that you may select from. Click “Save”.
  2. SGNL creates the catalog and populates it with the templates in the repository as shown below. You will then be able to click on a template, modify the fields as you see fit, and launch the corresponding SoR.

SGNL - Custom Catalog added to the list of Catalogs

Walkthrough of Creating Catalogs in SGNL

For a walkthrough on how to create catalogs in SGNL, watch the video below.