Administration Guide
Tools Reference (admin)
Reference for the per-Site Tools catalog: catalog management, invocation model, and RBAC.
Menu path
Admin Center > Site Settings > Customization > Tools.
Catalog scope
- The catalog is per-Site. Tools defined in one Site are not visible in another.
- The catalog is a mix of fourteen built-in entries (shipped with AlloyScan, not editable) and zero or more custom entries (defined by the Site Administrator).
For the operator-facing list of the fourteen built-ins, their purpose, and local client or target requirements, see Built-in Tools Reference in the User Guide.
Custom tool fields
| Field | Required | Description |
|---|---|---|
| Caption | yes | The label that appears on the Tools menu on a device form. |
| Run | yes | The command the Alloy Integration Launcher runs on the operator's workstation. May reference device attributes via placeholders. |
| Display PowerShell window | no | Shows the PowerShell window when the tool runs. |
Note: Global administrators can change the built-in tools available to new sites through the Site template.
Invocation model
Every Tool — built-in or custom — runs through the same path:
- The operator clicks the tool on a device form.
- The browser passes the tool definition and the device's address parameters to the Alloy Integration Launcher running on the operator's workstation.
- The Launcher invokes the local executable named in the invocation template, substituting the device attributes into the arguments.
- The local executable connects to the device.
Two operational consequences follow from this model:
- The Launcher must be installed on each operator's workstation. Without it, the Tools menu does nothing.
- The local executable named in the invocation must be installed and reachable on the operator's workstation. AlloyScan does not ship the local clients (Remote Desktop, VNC viewer, terminal, ping, traceroute, etc.).
Constraints
- Tools execute on the operator's workstation, not on the audited endpoint or on AlloyScan's servers.
- AlloyScan does not retain output from a tool invocation and does not log per-invocation results.
- Built-in tools cannot be edited or deleted from a site catalog. Global administrators can change the built-in tools available to new sites through the Site template.
- Custom tools persist until explicitly deleted by an administrator.
RBAC
| Action | Site Administrator | Site User |
|---|---|---|
| Open the catalog | yes | no |
| Add custom tool | yes | no |
| Edit custom tool | yes | no |
| Delete custom tool | yes | no |
| Invoke a tool from a device form | yes | yes |
Related
- About the Tools catalog — concept and the Launcher requirement.
- How to create a custom tool — admin step-by-step.
- Built-in Tools Reference — the fourteen built-ins (User Guide).
- How to use a tool on a device — operator workflow (User Guide).