User Guide

How to create a custom tool

This guide shows you how to add a custom Tool to your site's catalog so that operators can launch it against a device from the device form, alongside the built-in entries.

Prerequisites

  • You sign in with the Administrator role on the current site. Custom-tool authoring is not exposed to the User role.
  • The local executable, script, or client that the custom tool will invoke is installed on the workstations of the operators who will use it. Custom tools run on the operator's workstation, not on the AlloyScan server and not on the target device.
  • The Alloy Integration Launcher is installed on each operator workstation.

Steps

  1. Open Admin Center > Site Settings > Customization > Tools.
  2. Click + New tool.

  3. Fill out the tool definition.

    • Name — the label shown to operators in the device form's Tools menu.
    • Invocation template — how the Alloy Integration Launcher should call the local executable or script. Substitute device attributes (for example, the device's IP address or DNS name) into the template using the parameter placeholders supported by the form.
    • Target operating system — the OS gate that controls when the tool appears. A tool gated to Windows is not offered for macOS or Linux devices.
    • Any additional parameters the form exposes for argument substitution and execution context.

    Note: Field names and exact controls of the new-tool form may vary by deployment.

  4. Save the tool. It now appears in the site's Tools catalog at Admin Center > Site Settings > Customization > Tools and is offered in the device form's Tools menu for devices that match the OS gate.

  5. (Optional) Use the per-tool overflow menu in the catalog to Edit, Duplicate, or Delete the tool definition later.

Verify

After saving, you should see:

  • The new tool in the catalog grid at Admin Center > Site Settings > Customization > Tools, with its Name visible.
  • The new tool listed in the Tools menu of a device form for any audited device whose operating system matches the configured OS gate.

To smoke-test it, follow How to use a tool on a device and pick the new tool. The Launcher should start the matching local executable with the substituted device attributes.