Document statuses
Lesson 6 of 17 7 min read
Every Document status explained, with what it means for you and what, if anything, to do next.
A Document's status tells you how far it has got and whether it needs you. In this lesson you will learn every Document status, what causes it and what to do about it, so a glance at a list tells you where your attention is needed.
The statuses
- PendingThe data has arrived and is waiting to be processed. Documents normally spend only a fraction of a second here.
- In progressThe Document is being processed right now. The help centre also calls this Processing.
- ReadyProcessed successfully, but its Mapping is set to manual, so nothing has been sent. It is waiting for someone to process it.
- CompleteProcessed successfully to at least one Mapping.
- FailedAn error was thrown during processing. The logs explain why.
- CancelledOn source data or a Document, purely informational: the data is no longer in use and can be ignored. On target data it matters; see the lesson on duplicate protection.
- HeldDescribed in the help centre as not currently in use.
The ones that need you
Ready: waiting for a person
A Mapping has an Automatic switch. When it is on, the Mapping runs as soon as a Document is
created. When it is off, the Document is processed and then stops at Ready, and the Mapping
does not run.
That is deliberate. It lets someone review a Document, and edit it if needed, before it is sent.
It is useful for a new flow, or for a customer whose orders need checking. The risk is that
Ready Documents are forgotten. If you use manual Mappings, check for Ready Documents every
day.
Failed: something went wrong
An error was thrown while processing. There are many possible reasons: an unrecognised product, a missing party, bad data from the source system. The status alone will not tell you which. Open the Document's Logs, read the error, fix the cause, then reprocess. Module 4 walks through this routine.
The ones that are fine
Completemeans processed to at least one Mapping. If a Document should have gone to two places, check that there is target data for each.PendingandIn progressare brief. A Document that seems stuck in either for a long time is unusual; mention it to Support.Cancelledon a Document or source data is informational and can be ignored.
Priya's morning scan
Priya opens All documents and sorts by status:
- 212
Complete: nothing to do. - 3
Ready: orders for the grocery chain, whose Mapping she keeps manual. She checks each and processes them. - 1
Failed: an order with an unrecognised SKU. She opens the logs and starts fixing it.
Five minutes, and she knows exactly where the day's work is.
Trace shows statuses along the chain
Trace a Document to see the whole chain, from its source data to every target, drawn as a diagram with each record's status. Anything held or failed is highlighted.
Recap
PendingandIn progressare brief;Completemeans processed to at least one Mapping.Readymeans a manual Mapping is waiting for someone to process the Document; check for these daily.Failedmeans an error during processing; read the logs, fix the cause, reprocess.Cancelledon a Document or source data is informational; on target data it matters.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.