Introduction
Tools4ever maintains a GitHub account which contains scripts and other resources to extend HelloID's functionality.
The account is located at: https://github.com/Tools4everBV
Repository name conventions
Each repository in the Tools4ever GitHub account has a name in the following format:
HelloID - Category - Module - Type - Name/description
For example, the HelloID-Conn-Prov-Target-Azure-Guest-Account repository:
- Is in the 'connector' category of resources (Conn)
- Is used with HelloID's Provisioning module (Prov)
- Is used with target systems within Provisioning (Target)
- Is used specifically with the Azure AD target system (Azure)
- Creates guest accounts within the target system (Guest-Account)
Each repository contains a readme file with more details.
Category
- Connector (Conn)
A resource of this type connects HelloID to an external system of some sort. Includes source and target system connectors for the Provisioning (Prov) module, as well as delegated forms and tasks for the Service Automation (SA) module. - Library (Lib)
PowerShell and/or JavaScript helper functions which are not tied to any particular external system.
Module
HelloID comprises three modules:
- Provisioning (Prov)
- Service Automation (SA)
- Access Management (AM)
Currently, the Tools4ever GitHub contains resources only for the Service Automation and Provisioning modules. Follow the links below for the corresponding resources.
Type
There are currently three types of Conn repositories:
- Source
A Provisioning source system connector. - Target
A Provisioning target system connector. - Full
A Service Automation all-in-one delegated form - Training-Materials
Labs and other training support files.
Filename conventions
Provisioning (Prov) module
| Filename |
Description |
|---|---|
[root]\readme.md |
Readme file describing the repository's functionality. Includes any relevant special instructions, limitations, or recommendations. |
[root]\create.ps1[root]\enable.ps1[root]\update.ps1[root]\disable.ps1[root]\delete.ps1 |
User lifecycle event PowerShell scripts (target system connectors only) |
[root]\configuration.json[root]\entitlements.ps1[root]\grantPermission.ps1[root]\revokePermission.ps1 |
Input parameter configuration file and Permissions scripts (target system connectors only) |
[root]\configuration.json[root]\personMapping.json[root]\contractMapping.json [root]\persons.ps1[root]\departments.ps1 |
Input parameter configuration file, Persons/Contracts mapping definitions, and Persons/Departments data retrieval scripts (source system connectors only) |
See Provisioning GitHub resources for setup instructions.
Service Automation (SA) module
| Filename |
Description |
|---|---|
[root]\readme.md |
Readme file describing the repository's functionality. Includes any relevant special instructions, limitations, or recommendations. |
[root\All-in-one setup] |
Folder containing resources to automatically set up the delegated form |
[root\All-in-one setup]\createform.ps1 |
The all-in-one automatic PowerShell setup script |
[root\Manual resources] |
Folder containing resources to manually set up the delegated form |
[root\Manual resources]\datasource_{HelloID data source name}.ps1 |
Data source manual setup script |
[root\Manual resources]\task_{HelloID task name}.ps1 |
Task manual setup script |
[root\Manual resources]\dynamicform.json |
Dynamic form manual setup JSON definition |
[root\Assets] |
Miscellaneous assets folder |
See Service Automation GitHub resources for setup instructions.
Contribute to GitHub
Create a new repository
- Create a new repository, using the naming conventions described above
- Add a description to the repository, in the format
Connected system - Repository function. For example:Google G Suite - Targetfor a G Suite target Provisioning connector, orActive Directory - Show user detailsfor a delegated form that looks up an AD user. The description should be about the connected system and the specific function of the repository, rather than which HelloID module or feature is involved. - Add the following footer to
README.md:
# HelloID Docs
The official HelloID documentation can be found at: https://docs.helloid.com/ - If the repository isn't currently usable, temporarily add
[Work in progress]to both:
- The repository's description
- The header of
README.md
- Commit your files to the repository
- Remove the
[Work in progress]notices as soon as the repository is usable
Update a repository
- Clone the repository
- Make the required changes and updates locally
- Commit your files only when they are working and tested. If you must commit files which aren't usable, temporarily add
[Work in progress]to both:
- The repository's description
- The header of
README.md
- Include a comment clearly describing your commit
- Remove the
[Work in progress]notices as soon as the repository is usable