NetLock RMMNetLock RMM Docs
IV — Administration

Docusnap365

Connect NetLock RMM to Docusnap365: a device is linked to the scanned hardware object with its serial number. Nothing is written to that object.

Docusnap365

Docusnap 15 is not supported. The on-premises product has no REST API. This page is about the cloud product Docusnap365.

What this connector does

Docusnap runs its own network inventory, and its objects have no key an outside system could use. NetLock therefore does not add a second inventory. It links a device to the object Docusnap scanned, and the External systems tab of the device shows the link.

Nothing is written to a matched object: NetLock does not change values that Docusnap365 scanned.

Requirements

  • A plan with the Data API.
  • An API key, created in Docusnap365 under the gear icon, API Keys. The right Read is enough. Write is only needed for creating objects. A key has an expiry date; an expired key or a key without Read puts the connection into the error state with the reason.

The address api.docusnap365.com is fixed, so a stored key cannot be sent anywhere else.

Setup

  1. In Settings → Integrations, open the Docusnap365 tile and choose Connect.
  2. Enter the API key. The test of the connection shows the number of organizations, tries a search and checks that the objects of the first organization carry an id.
  3. Under options, switch on Sync devices as assets. It is off by default: without it the connection does nothing.
  4. Map each tenant to an organization, or import the organizations. Tenants without a mapping are not included.
  5. Activate the connection.

How a device finds its object

Only by its exact serial number, within the mapped organization. The match is case-sensitive. Names are not used, because scanned names and host names often differ.

A device is skipped, without counting as a failure, when:

Reason in the historyMeaning
no_serialThe device has no serial number, or a placeholder such as To Be Filled By O.E.M.
not_in_sourceThe organization has no object with this serial number
ambiguousSeveral objects have this serial number. NetLock does not guess. Remove the surplus objects in Docusnap
takenThe one object that fits belongs to another device of this connection. Deleting that device in NetLock frees the object
create_incompleteCreating is on, but a hardware type for the device class or the scope is missing
create_refusedDocusnap365 refused to create the object, see below
create_unconfirmedA create request was sent, but the object cannot be found, see below

A skipped device is checked again a week later, because requests are counted; a device with no_serial costs no request and is checked again a day later. Saving the settings, changing a mapping or Synchronize now ends the wait.

A linked device is checked again only when its serial number or its organization changes. If the object is no longer in the organization or carries another serial number, NetLock searches again; if nothing is found, the link is removed, so a device that moved to another tenant does not show the object of the old customer. An object deleted in Docusnap is not noticed until such a change.

Requests

Docusnap365 counts API requests per month: 50,000 in Pro, 100,000 in Business, unlimited in Enterprise. The requests of other tools with API keys count as well.

  • A linked device only costs a request when its serial number or organization changes. A new IP address or another operating system costs nothing, because this data is not sent to Docusnap365.
  • NetLock reads one list per organization and run step instead of one request per device, and processes the devices of an organization together.
  • A device without a serial number costs no request.
  • The test of the connection costs three requests, the dropdowns one each.

If Docusnap365 reports that the limit is reached, the run stops and tries again an hour later, unless the response gives a different time. While that job waits, no new one is added. The connection stays active, nothing pauses, and the Log tab says that the requests of the month may be used up.

If the list of one organization fails with a server error or a timeout, its devices are retried within the hour, and the other organizations are still processed.

Creating objects

Create objects for devices without a hit is off by default.

Warning: Docusnap365 does not recognise objects that NetLock created. If a gateway later scans a machine for which NetLock created an object, a second object can appear next to it. The serial number is then ambiguous, and you have to clean up in Docusnap. Leave this off where a gateway scans. It is meant for devices no scan reaches.

With it on, a device with a serial number and without a hit becomes a new hardware object in the mapped organization. Right before creating it, NetLock searches for the serial number once more, so an incomplete list does not lead to a second object. A device without a serial number is never created, because it could not be found again. Creating requires:

  • a key with Write,
  • a hardware type for the device class, under Mappings,
  • Scope of new objects, by default HwComputer. It applies to all new objects of the connection, so map only hardware types of this scope. A server type, for example, has its own scope in Docusnap365,
  • optionally a site from the mapping of the location, and Platform of new objects.

The serial number, the label and the note Created by NetLock RMM are the only data sent. Nothing is deleted, even when a device is removed. A serial number that exists with different case counts as ambiguous: no link, and no second object.

Refused: If Docusnap365 refuses to create an object, for example because the key lacks Write or the scope does not fit, creating stops for the whole run. The device waits a week, the others a day, and the Log tab shows the refusal.

Unconfirmed: A create request can be sent without NetLock finding the object afterwards: the response names no object and the search finds none, or no response arrives. The object may exist, so NetLock does not create this device again. The device stays on create_unconfirmed, and the Log tab names it. To end this:

  • If the object exists, make sure it is in the organization and carries the serial number of the device. The next check links it.
  • If it does not exist, switch Create objects for devices without a hit off, choose Synchronize now, and switch it on again.

Known limits

  • NetLock treats any unexpected answer as a failure, so a failure is never mistaken for an empty inventory. Status 429 counts as the monthly limit, 401 as an expired key.
  • A location in NetLock is only used when creating.
  • The External systems tab shows the link without a button to open the object.
  • Data flows in one direction only: Docusnap data does not flow into NetLock.