One post tagged with "Client Management"

This script takes a few parameters to create a Notification App. The App Name and Icon are the most important as these are what will appear in the toast notification.

Parameter documentation follows:

The Script​

loading...

Generic Example​

# Setup parameter hashtable.
$NotificationAppParams = @{
  IconURI = 'https://homotechsual.dev/img/Icon.png'
  IconFileName = 'homotechsual.png'
  WorkingDirectory = 'C:\RMM\NotificationApp'
  AppId = 'homotechsual.example'
  AppDisplayName = 'Homotechsual Example'
  AppIconBackgroundColor = 0
  ShowInSettings = 1
}
Register-NotificationApp @NotificationAppParams

RMM Example​

Unsurprisingly, I'm going to use NinjaOne as the example RMM here. So I've done the donkeywork that is best documented by NinjaOne themselves on the Dojo and added the script above to the NinjaOne Script Library - but what next?

Option 1: Same App for All Customers​

Well the chances are that you want to use the same relatively small set of apps per customer so we'll just store a nice blob of text in the Ninja Script Library.

We could end up with a "Preset Parameter" set like this:

-IconURI https://homotechsual.dev/img/Icon.png -IconFileName homotechsual.png -WorkingDirectory C:\RMM\NotificationApp -AppId homotechsual.example -AppDisplayName "Homotechsual Example" -AppIconBackgroundColor 0 -ShowInSettings 1

You can have multiple preset parameter sets and simply select the one you want to use when you run the script or when you schedule it against a group (or however you want to run this) but what about getting more creative?

Option 2: Pull App Details per Customer​

We can use Documentation fields to store the details of the app per client and then use the NinjaOne CLI to pull the details when we run the script. This is a little more work but it's worth it if you want to brand your notifications per customer.

We'll need to add a few fields to the NinjaOne Documentation tab for each client:

We can then use the NinjaOne CLI to pull the details for the client we're running the script against and use them to create the parameter set for the script.

This means editing our script a little to accept the parameters from the CLI and then using the NinjaOne CLI to pull the details from the Documentation tab. We're going to assume you called your Document Template Example Template and your fields named as above in the table (with spaces between words if you wish).

At the top of the script we're going to replace the entire parameter block:

[CmdletBinding()]
Param(
    # The URI of the app icon to use for the notification app registration.
    [Parameter(Mandatory)]
    [uri]$IconURI,
    # File name to use for the app icon. Optional. If not specified, the file name from the URI will be used.
    [string]$IconFileName,
    # The working directory to use for the app icon. If not specified, 'C:\RMM\NotificationApp\' will be used.
    [System.IO.DirectoryInfo]$WorkingDirectory = 'C:\RMM\NotificationApp\',
    # The app ID to use for the notification app registration. Expected format is something like: 'CompanyName.AppName'.
    [Parameter(Mandatory)]
    [string]$AppId,
    # The app display name to use for the notification app registration.
    [Parameter(Mandatory)]
    [string]$AppDisplayName,
    # The background color to use for the app icon. Optional. If not specified, the background color will be transparent. Expected format is a hex value like 'FF000000' or '0' for transparent.
    [ValidatePattern('^(0)$|^([A-F0-9]{8})$')]
    [string]$AppIconBackgroundColor = 0,
    # Whether or not to show the app in the Windows Settings app. Optional. If not specified, the app will not be shown in the Settings app. Expected values are 0 or 1 (0 = false, 1 = true).
    [int]$ShowInSettings = 0
)

$IconURI = Ninja-Docs-Property-Get "Example Template" "NotificationIconURI"
$IconFileName = 'NotificationIcon.png'
$WorkingDirectory = 'C:\RMM\NotificationApp\'
$AppId = Ninja-Docs-Property-Get "Example Template" "NotificationAppId"
$AppDisplayName = Ninja-Docs-Property-Get "Example Template" "NotificationAppDisplayName"
$AppIconBackgroundColor = Ninja-Docs-Property-Get "Example Template" "NotificationAppBackgroundColor"
$ShowInSettings = 1

if (($null -eq $IconURI) -or ($null -eq $AppId) -or ($null -eq $AppDisplayName)) {
    Write-Error "Required fields are not populated in the Documentation tab."
    exit
}

So this is an entirely separate script - you can use it with the custom app you just created or you can use it with the default where notifications come from Windows PowerShell. It's up to you.

This script takes a few parameters to create a Notification App. The App Name and Icon are the most important as these are what will appear in the toast notification.

Parameter documentation follows:

The Script​

loading...

Generic Example​

# Setup parameter hashtable.
$NotificationParams = @{
  AppId = 'homotechsual.example'
  NotificationImage = 'C:\RMM\NotificationApp\NotificationIcon.png'
  NotificationTitle = 'Example Notification'
  NotificationMessage = 'This is an example notification.'
  NotificationType = 'reminder'
}
Send-Notification @NotificationParams

Script Example​

It's probably most useful to use this script as part of a larger script. For example, you could use it to send a notification when a script has finished running. You could also use it to send a notification when a scheduled task has finished running.

loading...

This would output something like this: