Next Topic

Previous Topic

Creating Custom Agent Icons

Four Agent Icons

To incorporate custom agent icons in the system tray of each managed machine you create four icons in Windows icon format. These four icons must be named:

  • online.ico – The blue K icon displayed when agent is connected to the KServer
  • offline.ico – The gray K icon displayed when agent is not connected to the Server
  • blink.ico – The white K icon displayed when agent requires the user to click the icon to display a message that has been received using Remote Control > Send Message.
  • noremote.ico – The red K icon displayed when the user has selected the Disable remote control menu item from the agent popup menu

Creating Your Own Agent Icons

To create an icon in the Windows format, use an editor such as one in the Microsoft Visual Studio development environment.

  1. Select New > File... from the File menu in Microsoft Visual Studio.
  2. Select an Icon File template and click the OK button.
  3. Edit a standard 32x32 size icon image and save it as one of the four *.ico names listed above.
  4. Repeat this step and create four icons.

    Note: The color depth must not exceed 256 colors nor be larger than 32x32 pixels.

Uploading Your Custom Agent Icons into the KServer

  1. Select System > Customize.
  2. Click the Customize the graphical user interface link.
  3. Scroll to the bottom of the page and update the agent icon images for each of the following items labeled:
    • Agent system tray icon when agent is online (must be .ico format)
    • Agent system tray icon when agent is offline (must be .ico format)
    • Agent system tray icon when agent is blinking (must be .ico format)
    • Agent system tray icon when remote control is disabled (must be .ico format)

The agent displays the default Kaseya icons if any of the custom icons are omitted.

If the Custom Agent Icons Fail to Display in the System Tray of Managed Machines

The custom icon will fail to load if it is not properly formatted. Reasons include:

  • The color depth exceeds 256 colors.
  • The format is not the Windows icon format (e.g. a simple bitmap file was renamed to .ico extension).
  • The size is larger than 32x32 pixels.

Updating Existing Managed Machines with Custom Agent Icons

Schedule an agent update using Agent > Update Agent. You will need to check the Force update check box to update agents that are already at the current version.

Deploying Custom Agent Icons

The custom icons are automatically deployed with all new agent installation packages. If you have an agent installation package deployed using a domain login script, then you must download and replace the KcsSetup.exe file residing on the domain server.

Topic 3629: Send Feedback