Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

When a document is processed in Link, it is important to understand that it can be in different states, and it is also 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.

Typically, the document status is used in tracking scenarios (e.g. you could perform a document search for all documents with status “Failed”).

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.This list is organized in logical order in relation to a document’s journey through the Link engine.

Inbox

The document has been received, is placed in the Link Inbox queue from which it will be picked up and processed.

...

Document has been picked up by Link , but and is being processed. It has not yet been delivered.

...

Sometimes multiple documents need to be merged into one big file - this is called a batch. This status indicates that the document is currently being created as a batchin the process of being added to a batch, which has not yet been sent.

Awaiting Control

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 [TODO: INSERT LINK TO “Error handling”] section.

Ignored

The document has been manually handledThis 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

Document will have this state if it has a test flag. TODO: DESCRIBE

OutboxThe document has been delivered to an internal server at Bizbrains.

TODO: DESCRIBE

Testbox

TODO: SHOULD THIS BE HERE?

Completed

The document has been successfully delivered to the intended receiver.

Stakeholder

This dropdown contains all the stakeholders in your Link solution. If you know the stakeholder responsible for handling the error, you can input it hereLink will do nothing further with the document.