HelloID

Go to Self Service > Products and click Edit for the relevant product.

For this example, we'll edit our Google Chrome product.

Go to the Actions - New tab.

In the States pane, select the state of the Product request lifecycle during which this action will run.

For this example, we'll select the Approved state.

Enter a Name for the action.

For this example, we'll call it Product task: Google Chrome: Approved.

Click Add product action.

The code editor is shown.

There are two ways to start writing the script:

In this example we are starting with the default script.

Customize the script according to what should happen during the selected stage of the product lifecycle for this product. For example, make API calls into external systems based on the data available in the product, the request, etc.

Keep the following in mind when writing code for a product action:

For this example, we will query a weather API. We'll use the following script:

#######################################################################
# Template: HelloID SA PowerShell product action
# Name: Google Chrome: Approved
# Date: 8.7.2023
#######################################################################

#region init

$VerbosePreference = "SilentlyContinue"
$InformationPreference = "Continue"
$WarningPreference = "Continue"

# global variables (Automation --> Variable library):
$globalVarExample = $companyName

# product variables:
$requesterUsernameExample = $requester.userName
$requesterUserGUIDExample = $requester.userGUID
$productNameExample = $product.name

# variables configured in form:
$formVarExample = $form.tempUnitDropdown.tempUnitValue

#endregion init

#region functions

Function Get-Current-NYC-Weather {
    $locationEndpoint = "https://api.open-meteo.com/v1/forecast?latitude=40.71&longitude=-74.01&hourly=temperature_2m&temperature_unit=$formVarExample&windspeed_unit=mph&precipitation_unit=inch"
    $response = Invoke-RestMethod -uri $locationEndpoint
    Write-Information "Response: $response"
    return @{weather = "Current time: $($response.hourly.time[0]); current temperature: $($response.hourly.temperature_2m[0]) degrees $formVarExample"}
}

#endregion functions

#region task
try {
    Write-Verbose "Looking up NYC weather for [$requesterUsernameExample ($requesterUserGUIDExample)] at $globalVarExample, in product $productNameExample"

    $result = Get-Current-NYC-Weather
    Write-Information "Result: $($result.weather)"

    $Log = @{
        Action = "Undefined"
        System = "OpenMeteo"
        Message = "Successfully executed action for [$requesterUsernameExample ($requesterUserGUIDExample)]"
        IsError = $false
        TargetDisplayName = $requesterUsernameExample
        TargetIdentifier = $([string]$requesterUserGUIDExample)
    }

    Write-Information -Tags "Audit" -MessageData $log

    $email = @{
        from = "[email protected]"
        to = "[email protected]"
        subject = "Your weather report"
        body = "<strong>$($result.weather)</strong>"
        confidential= $false
    }

    Write-Information -Tags "Email" -MessageData $email
} catch {
    $ex = $PSItem
    Write-Warning "Error at Line '$($ex.InvocationInfo.ScriptLineNumber)': $($ex.InvocationInfo.Line). Error: $($ex.Exception.Message)"

    Write-Error "Error executing action for [$requesterUsernameExample ($requesterUserGUIDExample)]. Error Message: $($ex.Exception.Message)"

    $Log = @{
        Action = "Undefined"
        System = "OpenMeteo"
        Message = "Error executing action for [$requesterUsernameExample ($requesterUserGUIDExample)]. Error Message: $($ex.Exception.Message)"
        IsError = $true
        TargetDisplayName = $requesterUsernameExample
        TargetIdentifier = $([string]$requesterUserGUIDExample)
    }
    Write-Information -Tags "Audit" -MessageData $log
}
#endregion task

If your script relies on form data, enter JSON in the Input tab to simulate form input.

For this example, we'll enter the following JSON to simulate input from our Weather report form:

{
   "tempUnitDropdown": {
      "tempUnitLabel": "Fahrenheit",
      "tempUnitValue": "fahrenheit"
   }
}

To test your script, click Execute PowerShell. View the results on the Received logs and Received audit logs tabs.

For this example, the NYC weather has been fetched and logged.

Preview any email sends on the Notifications tab.

Click Update.

Click Save.

Go to Self Service > Products and click Edit for the relevant product.

Go to the Actions tab.

Click Add product action.

In the Task catalog dialog box, search for the pre-defined task that you want to create.

For this example, we'll add the Add AD user to AD group action.

Optional: Change the task's default Name.

For this example, we'll use Add AD user to AD group.

Set Execute On State to the stage of the Product request lifecycle when this script should be executed.

For this example, we'll set it to Approved.

Enter the required input values for the task.

Tip

Type {{ in a text field to activate autocomplete.

You have access to $manager, $product, $request, $requester, and $resourceOwnerGroup. You also have access to System variables (under {{portal.}}) and Custom variables (under {{variable.}}).

Click Update Action.

Optional: Add additional actions for other stages of the Product request lifecycle.

For example, here we've added the Remove AD user from AD group action to the product's Returned stage.

Click Save.

Go to Self Service > Products and click Edit for the relevant product.

Go to the Actions - New tab.

Click the relevant State.

For the relevant task, click Edit product action.

Continue by following the instructions in Add a product action.

Go to Self Service > Products and click Edit for the relevant product.

Go to the Actions - New tab.

Click the relevant State.

For the relevant action, click Delete product task.

To confirm, click Delete.

Click Save.