Branding With the Systray Icon

Topic

This article explains how to set up and use the Systray icon as part of your custom NinjaOne site.

Environment

NinjaOne platform

Description

NinjaOne allows you to create and deploy a custom Systray icon for your organization.

Branding: Systray Icon (NinjaOne Inc. 02:05)

Index

Select a category to learn more:

Enabling the Systray Icon

Before you can work with the Systray icon, you must enable it in NinjaOne. Click Administration in the NinjaOne navigation menu, then select Systray from the General drop-down menu and click the Enable button.

Once enabled, you can use the Add systray button to configure it.

add systray.png — **Figure 1**: Add a systray for NinjaOne

Configuring the Systray Icon

Click Add systray to configure a new systray icon. To configure an existing systray, click the ellipsis button and select Edit.

add or edit systray.png — **Figure 2:** Add or edit the Systray Icon

In the Add Systray menu, you will customize what appears when users click the Systray icon.

systray config modal.png — **Figure 3:** Systray configuration options

Click Add Systray, make sure you are on the General tab, then fill in the following fields:

Name: Give the Systray icon a descriptive name.
Description: Add an optional description.
Tooltip: Add text that appears when a user moves their cursor over the information icon.
Operating system systray icon: Upload the graphic image you would like to use as the Systray icon. This image must be a JPG or PNG file of equilateral size between 16x16 and 128x128 pixels.

Creating the Systray Icon Menu

In this step, you will configure the menu that appears when users click the Systray icon.

Adding Menu Items

On the Systray Menu tab, click Add Menu Item, then select the item type from the drop-down list.

systray menu_add menu item.png — **Figure 4:** Add systray menu item

Configure the menu item's settings. The configuration options will vary depending on the menu item type you select. Refer to the Menu Item Explanations table below to learn about each menu item type.

**Figure 5:** Menu item configuration (click to enlarge)

Editing Menu Items

To edit a menu item, place your cursor over it and click the Edit option when it appears. You can also drag and drop items in the menu tree to arrange them as desired. When finished, click Save Changes.

**Figure 6:** Edit menu item (click to enlarge)

Deleting Menu Items

To delete a menu item, place your cursor over it and click the Remove option when it appears.

**Figure 7:** Remove menu icon (click to enlarge)

Menu item explanations

The following table explains each menu item type.

Menu Item Type	Description
About	This item allows you to include information about your company. It is single-use and will always be at the root level position; it cannot be nested. The Description field supports basic HTML. The system will display the email and phone number created under Branding here.
Automation	NinjaOne will only offer automations compatible with the selected operating system. When a user selects an automation, the NinjaRMM agent runs the automation and all associated scripts in sequence. Automations run from the Systray will trigger an activity at the device level: "Start Requested by Device End User." You can filter these activities on the device dashboard. You can add automation that is not native to NinjaOne. First, add the automation to the Automation Library. Instructions are in Getting Started with NinjaOne's Automation Library (Scripting). Do not run Systray automations as the "current logged-in user" on Remote Desktop Servers. Doing so causes the script to run on the first session in a multi-user environment and, as such, will not target a specific user.
Email	The Email type allows you to customize an email that a customer can send to you. This option utilizes the mail program configured on the node. You can also use environment variables with the Email menu item.
Exit	This single-use item will always be at the root level position. It cannot be nested. The item inserts an "exit" option to allow your users to close out of the Systray executable.
Group	Group lets you create menu headings for your Systray items. By default, items are added at the root level. You can create as many groups as needed.
Help Request Form	This single-use item will always be at the root level position; it cannot be nested. This item type allows you to configure a dynamic form you can forward to an email address, your integrated PSA tool, or NinjaOne Ticketing. When you send the request to your integrated PSA tool, you can choose the ticket template. This option does not apply to NinjaOne Ticketing. The Subject and Description fields support basic HTML and placeholders. By default, all available placeholders are added to the form (and are listed in text form below). You can add, remove, and rearrange placeholders as desired. You can truncate any of the fields, which is helpful when forwarding to a PSA tool that limits the length of ticket titles. Here is an example of how to do this: `“Help request from ${client.name?truncate(25)} / ${form.subject?truncate(100)}“` You can use environment variables with the Help Request Form menu item. Refer to Branding: Environment Variables vis Systray Icon for more information. End users can submit screenshots and include image attachments. If your help request form is set up to forward to an integrated PSA tool, the email will appear as a note (along with all the other contents) on the ticket. The email will not automatically populate fields in your PSA or sync to an existing contact.
Launch	This item type lets you populate launch commands for your customers to use. You can specify the location and filename of the executable to launch along with command line arguments. This feature will run applications as the logged-on user. Here are some example cmd commands you can run through the Systray icon (this list is not exhaustive): show add/remove programs: `cmd.exe /c "appwiz.cpl"` show computer management: `cmd.exe /c "compmgmt.msc"` show control panel: `cmd.exe /c "control panel"` launch cmd prompt: `cmd.exe` show device management: `cmd.exe /c "devmgmt.msc"` show disk management utility: `cmd.exe /c "diskmgmt.msc"` show event viewer: `cmd.exe /c "eventvwr.msc"` show network connections: `cmd.exe /c "control netconnections"` show printers: `cmd.exe /c "control printers"` show MTSC: `cmd.exe /c "mstsc"` show services: `cmd.exe /c "services.msc"` show msinfo: `cmd.exe /c "msinfo32"` show task manager: `cmd.exe /c "taskmgr"` show computer name: `cmd.exe /c "Control sysdm.cpl"` show full IP configuration information: `cmd.exe /k "ipconfig /all"` release the IP address: `cmd.exe /k "ipconfig /release"` renew the IP address: `cmd.exe /k "ipconfig /renew"` purge DNS resolver cache: `cmd.exe /k "ipconfig /flushdns"` Note: The full path is not required for executables residing in directories listed in PATH environment variable Use the open command built natively into macOS for macOS devices. For example: `open "/Applications/Google Chrome.app"` For more examples of using the open command, use the man open command within the native terminal or the NinjaOne Remote Terminal. For macOS devices, you can also use the following example to write in a custom field: `"/Applications/NinjaRMMAgent/programdata/ninjarmm-cli" set Systraymacinstallshottr true`
Separator	This item type inserts a line separator between menu items or groups.
Static	This command lets you enter static text the system will display to the user.
URL	This item type allows you to configure specific URLs for your customers to launch as needed. This command is helpful if you'd like to enable your customers to call you via Skype or any other dynamic URL.

