Writing back to Plex

Updated Nov 14, 2026
Shop Floor

Writing back to Plex

How Shop Floor sends status changes and scrap bookings into Plex, and how to check what Plex did with each one.

Permissions: All of this needs the tenant's Shop Floor license. Anyone with DataMagik - Shop Floor Viewer, DataMagik - Maintenance or DataMagik - Shop Floor Admin can open the Write Outbox at /shop-floor/settings/write-outbox and can explain an hour from a board with Change status in Plex. Only DataMagik - Shop Floor Admin can book scrap, retry a write, stop a write, change approval settings or manage Operators. DataMagik - Builder and DataMagik - Viewer give no Shop Floor access. If the Shop Floor license lapses, queued writes are not sent.

How a write travels

Shop Floor never writes to Plex while you wait. Every write is stored in the outbox first and then sent in the background:

  1. You submit something, such as an explanation for an hour or a scrap booking. Shop Floor checks it and stores it as a write.
  2. If approval is required, the write waits for an approver and nothing is sent until someone approves it. Otherwise it is queued.
  3. A background sender picks up a queued write straight away when you submit it, or when it is approved or retried. It also checks the outbox regularly in case anything was missed. It checks the plant's rules again, then sends the write to Plex.
  4. Plex's answer is recorded on the write and shown in the outbox. If Plex never answered, the outbox says that too.

A status write is recorded in Plex against the person who made it, if that person is listed under Operators. Otherwise Plex records it against its automated account.

Submitting the same thing twice, for example by tapping twice, returns the original write and sends nothing extra. A corrected entry, such as a different status or quantity, counts as a new write.

Writes that come from a machine, set up with the Status writeback, Production booking and Scrap booking opt-ins on the Tag Map, go through the same outbox. See PLC mapping.

Just before a write is sent, the sender runs any transaction hooks your company has set up: your own scripts that can stop the write, change its description or booking, or start work once Plex has accepted it. A Shop Floor Admin sets them up under Setup → Data → Transaction hooks. Shop Floor's send-time plant rules are checked after the hooks. See Transaction hooks on the shop floor.

Explaining an hour from a board

On the Hour by Hour board, an hour that fell behind target, or has no target, shows an Explain button. The Active Issues screen shows the same button for each machine with an hour nobody has explained yet. Both buttons open the same dialog, Explain this hour, which has three tabs under What kind of loss.

On the Downtime tab:

  1. Choose a Status. This is required. You can also choose an Event and a Detail reason. All three lists come from your own Plex.
  2. Type under What happened, or hold Hold to talk and speak. The transcript appears in the box so you can check and correct it before saving. The audio is not stored.
  3. Press Change status in Plex. The dialog then shows the result: queued, held for approval, already submitted, or refused.

Caution: Plex cannot annotate a past hour. The dialog warns This changes what … is doing RIGHT NOW. When the write is sent, it ends the machine's current status in Plex and opens a new log entry stamped at that moment. The hour you picked, and your event and detail reason, are kept in Shop Floor against that hour. The detail reason is sent to Plex with the status change, and its name also travels in the note.

A status change is refused before it is sent if the workcenter is disabled in Shop Floor, the status is unknown or inactive, the event is not valid for that status, or no operator is clocked in. The dialog and the Write Outbox name the same causes.

If the status requires a logged-in operator in Plex, that is checked when the write is sent, not when you submit it. If nobody is clocked in at that workcenter at that point, the write is refused. If Shop Floor cannot reach Plex to check, the write is sent anyway. Plex only counts someone clocked in at that workcenter, not elsewhere in the plant.

The Performance tab lists the plant's performance reasons for reference only. Picking one records nothing.

Booking scrap

The Scrap tab books lost parts against a container in Plex. Everyone who can explain an hour sees this tab, but only a Shop Floor Admin can press Book scrap. For anyone else, the booking is refused.

To book scrap:

  1. Choose a Scrap reason. Only active reasons from the location's synced scrap reason list are offered.
  2. Enter the Quantity (parts).
  3. Pick from Container loaded at this machine. If the container is not listed, choose Other serial… and type it into Serial number (not on the list). Shop Floor checks that Plex has a container with that serial before queuing anything.
  4. Optionally add a note, then press Book scrap.

Caution: Booking scrap takes these parts off a container in Plex, and it cannot be undone from this screen. The confirmation repeats the quantity, container and reason, so check it.

Approval

