Skip to content
P4 Software P4 Software / logisticaHQ-en

Add these docs to Claude

Ask Claude questions about these docs. Claude reads the published pages and links you back to them. Copy this address:

https://p4-software.opendocs.page/mcp

In claude.ai or Claude Desktop: open Settings, then Connectors, choose Add custom connector and paste the address.

In Claude Code, run:

claude mcp add --transport http docs https://p4-software.opendocs.page/mcp

Document states

Document states: choose the colour and the name of every state
Setup › System › Document states
Applies to: Release 2.56.23, for administrators

Where to find it

Open the menu Setup › System › Document states. The page is for administrators. If someone who is not an administrator reaches the page (for example by a saved link), the page shows the sentence "Only administrators can change document states." and no editor, and nothing can be changed.

What a state, a colour and "Shows as" are

  • A state is the step a document is in: a pick ticket can be Unallocated, Ready To Pick, Being Picked or Shipped, for example. The software decides which states exist and when a document moves from one to the next. You cannot add, remove or reorder states here.
  • A colour is the colour of the small pill that shows the state in lists, on details screens and in the client portal. You pick one of 40 colours for each state.
  • Shows as is an optional name of your own for the state, for example "Waiting for stock" instead of "Unallocated". It is shown exactly as you typed it, the same in every language, and it replaces the standard name for everyone in your company. Leave it empty to keep the standard name, which is translated into each user's language.

The page, section by section

Header. The small line "Setup · User interface", the title "Document states", a sentence of explanation, and on the right the buttons Discard and Save (administrators only). Both buttons are grey (disabled) while there is nothing to save or while a save is running. When you have changed something, Save shows how many states you changed: "Save · 1 change" or "Save · 3 changes".

List of document types (left). One button per document type with the number of states it has (for example "19 states"). The chosen type is highlighted. Choosing another type does not lose what you changed on the first one: all your changes are one draft until you press Save or Discard. On a narrow screen this list becomes a row of buttons above the table. Below the list a note says: "Every state a document can be in is listed; new states appear here automatically when the software adds them."

Preview. A small grid, "Preview · Pick tickets list", with the columns Number, Customer, State, Lines and Required and four example documents. The State column uses the colours and names of your draft, and it changes at once when you click a colour or type a name, so you see what operators will see before you save. The example documents are made up; they are not your data.

The editor table. One line per state of the chosen type, with these columns:

Column What it shows and does
State The standard name of the state (translated) in bold, and below it the technical name in a small monospaced font.
Shows as A text box for your own name (see "Rules" below). It is empty by default and shows the standard name in grey as a hint. It accepts at most 40 characters; you cannot type more.
Colour A button with a small swatch, the colour name and an arrow. When the colour is not the shipped one it says "· changed". Pressing it opens the colour chooser.
Preview The pill exactly as it will look, with your name if you typed one.
Reset Puts this state back to its shipped colour and an empty name. It is grey and does nothing when the state already looks as shipped.

The colour chooser. A small window under the Colour button. It has two groups of 20 round swatches, each with its own heading: Strong · white text (solid colours with white writing) and Soft · dark text (light tints with dark writing). A note at the bottom says "40 colours in two palettes. Every one is readable on the grid, the Handheld and the portal." The swatch of the current colour has a ring around it. Hover a swatch, or let a screen reader read it, to get the colour name. Click a swatch to choose it: the window closes and the pill, the preview and the Save counter update at once. Press Escape or click anywhere outside to close it without choosing. Only one chooser is open at a time. With the keyboard: the chooser opens with the focus on the current colour, the arrow keys move between swatches (left and right by one, up and down by a row of ten), Home and End jump to the first and last, Space or Enter chooses, and Escape closes it and Returns you to the Colour button.

Reset all to defaults. A small button above the preview, next to the note "Two palettes, strong and soft, 40 colours; every one stays readable on the grid and the Handheld." It puts every state of the chosen type back to its shipped colour and an empty name. It changes the draft only; nothing is saved until you press Save, and Discard undoes it.

Step by step

1. Change a colour

  1. Open Setup > System > Document states.
  2. Choose the document type in the list on the left, for example Pick tickets.
  3. In the line of the state, press its Colour button.
  4. Click one of the 40 swatches. The window closes, the pill and the preview change, and the Save button now says "Save · 1 change".
  5. Press Save. A "Saved" message confirms it.

2. Give a state your own name

  1. Click the "Shows as" box of the state and type the name, for example "Waiting for stock". Spaces at the start and the end are removed.
  2. The pill and the preview show the name at once.
  3. Press Save. To go back to the standard name, empty the box and save again.

3. Put one state back as shipped

  1. Press Reset at the end of the state's line. The colour and name go back to the shipped ones in the draft.
  2. Press Save to keep it, or Discard to undo the reset.

4. Put a whole document type back as shipped

  1. Choose the type on the left and press "Reset all to defaults". Only that type is affected.
  2. Press Save to keep it, or Discard to undo it.

