Work Instructions

Last updated

License feature: Work Instructions

Monitor > Work Instructions opens Work Instructions ("Step-by-step operator instructions and sign-offs"). Tabs: Instructions, New (reads Edit while editing) and Sign-offs.

Note: Operators record sign-offs on the Sign-offs tab. The Work Instruction dashboard widget shows the step titles; media is only visible in the editor.

Create an instruction

1. On Instructions, click New Instruction (or open New). The title is New Instruction.
2. Enter Name (required), Part Number and Description.
3. Click Add Step for each step and fill in the fields below.
4. Click Create Instruction (disabled until Name is filled).

Step field	Meaning	Default
Title	"Step title..."	empty
Content	The instruction text ("Step instructions..."), plain text	empty
Media Type	None, Image, Video, PDF, Document	None
Est. Minutes	Expected time for the step	0
Media File	Appears when a media type is chosen; Browse picks a file from the File Manager or uploads one	none
Requires Sign-off	Flags the step as needing a sign-off	off

Steps are numbered in order (Step 1, Step 2 …). The up and down arrows on a step move it; the X removes it. To insert a step, add it at the end and move it up.

Warning: Sign-offs are stored by step position. After you move or remove a step, earlier sign-offs show against whichever step is now in that position. Each sign-off also records the step's title and the instruction version at the time, and moving steps raises the version, so the record itself stays accurate.

Media

• Browse opens a small file browser of the File Manager: folders, files with sizes, a Root breadcrumb, and Upload (images, video, PDF, .txt, .json, .html, .css).
• The step stores the file's path (folder names and file name). A preview appears: images and mp4/webm/ogg video inline, PDFs and others as a link.
• If the file is later renamed, moved or deleted in the File Manager, the step keeps the old path and the preview breaks.
• The Media Type does not have to match the file; the preview is chosen from the file extension.
• Clear (X) removes the file from the step.

Editing and versions

• Click the pencil on an instruction; the title shows Edit Instruction (Version n). Click Save Changes.
• The version goes up by 1 only when steps change. Name, part number and description don't change it.
• Old versions are not kept; the audit log records who changed what.
• Enabled in the editor, or clicking the Enabled/Disabled badge in the list, switches an instruction on or off. A disabled instruction stays in the list but its steps can't be signed off on the Sign-offs tab. The list's Status filter (All, Enabled, Disabled) filters on it.
• Delete with the trash icon ("Delete instruction "{name}"?"). Sign-off records are deleted with it; their electronic signatures, if any, stay in the audit trail.

Creating, editing, enabling, reordering and deleting needs editor or admin; operators and viewers don't see those controls.

Sign-offs

1. Open the Sign-offs tab and choose an Instruction ("— Select Instruction —").
2. Choose the Work Order the job is running under, or leave "— None —". The list and table then show that work order's sign-offs only; with "— None —" they show all of them. (The picker is hidden when Work Orders is switched off.)
3. Each step is listed with its content. A step marked Requires Sign-off has a Sign off button until it is signed; the sign-off then shows as "Signed off by {name} at {time}" with its meaning (Performed and verified) when it was signed electronically.
4. Click Sign off, optionally type Notes ("Torque verified 1.8 N·m"), and click Confirm sign-off.
5. When an admin has made Sign off a work instruction step a signed action, the Electronic signature box opens: enter your password (and your user ID or a reason when asked) and click Sign. See Electronic signatures.

Below the steps, the table shows every sign-off: Step #, Signed By, Signed At, Meaning, Version (the instruction version it was signed against), Notes and Signature (the electronic signature's number). Empty: "No sign-offs recorded".

Signing off needs operator, editor or admin; viewers see the steps and records but no button.

The appliance checks every sign-off, from the page or the API:

• the step exists and is marked Requires Sign-off, and the instruction is enabled;
• the work order, if given, exists, is not canceled, and has not been released or rejected;
• the step has not already been signed for this instruction version and work order (or for no work order). A sign-off against an older version shows greyed with Signed against v2; this is v3, and the step can be signed again for the current version.

Each sign-off records the signer's printed name, the instruction version and the step's title as they were, so it still reads correctly after the steps are edited or the account is deleted.

You can also post sign-offs from the API — for example from a custom page you build for the line:

POST /api/work-instructions/7/signoffs
Content-Type: application/json

{ "stepIndex": 2, "workOrderId": 12, "notes": "Torque verified 1.8 N·m" }

• stepIndex is zero-based: 2 is Step 3 on screen.
• The signer is the signed-in user; operator, editor or admin.
• The checks above apply. When sign-offs are signed, add "signature": { "password": "…" } (see Electronic signatures).
• Deleting a sign-off record needs admin and lets the step be signed again. The deletion is logged with who signed it and when; its electronic signature stays in the audit trail. Sign-offs of a released or rejected work order cannot be deleted.

Example

Name Capper head change – 28 mm, Part Number BTL-500:

1. "Lock out the capper" — Requires Sign-off, 5 min, Image SOP/capper-loto.png.
2. "Swap chuck heads" — 10 min, Video SOP/chuck-swap.mp4.
3. "Verify cap torque on 5 bottles" — Requires Sign-off, 5 min, PDF SOP/torque-check.pdf.

REST endpoints

Method	Path	Purpose	Role
GET	/api/work-instructions	List; partNumber, enabled, search	viewer
GET	/api/work-instructions/:id	One instruction with steps	viewer
POST	/api/work-instructions	Create: name required, description, partNumber, steps, enabled	editor
PUT	/api/work-instructions/:id	Update	editor
DELETE	/api/work-instructions/:id	Delete	editor
GET	/api/work-instructions/:id/signoffs	Sign-offs; optional workOrderId	viewer
POST	/api/work-instructions/:id/signoffs	Record a sign-off: stepIndex required, workOrderId, notes, signature when signed	operator
DELETE	/api/work-instructions/signoffs/:signoffId	Delete a sign-off	admin

Troubleshooting

Message or symptom	Cause	Fix
"Instruction name is required"	No name	Enter a name.
"stepIndex is required"	Sign-off without a step	Send stepIndex.
"Step N does not exist…" / "Step N does not require a sign-off"	Wrong stepIndex (it is zero-based), or the step is not marked	Check the step number; tick Requires Sign-off on the step.
"Step N was already signed off… by … at …"	That step is signed for this version and work order	Nothing to do; an admin can delete the sign-off if it was a mistake.
"This work instruction is disabled…"	The instruction is switched off	Enable it.
"Work order X has been released; its record is locked"	The work order's batch record is closed	Sign-offs can no longer be added or removed for it.
"Work instruction not found"	Wrong id or deleted	List instructions for ids.
Media preview broken	File moved or renamed in File Manager	Browse and pick the file again.
No Sign off button	The step doesn't require sign-off, the instruction is disabled, or you're a viewer	Tick Requires Sign-off on the step, enable the instruction, or sign in as an operator.

See also

• MES Overview: Work Orders, Recipes and Instructions
• File Manager
• Production Dashboard Widgets
• Work Orders