This guide explains the operations available within Cognitive Toolkit and how to use them.
Basics
Cognitive Toolkit contains 35 operations to help you understand and manage your data. These operations are runscript-based commands which can be run using a minimum set of required parameters or configured for more complex applications.
Run a command
To begin using Cognitive Toolkit, every operation follows these initial steps:
Type cmd in the Windows search box or charms bar, and then click Run as administrator. Alternatively, you may open a
CMDprompt using a Service Account with the appropriate permissions.Change directory (
cd) to your Cognitive Toolkit root folder. (ie. the location of the extracted shinydocs-cognitive-toolkit-[version]-[date].zip file)At the
CognitiveToolkit.exeprompt, enter the command for the operation you wish to run using either the minimum required parameters or edit the command as required.
Edit a command
To build a command you must provide, at a minimum, the required parameters identified in the Options Table for that command.
The command can be adapted to your specific requirements and environment by editing the command:
Add optional parameters as indicated in the command’s Options Table.
Option values are variables based on your environment, as well as the setup/location of source files.
Values should be surrounded by double quotation marks (“”) within the command.
For example:
DO:--query "C:\query-match-path-no-classification.json"
DO NOT:--query C:\query-match-path-no-classification.json
Tips
The first time you use Cognitive Toolkit, you are required to Activate your license.
Begin using Cognitive Toolkit by crawling an ECM and/or file system. This will build out an index in the Analytics Engine that can then be utilized to perform other operations.
Certain characters can negatively impact operation of the Cognitive Toolkit. Learn more about using special characters.
Source Setting Files
Source setting files provide the login credentials required to access a content source.
The following source setting files can be edited with your organization’s administrative login credential information:
Encyclopedia
🇦 A-B
Use the Activate Options Table to edit the command.
Activate Options Table
Use the AddClassifications Options Table to edit the command.
AddClassifications Options Table
Use the AddExtractedTextFromEngineeringDrawings Options Table to edit your runscript command.
AddExtractedTextFromEngineeringDrawings Options Table
Use the AddFromSqlDatabase Options Table to edit your runscript command.
AddFromSqlDatabase Options Table
Use the AddHashAndExtractedText Options Table to edit your runscript command.
AddHashAndExtractedText Options Table
Use the AddPathValidation Options Table to edit your runscript command.
AddPathValidation Options Table
Use the AddPropertyData Options Table to edit your runscript command.
AddPropertyData Options Table
🇨 C-D
Use the CacheFileSystemPermissions Options Table to edit your runscript command.
CacheFileSystemPermissions Options Table
Use the CopyItems Options Table to edit your runscript command.
CopyItems Options Table
Use the CrawlBox Options Table to edit your runscript command.
CrawlBox Options Table
Use the CrawlContentServer Options Table to edit your runscript command.
CrawlContentServer Options Table
Use the CrawlContentServerWorkflows Options Table to edit your runscript command.
CrawlContentServerWorkflows Options Table
Use the CrawlDocumentum Options Table to edit your runscript command.
CrawlDocumentum Options Table
Use the CrawlExchange Options Table to edit your runscript command.
CrawlExchange Options Table
Use the CrawlFileNet Options Table to edit your runscript command.
CrawlFileNet Options Table
Use the CrawlFileSystem Options Table to edit your runscript command.
CrawlFileSystem Options Table
Use the CrawlMaximo Options Table to edit your runscript command.
CrawlMaximo Options Table
Use the CrawlOneDrive Options Table to edit your runscript command.
CrawlOneDrive Options
Use the CrawlSharePointOnline Options Table to edit your runscript command.
CrawlSharePointOnline Options Table
Use the CrawlSharePointOnPrem Options Table to edit your runscript command.
CrawlSharePointOnPrem Options Table
Use the CrawlSharePointSites Options Table to edit your runscript command.
CrawlSharePointOnlineSites Options Table
Use the Dispose Options Table to edit your runscript command.
Dispose Options Table
🇪 E-K
Use the ExportFromIndex Options Table to edit your runscript command.
ExportFromIndex Options Table
Use the ExtractAndCrawlPst Options Table to edit your runscript command.
ExtractAndCrawlPst Options Table
Use the ExtractEntities Options Table to edit your runscript command.
ExtractEntities Options Table
Use the FindSimilarClassification Options Table to edit your runscript command.
FindSimilarClassification Options Table
🇱 L-O
Use the Migrate Options Table to edit your runscript command.
Migrate Options Table
🇵 P-S
Use the RemoveField Options Table to edit your runscript command.
RemoveField Options
Use the RemoveIndex Options Table to edit your runscript command.
RemoveIndex Options Table
Use the RemoveItems Options Table to edit your runscript command.
RemoveItems Options Table
Use the RestoreCachedFileSystemPermissions Options Table to edit your runscript command.
RestoreCachedFileSystemPermissions Options Table
Use the RunWithCredentials Options Table to edit your runscript command.
RunWithCredentials Options Table
Use the SaveValue Options Table to edit your runscript command.
SaveValue Options Table
Use the SetFileSystemPermissions Options Table to edit your runscript command.
SetFileSystemPermissions Options Table
🇹 T-Z
Use the TagDuplicate Options Table to edit your runscript command.
TagDuplicateField Options Table
Use the UpdateProperties Options Table to edit your runscript command.
UpdateProperties Options Table
To access the complete list of available operations from within the Cognitive Toolkit, type the following at the root folder of the Cognitive Toolkit: CognitiveToolkit.exe -h!|--help!