Funktionen der E4BC API

Funktionsname

Beschreibung

FindDocDefByRRef

(FindDocDefByRRef_2)

Sucht eine ECM Dokumentdefinition anhand der Tabellennummer, Tabellenbelegart und Startdatum.

Tabellennummer, Tabellenbelegart und Startdatum werden mit Hilfe der Einrichtung "ECM Object Reference Matrix" aus dem MainRecord (Variant) extrahiert.

Es werden die ECM Dokumentdefinitionen bis zum Startdatum herangezogen


FindDocDefByName

Sucht eine Dokumentendefinition anhand des angegebenen Namens


FindDocDefByName (Deprecated)

Sucht eine Dokumentendefinition anhand des angegebenen Namens

(Veraltet - Aus Komatiblitätsgründen noch in der ECM API)

ECMRepositoryRequest

Erstellt einen Eintrag in der ECM Warteschlange

ReleaseECMRepositoryRequest

Setzt den Status zu in der ECM Warteschlange von begonnen auf anstehend.

ECMRepositoryRequestWithFindDocDefByRRef

Sucht eine ECM Dokumentendefinition anhand der Tabellennummer, Tabellenbelegart und Startdatum.

Tabellennummer, Tabellenbelegart und Startdatum werden mit Hilfe der Einrichtung "ECM Object Reference Matrix" aus dem MainRecord (Variant) extrahiert,

Erstellt einen Eintrag in der ECM Warteschlange und setzt den Status in der ECM Warteschlange von begonnen auf anstehend.

SaveFileRequest

Trägt eine Datei in die Warteschlange ein.

TransferECMDocRefRequest

Fügt eine ECM Dokumentreferenz per Verweis in die Warteschlange ein.

CreateProcessNo

(CreateProcessNo_2)

(CreateProcessNo_3)

Erstellt eine neue Vorgangsnr. falls keine erzeugt wird, wird SubstituteProcessNo als Ersatz verwendet.

SaveAndSendDialog

Zeigt einen Auswahldialog zum Versenden und/oder Ablegen eines Dokuments an.

SaveAndSend

Führt auf Basis des Wertes "Selected" die entsprechende Funktion "Speichern und Senden" aus.

AssignDocumentID

(AssignDocumentID2)

Weist einem Datensatz(BC-Beleg) eine Dokumenten ID (Barcode) zu. Wenn PrintECMDocumentIDLabel = true wird ein Etikett/Leitbeleg ausgedruckt. Wenn ECMDocumentID  (Barcode)  leer, wird die  ECMDocumentID  (Barcode)  aus der Nummerserie erzeugt. [Zusätzlich können über ECM Document Journal Line weitere Parameter übergeben werden.]

GetBarCodeWithCheckSum

Gibt den Barcode mit Start-, Stop-Zeichen und bei Bedarf mit Prüfsumme zurück.

FieldValueWrite

Legt eine beliebige neue Zeile in der Tabelle MetaDataFieldValue (Metadaten) mit den übergebenen Parametern an.

FieldValueRead

Liest eine Zeile aus der Tabelle MetaDataFieldValue (Metadaten) mit den übergebenen Parametern aus

SaveReportOption

Legt eine neue Zeile ReportOption in der Tabelle MetaDataFieldValue (Metadaten) mit den übergebenen Parametern an.

GetReportOption

Liest eine Zeile ReportOption in der Tabelle MetaDataFieldValue (Metadaten) mit den übergebenen Parametern an.

SaveJnlEntryFieldMetadata

Speichert zu angegebenem ECM Warteschlangen Vorgang den angegebenen FieldValue (Journal line - Entry Field No.).

SaveRepositoryFieldMetadata

Speichert zu angegebenem ECM Warteschlangen Vorgang den angegebenen FieldValue (Repository).

GetDocument

(GetDocument2)

Holt das ECM Dokument inkl. aller Metadaten und Dateien aus dem Repository und speichert es in eine temporäre Dokumenten Puffer Tabelle.

GetDocument4ECMDocEntryNo

Holt das ECM Dokument inkl. aller Metadaten und Dateien aus dem Repository und speichert es in eine temporäre Dokumenten Puffer Tabelle.

ShowDocument

Zu angegebenen Dokumentenreferenz wird das jeweilige Dokument gesucht und angezeigt.

ShowDocument4ECMDocEntryNo

Zu angegebenen Entry No wird das jeweilige Dokument gesucht und angezeigt.

GetPDFGenerator

Wenn die Variable gefüllt ist, ist der Dokumentendruck für das Repository vorgesehen.

GetECMQueueTransNo

