Documentafbeeldingen

  • 4 minutes to read

API-pagina's voor documentafbeeldingen

Vanaf versie 28.0.20260619.0 zijn twee nieuwe read-only API-pagina's beschikbaar voor documentafbeeldingen via de BoCount Dynamics API (groep bocountdynamics, versie v1.0).

CFL Document Image Api (documentImages)

Geeft de metadata van documentafbeeldingen terug.

Veld Type Beschrijving
id Guid Systeem-ID van de documentafbeelding
primaryKey Text Primaire sleutel van het gekoppelde record
tableNo Integer Tabelnummer van het gekoppelde record
systemId Guid Systeem-ID van het gekoppelde record
fileName Text Bestandsnaam van de afbeelding
subfolder Text Submap
subfolder2 Text Pad
lastModifiedDateTime DateTime Datum en tijd van de laatste wijziging

Deze pagina bevat een subpagina documentImagesContent (zie hieronder).

CFL Document Image Content Api (documentImagesContent)

Subpagina van documentImages. Geeft de bestandsinhoud terug als Base64-gecodeerde tekst.

Veld Type Beschrijving
id Guid Systeem-ID van de documentafbeelding
fileContent Text Bestandsinhoud als Base64-tekst
NOTE

Beide API-pagina's zijn read-only: insert, modify en delete zijn niet toegestaan.

Interface CFL Document Image Path v2

Vanaf versie 28.0.20260609.0 is een nieuwe interface CFL Document Image Path v2 beschikbaar. Extensies die het opslagpad van documentafbeeldingen willen bepalen, implementeren deze interface.

De enum CFL Document Image Path is bijgewerkt met een DefaultImplementation die verwijst naar de nieuwe v2-interface. Bestaande implementaties van de vorige interface zijn gemigreerd.

Om een eigen opslagpad voor documentafbeeldingen te implementeren:

  1. Implementeer de interface CFL Document Image Path v2 in een nieuwe codeunit.
  2. Voeg de implementatie toe als DefaultImplementation of als override op de relevante enum-waarde van CFL Document Image Path.

Tables

CFL Document Image

In deze tabel worden de document-afbeeldingen gekoppeld aan een record opgeslagen. Dit wordt gebruikt bvb. in BoCount om de afbeelding van een factuur of creditnota bij te houden. De primary key van de tabel is een guid.

procedure CFLShow

procedure CFLShow()

Functie voor het weergeven van het bestand.

event CFLOnAfterShow

procedure CFLOnAfterShow(rec: record "CFL Document Image"; var Folder: text)

Dit event wordt gebruikt door System OnPrem om het bestand weer te geven in geval van lokale bestandsopslag.

procedure CFLDocumentPath

procedure CFLDocumentPath(): Text[1024]

Retourneert het pad van het bestand.

event CFLOnAfterDocumentPath

procedure CFLOnAfterDocumentPath(rec: record "CFL Document Image"; var Path: text)

Dit event wordt gebruikt door System OnPrem om het pad terug te geven in geval van lokale bestandsopslag.

procedure CFLDocumentExists

procedure CFLDocumentExists(): boolean

Retourneert true indien het bestand in de record ook bestaat in de opslag.

event CFLOnDocumentExists

procedure CFLOnAfterDocumentExists(rec: record "CFL Document Image"; var Exists: boolean)

Dit event wordt gebruikt door System OnPrem om het bestaan van het bestan te controleren in geval van lokale bestandsopslag.

procedure CFLShowWithDocumentNo

procedure CFLShowWithDocumentNo()

Functie voor het weergeven van het bestand. Op het bestand worden de primary key veld waarden van de record geplaatst.

event CFLOnAfterShowWithDocumentNo

local procedure CFLOnAfterShowWithDocumentNo(rec: record "CFL Document Image"; var tempblob: codeunit "Temp Blob")

Wordt gebruikt door System OnPrem om het documentnr toe te voegen aan het bestand.

procedure CFLGetDocumentNoWithoutSpecialChar

