All documents that are processed in Link will have a status. The status will automatically change as the document passes through Link, and it is important to have a good understanding of what the individual states mean.
This section goes through each of the built-in statuses in Link. Note that it is also possible to introduce custom statuses - this is an advanced topic that is further described in the “Developer” section of this documentation.
Inbox
The document has been received, is placed in the Link Inbox queue from which it will be picked up and processed.
Initialize
The document has been received and Link is now working on sorting out the basic context information e.g. sender, receiver, document type etc. This is necessary to determine the future path through Link.
Processing
Document has been picked up by Link and is being processed. It has not yet been delivered.
Batching
Sometimes multiple documents need to be merged into one big file - this is called a batch. This status indicates that the document is currently in the process of being added to a batch, which has not yet been sent.
AwaitingConfirmation
The document has been delivered, but Link is waiting for a control message from the receiving system or an acknowledgement that the message has been received. This status will only appear if the option “Expect acknowledgement” has been selected on the documents distribution.
Failed
The document has encountered some kind of error during the flow. Link will have given the document an error code and the assigned stakeholder is notified. You can read more about error codes and stakeholder in the Error Handling section.
Ignored
This status is put on a document if a user has selected it and pressed the button “Manually handle”. Link will do nothing further with the document.
Ready for test
This status is indicating that the received document was marked with a test flag. In this case Link will not process the document as normally. The idea is to be able to receive test documents in a production system and then work with them manually to ensure everything works as expected.
Some document formats (e.g. EDIFACT) supports this possibility while others don’t.
Outbox
The “Outbox” status shows that the document has been successfully processed, placed in the “Outbox”-queue and is now ready to be sent to the receiver via an asynchronous transport type.
This could be one of the native transport types (e.g. SFTP), but it is also a common scenario that companies choose to let systems pick messages from the outbox-queue via the REST API.
Completed
The document has been successfully delivered to the intended receiver. Link will do nothing further with the document.