ECM Queue

For trouble-free operation of all functionalities, regular checking and/or monitoring of the following components is required in order to be able to respond immediately in case of failure. All pending tasks can be tracked and checked via the archive queue.

images/download/attachments/95838554/ECM_Warteschlange_en.png

The queue must be checked daily, and stopped tasks must be reactivated after the cause has been removed.

Each entry in the queue may have one of the following status:

Status

Meaning

Started

All new entries initially receive the status Started (processing running).

Pending

All queue entries which are set to Pending and Reiterating will be processed by the export service.

Reiterating

After successful storage in the ECM system, cyclic entries will not be set to Saved – Archived, but to Reiterating. They will then be processed again by the export service.

Stored – Archived

The entry was successfully saved in the ECM system.

Stopped

Error while processing.

Finished

The document and the metadata were stored in the file directory without confirmation.

On Hold

Intermediate status, used for purchase invoices, for example.

Example: A sales invoice is posted and entered in the queue for storage/archiving. After creating the PDF sales invoice and outputting it to a directory, the status is set via the New status (after preparation) field in the document definition to On hold. After the sales invoice is signed, a new queue entry is created for the signed invoice, and the status of the original invoice is changed to Subsequent entry (example in the toolbox Codeunit 90012 ARC PDFFaktura).

Link

Will be used in future to store a document in EASY ECM, and then store the link for EASY xShare in Microsoft SharePoint.

The status can be manually switched in the queue via the Queue Work action.

Queue Operations

Although the queue is based on the general Microsoft Dynamics 365 Business Central principle of the journal, the "unposted" entries in the queue are not deleted after being saved in the ECM storage (posting). Therefore, depending on the amount of documents, the queue may soon become very extensive and confusing. It is recommended that you delete all entries which are no longer to be used at regular intervals. Logically, in doing so, the entries that have already been stored are removed.

The Queue Operations dialog facilitates filtering on, or manual selection of, specific queue entries. The most common and therefore default task, Change Status, however, is only one of multiple tasks that can be performed for the queue entries.

images/download/attachments/95838554/ECM_Warteschlange_2_en.png

Tasks

Description

Change Status

This option allows you to change the status manually.

Clear Data

Besides the queue entries, temporary files and data BLOBs can also be deleted by enabling the corresponding control panels (Remove Temp. Files, Clear Data BLOB, Reverse Document Entry). The data can also be deleted by selecting the Clear Data option.

Delete Queue Entries

For security reasons, only entries with the status Stopped, Saved – Archived andFinished can be deleted. When deleting entries with the status Saved – Archived, a check is made on whether an ECM document entry exists. If not, the queue entry will not be deleted, and this will be logged via an entry in the queue details. These entries can only be deleted after changing the status.

Update Metadata Field Values

The Update Metadata Field Values task allows updating metadata in the queue which have changed after creating the queue entry. Only empty fields will be populated, based on the stored document definition.

Reimport PDF Generator

If settings in the PDF Generator Matrix configuration are changed, this will initially have no effect on the queue entries. The Reread PDF Generator task allows updating the queue entries with the current PDF Generator Matrix configurations.

Reimport document definition

This action allows reimporting the document definition used. This is particularly useful when, for example, fields have been ignored or the document definition has been changed for a different reason and the new fields are now also to be transferred to the document entries.

Actions and navigation in the queue

Action

Description

Execute Export Line

Executes export for the selected line if it has the status Pending.

Execute Export for All Lines

Executes export for all lines with the status Pending.

Details

Displays the processing details of the queue entry. You can also glean from the Details, for example, why an archiving operation could not be performed.

Metadata Field Values

Opens an overview of the entry's metadata fields and its field values.

Status

Displays a status overview of the entire queue.

Document Entries

Opens the document entry that belongs to the entry (if available).

Show Document

Opens the archived document for an entry.

A document can only be displayed if it has previously been archived, i.e. set to the status Saved – Archived.