Deploying the Systray Configuration

After configuring the Systray icon, you can deploy it to individual or multiple organizations.

Navigate to the Administration → Organizations tab.
Select the checkbox next to the desired organizations. You can select more than one organization.
Click Edit settings and select Systray from the drop-down menu.

**Figure 8:** Edit Systray settings (click to enlarge)

Toggle the Enable systray switch, select the desired Systray template, and then select Apply to save changes.

Alternatively, you can deploy the Systray icon from the organization configuration page:

Navigate to the Administration → Organizations tab and select the organization. The General tab will be open by default.
Activate the Systray Icon toggle switch, select the desired icon template from the drop-down menu, and click Save.

**Figure 9:** Editing from the configuration page (click to enlarge)

Deleting or Editing the Systray Icon

Ensure that the Systray icon is not configured or associated with any organization before attempting to delete it. You cannot delete the default Systray.

Navigate to Administration → General and open the Systray tab.
Move your cursor over the Systray row and click the ellipsis (three dots) icon.
Select the action.

The system will display an error message if the Systray icon is already configured with an organization. You cannot delete the Systray icon until you delete its organization configuration. Click the organization name in the dialog box to change that organization's Systray icon.

The User Experience

After deploying the Systray, the user's system will show the icon you designated (or the default gear icon), and users can interact with the tooltips you have configured.

Microsoft Windows Example

**Figure 10:** Microsoft Windows Systray icon

Apple macOS Example

Linux Example

You may need to install a tray extension (such as GNOME) to use the Systray icon with the Linux agent. The tray extension will depend on the desktop environment used.

Advanced Usage

Placeholders for Menu Items

Placeholders for use in menu items (URLs, Launch, or About dialog box):

${IP_ADDR}: IP Addresses
${USERNAME}: Username of current user
${HOSTNAME}: Machine hostname
${DOMAIN}: Domain machine that the node has joined
${TIMESTAMP}: Current timestamp in ISO format (UTC)
Any environment variable, such as ${PROCESSOR_ARCHITECTURE}

Help Form Placeholders

First Name: ${form.firstName}
Last Name: ${form.lastName}
Email: ${form.email}
Phone: ${form.phone}
Subject: ${form.subject}
Problem Description: ${form.body}
Device: ${node.displayName}
Ninja URL: ${node.url}
Device Role: ${node.nodeRole}
Public IP: ${node.publicIpAddress}
Private IPs: ${node.ipAddress}
Device ID: ${node.id}
Organization: ${client.name}
Description: ${client.description}
Organization URL: ${client.url}
Policy: ${policy.name}
Policy Description: ${policy.description}
Policy URL: ${policy.url}

In addition, you can use any environment variable configured in the system with the env. Prefix.

COMPUTERNAME: ${COMPUTERNAME}
OS: ${env.OS}
NUMBER_OF_PROCESSORS: ${NUMBER_OF_PROCESSORS}
PROCESSOR_ARCHITECTURE: ${PROCESSOR_ARCHITECTURE}
USERDOMAIN: ${USERDOMAIN}
USERNAME: ${USERNAME}

Additional Resources

Refer to the following documentation for additional information: