Table of Contents

KVSDMSSetup

Summary: Handles setup and configuration of the DMS and ECM integration.

Procedures

HandleNotificationActionOpenAssistedSetup(Notification) :

Summary: This procedure is used as notification handler to call the assisted setup of the "DMS & ECM Interface" App.

procedure HandleNotificationActionOpenAssistedSetup(SetupNotification: Notification):

Parameters:

  • SetupNotification: Notification.

GetDefaultStoDefCodeAndDescription(Integer, Code[20], Text[100]) :

Summary: Gets a default Storage Definition Code and Description. This procedure can be used to calculate a default code and description based on the caption of the given table.

procedure GetDefaultStoDefCodeAndDescription(TableID: Integer; var DefCode: Code[20]; var DefDescription: Text[100]):

Parameters:

  • TableID: Integer specifies the unique id of the table to return a default storage definition code and description for.
  • DefCode: VAR Code[20] defines the calculated code to return.
  • DefDescription: VAR Text[100] defines the calculated description to return.

GetDefaultStoDefCodeAndDescription(Text, Code[20], Text[100]) :

Summary: Gets a default Storage Definition Code and Description. This procedure can be used to calculate a default code and description based on the caption of the given table.

procedure GetDefaultStoDefCodeAndDescription(SourceText: Text; var DefCode: Code[20]; var DefDescription: Text[100]):

Parameters:

  • SourceText: Text specifies the default source text for which the preocedure needs to return a default storage definition code and description for.
  • DefCode: VAR Code[20] defines the calculated code to return.
  • DefDescription: VAR Text[100] defines the calculated description to return.

CreateTemporaryStorageDefinition(Record KVSDMSStorageDefinition, Code[20], Text[100], Integer) :

Summary: Create a temporary storage definition and add it to the temporary list.

procedure CreateTemporaryStorageDefinition(var TempStorageDefinition: Record "KVSDMSStorageDefinition" temporary; NewCode: Code[20]; NewDescription: Text[100]; NewTableID: Integer):

Parameters:

  • TempStorageDefinition: Temporary VAR Record KVSDMSStorageDefinition specifies the temporary list of.
  • NewCode: Code[20] defines the unique code to create a new definition with.
  • NewDescription: Text[100] defines the description of the storage definition to use.
  • NewTableID: Integer specifies the id of the underlying table.

CreateTemporaryStorageDefinition(Record KVSDMSStorageDefinition, Code[20], Text[100], Integer, Integer, Text) :

Summary: Create a temporary storage definition and add it to the temporary list.

procedure CreateTemporaryStorageDefinition(var TempStorageDefinition: Record "KVSDMSStorageDefinition" temporary; NewCode: Code[20]; NewDescription: Text[100]; NewTableID: Integer; FilterFieldID: Integer; FilterText: Text):

Parameters:

  • TempStorageDefinition: Temporary VAR Record KVSDMSStorageDefinition specifies the temporary list.
  • NewCode: Code[20] defines the unique code to create a new definition with.
  • NewDescription: Text[100] defines the description of the storage definition to use.
  • NewTableID: Integer specifies the id of the underlying table.
  • FilterFieldID: Integer specifies the id of the field to set a filter on to.
  • FilterText: Text specifies the textual form of the filter to use on the given filterFieldID.

CreateTemporaryStorageDefinitionPlaceholder(Record KVSDMSStorageDefPlaceholder, Code[20], Enum KVSDMSDataSource, Integer, Integer, Enum KVSDMSDataSourceFunctions) :

Summary: Create a temporary storage definition placeholder and add it to the temporary list.

procedure CreateTemporaryStorageDefinitionPlaceholder(var TempPlaceholder: Record "KVSDMSStorageDefPlaceholder" temporary; StorageDefinitionCode: Code[20]; DataSource: Enum "KVSDMSDataSource"; TableNo: Integer; FieldNo: Integer; FunctionName: Enum "KVSDMSDataSourceFunctions"):

Parameters:

  • TempPlaceholder: Temporary VAR Record KVSDMSStorageDefPlaceholder specifies the temporary list.
  • StorageDefinitionCode: Code[20] specifies the unique code of the storage definition to add this placeholder definition to.
  • DataSource: Enum KVSDMSDataSource specifies the data source for the placeholder.
  • TableNo: Integer defines the table no. to use for the according placeholder entry.
  • FieldNo: Integer defines the id of the according table for the placeholder entry.
  • FunctionName: Enum KVSDMSDataSourceFunctions specifies the function to use if data source is of type Function.

