KMS

This plugin will periodically query the KMS application for managing of documents. The KMS service major function is routing the document between folders based on content type and practice area fields.

Copy the dll files from the Plugins\KMS directory to the site provisioning directory.
Restart the service to activate the plugin.

The plugin will schedule a job using the interval in seconds, start and end datetime properties. After each run the LastRunDate is updated.

Start the configurator and browse to CustomSettings to configure the plugin.

The plugin will perform 4 major steps:

1 - ProcessFiles_KMS_DocId. This method is responsible for updating and managing document IDs and associated metadata in the SharePoint library.
2 - ProcessFiles_KMS_DocId_Cleanup. This method focuses on cleaning up and sanitizing document contents within SharePoint.
3 - ProcessFiles_KMS_Route. This method is designed to route and manage files in the SharePoint library based on their content types and metadata.
4 - ProcessFiles_KMS_List. This method generates a report of csv files within the SharePoint library.

Property Documentation

SourceSharepointConfigName

• Category: Config
• Purpose: Specifies the name of the configuration file to be used for the plugin. This allows for customization by pointing to a different config file if required.
• Default Value: (Empty)

CleanupOffice2003Documents

• Category: Settings
• Display Name: Cleanup Emails and Office2003 Documents
• Purpose: Determines whether to remove document properties and default SharePoint values from older document formats such as .doc, .xls, .ppt, and .msg. This helps in sanitizing documents from legacy formats.
• Default Value: false

CleanupOffice2007Documents

• Category: Settings
• Display Name: Cleanup Office2007 or newer Documents
• Purpose: Specifies whether to remove document properties from newer document formats such as .docx, .xlsx, and .pptx. This is useful for cleaning up modern document formats.
• Default Value: false

KMSDocIdPrefix

• Category: Documents
• Display Name: KMSDocIdPrefix
• Purpose: Sets the prefix for document IDs in the KMS system. This prefix is used to identify and categorize documents.
• Default Value: "KMS"

KMSPracticeAreaField

• Category: Documents
• Display Name: KMSPracticeAreaField
• Purpose: Defines the field name used to categorize documents by practice area within the KMS system.
• Default Value: "PracticeArea"

Title

• Category: Documents
• Display Name: Title
• Purpose: Specifies the field name used for the document title in the KMS system.
• Default Value: "Title"

Responsible

• Category: Documents
• Display Name: Responsible
• Purpose: Indicates the field name that represents the responsible person or entity for the document.
• Default Value: "Responsible"

DocumentDate

• Category: Documents
• Display Name: DocumentDate
• Purpose: Defines the field name used for the document creation date.
• Default Value: "DocumentDate"

SubmissionDate

• Category: Documents
• Display Name: SubmissionDate
• Purpose: Specifies the field name used for the document submission date.
• Default Value: "SubmissionDate"

LastValidatedDate

• Category: Documents
• Display Name: LastValidatedDate
• Purpose: Sets the field name for the last date the document was validated.
• Default Value: "LastValidatedDate"

ExpirationDate

• Category: Documents
• Display Name: ExpirationDate
• Purpose: Indicates the field name for the document's expiration date.
• Default Value: "ExpirationDate"

ExpirationDateMonths

• Category: Documents
• Display Name: ExpirationDateMonths
• Purpose: Defines the number of months from the last validated date after which a document is considered expired.
• Default Value: 120

ArchiveDate

• Category: Documents
• Display Name: ArchiveDate
• Purpose: Specifies the field name for the date when the document was archived.
• Default Value: "ArchiveDate"

DropOffLibrary

• Category: Libraries
• Display Name: DropOffLibrary
• Purpose: Names the library used for dropping off documents.
• Default Value: "KMS (DropOff)"

DocumentsLibrary

• Category: Libraries
• Display Name: DocumentsLibrary
• Purpose: Specifies the library where documents are stored within the KMS system.
• Default Value: "KMS (KMS)"

ReportsLibrary

• Category: Libraries
• Display Name: ReportsLibrary
• Purpose: Defines the library where reports are stored within the KMS system.
• Default Value: "KMS (Reports)"

DropOffFolder

• Category: Libraries
• Display Name: DropOffFolder
• Purpose: Indicates the folder within the DropOffLibrary where documents are initially placed.
• Default Value: "DropOff"

PublishedFolder

• Category: Libraries
• Display Name: PublishedFolder
• Purpose: Specifies the folder where published documents are stored.
• Default Value: "Published"

ArchivedFolder

• Category: Libraries
• Display Name: ArchivedFolder
• Purpose: Defines the folder where archived documents are kept.
• Default Value: "Archived"