Codeunit WSB_PDFMergeSetup

A codeunit for setting up and applying PDF merges.

Properties

Name	Value
Access	Public

Methods

wgFncApplyPDFMerges

Applies configured PDF Merges to the passed PDF document.

Parameters

Type	Name	Description
Integer	pReportID	The ID of the report used to generate the PDF document.
Enum "WSB_PDFMergeScenario"	pPDFMergeScenario	The scenario in which the merge actions are applied.
InStream	vInStreamOutputDoc	The PDF Document as a Stream.

Returns

Type	Description
Boolean	true if PDF merges were applied successfully

wgFncApplyPDFMerges

Applies configured PDF Merges to the passed PDF document.

Parameters

Type	Name	Description
Integer	pReportID	The ID of the report used to generate the PDF document.
InStream	vInStreamOutputDoc	The PDF Document as a Stream.

Returns

Type	Description
Boolean	true if PDF merges were applied successfully

wgFncApplyPDFMerges

Applies the passed PDF Merges to the passed PDF document.

Parameters

Type	Name	Description
Integer	pReportID	The ID of the report used to generate the PDF document.
Record "WSB_PDFMerge"	vRecWSB_PDFMerge	The PDF Merges (as a record set/filtering)
InStream	vInStreamOutputDoc	The PDF Document as a Stream.

Returns

Type	Description
Boolean	true if PDF merges were applied successfully

wgFncClearPDFMergeFile

Clears the merge PDF for the passed export profile.

Parameters

Type	Name	Description
Record "WSB_PDFMerge"	vRecWSB_PDFMerge	The PDF Merge record

wgFncExportPDFMergeFile

Exports a PDF file of a PDF Merge record, prompting the user for a destination to save the file.

Parameters

Type	Name	Description
Record "WSB_PDFMerge"	vRecWSB_PDFMerge	The PDF Merge record.

wgFncExportPDFMergeFile

Exports a PDF file of a PDF Merge record and saves it to a Temp Blob.

Parameters

Type	Name	Description
Record "WSB_PDFMerge"	vRecWSB_PDFMerge	The PDF Merge record.
Codeunit "Temp Blob"	vCduTempBlob	A Temp Blob to save the merge PDF to.

wgFncGetPDFMergeDefaultFileName

Gets the default file name for importing/exporting PDF merge PDF files.

Parameters

Type	Name	Description
Enum "WSB_PDFMergeAction"	pPDFMergeAction	The PDF Merge Action Type.

Returns

Type	Description
Text	The default file name for this merge action type.

wgFncGetPDFMergeFileExtension

Gets the PDF Merge PDF file extension.

Returns

Type	Description
Text[3]	The file extension of PDF files used by PDF Merge.

wgFncGetPDFMergeFileFilter

Gets the PDF Merge PDF file filter used when importing files.

Returns

Type	Description
Text	The file filter for importing PDF files.

wgFncImportPDFMergeFile

Imports a merge PDF file for a PDF Merge record, prompting the user to upload a PDF file.

Parameters

Type	Name	Description
Record "WSB_PDFMerge"	vRecWSB_PDFMerge	The PDF Merge record.

wgFncImportPDFMergeFile

Imports a merge PDF file for a PDF Merge record..

Parameters

Type	Name	Description
Record "WSB_PDFMerge"	vRecWSB_PDFMerge	The PDF Merge record.
Codeunit "Temp Blob"	pCduTempBlob	The Temp Blob containing the merge PDF.
Text	pPdfFileName	The file name of the merge PDF.

wlEvpOnAfterApplyPDFMerges

Allows to hook into the moment after PDF merges are applied.

Parameters

Type	Name	Description
Integer	pReportID	The ID of the report object for which the PDF merges are about to be applied (if there are any applicable PDF merge actions).
Record "WSB_PDFMerge"	vRecWSB_PDFMerge	PDF Merge record filters.
InStream	vInStreamOutputDoc	The original PDF document as InStream.
Boolean	vSuccess	Whether the PDF merges were applied successfully.

wlEvpOnAfterGetPDFMergeScenarioFromDocumentPayload

Allows to hook into retrieving the PDF Merge Scenario from the document payload (provided by the OnDocumentReady event).

Parameters

Type	Name	Description
Text	pIntentAsText	The intent as text.
JsonObject	pDocumentPayload	The document payload.
Enum "WSB_PDFMergeScenario"	vPDFMergeScenario	The PDF Merge Scenario inferred from this.
Boolean	vArchiveScenarioSupported	Whether or not this merge scenario is supported.

wlEvpOnApplyPDFMergesOnBeforeFinish

Allows to hook into the moment right before the PDF Merges are finished.

Parameters

Type	Name	Description
Integer	pReportID	The ID of the report object for which the PDF merges are about to be applied (if there are any applicable PDF merge actions).
Guid	pJobId	The ID of the PDF Merging job.
InStream	vInStreamOutputDoc	The original PDF document as InStream.

wlEvpOnBeforeApplyPDFMerge

Allows to hook into the moment before a PDF merge is applied.

Parameters

Type	Name	Description
Record "WSB_PDFMerge"	pRecWSB_PDFMerge	The PDF Merge record to apply the merge action for.
Guid	pJobId	The ID of the merge job that is being processed.
Text	vAffinityCookieValue	The ARRAffinity cookie header value for the job.
Boolean	vApplied	Whether the PDF Merge action was successfully applied.
Boolean	vIsHandled	Set this to true if your extension handled the PDF merge.

wlEvpOnBeforeApplyPDFMerges

Allows to hook into the moment before PDF merges are applied.

Parameters

Type	Name	Description
Integer	pReportID	The ID of the report object for which the PDF merges are about to be applied (if there are any applicable PDF merge actions).
Record "WSB_PDFMerge"	vRecWSB_PDFMerge	PDF Merge record filters.
InStream	vInStreamOutputDoc	The original PDF document as InStream.
Boolean	vIsHandled	Set this to true if your extension handled the PDF merges.
Boolean	vSuccess	Whether the PDF merges were applied successfully.

wlEvpOnBeforeShouldApplyPDFMerge

Allows to hook into the moment before PDF Merge determines whether a merge should be applied.

Parameters

Type	Name	Description
Integer	pReportID	The ID of the report object for which the PDF merges are about to be applied
Record "WSB_PDFMerge"	pRecWSB_PDFMerge	The PDF Merge record to check for if it needs to be applied.
Boolean	vApplyPDFMerge	Set this to true if the PDF Merge record's merge action should be applied.
Boolean	vIsHandled	Set this to true if your extension handled the check for the PDF Merge record.