TOPdesk
Connect NetLock RMM to TOPdesk: alerts become incidents in the mapped branch, the all-clear adds an action and closes the incident, devices can be synced to Asset Management, branches can be imported.
TOPdesk
Requirements
- A TOPdesk operator or API account with the permission
REST APIand the write permissionUse application tokens, and the rights to create, read and edit first or second line incidents. Branch filters of the account apply, so it has to see the mapped branches. For the device sync, use an account without branch filters: an assignment it cannot see counts as no assignment. - An application token, created in TOPdesk under
My settingsor on the card of the API account. A token expires on the date set there, by default after one year. The connection then shows that the credentials are invalid or expired; create a new token and useReplace credentials. - For the device sync, permissions for Asset Management.
Setup
- In
Settings → Integrations, open the TOPdesk tile and chooseConnect. - Enter the
Instance address, theLogin nameand theApplication token.Allow unencrypted httpis for an instance on an internal network only. - Under options, choose the caller, the
Incident line, and optionally the operator group, category, subcategory, call type and entry type of new incidents. - Set how incidents close, see below.
- Map each tenant to a branch, or import the branches as tenants. Tenants without a mapping are not included.
- Map the severities. Each one maps to a priority or to a pair of impact and urgency, from which TOPdesk derives the priority through its matrix. Without a mapping TOPdesk applies its own default.
- Activate the connection.
Caller
By default, the caller of an incident is an unregistered caller named after Caller name, in the mapped branch. With Registered caller (e-mail address) the person with that address is the caller of the incidents of their own branch; the person needs the caller role on their card, and the account has to be allowed to read persons. A registered caller always carries the branch from their card, so incidents of all other branches keep the unregistered caller, and branch filters and reports per customer keep working.
What goes to the vendor
For every alert that passes the filter of the connection: a title, the severity, tenant, location and device name, the source, first and last time seen, the alert text, and a link to the web console if the public console URL is set. Check that this matches your data processing agreements before you activate the connection.
With the asset sync on, also: device name and its NetLock device id, and with Field for device details set the operating system, manufacturer, model, serial number, IP address and MAC address.
What happens to an incident
- An alert becomes an incident of the mapped branch. TOPdesk limits the brief description to 80 characters, so a long title is cut. The reference
NetLock-Alert-<id>is stored in theExternal numberof the incident. - When the alert ends, the incident gets an action that is invisible to the caller and is closed if nobody is working on it. An operator group alone does not count as assigned; an operator does.
- With a status in
Status when closingNetLock sets that processing status. Whether it closes the incident depends on the settings of the status in TOPdesk; if it does not, the incident stays open and the history saysno_transition. Without a status NetLock sets the incident to closed directly.Closure codeis sent as well. - If TOPdesk refuses to close, for example because of a setting of the status, the incident stays open with its note, and the history says
close_refused. - An archived incident cannot be changed, not even with a note.
The behaviour is set in the Settings tab, see A.14.4. NetLock never closes an incident whose status somebody changed in the meantime, and it never deletes anything at the vendor.
Asset sync
The sync is off by default. Switch on Sync devices as assets, and map device classes to asset templates or choose a Default asset type.
The fields of an asset belong to its template and differ per installation. NetLock only sets the name, and fills the text field you choose in Field for device details with the remaining values. If the template requires fields that NetLock does not know, creating the asset fails, and the device is named in the history.
Every hour NetLock sends the authorized devices of the mapped tenants that changed since the last run, at most 200 per run; if more devices changed, the next run starts right after. Synchronize now starts a run immediately.
- TOPdesk requires a name that is unique among all assets, while host names repeat across customers. A new asset is therefore named
<host> (NetLock-<id>), and the name is updated when the device is renamed. - A new asset is assigned to the branch of its tenant.
- A device with the plain host name of an existing asset of the template is linked to that asset, which keeps its name, provided that exactly one such asset exists, it is not archived, no other device holds it, and it is not assigned to another branch.
- A device that moved to another tenant keeps its asset and is named in the history, because TOPdesk would show the asset at both branches. Move the assignment by hand.
- A device that fails is named in the history and waits for the next run; the other devices are still processed.
- An alert of a synced device links the asset to the incident.
Nothing is deleted in TOPdesk.
Known limits
- Tickets in NetLock show the incident number, no link.
- Locations of the asset are not set, only the branch.
Related
ITFlow
Connect NetLock RMM to a self-hosted ITFlow: alerts become tickets, the all-clear adds an internal reply and resolves or closes the ticket, devices can be synced as assets, clients and locations can be imported.
DocBee
Connect NetLock RMM to DocBee: alerts become tickets of the mapped customer, the all-clear adds an internal message and sets the closing status, devices can be synced as customer objects, customers can be imported.