Gibt die aktuelle ECM Warteschlangen Vorgangsnr. als BigInteger zurück.

GetECMQueueTransNoLast

Gibt die letzte ECM Warteschlangen Vorgangsnr. als BigInteger zurück.

SetProcessRelation (Deprecated)

Verknüpft die Vorgangsnr. von dem Vorgänger mit den Nachfolger.

Optional: Kann zusätzlich eine Prozessbeschreibung in der ECM Prozess Verknüpfungs- Tabelle eingetragen werden

SetProcessLink

Verknüpft die Vorgangsnr. von dem Vorgänger mit den Nachfolger.

Optional: Kann zusätzlich eine Prozessbeschreibung in der ECM Prozess Verknüpfungs- Tabelle eingetragen werden

SetProcess2Relation (Depercated)

Verknüpft die Vorgangsnr. 2 von dem Vorgänger mit den Nachfolger.

Optional: Kann zusätzlich eine Prozessbeschreibung in der ECM Prozess Verknüpfungs- Tabelle eingetragen werden

SetProcess2Link

Verknüpft die Vorgangsnr. 2 von dem Vorgänger mit den Nachfolger.

Optional: Kann zusätzlich eine Prozessbeschreibung in der ECM Prozess Verknüpfungs- Tabelle eingetragen werden

CopySourceProcessNoToTarget

(CopySourceProcessNoToTarget_2)

(CopySourceProcessNoToTarget_3)

Überträgt die Vorgangsnr. von dem Vorgänger in den Nachfolger. Dabei wird anhand des Feldes xxx in der Objektbezugsmatrix wird die Vorgangsnummer kopiert oder verknüpft. 

Überträgt die Vorgangsnr. von dem Vorgänger in den Nachfolger. Dabei wird anhand des Feldes xxx in der Objektbezugsmatrix wird die Vorgangsnummer kopiert oder verknüpft. Zusätzlich wird eine Prozessbeschreibung in der ECM Prozess Verknüpfungs-Tabelle eingetragen.

Überträgt die Vorgangsnr. von dem Vorgänger in den Nachfolger. Dabei wird anhand des Feldes xxx in der Objektbezugsmatrix wird die Vorgangsnummer kopiert oder verknüpft. Die Dokumentdefiniten können hier übergeben werden.

CopySourceProcessNo2ToTarget

(CopySourceProcessNo2ToTarget_2)

Überträgt die Vorgangsnr. 2 von dem Vorgänger in den Nachfolger. Zusätzlich wird eine Prozessbeschreibung in der ECM Prozess Verknüpfungs-Tabelle eingetragen.

Überträgt die Vorgangsnr. 2 von dem Vorgänger in den Nachfolger.  Zusätzlich wird eine Prozessbeschreibung in der ECM Prozess Verknüpfungs-Tabelle eingetragen. Die Dokumentdefinitionen können hier übergeben werden.

ViewDocumentEntries

Zeigt alle Dokumentposten zu dem übergebenen Datensatz.

CheckMandatoryMetadatafield

Prüft ob, die Repository Pflichtfelder gefüllt sind. Die Repository Pflichtfelder werden in der Dokumentdefinition definiert.

WriteLog

Schreibt einen Datensatz in die Tabelle ECM Log inkl. Datei aus dem Puffer TempBlob

Schreibt einen Datensatz in die Tabelle ECM Log inkl. XML Document

Schreibt einen Datensatz in die Tabelle ECM Log inkl. Stream (http Response)

HasValidECMSetup

Überprüft, ob eine valide ECM Einrichtung vorhanden ist.

HasValidECMLicense

Prüft ob ein gültige ECM Lizenz vorhanden ist.

PrintECMDocumentIDLabelDialog

Weist einem Datensatz (Business Central-Beleg) eine Dokumenten ID (Barcode) zu und druckt ein Etikett/Leitbeleg.

Wenn die ECMDocumentID leer ist, wird die Dokumentendefinition aus der Nummerserie erzeugt.

Zusätzlich wird eine Dialog Page für die Eingabe von Metadaten angezeigt. Diese wird von der Info Box verwendet.

AssignDocumentIDDialog

Weist einem Datensatz (Business Central-Beleg) eine Dokumenten ID (Barcode) zu.

Wenn ECMDocumentID leer ist, wird die Dokumentendefinition aus der Nummernserie erzeugt.

AssignFileDialog

Kernfunktionalität zur Ablage einer Datei. Nachdem der Anwender die Datei ausgewählt hat, wird diese in die ECM Warteschlange eingetragen.

Funktionen, die in der API enthalten, aber nicht dokumentiert sind, werden ausschließlich intern verwendet und sind daher nicht dokumentiert.