Codeunit WSB_ReportSelectionMgt¶

Exposes procedures that help with configuring report and corresponding layout selections.

Properties¶

Name	Value
Access	Public

Methods¶

wgFncCopySettingsFromReportSelection¶

Copy settings from the report selection to the custom report selection.

Parameters¶

Type	Name	Description
`Record "Custom Report Selection"`	`vRecCustomReportSelection`	The custom report selection to write

wgFncGetReportSelectionsPageId¶

Gets the ID of the page to use for a certain usage type.

Parameters¶

Type	Name	Description
`Enum "WSB_ReportSelectionUsageType"`	`pUsageType`	The usage type
`Boolean`	`vInitUsageFromFilterSupported`	Whether it is possible to open the page for a specific usage from record filters.

Returns¶

Type	Description
`Integer`	The page ID.

wgFncGetReportSelectionUsageType¶

Gets the usage type for a report selection usage.

Parameters¶

Type	Name	Description
`Enum "Report Selection Usage"`	`pUsage`	The usage.

Returns¶

Type	Description
`Enum WSB_ReportSelectionUsageType`	The usage type.

wgFncGetTempReportSelectionSetForAllUsages¶

Fills a buffer with a report selection for each report selection usage.

Parameters¶

Type	Name	Description
`Record "Report Selections" temporary`	`vRecTempReportSelection`	The report selection buffer.

wgFncOpenReportSelectionsPage¶

Opens the report selection page for a report selection usage.

Parameters¶

Type	Name	Description
`Enum "Report Selection Usage"`	`pUsage`	The usage.

Returns¶

Type	Description
`Action`	The Action returned after closing the page.

wgFncRestoreDefaultReportSelections¶

Restores the default Business Central report selections.

wgFncSelectReportLayout¶

Opens a page to select a report layout from the "Report Layouts" page.

Parameters¶

Type	Name	Description
`Integer`	`pReportID`	The ID of the report object for which to select a layout.
`Record "Report Layout List"`	`vRecReportLayoutList`	The report layout that was selected.
`Boolean`	`pForEmailBody`	Whether to filter the page to only display layouts that can be used as email body.

Returns¶

Type	Description
`Boolean`	true if a layout was selected on the page (the user selected a layout and pressed OK)

wgFncUpdateWarehouseReportSelection¶

Updates the warehouse report selection for a specific usage to the specified report ID.

Parameters¶

Type	Name	Description
`Enum "Report Selection Warehouse Usage"`	`pUsage`	The Usage.
`Integer`	`pReportID`	The new Report ID.

wlEvpOnAfterClearCustomReportSelectionLayoutFields¶

Allows to hook into the moment that fields on the "Custom Report Selection" record are cleared.

Parameters¶

Type	Name	Description
`Record "Custom Report Selection"`	`vRecCustomReportSelection`	The record.

wlEvpOnAfterCopySettingsFromReportSelection¶

Allows to hook into copying settings from a "Report Selections" record to a "Custom Report Selection" record.

Parameters¶

Type	Name	Description
`Record "Custom Report Selection"`	`vRecCustomReportSelection`	The Custom Report Selection record that is modified.
`Record "Report Selections"`	`pRecReportSelection`	The Report Selections record whose values are used.

wlEvpOnAfterGetReportSelectionsPageId¶

Allows to hook into retrieving the ID of a page that should be used for a certain Report Selection Usage Type.

Parameters¶

Type	Name	Description
`Enum "WSB_ReportSelectionUsageType"`	`pUsageType`	The usage type.
`Boolean`	`vInitUsageFromFilterSupported`	Whether the page supports having the selection on the appropriate document type/usage based on the filters when the page is opened.
`Integer`	`vPageId`	The ID of the page to open for the Usage Type.

wlEvpOnAfterGetReportSelectionUsageType¶

Allows to hook into getting a usage type for a report selection usage.

Parameters¶

Type	Name	Description
`Enum "Report Selection Usage"`	`pUsage`	The report selection usage.
`Enum "WSB_ReportSelectionUsageType"`	`vUsageType`	The usage type.
`Boolean`	`vIsHandled`	Whether this usage type was already handled or is handled by your extension.

wlEvpOnBeforeUpdateReportSelectionWhse¶

Allows to hook into the moment before the report selection for a Warehouse Report Selection is modified.

Parameters¶

Type	Name	Description
`Enum "Report Selection Warehouse Usage"`	`pUsage`	The usage.
`Integer`	`vReportID`	The report ID to use for this usage.
`Boolean`	`vIsHandled`	Whether this usage is handled by your extension.

wlEvpOnGetCustomReportSelectionSourceTypeCaseElse¶

Allows to hook into getting a source type for a report selection usage when a the source type cannot be determined

Parameters¶

Type	Name	Description
`Enum "Report Selection Usage"`	`pUsage`	The usage.
`Integer`	`vSourceType`	Source Type, usually Database::Customer or Database::Vendor