You can hold writes until a person approves them. A held write waits in the outbox as Pending approval and nothing reaches Plex until someone decides it. Approving it queues the write to be sent. Rejecting it cancels the write, and nothing is sent.

A write is held if its workcenter or its status needs approval. Production a person reports is always held. Production counted by a machine is held only if its workcenter or status needs approval.

Set up approval

  1. Choose who approves. Under Locations, open the location's card, pick a role in Write-approval role and save. The list shows your company's roles. Members of that role decide held writes in the approvals inbox. Until a role is chosen, the field reads None (approval cannot be turned on), and approval cannot be switched on for that location.
  2. Hold writes to a machine. On the Write Outbox, under Approval before writing, tick a workcenter to hold every status write to it until a person approves it.
  3. Hold a status everywhere. Under Approval before writing, by status, tick a status to hold every write that sets it, on any workcenter at the location. Use it for a status that is sensitive wherever it happens. If the list is empty, press Sync status tree on the location's card under Locations first.

Each box saves as you change it, and the page says what changed. Unticking a box sends future writes straight to the queue, but writes already held stay held until someone decides them.

Make sure someone is watching: a held write sends nothing until it is decided. While any workcenter or status at a location still needs approval, you cannot set its Write-approval role back to none, so a held write always has someone to decide it.

The Write Outbox

The outbox lists the 200 most recent writes for one location, newest first. Use Location to switch locations and State to filter. Tiles at the top count Writes, Sent, Rejected, Failed, Blocked and Awaiting, and a line below them summarizes what went wrong. Each row shows When, Workcenter, Status asked for (or the kind of write, for scrap and production), State and Submitted by. Under the row you'll find Plex's own answer, your note, the Plex log entry, the number of attempts and when the write was sent.

  • Queued: waiting for the sender. Sending: in flight now.
  • Awaiting approval: held for a person. Nothing has been sent.
  • Sent: Plex accepted the write.
  • Rejected by Plex: Plex refused the write, or a plant rule checked at send time refused it. The reason is shown in the row.
  • Stopped by a hook: one of your transaction hooks stopped the write before it was sent, or a required hook's script failed. The row shows why. The Rejected filter includes these.
  • Plex not reached (the Failed to reach Plex filter): a timeout, server error or similar. Nothing was decided.
  • Blocked here: Shop Floor refused the write before sending it, or someone stopped it.
  • Cancelled: an approver rejected the write.

Fixing failures

  • Plex not reached: once Plex is reachable again, a Shop Floor Admin presses Retry on the row. Shop Floor never retries a failed write automatically.
  • Rejected by Plex: there is no Retry, because asking again gets the same answer. Fix what Plex's message describes, then submit a new write.
  • Stopped by a hook: there is no Retry either. Press Test on the hook under Setup → Data → Transaction hooks to see why it stopped the write, fix the write or the script, then submit a new write.
  • Blocked here: the message names the fix. For example, the workcenter is disabled in Shop Floor, the status is unknown or inactive (press Sync status tree on the location's card under Locations), the event is not valid for that status, or no operator is clocked in. Fix it and submit again.
  • To stop a Queued write before it is sent, a Shop Floor Admin presses Stop and confirms. Nothing reaches Plex, but the stop cannot be undone. To send it later, submit it again. A write that is Awaiting approval is stopped by rejecting its approval.

Writes that are Failed or Blocked from the last seven days also appear on the Active Issues screen, so the floor sees them without opening the outbox.

Operators

The Operators section at the bottom of the Write Outbox lists who each person at the location is in your Plex. It is marked Beta, and only a Shop Floor Admin sees it. Once a person is listed, the status writes they make are recorded in Plex against them rather than Plex's automated account.

To add a person:

  1. Choose the location with Location at the top of the Write Outbox.
  2. Under Add a person, pick a DataMagik user (optional), enter a Badge number, or both. A row needs at least one of them.
  3. Enter the Name shown at a machine and the person's Plexus user number, which is their user number in Plex. The Plexus user number is required and must be a whole number above zero.
  4. Optionally add a Note, then press Save person.

The list under People at this location shows each person's badge, Plexus user number and whether they have a DataMagik login. Use Edit to change a row. You cannot change who a row is for while editing it. To change that, delete the row and add it again. Delete asks you to confirm. After that, the person's writes go back to Plex's automated account.

Each person can also have a PIN. Use Set PIN, Change PIN or Clear PIN. A PIN needs at least 4 characters. A PIN is never shown, only PIN set or No PIN.

Related

Was this page helpful?