Document statuses
What each Document status means, where you see it, and what to do about it.
A Document status tells you whether data was processed: understood and turned into something else, such as source data into a Document, or a Document into target data. In lists it is shown as the translation status. Whether data was actually delivered is a separate question, answered by the communication status.
Good to know
On the Target Data screen, the Status column only appears if at least one item there has a
status other than Complete.
At a glance
- PendingThe data has arrived and is waiting to be processed. Documents typically spend only a fraction of a second here.
- In progressBeing processed right now. The help centre also calls this status Processing.
- ReadyProcessed successfully, but its Mapping is set to manual, so the Mapping hasn't run. Waiting for someone to process it.
- CompleteProcessed successfully to at least one Map.
- FailedAn error was thrown during processing. There are many possible reasons; the logs say which.
- CancelledOn source data or a Document: information only, the data is no longer in use. On target data: important, because it stops duplicates.
- HeldNot currently in use.
What to do about each status
| Status | Do you need to act? | What to do |
|---|---|---|
Pending | No | Wait. A Document stuck here for a long time is unusual: tell Support. |
In progress | No | Wait. A Document stuck here for a long time is unusual: tell Support. |
Ready | Yes | Review the Document, edit it if needed, then process it to its Mapping. Check for Ready Documents every day if you use manual Mappings. |
Complete | Usually not | If the Document should have gone to more than one place, check there is target data for each, and check each one's communication status. |
Failed | Yes | Open the Document's Logs, read the error, fix the cause (often missing master data) and reprocess. See Reprocess a Document. |
Cancelled on source data or a Document | No | Ignore it. |
Cancelled on target data | Only if you meant to send it | See Cancelled and duplicates below. |
Held | No | Not currently in use. |
Ready and manual Mappings
When you set up a Mapping you can switch its Automatic flag on or off.
- Automatic on: the Mapping runs whenever a Document is created.
- Automatic off (manual): the Document is processed, its status is set to
Ready, and the Mapping doesn't run.
This lets you create and process a Document without sending it, which is useful when someone needs to review a Document before it goes to its Mapping.
Failed
Failed means an error was thrown during processing. The status alone doesn't say why; common causes
include an unrecognised product code, a missing Party, or a pack size with no conversion. Common fixes:
Cancelled and duplicates
Cancelled means different things depending on where you see it.
- On source data or a Document it is purely informational: the data is no longer in use and can be ignored.
- On target data it matters. When you process a Document, Supply Lens checks whether target data
already exists for the same Integration with the same reference. If it does, the processing
fails, so no duplicate is created. The same check is also described as creating the new target
data with the communication status
Cancelled(see Communication statuses). Either way, the outcome is the same: no duplicate is sent.
This fail-safe means you can:
- avoid accidental duplicates;
- bulk reprocess a range of Documents, confident that no duplicates will be created;
- test and reprocess source data quickly without fear of creating target data again.
To send it again on purpose, set the existing target data with the same reference to Cancelled
first, then reprocess. See Resend a Document.
Watch out
Before you resend, check the receiving system really doesn't have the data, or you will create the duplicate the fail-safe was protecting you from.