Skip to content

KVSDMSDocumentsSearch#

Procedures#

SetParameterForRecordRelatedFiles(RecordRef, Boolean) :#

Summary: Use this procedure in order to call the document search page related to a record. This procedure must be called to set parameters on page document search just before opening the page itself using .Run oder .RunModal calls.

procedure SetParameterForRecordRelatedFiles(baseRecRef: RecordRef; newExecuteSearchOnOpenPage: Boolean):

Parameters:

  • baseRecRef: Given referenced record for which you want to call the document search page for.
  • newExecuteSearchOnOpenPage: Activate this flag in order to execute the search automatically whith opening the page. Set to false if you want to set more filter criteria manually.

SetParameterForSearchByDefinition(RecordRef, Code[20], Boolean) :#

Summary: Use this procedure in order to call the document search page with informations related to a record and a search definition. This procedure must be called to set parameters on page document search just before opening the page itself using .Run oder .RunModal calls.

procedure SetParameterForSearchByDefinition(baseRecRef: RecordRef; searchDefinition: Code[20]; newExecuteSearchOnOpenPage: Boolean):

Parameters:

  • baseRecRef: Given referenced record for which you want to call the document search page for.
  • searchDefinition: Search Definition Code which should be used for search.
  • newExecuteSearchOnOpenPage: Activate this flag in order to execute the search automatically whith opening the page. Set to false if you want to set more filter criteria manually.

SetParameterForSearchByText(Text, Boolean) :#

Summary: Use this procedure in order to call the document search page with a given search text. This procedure must be called to set parameters on page document search just before opening the page itself using .Run oder .RunModal calls.

procedure SetParameterForSearchByText(newSearchText: Text; newExecuteSearchOnOpenPage: Boolean):

Parameters:

  • newSearchText: Given search text for which you want to call the document search page for.
  • newExecuteSearchOnOpenPage: Activate this flag in order to execute the search automatically whith opening the page. Set to false if you want to set more filter criteria manually.

SetParameterForSearchByTags(Record KVSDMSArchivingTagCode, Boolean, Boolean) :#

Summary: Use this procedure in order to call the document search page with a given set of filtered archiving tags and values. This procedure must be called to set parameters on page document search just before opening the page itself using .Run oder .RunModal calls.

procedure SetParameterForSearchByTags(var TempTags: Record "KVSDMSArchivingTagCode" temporary; newFindDocsWithSingleTagMatch: Boolean; newExecuteSearchOnOpenPage: Boolean):

Parameters:

  • TempTags: Given temporary set of archiving tag codes and values used as filter criteria to call the document search page for.
  • newFindDocsWithSingleTagMatch: Specifies if documents should be shown in the search results if matching not all tags but at least a single one.
  • newExecuteSearchOnOpenPage: Activate this flag in order to execute the search automatically whith opening the page. Set to false if you want to set more filter criteria manually.

Events#

OnBeforeDoSearch(Enum KVSDMSSearchMode, Text, RecordId, Record KVSDMSDocumentDrive, Code[20], Code[20], Boolean, Record KVSDMSArchivingTagCode) :#

Summary: Integration event triggered before the document search is executed.

[IntegrationEvent(false, false)]
local procedure OnBeforeDoSearch(SearchMode: Enum "KVSDMSSearchMode"; SearchText: Text; ChosenRecordID: RecordId; var DocumentDrives: Record "KVSDMSDocumentDrive"; ChosenSearchDefinition: Code[20]; ChosenDisplayDefinition: Code[20]; FindDocsWithSingleTagMatch: Boolean; var TempTags: Record "KVSDMSArchivingTagCode" temporary): 

[EventSubscriber(ObjectType::Page, Page::"KVSDMSDocumentsSearch", 'OnBeforeDoSearch', '', false, false)]
local procedure DoSomethingOnBeforeDoSearch(SearchMode: Enum "KVSDMSSearchMode"; SearchText: Text; ChosenRecordID: RecordId; var DocumentDrives: Record "KVSDMSDocumentDrive"; ChosenSearchDefinition: Code[20]; ChosenDisplayDefinition: Code[20]; FindDocsWithSingleTagMatch: Boolean; var TempTags: Record "KVSDMSArchivingTagCode" temporary)
begin
end;

Parameters:

  • SearchMode: The current search mode being used.
  • SearchText: The search text to be used for document search.
  • ChosenRecordID: The chosen record ID for search.
  • DocumentDrives: The document drives used for the search.
  • ChosenSearchDefinition: The selected search definition code.
  • ChosenDisplayDefinition: The selected display definition code.
  • FindDocsWithSingleTagMatch: Flag to find documents with single tag match.
  • TempTags: Temporary set of archiving tags used as filter criteria.