Codeunit WSB_DCAFolderStructure¶

Implements the WSB_IDCARemoteFolderStructure for custom folder structures that are defined in the BC client and can be customized by administrators.

Properties¶

Name	Value
Access	Public

Methods¶

wgFncCopyRemoteFolderStructure(WSB_DCAFolderStructure):Boolean¶

Creates a copy of an existing remote folder structure. Opens a page where the user can enter a code and description for the new folder structure.

Parameters¶

Type	Name	Description
`Record "WSB_DCAFolderStructure"`	`pRecWSB_DCAFolderStructure`	The existing folder structure.

Returns¶

Type	Description
`Boolean`	true iff the folder structure has been copied.

wgFncCopyRemoteFolderStructure(WSB_DCAFolderStructure, Code[30], Text[100])¶

Creates a copy of an existing remote folder structure.

Parameters¶

Type	Name	Description
`Record "WSB_DCAFolderStructure"`	`pRecWSB_DCAFolderStructure`	The existing folder structure.
`Code[30]`	`pNewFolderStructureCode`	The code of the new folder structure
`Text[100]`	`pNewFolderStructureDesc`	The description of the new folder structure.

wgFncCreateSampleFolderStructure:Boolean¶

Creates a sample folder structure.

Returns¶

Type	Description
`Boolean`	true iff the sample folder structure has been created by the procedure.

wgFncEditTableFolderStructureFilters(WSB_DCATableFolderStructure@):Boolean¶

Edit the filters for a table-specific folder structure entry.

Parameters¶

Type	Name	Description
`Record "WSB_DCATableFolderStructure"`	`vRecWSB_DCATableFolderStructure`	The table-specific folder structure entry

Returns¶

Type	Description
`Boolean`	true iff the filters were edited successfully.

wgFncExportFolderStructures(WSB_DCAFolderStructure@)¶

Exports folder structure(s) to an XML file.

Parameters¶

Type	Name	Description
`Record "WSB_DCAFolderStructure"`	`vRecWSB_DCAFolderStructure`	Filter of the folder structures to export.

