Introduction
HelloID provides some custom PowerShell cmdlets (pronounced "command-let") that allow your scripts to perform actions that are specific to your HelloID environment. The cmdlets and their usage will be detailed in this article.
Hid-Write-Status
This cmdlet writes information to the progress log.
Example:
Hid-Write-Status -Message "This will be the logging" -Event Information
Parameters:
- Message
The text that you wish to be displayed in the progress log. - Event
The class of event that you are reporting. Acceptable values are Information, Success, Error, and Failed.
Hid-Write-Summary
This cmdlet writes information to the task's summary log.
Example:
Hid-Write-Summary -Message "This will be the logging" -Event Information -Icon fa-tasks
Parameters:
- Message
The text that you wish to be displayed in the progress log. - Event
The class of event that you are reporting. Acceptable values are Information, Success, Error, and Failed. - Icon
The Font Awesome icon to be displayed next to the message in the summary log.
Hid-Add-TaskResult
This cmdlet adds a PowerShell object to an array, which is then passed as output for use elsewhere in HelloID, such as in a data source.
Example:
$result_object = @{givenName = "Bob"; familyName = "Johnson"; title = "Engineer";}
Hid-Add-TaskResult -ResultValue $result_object
Parameters:
ResultValue
The object that is to be added to the output array.