KVSDMSDocumentStorageProcessor
Summary: Processes document storage operations for DMS and ECM systems.
Procedures
TestConnectivity(Text) : Boolean
Summary: Checks whether the connectivity to the host is given.
procedure TestConnectivity(var Message: Text): Boolean
Parameters:
Message: Specifies the message to show returned by the check procedure.
Returns: Return variable success of type Boolean that states if connection is possible.
UploadFile(Variant, Record KVSDMSDocumentDrive, Text, Text, Dictionary, InStream) : Text
procedure UploadFile(SourceRecord: Variant; DocumentDrive: Record "KVSDMSDocumentDrive"; DirectoryPath: Text; FileName: Text; Tags: Dictionary; FileContentAsStream: InStream): Text
UpdateFileTags(Record KVSDMSFileBuffer, Dictionary) :
MoveAllFilesFromDirectoryToAnotherDirectory(Text, Text, Text, Text, Text, Text) :
Summary: Move all files from an directory to another directory.
procedure MoveAllFilesFromDirectoryToAnotherDirectory(FromSiteID: Text; FromDriveID: Text; FromDirectoryPath: Text; ToSiteID: Text; ToDriveID: Text; ToDirectoryPath: Text):
Parameters:
FromSiteID: Site ID of the source site.FromDriveID: Drive ID of the source drive.FromDirectoryPath: Directory path of the source directory.ToSiteID: Site ID of the target site.ToDriveID: Drive ID of the target drive.ToDirectoryPath: Directory path of the target directory.
GetFileTags(Record KVSDMSFileBuffer, List, Dictionary, Text) : Boolean
GetFileListFromDirectory(Text, Text, Text, Enum KVSDMSRetrieveFileMode, Record KVSDMSFileBuffer, Text) : Boolean
Summary: Get list of all files within a Directory.
procedure GetFileListFromDirectory(SiteID: Text; DriveID: Text; DirectoryPath: Text; RetrieveFileMode: Enum "KVSDMSRetrieveFileMode"; var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; var ErrorMessage: Text): Boolean
Parameters:
SiteID: Site Id of the site to list files from.DriveID: Drive Id of the drive to list files from.DirectoryPath: Directory path to list files from.RetrieveFileMode: Specifes the Enum KVSDMSRetrieveFileMode which defines which entries to retrieve.TempFileBuffer: Temporary VAR Record KVSDMSFileBuffer specifies the returnable list of files and tags.ErrorMessage: VAR Text specifies the Error Message that possibly occurs.
Returns: Return value of type Boolean specifies if procedure was successfull.
GetFileListFromDirectory(Text, Text, Text, Text, Enum KVSDMSRetrieveFileMode, Record KVSDMSFileBuffer, Text) : Boolean
Summary: Get list of all files within a Directory.
procedure GetFileListFromDirectory(SiteID: Text; DriveID: Text; DirectoryPath: Text; FileTagsToRetrieveArray: Text; RetrieveFileMode: Enum "KVSDMSRetrieveFileMode"; var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; var ErrorMessage: Text): Boolean
Parameters:
SiteID: Site Id of the site to list files from.DriveID: Drive Id of the drive to list files from.DirectoryPath: Directory path to list files from.FileTagsToRetrieveArray: Array[20] of Text specifies the list of tag codes to retrieve.RetrieveFileMode: Specifes the Enum KVSDMSRetrieveFileMode which defines which entries to retrieve.TempFileBuffer: Temporary VAR Record KVSDMSFileBuffer specifies the returnable list of files and tags.ErrorMessage: VAR Text specifies the Error Message that possibly occurs.
Returns: Return value of type Boolean specifies if procedure was successfull.
SearchFilesByTags(Dictionary, Record KVSDMSDocumentDrive, Boolean, Text, Record KVSDMSFileBuffer, Text) : Boolean
SearchFilesByText(Text, Record KVSDMSDocumentDrive, Text, Record KVSDMSFileBuffer, Text) : Boolean
Summary: Search Files by given searchtext.
procedure SearchFilesByText(SearchText: Text; var FilteredSearchDrives: Record "KVSDMSDocumentDrive"; FileTagsToRetrieveArray: Text; var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; var ErrorMessage: Text): Boolean
Parameters:
SearchText: Text defining the searchterm to search for.FilteredSearchDrives: VAR Record KVSDMSDocumentDrive specifies the document drives to search within.FileTagsToRetrieveArray: Array[20] of Text specifies the list of tag codes to retrieve.TempFileBuffer: Temporary VAR Record KVSDMSFileBuffer specifies the returnable list of files and tags.ErrorMessage: VAR Text specifies the Error Message that possibly occurs.
Returns: Return value of type Boolean specifies if procedure was successfull.
GetURLFromDirectory(Text, Text, Text) : Text
Summary: Get URL from directory.
procedure GetURLFromDirectory(SiteID: Text; DriveID: Text; DirectoryPath: Text): Text
Parameters:
SiteID: Site Id of the site to get the directory url from.DriveID: Drive Id of the drive to get the directory url from.DirectoryPath: Directory path to get the directory url from.
Returns: Return value of type Text defines the url of the given directory path.
GetURLFromFile(Record KVSDMSFileBuffer) : Text
Summary: Get URL from file.
procedure GetURLFromFile(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary): Text
Parameters:
TempFileBuffer: Temporary VAR Record KVSDMSFileBuffer specifies the file informations to return the url for.
Returns: Return value of type Text defines the url of the given file.
GetBase64DataStreamFromFile(Record KVSDMSFileBuffer) : Boolean
Summary: Get Base64 encoded data stream from file and save as "File Content" BLOB field within TempFileBuffer.
procedure GetBase64DataStreamFromFile(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary): Boolean
Parameters:
TempFileBuffer: Temporary VAR Record KVSDMSFileBuffer specifies the file informations to return the Base64 encoded stream for.
Returns: Return value of type Boolean specifies if procedure was successfull.
GetBase64DataStreamFromFile(Record KVSDMSFileBuffer, Text) : Boolean
Summary: Get Base64 encoded data stream from file.
procedure GetBase64DataStreamFromFile(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; var B64FileContent: Text): Boolean
Parameters:
TempFileBuffer: Temporary VAR Record KVSDMSFileBuffer specifies the file informations to return the Base64 encoded stream for.B64FileContent: VAR Text specifies the base64 encoded file stream value.
Returns: Return value of type Boolean specifies if procedure was successfull.
GetBase64DataStreamFromFile(Record KVSDMSFileBuffer, Dictionary) : Boolean
procedure GetBase64DataStreamFromFile(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; var B64FileContents: Dictionary): Boolean
DeleteEntry(Record KVSDMSFileBuffer, Text) : Boolean
Summary: Try to delete an Entry of the DMS or ECM. Success depends on the assigned compliance rules.
procedure DeleteEntry(var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; var ErrorMessage: Text): Boolean
Parameters:
TempFileBuffer: Temporary VAR Record KVSDMSFileBuffer specifies the file informations to delete.ErrorMessage: VAR Text specifies the Error Message that possibly occurs.
Returns: Return value of type Boolean specifies if procedure was successfull.
RetrieveAllAvailableSites(Record KVSDMSSiteBuffer) :
Summary: Retrieve all available sites.
procedure RetrieveAllAvailableSites(var SiteBuffer: Record "KVSDMSSiteBuffer"):
Parameters:
SiteBuffer: VAR Record KVSDMSSiteBuffer specifies the available sites within the DMS or ECM.
RetrieveAllAvailableDrivesForSite(Text, Record KVSDMSDriveBuffer) :
Summary: Retrieve all available drives for given site.
procedure RetrieveAllAvailableDrivesForSite(SiteID: Text; var DriveBuffer: Record "KVSDMSDriveBuffer"):
Parameters:
SiteID: Site Id of the site to get the all drives from.DriveBuffer: VAR Record KVSDMSDriveBuffer specifies the available drives within the DMS or ECM for the given site.
GetSiteIDBySiteName(Text) : Text
Summary: Get Site-ID by Site-Name.
procedure GetSiteIDBySiteName(SiteName: Text): Text
Parameters:
SiteName: Specifies the name of the site to return the id for.
Returns: Return value of type Text specifies the Site-ID assigned to the site with the given name.
GetDriveIDByDriveName(Text, Text) : Text
Summary: Get Drive-ID by Drive-Name.
procedure GetDriveIDByDriveName(SiteID: Text; DriveName: Text): Text
Parameters:
SiteID: Specifies the Site-Id of the site to look for a drive with the given name.DriveName: Specifies the name of the drive to return the id for.
Returns: Return value of type Text specifies the Drive-ID assigned to the drive with the given name.
LookupDirectoryPathForStorageDefinition(Text, Text, Text) : Boolean
Summary: Lookup Directory-Path and returns a selected directory path for storage definition.
procedure LookupDirectoryPathForStorageDefinition(SiteID: Text; DriveID: Text; var DirectoryPath: Text): Boolean
Parameters:
SiteID: Specifies the Site-Id of the site to look for directories.DriveID: Specifies the Drive-Id to look for directories. A Lookup page will be opened to select the according directory path.DirectoryPath: VAR Text specifies the directory path that has been choosen by the user using the lookup page.
Returns: Return value of type Boolean specifies if procedure was successfull.
GetAllArchivingSystemFieldCodes(Text, Text, Record KVSDMSTagBuffer) :
Summary: Get all archiving system field codes (tags).
procedure GetAllArchivingSystemFieldCodes(SiteID: Text; DriveID: Text; var TagBuffer: Record "KVSDMSTagBuffer"):
Parameters:
SiteID: Specifies the Site-Id of the site to look for tags.DriveID: Specifies the Drive-Id to look for tags.TagBuffer: VAR Record KVSDMSTagBuffer specifies the list of found tags .
SetForCompanyCode(Text) :
Summary: Set the Company Code to handle values for.
procedure SetForCompanyCode(NewValue: Text):
Parameters:
NewValue: Text that specifies the company code.
SearchFilesBySearchDefinition(Variant, Record KVSDMSDocSearchDefinition, Record KVSDMSFileBuffer, Text) : Boolean
Summary: Search files by given search definition.
procedure SearchFilesBySearchDefinition(SourceRecord: Variant; SearchDefinition: Record "KVSDMSDocSearchDefinition"; var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; var ErrorMessage: Text): Boolean
Parameters:
SourceRecord: Variant specifying the record to get files for.SearchDefinition: Record KVSDMSDocSearchDefinition defines the assigned search definition to use for searching files.TempFileBuffer: Temporary VAR Record KVSDMSFileBuffer that will be filled with the found file entries.ErrorMessage: VAR Text specifies the Error Message that possibly occurs.
Returns: Return value of type Boolean specifies if procedure was successfull.
SearchFilesBySearchDefinition(Variant, Record KVSDMSDocSearchDefinition, Text, Record KVSDMSFileBuffer, Text) : Boolean
Summary: Search files by given search definition.
procedure SearchFilesBySearchDefinition(SourceRecord: Variant; SearchDefinition: Record "KVSDMSDocSearchDefinition"; FileTagsToRetrieveArray: Text; var TempFileBuffer: Record "KVSDMSFileBuffer" temporary; var ErrorMessage: Text): Boolean
Parameters:
SourceRecord: Variant specifying the record to get files for.SearchDefinition: Record KVSDMSDocSearchDefinition defines the assigned search definition to use for searching files.FileTagsToRetrieveArray: Array[20] of Text defining the array of file tags to retrieve.TempFileBuffer: Temporary VAR Record KVSDMSFileBuffer that will be filled with the found file entries.ErrorMessage: VAR Text specifies the Error Message that possibly occurs.
Returns: Return value of type Boolean specifies if procedure was successfull.
FindStorageDefinitionForSourceRecord(RecordRef, Record KVSDMSStorageDefinition, Boolean) : Boolean
Summary: Find Storage Definition for record.
procedure FindStorageDefinitionForSourceRecord(RecRef: RecordRef; var StorageDefinition: Record "KVSDMSStorageDefinition"; ExcludeBackgroundPostingDefinitions: Boolean): Boolean
Parameters:
RecRef: RecordRef defines the source record to find a storage definition for.StorageDefinition: VAR Record KVSDMSStorageDefinition specifies the found and returned storage definition.ExcludeBackgroundPostingDefinitions: Using this parameter you can specify whether storage definitions that are defined for background postings should be excluded.
Returns: Return value of type Boolean specifies if procedure was successfull.
FindStorageDefinitionForSourceRecord(RecordRef, Record KVSDMSStorageDefinition, Enum KVSDMSFindStorageDefType) : Boolean
Summary: Find Storage Definition for record.
procedure FindStorageDefinitionForSourceRecord(RecRef: RecordRef; var StorageDefinition: Record "KVSDMSStorageDefinition"; FindStoragedefType: Enum "KVSDMSFindStorageDefType"): Boolean
Parameters:
RecRef: RecordRef defines the source record to find a storage definition for.StorageDefinition: VAR Record KVSDMSStorageDefinition specifies the found and returned storage definition.FindStoragedefType: Enum KVSDMSFindStorageDefType specifies the type of Storage Types to return. In Standard you can choose to return all, only background definitions or to exclude background definitions.
Returns: Return value of type Boolean specifies if procedure was successfull.
DoesSearchDefinitionMatchSourceRecord(RecordRef, Record KVSDMSStorageDefinition) : Boolean
Summary: Check if given storage definition matches the given source record.
procedure DoesSearchDefinitionMatchSourceRecord(RecRef: RecordRef; StorageDefinition: Record "KVSDMSStorageDefinition"): Boolean
Parameters:
RecRef: RecordRef defines the source record to check a storage definition for.StorageDefinition: Record KVSDMSStorageDefinition specifies the storage definition to check against the RecordRef.
Returns: Return value of type Boolean specifies if storage definition matches the given RecordRef.
FindSearchDefinitionForSourceRecord(RecordRef, Record KVSDMSDocSearchDefinition) : Boolean
Summary: Find Search Definition for record.
procedure FindSearchDefinitionForSourceRecord(RecRef: RecordRef; var SearchDefinition: Record "KVSDMSDocSearchDefinition"): Boolean
Parameters:
RecRef: RecordRef defines the source record to find a search definition for.SearchDefinition: VAR Record KVSDMSDocSearchDefinition specifies the found and returned search definition.
Returns: Return value of type Boolean specifies if procedure was successfull.
FindSearchDefinitionForSourceRecord(RecordRef, Record KVSDMSDocSearchDefinition, Boolean) : Boolean
Summary: Find Search Definition for record.
procedure FindSearchDefinitionForSourceRecord(RecRef: RecordRef; var SearchDefinition: Record "KVSDMSDocSearchDefinition"; LookForMoveDefinition: Boolean): Boolean
Parameters:
RecRef: RecordRef defines the source record to find a search definition for.SearchDefinition: VAR Record KVSDMSDocSearchDefinition specifies the found and returned search definition.LookForMoveDefinition: Specifies if the search definition should be searched for move definitions.
Returns: Return value of type Boolean specifies if procedure was successfull.
DoesSearchDefinitionMatchSourceRecord(RecordRef, Record KVSDMSDocSearchDefinition) : Boolean
Summary: Check if given search definition matches the given source record.
procedure DoesSearchDefinitionMatchSourceRecord(RecRef: RecordRef; SearchDefinition: Record "KVSDMSDocSearchDefinition"): Boolean
Parameters:
RecRef: RecordRef defines the source record to check a search definition for.SearchDefinition: Record KVSDMSDocSearchDefinition specifies the search definition to check against the RecordRef.
Returns: Return value of type Boolean specifies if SearchDefinition matches the given RecordRef.
GetAvailableSubdirectoryBufferForUpload(Variant, Record KVSDMSStorageDefinition, Record KVSDMSDocumentDrive, Record KVSDMSStorageDefSubdirectory) : Boolean
Summary: Get available subdirectory buffer for upload.
procedure GetAvailableSubdirectoryBufferForUpload(SourceRec: Variant; StorageDefinition: Record "KVSDMSStorageDefinition"; DocumentDrive: Record "KVSDMSDocumentDrive"; var TempSubdirectories: Record "KVSDMSStorageDefSubdirectory" temporary): Boolean
Parameters:
SourceRec: Variant specifying the record to search upload directories for.StorageDefinition: Record KVSDMSStorageDefinition defines the calculated storage definition used for upload.DocumentDrive: Record KVSDMSDocumentDrive specifies the document drive to upload files to.TempSubdirectories: Temporary VAR Record KVSDMSStorageDefSubdirectory defines a list of directories found for uploading files.
Returns: Return value of type Boolean specifies if procedure was successfull.
CalcStorageDirectoryWithPlaceholders(Variant, Record KVSDMSStorageDefinition, Integer, Text) : Boolean
Summary: Calculates the storage directory with placeholders.
procedure CalcStorageDirectoryWithPlaceholders(SourceRec: Variant; StorageDefinition: Record "KVSDMSStorageDefinition"; SubDirectoryEntryNo: Integer; var DirectoryPath: Text): Boolean
Parameters:
SourceRec: Variant specifying the record to calculate the storage directory for.StorageDefinition: Record KVSDMSStorageDefinition specifies the storage definition used for calculating the directory.SubDirectoryEntryNo: Specifies the entry no. of the selected sub directory.DirectoryPath: VAR Text specifies the path of the selected directory entry.
Returns: Return value of type Boolean specifies if procedure was successfull.
CalcStorageDirectoryWithPlaceholders(Variant, Record KVSDMSStorageDefinition, Text, Text) : Boolean
Summary: Calculates the storage directory with placeholders.
procedure CalcStorageDirectoryWithPlaceholders(SourceRec: Variant; StorageDefinition: Record "KVSDMSStorageDefinition"; SubDirectoryPath: Text; var DirectoryPath: Text): Boolean
Parameters:
SourceRec: Variant specifying the record to calculate the storage directory for.StorageDefinition: Record KVSDMSStorageDefinition specifies the storage definition used for calculating the directory.SubDirectoryPath: This parameter specifies the choosen sub directory path and will be included as part of the DirectoryPath.DirectoryPath: VAR Text specifies the path of the selected directory entry including the sub directory path.
Returns: Return value of type Boolean specifies if procedure was successfull.
CalcStorageDirectoryWithPlaceholders(Variant, Record KVSDMSStorageDefinition, Text, Boolean, Text) : Boolean
Summary: Calculates the storage directory with placeholders.
procedure CalcStorageDirectoryWithPlaceholders(SourceRec: Variant; StorageDefinition: Record "KVSDMSStorageDefinition"; SubDirectoryPath: Text; ShowError: Boolean; var DirectoryPath: Text): Boolean
Parameters:
SourceRec: Variant specifying the record to calculate the storage directory for.StorageDefinition: Record KVSDMSStorageDefinition specifies the storage definition used for calculating the directory.SubDirectoryPath: This parameter specifies the choosen sub directory path and will be included as part of the DirectoryPath.ShowError: Boolean defines whether to show errors during calculation. If false, no error will be thrown by GUI.DirectoryPath: VAR Text specifies the path of the selected directory entry including the sub directory path.
Returns: Return value of type Boolean specifies if procedure was successfull.
GetNonManuallyTagsForSourceRecord(Variant, Code[20], Enum KVSDMSDocumentTagType, Text) : Dictionary
Summary: Get non-manually tags for the record will return all storage definition tags, that are not marked as "manually".
Parameters:
SourceRec: Variant specifying the record to calculate the storage definition tags for.StorageDefinitionCode: Code[20] specifies the storage definition code to use for calculation.TagType: Enum KVSDMSDocumentTagType defines whether to choose the storage definition or the search definition as base for calculation.FileName: Text specifying the fileName of the according storage file.
Returns: Return variable tags of type Dictionary of [Text, Text] defining the non-manually tags as Key-Value pair.
ShowEditManuallyTagsForFile(Text, Code[20], Dictionary) : Boolean
ShowEditManuallyTagsForFile(Text, Code[20], Dictionary, Boolean) : Boolean
ShowListAllTagsForFile(Text, Code[20], Dictionary) :
GetManuallyTagsSubstitutionValuesForBackgroundProcesses(Code[20], Dictionary) :
UpdateTagsForAllFilesRelatedToRecord(Variant, Record KVSDMSStorageDefinition, Boolean) :
Summary: Update tags for all files related to a record.
Parameters:
SourceRec: Variant specifying the record to calculate the files to update for.StorageDefinition: Record KVSDMSStorageDefinition specifies the storage definition used for calculating the tags.ShowGUI: Boolean specifying whether to allow the display of a dialog window. If false, no dialog will be displayed.
UpdateTagsForAllFilesRelatedToRecord(Variant, Record KVSDMSStorageDefinition, Record KVSDMSDocSearchDefinition, Boolean) :
Summary: Update tags for all files related to a record.
Parameters:
SourceRec: Variant specifying the record to calculate the files to update for.StorageDefinition: Record KVSDMSStorageDefinition specifies the storage definition used for calculating the tags.BySearchDefinition: Record KVSDMSDocSearchDefinition specifies the search definition that will be used in order to search the files to update.ShowGUI: Boolean specifying whether to allow the display of a dialog window. If false, no dialog will be displayed.
ConvertTagNameArrayToCommaSeparatedList(Text) : Text
Summary: Convert tag name list to comma separated list.
procedure ConvertTagNameArrayToCommaSeparatedList(TagArray: Text): Text
Parameters:
TagArray: array[20] of Text defines the tag array that will be used for conversion.
Returns: Return value of type Text specifying the comma separated lit of tags names.
ConvertTagNameListToCommaSeparatedList(List) : Text
procedure ConvertTagNameListToCommaSeparatedList(TagList: List): Text
GetFileTagsToRetrievedArrayFromDisplayDefinition(Code[20]) : Text
Summary: Get file tags to retrieved array from display definition.
Parameters:
DisplayDefinitionCode: Code[20] defines the code of the display definition to calculate the file tags for.
Returns: Return variable displayDefinitionTagCodeArray of type array[20] of Text specifying the list of tags that are assigned to the according display definition.
Events
OnCalcDataSourceValueForFunctionElse(Variant, Enum KVSDMSDataSourceFunctions, Text, Text, Text, Text[250], Text) :
Summary: Raised when calculating data source value for function with custom logic.
[IntegrationEvent(false, false)]
local procedure OnCalcDataSourceValueForFunctionElse(SourceRec: Variant; DataSourceFunction: Enum "KVSDMSDataSourceFunctions"; Parameter: Text; FileName: Text; RunForCompanyCode: Text; FormatString: Text[250]; var Result: Text):
Parameters:
SourceRec: The source record for which the data source value is being calculated.DataSourceFunction: The data source function being used.Parameter: The parameter for the data source function.FileName: The file name for which the data source value is being calculated.RunForCompanyCode: The company code for which the data source value is being calculated.FormatString: The format string for the data source value.Result: The result of the data source value calculation.
OnCheckDataSourceFunctionAllowedForTableElse(Enum KVSDMSDataSourceFunctions, Integer, Boolean) :
Summary: Raised when checking if a data source function is allowed for a specific table.
[IntegrationEvent(false, false)]
local procedure OnCheckDataSourceFunctionAllowedForTableElse(DataSourceFunction: Enum "KVSDMSDataSourceFunctions"; TableId: Integer; var IsAllowed: Boolean):
Parameters:
DataSourceFunction: The data source function to check.TableId: The table ID to check against.IsAllowed: Output parameter indicating whether the function is allowed for the table.
OnAfterSetFilterFindStorageDefinitionForSourceRecord(RecordRef, Record KVSDMSStorageDefinition) :
Summary: Raised after setting filters for finding a storage definition for a source record.
[IntegrationEvent(false, false)]
local procedure OnAfterSetFilterFindStorageDefinitionForSourceRecord(RecRef: RecordRef; var StorageDefinition: Record "KVSDMSStorageDefinition"):
Parameters:
RecRef: The record reference for which to find a storage definition.StorageDefinition: The storage definition record with filters applied.
OnAfterSetFilterFindSearchDefinitionForSourceRecord(RecordRef, Record KVSDMSDocSearchDefinition) :
Summary: Raised after setting filters for finding a search definition for a source record.
[IntegrationEvent(false, false)]
local procedure OnAfterSetFilterFindSearchDefinitionForSourceRecord(RecRef: RecordRef; var SearchDefinition: Record "KVSDMSDocSearchDefinition"):
Parameters:
RecRef: The record reference for which to find a search definition.SearchDefinition: The search definition record with filters applied.
OnBeforeCalcStorageDirectoryWithPlaceholders(Variant, Record KVSDMSStorageDefinition, Text, Text, Text) :
Summary: Raised before calculating storage directory with placeholders.
[IntegrationEvent(false, false)]
local procedure OnBeforeCalcStorageDirectoryWithPlaceholders(SourceRec: Variant; StorageDefinition: Record "KVSDMSStorageDefinition"; SubDirectoryPath: Text; RunForCompanyCode: Text; var DirectoryPath: Text):
Parameters:
SourceRec: The source record for directory calculation.StorageDefinition: The storage definition used for calculation.SubDirectoryPath: The chosen subdirectory path.RunForCompanyCode: The company code for which the calculation is performed.DirectoryPath: The resulting directory path.
OnAfterCalcStorageDirectoryWithPlaceholders(Variant, Record KVSDMSStorageDefinition, Text, Text, Text, Boolean) :
Summary: Raised after calculating storage directory with placeholders.
[IntegrationEvent(false, false)]
local procedure OnAfterCalcStorageDirectoryWithPlaceholders(SourceRec: Variant; StorageDefinition: Record "KVSDMSStorageDefinition"; SubDirectoryPath: Text; RunForCompanyCode: Text; var DirectoryPath: Text; var Result: Boolean):
Parameters:
SourceRec: The source record for directory calculation.StorageDefinition: The storage definition used for calculation.SubDirectoryPath: The chosen subdirectory path.RunForCompanyCode: The company code for which the calculation is performed.DirectoryPath: The resulting directory path.Result: Indicates whether the calculation was successful.
OnAfterGetNonManuallyTagsForSourceRecord(Variant, Code[20], Enum KVSDMSDocumentTagType, Text, Dictionary) :
OnAfterUpdateTagsForAllFilesRelatedToRecord(Variant, Record KVSDMSFileBuffer, Record KVSDMSStorageDefinition, Text) :
Summary: Raised after updating tags for all files related to a record.
Parameters:
SourceRec: The source record for which files were updated.TempFileBuffer: The temporary file buffer containing updated files.StorageDefinition: The storage definition used for the update.RunForCompanyCode: The company code for which the update was performed.
OnBeforeDoesRecRefMatchRecordViewGeneric(RecordId, Integer, Codeunit Temp Blob, Text, Boolean, Boolean) :
[IntegrationEvent(false, false)]
local procedure OnBeforeDoesRecRefMatchRecordViewGeneric(SourceRecordID: RecordId; TableId: Integer; TempBlob: Codeunit "Temp Blob"; RunForCompanyCode: Text; var Result: Boolean; var IsHandled: Boolean):
OnBeforeCalcDataSourceValueForOwnRecord(Variant, Integer, Text, Text[250], Text, Boolean) :
Summary: Raised before calculating data source value for own record.
[IntegrationEvent(false, false)]
local procedure OnBeforeCalcDataSourceValueForOwnRecord(SourceRec: Variant; FieldNo: Integer; RunForCompanyCode: Text; FormatString: Text[250]; var Result: Text; var IsHandled: Boolean):
Parameters:
SourceRec: The source record for value calculation.FieldNo: The field number to retrieve value from.RunForCompanyCode: The company code for which the calculation is performed.FormatString: The format string for the value.Result: The calculated result value.IsHandled: Indicates whether the event has been handled.
OnBeforeCalcDataSourceValueForRelatedRecordWithRelationChain(Variant, Integer, Integer, Integer, Text, Text[250], Text, Boolean) :
Summary: Raised before calculating data source value for related record using relation chain.
Parameters:
SourceRec: The source record for value calculation.TableId: The related table ID.RelationChainNo: The relation chain number.FieldNo: The field number to retrieve value from.RunForCompanyCode: The company code for which the calculation is performed.FormatString: The format string for the value.Result: The calculated result value.IsHandled: Indicates whether the event has been handled.
OnAfterShowEditManuallyTagsForFile(Text, Code[20], Text, Dictionary) :
OnCheckDataSourceFunctionAllowedForDirectoryPlaceholder(Enum KVSDMSDataSourceFunctions, Boolean) :
Summary: Raised when checking if a data source function is allowed for directory placeholders.
[IntegrationEvent(false, false)]
local procedure OnCheckDataSourceFunctionAllowedForDirectoryPlaceholder(DataSourceFunction: Enum "KVSDMSDataSourceFunctions"; var IsAllowed: Boolean):
Parameters:
DataSourceFunction: The data source function to check.IsAllowed: Output parameter indicating whether the function is allowed.
OnCheckDataSourceFunctionAllowedForTagType(Enum KVSDMSDataSourceFunctions, Enum KVSDMSDocumentTagType, Boolean) :
Summary: Raised when checking if a data source function is allowed for a specific tag type.
[IntegrationEvent(false, false)]
local procedure OnCheckDataSourceFunctionAllowedForTagType(DataSourceFunction: Enum "KVSDMSDataSourceFunctions"; TagType: Enum "KVSDMSDocumentTagType"; var IsAllowed: Boolean):
Parameters:
DataSourceFunction: The data source function to check.TagType: The tag type to check against.IsAllowed: Output parameter indicating whether the function is allowed.
OnBeforeRemoveInvalidCharactersFromDirectoryPath(Text, Boolean) :
Summary: Raised before removing invalid characters from directory path.
[IntegrationEvent(false, false)]
local procedure OnBeforeRemoveInvalidCharactersFromDirectoryPath(var DirectoryPath: Text; var IsHandled: Boolean):
Parameters:
DirectoryPath: The directory path to be cleaned.IsHandled: Indicates whether the event has been handled.
OnAfterGetManuallyTagsSubstitutionValuesForBackgroundProcesses(Code[20], Text, Dictionary) :
OnCheckParametersForDataSourceFunctionAreValid(Enum KVSDMSDataSourceFunctions, Text[250], Boolean) :
Summary: Raised when checking parameters for a data source function.
[IntegrationEvent(false, false)]
local procedure OnCheckParametersForDataSourceFunctionAreValid(DataSourceFunction: Enum "KVSDMSDataSourceFunctions"; Parameters: Text[250]; var ParametersAreValid: Boolean):
Parameters:
DataSourceFunction: The data source function being checked.Parameters: The parameters to validate.ParametersAreValid: Output parameter indicating whether the parameters are valid.
OnAssistEditParameterForDataSourceFunction(Enum KVSDMSDataSourceFunctions, Text[250]) :
Summary: Raised for assisting in editing parameters for a data source function.
[IntegrationEvent(false, false)]
local procedure OnAssistEditParameterForDataSourceFunction(DataSourceFunction: Enum "KVSDMSDataSourceFunctions"; var Parameters: Text[250]):
Parameters:
DataSourceFunction: The data source function for parameter editing.Parameters: The parameters being edited.
OnDoesDataSourceFunctionRequireParameter(Enum KVSDMSDataSourceFunctions, Boolean) :
Summary: Raised when checking if a data source function requires a parameter.
[IntegrationEvent(false, false)]
local procedure OnDoesDataSourceFunctionRequireParameter(DataSourceFunction: Enum "KVSDMSDataSourceFunctions"; var Result: Boolean):
Parameters:
DataSourceFunction: The data source function to check.Result: Output parameter indicating whether a parameter is required.
OnTransformDataSourceValueElse(Text, Enum KVSDMSTransformationRule, Text, Text) :
Summary: Raised when transforming data source value with custom transformation rule.
[IntegrationEvent(false, false)]
local procedure OnTransformDataSourceValueElse(DataSourceValue: Text; TransformationRule: Enum "KVSDMSTransformationRule"; RunForCompanyCode: Text; var TransformedValue: Text):
Parameters:
DataSourceValue: The source value to transform.TransformationRule: The transformation rule to apply.RunForCompanyCode: The company code for which the transformation is performed.TransformedValue: The resulting transformed value.
OnBeforeUploadFileImplementation(Variant, Record KVSDMSDocumentDrive, Text, Text, Dictionary, InStream) :
[IntegrationEvent(false, false)]
local procedure OnBeforeUploadFileImplementation(SourceRecord: Variant; var DocumentDrive: Record "KVSDMSDocumentDrive"; var DirectoryPath: Text; var FileName: Text; var Tags: Dictionary; var FileContentAsStream: InStream):
OnAfterUploadFile(Variant, Record KVSDMSDocumentDrive, Text, Text, Dictionary, Text) :
[IntegrationEvent(false, false)]
local procedure OnAfterUploadFile(SourceRecord: Variant; DocumentDrive: Record "KVSDMSDocumentDrive"; DirectoryPath: Text; FileName: Text; Tags: Dictionary; FileID: Text):