Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The CLI executable is located in the root folder of the application installation. For example C:\Program Files (x86)\GVClient\app-4.5.0.0. The executable name is GVClient.CLI.Windows.exe. Using your shell application of choice, the CLI can be used with the general format:

Code Block
languagebash
GVClient.CLI.Windows.exe <command> [options]

New CLI Options will work for Agent 4.5.0 and above.

Commands:

  • classify: Classify all specified files of any type using default visual label settings. This is the default option chosen if no command is specified.

  • word: Classify all specified Word files. Can choose to override the default visual label settings.

  • ppt: Classify all specified PowerPoint files. Can choose to override the default visual label settings.

  • excel: Classify all specified Excel files. Can choose to override the default visual label settings.

  • help: Shows this same help information on usage in the shell

...

Code Block
languagejson
  "externalLabelMappings": [
    {
      "regex": "regex_pattern_for_external_label_Public",
      "tagsettagsetid": "e16409a7-1700-4153-9090-3955bc2f0ae8",
      "tag": "Public"
    },
    {
      "regex": "regex_pattern_for_external_label_External",
      "tagsettagsetid": "e16409a7-1700-4153-9090-3955bc2f0ae8",
      "tag": "External"
    },
    {
      "regex": "regex_pattern_for_external_label_Confidential",
      "tagsettagsetid": "e16409a7-1700-4153-9090-3955bc2f0ae8",
      "tag": "Confidential"
    }     
  ],

...

Code Block
languagejson
   "externalLabelMappings": [
    {
      "regex": "xxxxxxxxxxxxx",
      "tagsettagsetid": "f14fc1f1-8950-40d5-8a29-45909da947d6",
      "tag": "GDPR/PII"
    },
    {
      "regex": "yyyyyyyyyyyyy",
      "tagsettagsetid": "004dea33-8751-4399-a76e-95f371cb4119",
      "tag": "External"
    }     
  ],

...

Note

Verify customer is using Agent with at least version 4.5.0.0

Log files for CLI can be located at:

Code Block
%AppData%\Roaming\GVClient.CLI.Windows\Logs

Example of log after running CLI with --map:

...

Since the CLI is designed as a lightweight intermediary application that communicates with AgentEngine (which executes the actual classification logic), the AgentEngine logs must also be checked under:

Code Block
%AppData%\GVClient.AgentEngine.Windows\Logs

The output from the CLI will also provide some feedback on the result of the classification, as well as reasons that files were skipped/failed (see below). Failures in single files should not prevent the remaining files from classifying. Note that file paths are only reported for files that were skipped or failed to keep the output concise.

...