Skip to content

Codeunit WSB_DCAEntityDefinition

Exposes procedures for working with Document Archive entity definitions.

Properties

Name Value
Access Public

Methods

wgFncEditEntityDefinitionFilters

Edit the filters for a entity definition.

Parameters

Type Name Description
Record "WSB_DCAEntityDefinition" vRecWSB_DCAEntityDefinition The entity definition

Returns

Type Description
Boolean true iff the filters were edited successfully.

wgFncEntityDefinitionsExistForTable

Determines whether (enabled) entity definitions exist for a table.

Parameters

Type Name Description
Integer pTableID The ID of the table.

Returns

Type Description
Boolean true iff entity definitions exist for the table.

wgFncGetCategoryFilterForEntityDefinition

Gets a filter of category-codes restricted to a specific entity definition.

Parameters

Type Name Description
Record "WSB_DCAEntityDefinition" pRecWSB_DCAEntityDefinition The entity definition to restrict the filter to.

Returns

Type Description
Text The resulting filter.

wgFncGetEntityDefinitionFiltersText

Gets the entity definition's filters as a readable text.

Parameters

Type Name Description
Record "WSB_DCAEntityDefinition" vRecWSB_DCAEntityDefinition The entity definition.

Returns

Type Description
Text The filters as a readable text.

wgFncGetEntityDefinitionFilterView

Gets the entity definition's filter view.

Parameters

Type Name Description
Record "WSB_DCAEntityDefinition" vRecWSB_DCAEntityDefinition The entity definition.

Returns

Type Description
Text The filter view.

wgFncGetEntityDefinitionForFileRecord

Gets the entity definition matching for a file.

Parameters

Type Name Description
Record "WSB_DCARemoteFile" pRecWSB_DCARemoteFile The remote file record to get a matching entity definition for.
Record "WSB_DCAEntityDefinition" vRecWSB_DCAEntityDefinition The entity definition that was found.

Returns

Type Description
Boolean true iff an entity definition was found.

wgFncGetEntityDefinitionForRecord

Gets the entity definition matching for a record.

Parameters

Type Name Description
RecordId pSourceRecordID The record to get a matching entity definition for.
Record "WSB_DCAEntityDefinition" vRecWSB_DCAEntityDefinition The entity definition that was found.

Returns

Type Description
Boolean true iff an entity definition was found.

wgFncGetEntityTranslation

Retrieve the translation for an entity definition and session's current language.

Parameters

Type Name Description
Record "WSB_DCAEntityDefinition" pRecWSB_DCAEntityDefinition The entity definition.
Record "WSB_DCAEntityTranslation" vRecWSB_DCAEntityTranslation The translation that was found.

Returns

Type Description
Boolean true iff a translation was found.

wgFncGetEntityTranslation

Retrieve the translation for an entity definition and language.

Parameters

Type Name Description
Record "WSB_DCAEntityDefinition" pRecWSB_DCAEntityDefinition The entity definition.
Code[10] pLanguageCode The code of the language to get the entity translation for.
Record "WSB_DCAEntityTranslation" vRecWSB_DCAEntityTranslation The translation that was found.

Returns

Type Description
Boolean true iff a translation was found.

wgFncGetEntityTranslationForFile

Retrieve the translation for the entity.

Parameters

Type Name Description
Record "WSB_DCARemoteFile" pRecWSB_DCARemoteFile The file to get the entity translation for.
Record "WSB_DCAEntityTranslation" vRecWSB_DCAEntityTranslation The translation that was found.

Returns

Type Description
Boolean true iff a translation was found.

wgFncIsCategoryAvailableForEntity

Determines whether the category is available for an entity definition.

Parameters

Type Name Description
Code[20] pCategoryCode The code of the category.
Record "WSB_DCAEntityDefinition" pRecWSB_DCAEntityDefinition The entity definition.

Returns

Type Description
Boolean true iff the category is available for the entity definition.

wgFncLookupEntityDefinitions

Opens the "Entity Definitions" page to select entity definitions. If the user clicks on "OK" to close the page, the selected permission set(s) will be returned.

Parameters

Type Name Description
Boolean pAllowMultiselect Whether to allow multi-select.
Record "WSB_DCAEntityDefinition" pRecSelectedEntityDefinition The entity definition the user had selected before opening the page.
Record "WSB_DCAEntityDefinition" temporary vRecTempWSB_DCAEntityDefinition The entity definition(s).

Returns

Type Description
Boolean true iff the user entity definition(s) and pressed "OK".

wgFncMultiselectCategoryEntityDefinitionLookup

Opens the entity definitions page, allowing for multi-select. When the user clicks "OK", the selected entity definitions are added for the category.

Parameters

Type Name Description
Code[20] pCategoryCode The code of the category.
Record "WSB_DCACategoryEntity" pRecSelectedCategoryEntity The selected entity definition

Returns

Type Description
Boolean true iff category entity definitions were added.

wgFncSelectTableFilters

Lets the user select table filters for an entity definition.

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).