EASY for Dynamics 365 Business Central - API

Functios of the E4BC API

Funktionsname

Beschreibung

FindDocDefByRRef

(FindDocDefByRRef_2)

Searches an ECM document definition by table number, table document type and start date.

Table number, table document type and start date are extracted from the MainRecord (Variant) using the "ECM Object Reference Matrix" setup.

The ECM document definitions up to the start date are used.


FindDocDefByName

Searches for a document definition by the specified name


FindDocDefByName (Deprecated)

Searches for a document definition based on the specified name.

(Deprecated - Still in the ECM API for comatiblity reasons).

ECMRepositoryRequest

Creates an entry in the ECM queue

ReleaseECMRepositoryRequest

Sets the status to in the ECM queue from started to pending.

ECMRepositoryRequestWithFindDocDefByRRef

Searches an ECM document definition by table number, table document type and start date.

Table number, table document type and start date are extracted from the MainRecord (Variant) using the "ECM Object Reference Matrix" setup.

Creates an entry in the ECM queue and sets the status in the ECM queue from started to pending.

SaveFileRequest

Enters a file into the ECM queue.

TransferECMDocRefRequest

Inserts an ECM document reference by reference into the ECM queue.

CreateProcessNo

(CreateProcessNo_2)

(CreateProcessNo_3)

Creates a new process number. If none is created, SubstituteProcessNo is used as a substitute.

SaveAndSendDialog

Displays a selection dialog for sending and/or filing a document.

SaveAndSend

Executes the corresponding "Save and Send" function based on the "Selected" value.

AssignDocumentID

(AssignDocumentID2)

Assigns a document ID (barcode) to a record (BC document). If PrintECMDocumentIDLabel = true a label/lead document is printed. If ECMDocumentID (Barcode) is empty, the ECMDocumentID (Barcode) is generated from the number series. [Additional parameters can be passed via ECM Document Journal Line].

GetBarCodeWithCheckSum

Returns the barcode with start, stop characters and checksum if required.

FieldValueWrite

Creates any new row in the MetaDataFieldValue (metadata) table with the passed parameters.

FieldValueRead

Reads a row from the MetaDataFieldValue table (metadata) with the passed parameters

SaveReportOption

Creates a new row ReportOption in the MetaDataFieldValue table (metadata) with the passed parameters.

GetReportOption

Reads a row ReportOption in the MetaDataFieldValue table (metadata) with the passed parameters.

SaveJnlEntryFieldMetadata

Saves the specified FieldValue (Journal line - Entry Field No.) to the specified ECM queue operation.

SaveRepositoryFieldMetadata

Saves the specified FieldValue (repository) to the specified ECM queue operation.

GetDocument

(GetDocument2)

Fetches the ECM document including all metadata and files from the repository and stores it in a temporary document buffer table.

GetDocument4ECMDocEntryNo

Fetches the ECM document including all metadata and files from the repository and stores it in a temporary document buffer table.

ShowDocument

The respective document is searched for and displayed for the specified document reference.

ShowDocument4ECMDocEntryNo

The respective document is searched and displayed for the specified Entry No.

GetPDFGenerator

If the variable is filled, the document printing is intended for the repository.

GetECMQueueTransNo

Returns the current ECM queue transaction number as BigInteger.

GetECMQueueTransNoLast

Returns the last ECM queue operation number as BigInteger.

SetProcessRelation (Deprecated)

Links the process number of the predecessor with the successor.

Optional: Additionally a process description can be entered in the ECM process link table.

SetProcessLink

Links the process number of the predecessor with the successor.

Optional: Additionally a process description can be entered in the ECM process link table.

SetProcess2Relation (Depercated)

Links the process number 2 of the predecessor with the successor.

Optional: Additionally a process description can be entered in the ECM process link table.

SetProcess2Link

Links the process number 2 of the predecessor with the successor.

Optional: Additionally a process description can be entered in the ECM process link table.

CopySourceProcessNoToTarget

(CopySourceProcessNoToTarget_2)

(CopySourceProcessNoToTarget_3)

Transfers the operation number from the predecessor to the successor. The operation number is copied or linked on the basis of the xxx field in the object reference matrix.

Transfers the operation number from the predecessor to the successor. The process number is copied or linked on the basis of the xxx field in the object reference matrix. In addition, a process description is entered in the ECM process link table.

Transfers the process number from the predecessor to the successor. The process number is copied or linked on the basis of the field xxx in the object reference matrix. The document definitions can be transferred here.

CopySourceProcessNo2ToTarget

(CopySourceProcessNo2ToTarget_2)

Transfers the process no. 2 from the predecessor to the successor. In addition, a process description is entered in the ECM process link table.

Transfers process no. 2 from the predecessor to the successor. Additionally a process description is entered in the ECM process link table. The document definitions can be transferred here.

ViewDocumentEntries

Shows all document items for the given record.

CheckMandatoryMetadatafield

Checks if the repository mandatory fields are filled. The repository mandatory fields are defined in the document definition.

WriteLog

Writes a record into the table ECM Log incl. file from the buffer TempBlob

Writes a record into the table ECM Log incl. XML Document

Writes a record into the table ECM Log incl. stream (http response)

HasValidECMSetup

Checks if a valid ECM setup exists.

HasValidECMLicense

Checks if a valid ECM license is available.

PrintECMDocumentIDLabelDialog

Assigns a document ID (barcode) to a record (BC document) and prints a label/lead document. If ECMDocumentID is empty, the document definition is generated from the number series. Additionally a dialog page for meta data is displayed. This is used by the Info Box.

AssignDocumentIDDialog

Assigns a document ID (barcode) to a record (Business Central document).

If ECMDocumentID is empty, the document definition is generated from the number series.

AssignFileDialog

Core functionality for storing a file. After user has selected file it will be added to the queue.

Functions that are included in the API but not documented are used internally only and are therefore not documented.