Introduction
The Tools4ever GitHub account contains two types of resources for use with HelloID's Service Automation module:
Each repository's name starts with HelloID-Conn-SA. For example, HelloID-Conn-SA-Full-AD-ReportAccountsRecentlyCreated. For more information on naming conventions, see GitHub Resources - Introduction.
Delegated forms
To browse all repositories in the T4E GitHub account that contain delegated forms, search GitHub for org:Tools4everBV topic:delegated-form:
Each repository comprises a set of PowerShell scripts and JSON files. For more information on these files, see GitHub Resources - Introduction.
There are two ways to bring a delegated form into your HelloID environment from GitHub: automated import or manual import.
Automated import (recommended)
- Ensure you have at least one API key configured. (This process internally uses the first API key listed in the table in Security > API.)
- Go to the Delegated Forms overview.
- Select the Import external template button.
- On the Select a Script screen, all the delegated forms in the T4E GitHub are displayed in a list. These are the same repositories returned by a GitHub search for
org:Tools4everBV topic:delegated-form. Locate the form you want to import, and select its Import button.
- The all-in-one PowerShell creation script (createform.ps1) is loaded into the left pane, and the repository's readme is loaded into the right pane. The script sets up the needed dynamic form, data sources, tasks, user variables, and delegated form. Then, it connects everything together.
- Customize the variables in the script's header section,
#HelloID variables, according to the Connection Details table below.
- Select the Execute button.
- If errors occur, review the Logs. Select the Previous button, fix the script, and then select the Execute button again.
- When the script succeeds, the Script executed successfully message is displayed.
- Select the Finish button.
- Your new delegated form is now listed in the Delegated Forms overview.
Connection details
| Variable | Description | Example |
Line |
|---|---|---|---|
| $portalBaseUrl | Your HelloID portal's URL | https://customer01.helloid.com |
2 |
| $delegatedFormAccessGroupName | Array of local HelloID group names which will have access to this delegated form | @("Users", "HID_administrators") |
3 |
| $delegatedFormCategories | Array of HelloID delegated form categories in which this form will be placed | @("Active Directory","Group Management") |
4 |
Manual import
The second way to bring delegated forms from GitHub into your HelloID environment is by manually running the all-in-one PowerShell script (createform.ps1) in a PowerShell environment outside of HelloID. This achieves the same result as the automated import process.
- Locate the desired delegated form repository in the T4E GitHub account.
- Download
createform.ps1from the /All-in-one setup folder. - Open it in your preferred PowerShell console/editor.
- Customize the variables in the script's header section,
#HelloID variables, according to the Connection Details table below. This includes your API key and secret. - Run the script on a machine with PowerShell support and an internet connection
- Perform any additional steps listed in the Post-setup configuration section of the GitHub repository's readme.
Connection details
| Variable | Description | Example |
Line |
|---|---|---|---|
| $portalBaseUrl | Your HelloID portal's URL | https://customer01.helloid.com |
2 |
| $apiKey | API key value of your own environment | 3 | |
| $apiSecret | API secret value of your own environment | 4 | |
| $delegatedFormAccessGroupName | Array of local HelloID group names which will have access to this delegated form | @("Users", "HID_administrators") |
5 |
| $delegatedFormCategories | Array of HelloID delegated form categories in which this form will be placed | @("Active Directory","Group Management") |
6 |
Custom delegated forms
If GitHub doesn't contain a suitable delegated form for your needs, and you need to create one from scratch, refer to Create a custom delegated form.
Tasks
To browse all repositories in the T4E GitHub account that contain tasks, search GitHub for org:Tools4everBV topic:scheduled-task:
Each repository comprises a PowerShell script and miscellaneous assets.
There is only one way to bring a task into your HelloID environment from GitHub: manual import.
Manual import
- Create a new custom PowerShell task.
- Copy and paste the contents of the repository's
.ps1file into the body of the PowerShell script.