Skip to main content

Commissioning Log

Part of: Integrating Tagnet with Your Systems — where each API-created batch of inventory landed, and what to do about the rows that failed

Commissioning is the generic way your systems add inventory to Tagnet through the API and link it to RFID tags. Whenever an integration calls the commission endpoint, whether that is a print station registering new labels, a receiving system creating asset records, or a script backfilling a catalog, Tagnet records the call as a commission batch. The Commissioning Log is where you go to answer "did last night's integration run work?" without calling the API or searching server logs.

What a batch is​

A batch is one call to the commission API. It has a batch key, the idempotency key your integration chose (an order id, a job id, a work order number), and a set of rows, one per item the call tried to create. Each row resolves independently: some rows can commission successfully while others fail, and the batch as a whole is Completed, Partially completed, or Failed depending on the mix.

For the exact API behavior, idempotency rules, and how an integration should recover from a partial failure, see Commissioning Reliability and Retry Handling. This guide covers reading the results in the UI.

What an attempt is​

A batch key is not always one batch. If every row in a call fails, the key stays retryable: the integration can resend the same key with corrected data, and that resend becomes a new attempt under the same key. The Attempt column on the list, and the attempt number on the detail page, tell you which try you are looking at.

The moment an attempt commissions at least one row, the key locks. Resending it after that replays the stored result instead of trying again, so a batch key with committed inventory behind it cannot be retried into a different outcome. This means a batch key with several attempts tells its own story: one or more failed tries, followed by the attempt that finally got through (or is still failing).

Finding a batch​

Open the Commissioning Log tab of the Integrations page (/integrations/commissioning). It sits beside the outbox: the outbox shows what Tagnet sends out, and the log shows what integrations bring in. The list shows one row per attempt, newest first, with the batch key, attempt number, status, row counts, and when it was created.

Use the search box to find a batch by partial batch key, for example the order or job id your integration used. The filter drawer narrows the list further:

FilterWhat it does
StatusShow only Completed, Partially completed, or Failed batches
Access ScopeShown to admins and users with more than one scope; narrows to a single site or department
CreatedA from/to date range on when the batch was submitted

The app-wide site filter in the header also applies here, the same way it does on Inventory and other list pages, so switching sites narrows the batch list along with everything else.

Reading the detail page​

Click a row to open the batch. The Batch section summarizes the outcome:

FieldMeaning
Batch keyThe idempotency key the integration chose, such as an order or job id
AttemptWhich attempt of this batch key you are viewing
StatusThe batch's aggregate result, with a note on what it means: every row commissioned, some rows failed, nothing was commissioned, or retried in a later attempt
SubmittedWhen the call arrived
Rows submittedHow many rows the call submitted
CommissionedHow many rows became live inventory
FailedHow many rows did not; the Rows section below shows why

If the batch key has more than one attempt, an Attempts section lists them oldest first, so a retried batch reads as a timeline: the failed tries, then the one that succeeded (or the latest failure, if it still hasn't). The attempt you are currently viewing is highlighted; the others link to their own pages.

Diagnosing failed rows​

The Rows section lists every row from the batch, in submission order. Use the All, Failed, and Commissioned chips above the table to narrow the view, and the search box to find a specific row by its row ref, item, instance ID, or tag ID.

A failed row is tinted and shows its error message inline, right in the row, so you don't have to open anything to see why it didn't commission. Typical causes are the same ones covered in Commissioning Reliability and Retry Handling: an invalid custom field value, a tag id conflict, or a row that violated its own tagIdSource assertion.

When a row carries stored custom fields or a passthrough payload, an expand arrow on that row reveals both as formatted JSON. This is useful for confirming exactly what your integration sent, especially when a custom field value was the problem.

Following a row to its inventory item, and back​

A commissioned row's Instance ID is a link to the inventory item it created. If that item was later deleted, the row still shows its instance ID and tag ID, marked (deleted), so the batch keeps a full record of what was made even after the item is gone.

The link works in the other direction too. Open any inventory item's detail page: the Basics card shows a Commission batch link back to the batch (and attempt) that created it. This is the fastest way to answer "where did this tag come from?" when you're starting from the item instead of the integration log. The link only appears for users with the View Integrations permission who can read that batch, following the same scope rules as the batch list.

Scope visibility​

Commission batches are access-scope-controlled like other Tagnet data. You only see batches in the access scopes you can view, and opening a batch outside them by its link shows "Commission batch not found." The same batch key can be used in more than one scope; those are separate batches, and a batch's Attempts section only lists the attempts made in its own scope.

Permissions​

The Commissioning Log requires the View Integrations permission. It is meant for the people who build and troubleshoot integrations, rather than for everyone who works with inventory. Today only the Admin role has View Integrations, so other users do not see the Integrations page or this tab.

The Commission batch link on an inventory item follows the same rule: it only appears for users with View Integrations.