Document Error Codes

When documents cannot be fully processed by Routty, they become available in an error queue and get assigned a document error code. When issues have be diagnosed and a resolution has been found, implementation partners or tenants can manually request a reprocessing of the document by Routty.

The following document error types are supported by Routty:

Document error type	Description	Location	By default assigned to
`BusinessPartnerNotFound`	`A matching business partner could not be found in the database.`	During the determination process when trying to determine the business partner of the document	Partner
`BusinessPartnerNotFoundForEnrichment`	`A businessPartner with id '{businessPartnerId}' could not be found for document enrichment.`	This should probably never happen as this would be caught be the above `BusinessPartnerNotFound` document error.	Partner
`CompanyNotFound`	`A matching company could not be found in the database.`	During the determination process when trying to determine the company of the document	Admin
`CompanyNotFoundForEnrichment`	`A company with id '{companyId}' could not be found for document enrichment.`	This should probably never happen as this would be caught be the above `CompanyNotFound` document error.	Partner
`ConnectorConfigurationIsDisabled`	`The connector configuration '{connectorConfigurationName}' for connector '{connectorName}' ,which was used to upload this document, is disabled.`	During the determination flow, we will verify whether the connector configuration used to upload the document is disabled. If it is, this document error is created.	Partner
`ConnectorNotFound`	`A connector with id '{connectorId.ToString()}' could not be found.`	This should probably never happen as an unknown connector will not be able to upload documents.	Admin
`DocumentMetadataNotFound`	`The document metadata could not be found.`	This should probably never happen as a document can only be uploaded after the document metadata (a first version of it) was created.	Admin or Partner
`DocumentNotFound`	`The document could not be found.`	At the start of the document processing, we will retrieve the document (XML) based on the document URL. This should probably never happen as the document processing is triggered by the upload of a document which means the processing will only be done for documents (XMLs) that are available in our storage	Admin
`DocumentTypeHasNoBusinessPartnerType`	`The document type '{documentTypeName}' has no business partner type associated with it. Please update the document type with a business partner type.`	During non masterdata enrichment, a document type needs to have a business partner type defined. If it does not, we will throw this error and it is up to the admin to set the correct type.	Admin
`DocumentTypeMappingNotFound`	`The document type mapping to generate a pdf from the xml was not found.`	During the pdf generation, error thrown if the mapping file specified by the document type is not found.	Admin
`DocumentTypeNotFoundForDocument`	`The document type was not found for this document.`	During either pdf generation or non masterdata enrichment, occurs when the document type identified does not exist anymore. Should never occur.	Admin
`FailedToExtractAttachmentsDocument`	`Something went wrong while extracting the attachments for this document. Please contact admin if the issue persists.`	During attachment extraction, this error is a generic catch for unforeseen errors during processing of the attachments.	Admin
`FailedToGeneratePdf`	`Something went wrong while generating a pdf for this document. Please contact admin if the issue persists.`	During pdf generation, this error is a generic catch for unforeseen errors during the transformation to pdf.	Admin
`FailedToStoreGeneratedPdf`	`Something went wrong while storing the generated pdf. Please contact admin if the issue persists.`	During pdf generation, occurs when the created pdf was not able to be saved to the storage for some reason.	Admin
`GenericEnrichmentError`	`Something went wrong while enriching the document.`	During enrichment (adding company and business partner to the XML). Any unforeseen errors will be caught by this error.	Partner
`IncompleteDocumentMetaDataForEnrichment`	`The document metadata is missing data ({string.Join(',', missingDataList)}) for enrichment.`	During the enrichment of a document (adding company and business partner to the XML), we require that the route, company and business partner are known for that document. This should probably never happen as another document error will be given when either of the required entities could not be determined.	Partner
`IncompleteDocumentMetaDataForNonMasterDataEnrichment`	`The document metadata is missing data ({string.Join(',', missingDataList)}) for non master data enrichment.`	If the metadata does not contain necessary data to perform non master data enrichment, we create this error. This should not occurs since this step is called after previous steps successfully determine all the necessary data.	Admin
`InvalidXml`	`The xml inside this document is invalid: '{message}'`	When reading the XML, if an error occurs, this document error will be created.	Admin
`NoMatchingFormatFound`	`A matching format could not be found.`	During the determination process when trying to determine the format of the document	Admin
`NoSupportedFormatsFound`	`Connector with id '{connectorId.ToString()}' does not have any supported formats.`	This error will be created if the connector used to upload the document does not have any supported formats.	Admin
`ParameterIsRequired`	`The parameter {parameterName} is required.`	Multiple locations	Admin
`RouteNotFound`	`A matching route could not be found in the database.`	No route could be found based on the information in the XML (eg. company, business partner, …	Admin
`TenantIsDisabled`	`The tenant {tenantName} identified in the document is disabled. Documents will not get fully processed.`	After the company determination, if the tenant linked to this company is disabled, this error will be created.	Partner
`TenantNotFound`	`The tenant with id {tenantId} identified in the document is not found.`	During business partner determination, if the tenant is not found in the database, this error is created. Should not happen since the tenant is successfully identified in a previous step.	Partner
`TransformedInputDocumentNotAvailableDocument`	`The transformed input document is not available.`	During non master data enrichment, this errors occurs if the transformed input document can not be found. Should not occur.	Admin
`UnhandledDocument`	`The document was unhandled by Routty. Try reprocessing.`	This error is a catch all for any unhandled errors we might encounter during processing that we didn’t catch at the time of processing. Some document might be stuck in the processing state somewhere along the flow, after 24 hours, the document is automatically marked in error with this error.	Admin

In addition to the document errors in the above table, there are also ‘dynamic’ document errors based on the feedback from the connectors. Currently no validation is done on this error input from connectors as Routty does not know which type or description the connectors will use.