|
<< Click to Display Table of Contents >> Navigation: Zetadocs SDK Guide > Zetadocs SDK API > OnBeforeDocumentQueueDisplay |
OnBeforeDocumentQueueDisplay Event
Runs foreach item in the Document Queue before the Document Queue page is displayed. It provides methods to access and update the Document Queue Item.
Publisher
[IntegrationEvent(false, false)]
procedure OnBeforeDocumentQueueDisplay(var onBeforeDocumentQueueDisplayHandler: Codeunit "Zdd OnBeforeDocQueueDisplay")
begin
end;
Subscriber
To subscribe to this event, you will need to decorate the subscriber method with the correct EventSubscriber attributes:
[EventSubscriber(ObjectType::Codeunit, Codeunit::"Zetadocs Customize", 'OnBeforeDocumentQueueDisplay', '', true, true)]
local procedure OnBeforeDocQueueDisplay(var onBeforeDocumentQueueDisplayHandler: Codeunit "Zdd OnBeforeDocQueueDisplay")
begin
end;
Zdd OnBeforeDocQueueDisplay Codeunit
This codeunit exposes procedures that give you access to the Purchase Line, Zetadocs Review Header and Zetadocs Review Lines.
Method name |
Description |
|---|---|
GetDocQueueItem(var docQueueItem: Record "Zetadocs Doc. Queue Item") |
Returns the Document Queue Item, before it is displayed on the Document Queue Page. |
SetDocQueueItem(var docQueueItem: Record "Zetadocs Doc. Queue Item") |
Overrides the Document Queue Item with the data provided. |
GetRecognisedKeyValuePairs(): JsonArray |
Will return a JsonArray of all the recognized Key Value pairs from the document in the Document Queue (Requires AP Automation to be enabled for the Document Queue - otherwise an empty array is returned). |
Will return Document Queue Item, before it is displayed on the Document Queue Page.
Syntax
onBeforeDocumentQueueDisplayHandler.GetDocQueueItem(var docQueueItem: Record "Zetadocs Doc. Queue Item")
Parameters
docQueueItem
Type: Record "Zetadocs Doc. Queue Item"
The record variable for the current Document Queue Item to be added to the list for display.
Will override the Document Queue Item with the data provided.
Syntax
onBeforeDocumentQueueDisplayHandler.SetDocQueueItem(var docQueueItem: Record "Zetadocs Doc. Queue Item")
Parameters
docQueueItem
Type: Record "Zetadocs Doc. Queue Item"
The record variable for the current Document Queue Item to be added to the list for display.
GetRecognisedKeyValuePairs Method
Will return a JsonArray of all the recognised Key Value pairs from the document in the Document Queue. Or an empty array if there are none.
Syntax
onBeforeDocumentQueueDisplayHandler.GetRecognisedKeyValuePairs() KeyValuePairs : JsonArray
Parameters
KeyValuePairs
Type: JsonArray
The JSON array of the Key Value Pairs that have been recognised in the document. The JSON will be in the format:
'[
{"Key": "IBAN:", "Value": "GB23 BOFA 121211 4534333"},
{"Key": "Bank:", "Value": "HSBC Bank PLC."},
{"Key": "Sort code:", "Value": "111111."}
]'