CreateTemporaryStorageDefinitionTag(Record KVSDMSStorageDefinitionTag, Code[20], Code[20], Enum KVSDMSDataSource, Integer, Integer, Enum KVSDMSDataSourceFunctions) :

Summary: Create a temporary storage definition tag and add it to the temporary list.

procedure CreateTemporaryStorageDefinitionTag(var TempTags: Record "KVSDMSStorageDefinitionTag" temporary; StorageDefinitionCode: Code[20]; TagCode: Code[20]; DataSource: Enum "KVSDMSDataSource"; TableNo: Integer; FieldNo: Integer; FunctionName: Enum "KVSDMSDataSourceFunctions"):

Parameters:

  • TempTags: Temporary VAR Record KVSDMSStorageDefinitionTag specifies the temporary list.
  • StorageDefinitionCode: Code[20] specifies the unique code of the storage definition to add this tag definition to.
  • TagCode: Code[20] specifies the code of the tag to add.
  • DataSource: Enum KVSDMSDataSource specifies the data source for the tag.
  • TableNo: Integer defines the table no. to use for the according tag entry.
  • FieldNo: Integer defines the id of the according table for the tag entry.
  • FunctionName: Enum KVSDMSDataSourceFunctions specifies the function to use if data source is of type Function.

CreateTemporaryStorageDefinitionTag(Record KVSDMSStorageDefinitionTag, Code[20], Enum KVSDMSPredefinedTagType, Enum KVSDMSDataSource, Integer, Integer, Enum KVSDMSDataSourceFunctions) :

Summary: Create a temporary storage definition tag and add it to the temporary list.

procedure CreateTemporaryStorageDefinitionTag(var TempTags: Record "KVSDMSStorageDefinitionTag" temporary; StorageDefinitionCode: Code[20]; PredefinedTagType: Enum "KVSDMSPredefinedTagType"; DataSource: Enum "KVSDMSDataSource"; TableNo: Integer; FieldNo: Integer; FunctionName: Enum "KVSDMSDataSourceFunctions"):

Parameters:

  • TempTags: Temporary VAR Record KVSDMSStorageDefinitionTag specifies the temporary list.
  • StorageDefinitionCode: Code[20] specifies the unique code of the storage definition to add this tag definition to.
  • PredefinedTagType: Enum KVSDMSPredefinedTagType specifies the pre-defined tag type to create a tag for. The code of the tag will be created automatically.
  • DataSource: Enum KVSDMSDataSource specifies the data source for the tag.
  • TableNo: Integer defines the table no. to use for the according tag entry.
  • FieldNo: Integer defines the id of the according table for the tag entry.
  • FunctionName: Enum KVSDMSDataSourceFunctions specifies the function to use if data source is of type Function.

CreateExtTableRelationHeader(Integer, Integer, Text[100], Record KVSDMSExtTableRelHeader) : Boolean

Summary: Create a new extended table relation header.

procedure CreateExtTableRelationHeader(FromTableID: Integer; ToTableID: Integer; Description: Text[100]; var ExtTableRelationHeader: Record "KVSDMSExtTableRelHeader"): Boolean

Parameters:

  • FromTableID: Integer specifies the source table to use.
  • ToTableID: Integer specifies the target table to use.
  • Description: Text[100] specifies the description to use.
  • ExtTableRelationHeader: VAR Record KVSDMSExtTableRelHeader defines the returnable created record.

Returns: Return value of type Boolean specifies whether the procedure call has been successfull.

CreateExtTableRelationLine(Integer, Integer, Enum KVSDMSExtTableRelLineValueType, Integer, Text[250]) :

Summary: Create extended table relation line.

procedure CreateExtTableRelationLine(TableRelationHeaderNo: Integer; ToFieldNo: Integer; ValueType: Enum "KVSDMSExtTableRelLineValueType"; FromFieldNo: Integer; FromConstantValue: Text[250]):

Parameters:

  • TableRelationHeaderNo: Integer defines the unique no. of the table relation header you want to add a line to.
  • ToFieldNo: Integer specifies the field no. of the target table record.
  • ValueType: Enum KVSDMSExtTableRelLineValueType of the connection. Can be "Field" for a linked table field or "Constant" for recognizing a constant value.
  • FromFieldNo: Integer specifies the field no. of the source table record.
  • FromConstantValue: Text[250] specifies the constant value to set the table relation line link to.

Events

OnCreateStorageDefinitionBeforeModify(Record KVSDMSStorageDefinition, Record KVSDMSStorageDefinition) :

Summary: Raised before modifying a storage definition.

[IntegrationEvent(false, false)]
local procedure OnCreateStorageDefinitionBeforeModify(var StorageDefinition: Record "KVSDMSStorageDefinition"; var TempStorageDefinition: Record "KVSDMSStorageDefinition" temporary):

