Tasks
Use tasks to run actions & integrations related to your HelloID environment and/or other organizational systems or applications.
There are two types of tasks in HelloID: Pre-defined tasks and PowerShell tasks. Tasks can be run using Scheduled tasks or as Product tasks.
Note
Tasks are executed by an Access Management Agent, not a Service Automation Agent.
Pre-defined tasks
The HelloID Task catalog contains a variety of common, pre-defined tasks which can be quickly added to your HelloID environment with minimal effort.
PowerShell tasks
If there are no suitable Pre-defined tasks in the Task catalog, you can create a custom task using PowerShell.
To get started, Add a PowerShell scheduled task or Add a PowerShell product task.
In HelloID, PowerShell tasks use proprietary cmdlets for logging.
These include Hid-Write-Status and Hid-Write-Summary.
Hid-Write-Summary
Writes information to the task's Summary tab. The summary log is for brief, high-level results.
Hid-Write-Summary -Message "This will be the message" -Event Information -Icon fa-tasks
MessageThe text to be written to the task's summary log.
EventThe class of event that you are logging. These have no effect on the task's functionality, and can be chosen at your discretion. Their purpose is to let you filter logged events by severity. Acceptable values are:
InformationSuccessWarningErrorFailedCritical
IconThe Font Awesome icon displayed next to the message in the summary log.
Hid-Write-Status
Writes information to the current task's Progress Log tab. The progress log is for detailed script logging, to support troubleshooting.
Hid-Write-Status -Message "This will be the message" -Event Information
MessageThe text to be written to the task's progress log.
EventThe class of event that you are logging. These have no effect on the task's functionality, and can be chosen at your discretion. Their purpose is to let you filter logged events by severity. Acceptable values are:
InformationSuccessWarningErrorFailedCritical
Note
Non-task PowerShell scripts (i.e., PowerShell data sources and in Delegated form PowerShell scripts) use standard PowerShell logging cmdlets. See Logging in PowerShell data sources and Logging in delegated form PowerShell scripts, respectively.
Audit logging is not currently supported in PowerShell tasks.
Active Directory synchronization task
An Active Directory synchronization task is a special kind of scheduled task (see Scheduled tasks), created automatically by HelloID when you set up AD sync. It syncs AD users and groups to HelloID Users and Groups, based on the associated AD mapping set.