5. Throw away what you changed

  1. Press Discard (top right). Every unsaved change, in every document type, goes away and the page shows what is saved.

6. Save

  1. Press Save. The button counts the states that differ from what is saved, in all document types.
  2. When it finishes, the "Saved" message appears and your own screens use the new colours and names at once. Other people see them the next time they sign in or reload the page.
  3. If something is refused, a message in plain words says what to fix, and your changes stay on the page so nothing you typed is lost.

If you leave the page (a menu click, a link or the browser's Back button) with unsaved changes, a question appears: "Discard unsaved changes?" with the buttons "Discard changes" and "Keep editing". Closing the browser tab also asks before it closes.

The document types, their states and the colour each state has when shipped

Until you change something, every state has the colour it had before this page existed. "Technical name" is what you see under the state in the editor. The table lists the states in the order the software uses.

Pick tickets (19 states)

Technical name Meaning Shipped colour
Draft The order is being prepared and has not been released yet. Grey
Unallocated Released, but no stock has been reserved for it yet. Orange
HeldShort There was not enough stock for every line, so the order is held short. Red
PendingLetdown Waiting for stock to be let down from a pallet position to the pick bin. Olive
PendingProduction Waiting for a production order that makes part of the order. Brown
PendingPacksizeBreakdown Waiting for a pack to be broken down into smaller packs. Brown
ReadyToPick Stock is reserved and the order can be picked. Blue
Waved The order is part of a wave that has been released to the floor. Indigo
BeingPicked Pickers are working on the order. Sky
Rating Picking is finished; the order is being rated with the carrier before it ships. Green
Suspended Someone put the order on hold. Crimson
PendingShipCount Waiting for the count that is taken before the order ships. Teal
PendingDriverSignature Waiting for the driver to sign. Cyan
Shipped The order has left the Warehouse. Dark green
PendingDeliveryCount Waiting for the Delivery count. Teal
PendingDeliverySignature Waiting for the customer to sign for the Delivery. Cyan
Closed The order is finished and closed. Slate
PendingQc Picked, but the quality-control workflow has not released every tote yet. Purple
QcHold At least one tote ended on a Hold result and waits for a supervisor. Red

Purchase orders (5 states)

Technical name Meaning Shipped colour
Draft Being prepared; not sent to the vendor. Grey
NotReceived Open; nothing has arrived yet. Blue
PartiallyReceived Some of the quantity has arrived, some is still to come. Orange
Received Everything ordered has been received. Green
Closed Finished and closed. Slate

Returns (5 states)

Technical name Meaning Shipped colour
Draft Being prepared. Grey
NotReceived Authorised; the goods have not arrived yet. Blue
PartiallyReceived Some of the goods have arrived. Orange
Received All the goods have been received. Green
Closed Finished and closed. Slate

Truck loads (6 states)

Technical name Meaning Shipped colour
Draft The load is being prepared. Grey
Consolidating Orders are being gathered onto the load. Blue
Staging The load is staged at the dock, waiting to be loaded. Blue
PendingShipperSignature Waiting for the shipper to sign. Orange
PendingCarrierSignature Waiting for the carrier to sign. Orange
Shipped The load has left. Green

Production orders (12 states)

Technical name Meaning Shipped colour
Draft Being prepared. Grey
Unallocated Released, but its components are not reserved yet. Orange
HeldShort Not enough components for the order. Red
PendingLetdown Waiting for a letdown of components. Orange
PendingPacksizeBreakdown Waiting for a pack breakdown. Orange
ReadyToPick Components are reserved and can be picked. Blue
BeingPicked Components are being picked. Blue
ReadyForProduction Components are at the production area. Blue
InProduction The product is being made. Blue
Completed Production is finished. Green
Closed Finished and closed. Grey
Suspended Put on hold. Red

Kits (9 states)

Technical name Meaning Shipped colour
Draft No contents defined yet. Grey
Ready Stocked and available for dispatch. Green
ReadyShort Closed short on purpose (a line skipped at refill or a unit pulled) and put away; it can be dispatched after you confirm. Orange
PendingDispatch The pick ticket was created; not shipped yet. Blue
AtHospital Shipped; waiting for the tray to come back. Blue
BeingCounted Return Receiving has started. Blue
PendingReconcile The count is complete; the consumption is not reconciled yet. Orange
InRefill Reconciled; being topped back up to its Bill of materials. Blue
Inactive Deactivated. Grey

Kit cases (4 states)

Technical name Meaning Shipped colour
Booked The case is booked. Blue
Dispatched The kit has been sent for the case. Blue
Completed The case is finished. Green
Cancelled The case was cancelled. Grey

The two palettes and the 40 colours

Strong colours are solid with white text; Soft colours are light tints with dark text of the same family. Every one of the 40 pairs has a contrast ratio of at least 4.5 to 1 (the WCAG AA level), so the text is readable on every screen; you cannot pick an unreadable combination because the 40 pairs are fixed. A pill looks the same in the light and the dark theme.

Strong · white text (20)

Colour Background Text
Grey #616161 #ffffff
Blue #1565c0 #ffffff
Orange #bf360c #ffffff
Green #2e7d32 #ffffff
Red #c62828 #ffffff
Crimson #ad1457 #ffffff
Pink #c2185b #ffffff
Purple #7b1fa2 #ffffff
Violet #512da8 #ffffff
Indigo #303f9f #ffffff
Navy #1a237e #ffffff
Sky #0277bd #ffffff
Cyan #00838f #ffffff
Teal #00695c #ffffff
Dark green #1b5e20 #ffffff
Lime #33691e #ffffff
Olive #827717 #ffffff
Brown #5d4037 #ffffff
Slate #37474f #ffffff
Black #212121 #ffffff

Soft · dark text (20)

Colour Background Text
Soft grey #f0f0f0 #424242
Soft blue #ebf3fc #0f548c
Soft amber #fff4ce #8a3707
Soft green #f1faf1 #0e700e
Soft red #fdf3f4 #b10e1c
Soft slate #e9edf2 #334155
Soft sky #e0f2fe #075985
Soft teal #ccfbf1 #115e59
Soft cyan #cffafe #155e75
Soft lime #ecfccb #3f6212
Soft yellow #fef9c3 #713f12
Soft orange #ffedd5 #9a3412
Soft rose #ffe4e6 #9f1239
Soft pink #fce7f3 #9d174d
Soft fuchsia #fae8ff #86198f
Soft purple #f3e8ff #6b21a8
Soft violet #ede9fe #5b21b6
Soft indigo #e0e7ff #3730a3
Soft brown #efebe9 #5d4037
Soft olive #f1f5e9 #4d5e1e

Where the changes show up

  • Lists: the State column of Pick tickets, Truck loads, Master truck loads, Returns, Production orders, Kits, Kit expiry and Kit cases (and the state in the pick ticket drawer, the Totes list and the Purchase orders list and preview).
  • Details screens: the state pill at the top of Pick ticket details (it is now a coloured pill beside the existing words), the State row of the details of Production orders, Truck loads, Returns, kits and Purchase orders, and the purchase order status hero.
  • Order matrix: the names of the States on the row and column headings use your names.
  • Kit list: the "Tray states" help (the question mark) uses your names.
  • The client portal: the status of orders and of inbound orders uses the same colours and names. As part of this change the portal status is also translated into the user's language; before, it showed the raw word such as "BeingPicked".

The colours and names are read once when a person signs in or loads the page. Your own session shows what you saved at once. Everyone else sees it the next time they sign in or reload the page; screens already open in their browser keep the old look until then. While the page is still loading, screens use the shipped colours, so nothing flashes or breaks.

The old "CSS styles" box

Configuration used to have a box called "CSS styles for document state indicators". It never did anything: no screen read it. It has been removed, together with any text that had been typed into it. Use this page instead.

Rules

  • The name you type is shown exactly as typed, the same in every language. It is never translated.
  • The name has at most 40 characters. Spaces at the start and the end are removed. An empty or blank box means "keep the standard name".
  • Colour and name apply to everyone in your company, in every language.
  • Only the states that differ from the shipped look are stored. Putting a state back to its shipped colour with an empty name removes its entry.
  • When a later version of the software adds a state, it appears on this page by itself with a neutral grey colour and its standard name, until you change it.
  • The server checks the whole save first. If anything is wrong nothing is saved.
  • Only administrators can save.

What is not covered

  • LTL loads, QC inspections, client Invoices, the Print queue and the history screens keep their own fixed colours; they are not document states of the seven types above.
  • Attention tiles and counters on the Warehouse overview (for example the red and amber tiles), the kit case Calendar bars and the flow stages of the Overview are not document-state pills and keep their colours.
  • The Handheld app is a separate application. This release does not change it.

Troubleshooting

What you see What it means and what to do
The Document states entry is not in my menu. Only administrators see it. Ask an administrator, or ask for your user type to be changed.
The page says only administrators can change document states. Your user is not an administrator. Nothing can be changed from this account.
Save is grey. There is nothing to save, or a save is running. Change a colour or a name first.
A red message appears after Save. The server refused the save and said why in plain words (for example a name longer than 40 characters, which the box does not allow, or a state that no longer exists). Your changes are still on the page; fix the point and save again. If the message says only administrators can change document states, sign in as an administrator.
I saved, but another screen or another person still shows the old colour. Reload the page. The colours are read when the page loads or the person signs in.
A state is shown with a grey pill and its standard name. That is the neutral default of a state this page has not changed.
I typed a name but Users in another language see the standard name. The name is shown exactly as typed in every language. If you still see the standard name, the name was not saved: look at the Save counter and press Save.
I want everything back as it was. Choose each type and press "Reset all to defaults", then Save.

Was this page helpful?