• ConnectorGenerator
  • Table of contents
  • Introduction
  • Features
  • Used libraries
  • Using the ConnectorGenerator VSCode extension
    • Create a new connector
      • From the command palette
      • From the context menu
    • Caching
    • Code snippets
      • Using snippets
      • Updating the cache
    • Detecting variables holding sensitive information
    • Development features
  • Contributing
    • Bug report
    • Feature request

Hi 👋

If you're looking to create a new target connector for HelloID provisioning and don't know where to start, you're in the right place.

This ConnectorGenerator extension for VSCode is the perfect starting point for building out your new connector, with all the essential resources you'll need to get started.

If you're a new to the templates and the ConnectorGenerator refer to the QuickStart to help you get started.

The following libraries are used in this extension:

1. Open the command palette by clicking on View -> Command palette or press ctrl+shift+p (cmd+shift+p on mac).
2. Search for Create new HelloID connector project scaffolding.
3. Select the connector type target.
4. Enter a name for the connector.
5. Browse to the location where you want the files to be created and press enter.

Only available when a new file (can be of any type) is opened.

1. Right click to open the context menu.
2. Click on ConnectorGenerator -> Create new HelloID connector project scaffolding.
3. Select the connector type target.
4. Enter a name for the connector.
5. Browse to the location where you want the files to be created and press enter.

The source connector templates are currently not available.

When creating a new connector based of the template, the latest release will be downloaded from: https://github.com/Tools4everBV/HelloID-Conn-Prov-Target-V2-Template/releases. The zip file will be unpacked and saved to in user folder using the latest release version as the folderName.

• Windows: C:\Users\<username>\<vscode-version>\extensions\connectorteam.connectorgenerator-<version>/cache
• macOS: ~/.vscode/extensions/connectorteam.connectorgenerator-<version>/cache
• Linux: ~/.vscode/extensions/connectorteam.connectorgenerator-<version>/cache

The latest will only be donwloaded in case the locally cached version is older then the latest version available on GitHub.

From version 1.2.0 Code snippets can be retrieved directly from the context menu: ConnectorGenerator -> Retrieve code snippets or from the command palette. Code snippets are retrieved from our helper repository on GitHub and cached locally in your user directory.

• Windows: C:\Users\<username>\<vscode-version>\extensions\connectorteam.connectorgenerator-<version>/cache/snippets.json
• macOS: ~/.vscode/extensions/connectorteam.connectorgenerator-<version>/cache/snippets.json
• Linux: ~/.vscode/extensions/connectorteam.connectorgenerator-<version>/cache/snippets.json

In order to use a code snippet:

1. Select a snippet from the list and click the arrow button to expand.
2. Click Copy to copy the snippet to the clipboard.

The snippets cache can only be updated manually by clicking: Refresh snippet cache from the status bar.

To prevent uploading secrets ConnectorGenerator actively scans for variables that might contain sensitive information. Potentially unsafe variables will marked red to make them stand out.

To disable this feature:

1. Open the VSCode settings windows by clicking on: ctrl + , or (cmd + , on macOs).
2. Type: connectorgenerator to go to the section for this extension.
3. Make sure to toggle: Enable Secret Scanning.

If you wish to extend or modify the template, you can do so by creating a new folder in the cache folder. Make sure the name of the new folder adheres to semver.

To create a connector based of your updated version:

1. Open the VSCode settings windows by clicking on: ctrl + , or (cmd + , on macOs).
2. Type: connectorgenerator to go to the section for this extension.
3. Make sure to toggle: Enable Version Selection For Development Purposes.

This will enable two features:

• Quikly open the cache folder from the status bar by clicking on: Open cache folder.
• Option to select a template version when you create a new connector.

If you have an idea or suggestion for improving the ConnectorGenerator VSCode extension, one of the best ways to get involved is by opening up an issue on GitHub repository.

🪲

To submit a new issue, navigate to the Issues tab on the repository page and click the New Issue button. Describe the issue in as much detail as possible, including any error messages or steps to reproduce the issue. This will help the development team to diagnose and fix the problem.

🚀

To request a new feature, create a new issue using the same process as for a bug report. Be sure to describe the feature you would like to see added, and explain how it would improve your experience.