Add Reference field to scheduled task handling

Introduces a 'Reference' field to scheduled task entities and propagates its usage through task creation, execution, and notification logic. This allows tasks to be associated with an external or user-defined reference for improved traceability.

Author: Zacgoose

Modules/CIPPCore/Public/Add-CIPPScheduledTask.ps1

@@ -174,21 +174,22 @@ function Add-CIPPScheduledTask {
             }
 
             $entity = @{
-                PartitionKey         = [string]'ScheduledTask'
-                TaskState            = [string]'Planned'
-                RowKey               = [string]$RowKey
-                Tenant               = [string]$tenantFilter
-                excludedTenants      = [string]$excludedTenants
-                Name                 = [string]$task.Name
-                Command              = [string]$task.Command.value
-                Parameters           = [string]$Parameters
-                ScheduledTime        = [string]$task.ScheduledTime
-                Recurrence           = [string]$Recurrence
-                PostExecution        = [string]$PostExecution
-                AdditionalProperties = [string]$AdditionalProperties
-                Hidden               = [bool]$Hidden
-                Results              = 'Planned'
-                AlertComment         = [string]$task.AlertComment
+                PartitionKey           = [string]'ScheduledTask'
+                TaskState              = [string]'Planned'
+                RowKey                 = [string]$RowKey
+                Tenant                 = [string]$tenantFilter
+                excludedTenants        = [string]$excludedTenants
+                Name                   = [string]$task.Name
+                Command                = [string]$task.Command.value
+                Parameters             = [string]$Parameters
+                ScheduledTime          = [string]$task.ScheduledTime
+                Recurrence             = [string]$Recurrence
+                PostExecution          = [string]$PostExecution
+                Reference              = [string]$task.Reference
+                AdditionalProperties   = [string]$AdditionalProperties
+                Hidden                 = [bool]$Hidden
+                Results                = 'Planned'
+                AlertComment           = [string]$task.AlertComment
             }
 
 

Modules/CIPPCore/Public/Entrypoints/Activity Triggers/Push-ExecScheduledCommand.ps1

@@ -280,7 +280,7 @@ function Push-ExecScheduledCommand {
             $HTML += "<div style='background-color: transparent; border-left: 4px solid #007bff; padding: 15px; margin: 15px 0;'><h4 style='margin-top: 0; color: #007bff;'>Alert Information</h4><p style='margin-bottom: 0;'>$($task.AlertComment)</p></div>"
         }
 
-        $title = "$TaskType - $Tenant - $($task.Name)"
+        $title = "$TaskType - $Tenant - $($task.Name)$(if ($task.Reference) { " - $($task.Reference)" })"
         Write-Information 'Scheduler: Sending the results to the target.'
         Write-Information "The content of results is: $Results"
         switch -wildcard ($task.PostExecution) {

Modules/CIPPCore/Public/Entrypoints/HTTP Functions/Identity/Administration/Users/Invoke-AddUser.ps1

@@ -23,9 +23,10 @@ function Invoke-AddUser {
                 value = 'New-CIPPUserTask'
                 label = 'New-CIPPUserTask'
             }
-            Parameters    = [pscustomobject]@{ UserObj = $UserObj }
-            ScheduledTime = $UserObj.Scheduled.date
-            PostExecution = @{
+            Parameters             = [pscustomobject]@{ UserObj = $UserObj }
+            ScheduledTime          = $UserObj.Scheduled.date
+            Reference = $UserObj.reference ?? $null
+            PostExecution          = @{
                 Webhook = [bool]$Request.Body.PostExecution.Webhook
                 Email   = [bool]$Request.Body.PostExecution.Email
                 PSA     = [bool]$Request.Body.PostExecution.PSA

Modules/CIPPCore/Public/Entrypoints/HTTP Functions/Tenant/Conditional/Invoke-ExecCAExclusion.ps1

@@ -84,6 +84,8 @@ function Invoke-ExecCAExclusion {
                 }
                 Parameters    = [pscustomobject]$Parameters
                 ScheduledTime = $StartDate
+                PostExecution = $Request.Body.postExecution
+                Reference     = $Request.Body.reference
             }
 
             Write-Information ($TaskBody | ConvertTo-Json -Depth 10)
@@ -117,6 +119,7 @@ function Invoke-ExecCAExclusion {
                     Command       = @{ value = 'Set-CIPPAuditLogUserExclusion'; label = 'Set-CIPPAuditLogUserExclusion' }
                     Parameters    = [pscustomobject]@{ Users = $AuditUsers; Action = 'Remove'; Type = 'Location' }
                     ScheduledTime = $EndDate
+                    Reference     = $Request.Body.reference
                 }
                 Add-CIPPScheduledTask -Task $AuditRemoveTask -hidden $true
             }