Parameters:

  • StorageDefinition: Record of storage definition to be modified.
  • TempStorageDefinition: Temporary record of storage definition.

OnCreateStorageDefinitionAfterModify(Record KVSDMSStorageDefinition, Record KVSDMSStorageDefinition) :

Summary: Raised after modifying a storage definition.

[IntegrationEvent(false, false)]
local procedure OnCreateStorageDefinitionAfterModify(var StorageDefinition: Record "KVSDMSStorageDefinition"; var TempStorageDefinition: Record "KVSDMSStorageDefinition" temporary):

Parameters:

  • StorageDefinition: Record of storage definition that was modified.
  • TempStorageDefinition: Temporary record of storage definition.

OnAfterLoadTemporarySupportedStorageDefinitions(Record KVSDMSStorageDefinition, Record KVSDMSStorageDefPlaceholder, Record KVSDMSStorageDefinitionTag, Record KVSDMSStorageDefSubdirectory) :

Summary: Raised after loading temporary supported storage definitions.

[IntegrationEvent(false, false)]
local procedure OnAfterLoadTemporarySupportedStorageDefinitions(var TempStorageDefinition: Record "KVSDMSStorageDefinition" temporary; var TempPlaceholder: Record "KVSDMSStorageDefPlaceholder" temporary; var TempTags: Record "KVSDMSStorageDefinitionTag" temporary; var TempSubDirectories: Record "KVSDMSStorageDefSubdirectory" temporary):

Parameters:

  • TempStorageDefinition: Temporary record of storage definition.
  • TempPlaceholder: Temporary record of storage definition placeholder.
  • TempTags: Temporary record of storage definition tag.
  • TempSubDirectories: Temporary record of storage definition subdirectory.

OnGetNoOfAssistedSetupSteps(Integer) :

Summary: Raised to get the number of assisted setup steps.

[IntegrationEvent(false, false)]
local procedure OnGetNoOfAssistedSetupSteps(var NoOfSteps: Integer):

Parameters:

  • NoOfSteps: Number of assisted setup steps.

OnAfterCreatePredefinedExtTableRelationsBeforeAutoUpdateTableRelDescriptions() :

Summary: Raised after creating predefined external table relations before auto-updating table relation descriptions.

[IntegrationEvent(false, false)]
local procedure OnAfterCreatePredefinedExtTableRelationsBeforeAutoUpdateTableRelDescriptions():

OnAfterCreatePredefinedExtTableRelationsAfterAutoUpdateTableRelDescriptions() :

Summary: Raised after creating predefined external table relations after auto-updating table relation descriptions.

[IntegrationEvent(false, false)]
local procedure OnAfterCreatePredefinedExtTableRelationsAfterAutoUpdateTableRelDescriptions():

OnBeforeInsertDocumentDriveByDrivesBuffer(Record KVSDMSDocumentDrive, Record KVSDMSDriveBuffer) :

Summary: Raised before inserting a document drive from a drives buffer.

[IntegrationEvent(false, false)]
local procedure OnBeforeInsertDocumentDriveByDrivesBuffer(var DocumentDrive: Record "KVSDMSDocumentDrive"; var DrivesBuffer: Record "KVSDMSDriveBuffer"):

Parameters:

  • DocumentDrive: Record of document drive to be inserted.
  • DrivesBuffer: Record of drives buffer.

OnBeforeModifyTagsBufferFromArchivingTag(Record KVSDMSTagBuffer, Record KVSDMSArchivingTagCode) :

Summary: Raised before modifying tags buffer from archiving tag.

[IntegrationEvent(false, false)]
local procedure OnBeforeModifyTagsBufferFromArchivingTag(var TagsBuffer: Record "KVSDMSTagBuffer"; ArchivingTag: Record "KVSDMSArchivingTagCode"):

Parameters:

  • TagsBuffer: Record of tags buffer to be modified.
  • ArchivingTag: Record of archiving tag code.

OnBeforeInsertArchivingTagFromTagsBuffer(Record KVSDMSArchivingTagCode, Record KVSDMSTagBuffer) :

Summary: Raised before inserting an archiving tag from tags buffer.

[IntegrationEvent(false, false)]
local procedure OnBeforeInsertArchivingTagFromTagsBuffer(var ArchivingTag: Record "KVSDMSArchivingTagCode"; TagsBuffer: Record "KVSDMSTagBuffer"):

Parameters:

  • ArchivingTag: Record of archiving tag code to be inserted.
  • TagsBuffer: Record of tags buffer.