wgFncExportFolderStructures(WSB_DCAFolderStructure@, Codeunit::System#Utilities#Temp Blob@)¶

Exports folder structure(s) as XML to a BLOB.

Parameters¶

Type	Name	Description
`Record "WSB_DCAFolderStructure"`	`vRecWSB_DCAFolderStructure`	Filter of the folder structures to export.
`Codeunit "Temp Blob"`	`vCduTempBlob`	The TempBlob to write the folder structures to.

wgFncGetDocumentArchiveFolderStructureFileFilter:Text¶

Returns the file filter for Document Archive Folder Structure files.

Returns¶

Type	Description
`Text`	Document Archive Folder Structure file filter.

wgFncGetDocumentArchiveFolderStructuresFileExtension:Text[3]¶

Returns the file extension for Document Archive folder structure files.

Returns¶

Type	Description
`Text[3]`	Document Archive folder structure file extension.

wgFncGetFolderPathEntryText(WSB_DCAFolderPathStructure):Text¶

Gets the folder path part for a folder path structure entry.

Parameters¶

Type	Name	Description
`Record "WSB_DCAFolderPathStructure"`	`pRecWSB_DCAFolderPathStructure`	The folder path structure entry.

Returns¶

Type	Description
`Text`	The folder path part for the entry.

wgFncGetFolderPathEntryText(WSB_DCAFolderPathStructure, WSB_DCAFile):Text¶

Gets the folder path part for a folder path structure entry.

Parameters¶

Type	Name	Description
`Record "WSB_DCAFolderPathStructure"`	`pRecWSB_DCAFolderPathStructure`	The folder path structure entry.
`Record "WSB_DCAFile"`	`pRecWSB_DCAFile`	The Document Archive file to get the path for.

Returns¶

Type	Description
`Text`	The folder path part for the entry.

wgFncGetRemoteFolderPath(WSB_DCAFile):Text¶

Retrieves the remote folder path for a file record.

Parameters¶

Type	Name	Description
`Record "WSB_DCAFile"`	`pRecWSB_DCAFile`	The file record.

Returns¶

Type	Description
`Text`	The remote folder path.

wgFncGetRemoteFolderPath(Code[30], WSB_DCAFile):Text¶

Retrieves the remote folder path for a specific folder structure for a file record.

Parameters¶

Type	Name	Description
`Code[30]`	`pFolderStructureCode`	The code of the folder structure.
`Record "WSB_DCAFile"`	`pRecWSB_DCAFile`	The file record.

Returns¶

Type	Description
`Text`	The remote folder path.

wgFncGetRemoteFolderPathSample:Text¶

Retrieves a sample remote folder path.

Returns¶

Type	Description
`Text`	The remote folder path.

wgFncGetRemoteFolderPathSample(WSB_DCAFolderStructure):Text¶

Retrieves a sample remote folder path for a specific folder structure.

Parameters¶

Type	Name	Description
`Record "WSB_DCAFolderStructure"`	`pRecWSB_DCAFolderStructure`	The folder structure.

Returns¶

Type	Description
`Text`	The remote folder path.

wgFncGetRemoteFolderPathSample(Code[30]):Text¶

Retrieves a sample remote folder path for a specific folder structure.

Parameters¶

Type	Name	Description
`Code[30]`	`pFolderStructureCode`	The code of the folder structure.

Returns¶

Type	Description
`Text`	The remote folder path.

wgFncGetRemoteFolderPathSample(Code[30], Integer):Text¶

Retrieves a sample remote folder path for a specific folder structure, specifically for a table.

Parameters¶

Type	Name	Description
`Code[30]`	`pFolderStructureCode`	The code of the folder structure.
`Integer`	`pTableNo`	The ID of the table to get a sample folder path for.

Returns¶

Type	Description
`Text`	The remote folder path.

wgFncGetRemoteFolderPathSample(WSB_DCATableFolderStructure):Text¶

Retrieves a sample remote folder path for a table-specific folder structure.

Parameters¶

Type	Name	Description
`Record "WSB_DCATableFolderStructure"`	`pRecWSB_DCATableFolderStructure`	The table-specific folder structure.

Returns¶

Type	Description
`Text`	The remote folder path.

wgFncGetRemoteFolderPathSample(Code[30], Variant):Text¶

Retrieves a sample remote folder path for a specific folder structure, specifically for a record.

Parameters¶

Type	Name	Description
`Code[30]`	`pFolderStructureCode`	The code of the folder structure.
`Variant`	`pRecRelatedVariant`	The record.

Returns¶

Type	Description
`Text`	The remote folder path.

wgFncGetSampleFolderStructureCode:Code[30]¶

Retrieve the code/identifier of the sample folder structure.

Returns¶

Type	Description
`Code[30]`	The code of the sample folder structure.

wgFncGetTableFolderStructureFiltersText(WSB_DCATableFolderStructure@):Text¶

Gets the table-specific folder structure entry's filters as a readable text.

Parameters¶

Type	Name	Description
`Record "WSB_DCATableFolderStructure"`	`vRecWSB_DCATableFolderStructure`	The table-specific folder structure.

Returns¶

Type	Description
`Text`	The filters as a readable text.

wgFncGetTableFolderStructureFilterView(WSB_DCATableFolderStructure@):Text¶

Gets the table-specific folder structure entry's filter view.

Parameters¶

Type	Name	Description
`Record "WSB_DCATableFolderStructure"`	`vRecWSB_DCATableFolderStructure`	The table-specific folder structure.

Returns¶

Type	Description
`Text`	The filter view.

wgFncImportFolderStructures¶

Imports folder structures from an XML file.

wgFncImportFolderStructures(Codeunit::System#Utilities#Temp Blob)¶

Imports folder structure(s) that were stored in XML format.

Parameters¶

Type	Name	Description
`Codeunit "Temp Blob"`	`pCduTempBlob`	The TempBlob to read the folder structure(s) from.

wgFncSelectTableFilters(Integer, Text, Text, Text@):Boolean¶

Lets the user select table filters for a table-specific folder structure entry.

Parameters¶

Type	Name	Description
`Integer`	`pTableNumber`	The ID of the table.
`Text`	`pTableCaption`	The caption of the table.
`Text`	`pInputFilterViewAsText`	The current filter view.
`Text`	`vOutputFilterViewAsText`	The output filter view.

Returns¶

Type	Description
`Boolean`	true iff filters were selected successfully (false if the user aborted).

wgFncSetRemoteFileName(WSB_DCAFile@)¶

Sets the remote file name for a file record.

Parameters¶

Type	Name	Description
`Record "WSB_DCAFile"`	`vRecWSB_DCAFile`	The file record.

wlEvpOnBeforeGetFolderPathEntryValueText(WSB_DCAFolderPathStructure, WSB_DCAFile, Text@, Boolean@)¶

Allows to hook into determining a folder path part for a remote folder path.

Parameters¶

Type	Name	Description
`Record "WSB_DCAFolderPathStructure"`	`pRecWSB_DCAFolderPathStructure`	The folder path entry record.
`Record "WSB_DCAFile"`	`pRecWSB_DCAFile`	The Document Archive File record.
`Text`	`vFolderPathEntryValueText`	The folder path part.
`Boolean`	`vIsHandled`	Set this to true if your extension handles computing a folder path part for this folder path entry record.