Skip to main content

HelloID

Scheduled tasks

Scheduled tasks are Tasks that run on a regular, recurring basis. Both Pre-defined tasks and PowerShell tasks can be scheduled.

2022-07-12_13-27-02.jpg

To get started, Add a pre-defined scheduled task or Add a PowerShell scheduled task.

Tip

The Tools4ever GitHub account contains a variety of PowerShell scheduled tasks that you can import into your HelloID environment. See Service Automation GitHub resources.

In HelloID, PowerShell scheduled tasks use proprietary cmdlets for logging.

These include Hid-Write-Status and Hid-Write-Summary.

Note

PowerShell scheduled tasks are the only PowerShell scripts in HelloID that use proprietary logging cmdlets. All other types of PowerShell scripts use standard logging cmdlets.

Hid-Write-Summary

Writes information to the task's Summary tab. The summary log is for brief, high-level results.

Example
Hid-Write-Summary -Message "This will be the message" -Event Information -Icon fa-tasks
Parameters
Message

The text to be written to the task's summary log.

Event

The 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:

  • Information

  • Success

  • Warning

  • Error

  • Failed

  • Critical

Icon

The 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.

Example
Hid-Write-Status -Message "This will be the message" -Event Information
Parameters
Message

The text to be written to the task's progress log.

Event

The 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:

  • Information

  • Success

  • Warning

  • Error

  • Failed

  • Critical

Audit logging is not currently supported in PowerShell scheduled tasks.

Email sends are not currently supported in PowerShell scheduled tasks.