procedure CFLGetDocumentNoWithoutSpecialChar() DocNo: Text

Retourneert de primary key veld waarden zonder speciale characters. de veldwaarden zijn gescheiden door een .

procedure CFLGetDocumentNo

procedure CFLGetDocumentNo() DocNo: Text

Retourneert de primary key veld waarden. de veldwaarden zijn gescheiden door een .

procedure CFLSaveFile

procedure CFLSaveFile(Base64: Bigtext; FileName: text; RecID: RecordId)

Koppelen van een bestand aan een opgegeven record via een Base64-bigtext variabele. Het bestand wordt opgeslagen in het bestandsaccount dat via CFL File Scenarios is geconfigureerd voor het recordtype.

event CFLOnAfterSaveFileFromBase64

local procedure CFLOnAfterSaveFileFromBase64(RecId: RecordId; var Base64: BigText; FileName: text)

Dit event wordt gebruikt door System OnPrem om het bestand op te slaan in geval van lokale bestandsopslag.

procedure CFLSaveFile

procedure CFLSaveFile(Base64: Bigtext; FileName: text; TableNo: integer; SystemID :Guid)

Koppelen van een bestand aan een opgegeven record via een Base64-bigtext variabele. Het bestand wordt opgeslagen in het bestandsaccount dat via CFL File Scenarios is geconfigureerd voor het recordtype.

event CFLOnAfterSaveFileFromBase64BySystemID

local procedure CFLOnAfterSaveFileFromBase64BySystemID(TableNo: integer; SystemID :Guid; var Base64: BigText; FileName: text)

Dit event wordt gebruikt door System OnPrem om het bestand op te slaan in geval van lokale bestandsopslag.

procedure CFLSaveFile

procedure CFLSaveFile(var tempBlob: codeunit "Temp Blob"; FileName: text; RecID: RecordId)

Koppelen van een bestand aan een opgegeven record via een tempblob variabele. Het bestand wordt opgeslagen in het bestandsaccount dat via CFL File Scenarios is geconfigureerd voor het recordtype.

event CFLOnAfterSaveFileFromTempBlob

local procedure CFLOnAfterSaveFileFromTempBlob(RecId: RecordId; var tempblob: codeunit "Temp Blob"; FileName: text)

Dit event wordt gebruikt door System OnPrem om het bestand op te slaan in geval van lokale bestandsopslag.

procedure CFLSaveFile

procedure CFLSaveFile(var tempBlob: codeunit "Temp Blob"; FileName: text; TableNo: integer; SystemID :Guid)

Koppelen van een bestand aan een opgegeven record via een bestand. Het bestand wordt opgeslagen in het bestandsaccount dat via CFL File Scenarios is geconfigureerd voor het recordtype. Het bestand wordt hierbij gekopieerd.

NOTE

Het bronbestand wordt niet verwijderd.

event CFLOnAfterSaveFileFromTempBlobBySystemID

local procedure CFLOnAfterSaveFileFromTempBlobBySystemID(TableNo: integer;SystemID : Guid; var tempblob: codeunit "Temp Blob"; FileName: text)

Dit event wordt gebruikt door System OnPrem om het bestand op te slaan in geval van lokale bestandsopslag.

NOTE

Er zijn verschillende functies met dezelfde naam "CFLSaveFile" maar verschillende parameters.
Dit principe wordt "overloading" genoemd. Op basis van de parameters die gebruikt worden bij het aanroepen van "CFLSaveFile" wordt automatisch de correctie functie gebruikt.

procedure CFLGetFileBase64

procedure CFLGetFileBase64() Base64String: text

Retourneert een base64-string van het bestand.

event CFLOnAfterGetFileBase64

local procedure CFLOnAfterGetFileBase64(Url: text; var Base64String: text)

Dit event wordt gebruikt door System OnPrem om de base64 van het bestand terug te geven in geval van lokale bestandsopslag.

CFL Document Image pK Fields

Deze tabel bevat de primary key veldwaardes van de record-id uit de tabel CFL Document Image.