Record

Opens the record in Microsoft Dynamics 365 Business Central to which the queue entry refers.

Default Document Display

If the document has been successfully archived, the document will open according to the user configuration of the default ECM user.

Show First Document

If the queue entry has been used to archive multiple documents, this action will only open the first document of the entry.

Document Details View

Displays all details of the archived document.

Queue message codes

If a queue entry could not be processed correctly, the status of the respective entry is set to "Canceled". The Message Type, Message Code, and Message fields provide information about why the record could not be processed.

Message type

Message code

Message

Troubleshooting

Error

3

There is nothing to store (archive). Record not found.

The record to be archived could not be found. This is the case if, for example, a volatile document (order) has been entered and is intended for archiving, but has been deleted so that it is no longer in the system at the time of archiving. In this case, the queue entry can be deleted.

Error

12

The file to be saved (archived) does not exist.

This error indicates that the BLOB field of the queue entry is empty. This is the case when, for example, the PDF could not be created or the queue entry was subsequently manipulated by clearing the BLOB field.

Error

17

EBIS: An error occurred when writing to the ECM storage.

EBIS (EASY BUSINESS INTERFACE SERVICES) returned an error while processing. The reason why the document could not be processed can be found in the EBIS log or the "Queue Details".

Error

20

The metadata values could not be generated.

If, for instance, mapping codes were used to create certain metadata values, the metadata might not be created due to improper processing.

Error

24

An error occurred while uploading the file.

This message appears when the BitStream of a file could not be completely transferred. This usually occurs only with very large files. The entry must be set to Pending so that the file can be retransmitted.

Error

25

EASY ENTERPRISE: XML server error

The EASY ENTERPRISE XML server returned an error while processing. The reason why the document could not be processed can be read in the log of the XML server or the "Queue Details".

Error

26

EASY ENTERPRISE - Login error: user context not available

No ECM users have been created in Microsoft Dynamics 365 Business Central for the specified ECM server. Therefore, no user is found for login.

Error

31

http server address is empty.

No address specified for the ECM server. As long as this information is missing, data cannot be stored in the archive. If a valid http address has been set up in the ECM Server Setup, the document definition must be reimported and the entry must be set to Pending.

Error

51

No ECM Library/storage is available for export.

Before a record is transferred to the archive, a check is made on whether the storage stored in the document definition actually exists in the archive. If this message appears, the storage stored in the document definition is not available, or it does not exist.

Error

52

Communication error between Dynamics 365 Business Central and ECM servers.

The connection between the Dynamics 365 Business Central server and the ECM server has been lost. Please go to the ECM server card and check using the "Log In" & "Log Out" action if a general connection is possible. If not, check

  • that the ECM server is running

  • that the ECM user acting as a technical user is registered on the ECM system and has the necessary permissions

  • that network traffic is working properly

Error

66

Cannot find a transfer/update definition line for this transfer.

No valid transfer/update document definition was found so the operation cannot be performed. Either choose a valid transfer/update document definition, or correct the one used. Next, the document definition must be reimported for this entry and the status must be set to Pending.

Error

71

No document definition found.

The document definition stored in this entry was either removed or locked; it can no longer be used. Either the document definition must be unlocked, or a valid definition must be selected. Afterwards, the "Reimport document definition" and "Change status" functions must be executed.

Message

500

The user has changed the status.

This message appears every time the status of the entry has been changed by the "Edit Queue" wizard. It serves only as information.

Message

501

The user has updated the metadata values.

This message appears every time the metadata of the entry has been changed by the "Edit Queue" wizard.

Message

503

Document definition data has been reimported.

This message always appears every time the document definition has been reimported by the "Edit Queue" wizard. It serves only as information.

Message

801

Note: There is nothing to store (archive). No recent metadata found for update.

This message is only information. If the metadata of the document to be updated is identical to the metadata already archived, no update will be performed.