Veritas Enterprise Vault™ Classification using the Microsoft File Classification Infrastructure

Last Published:
Product(s): Enterprise Vault (12.2)
  1. About this guide
    1. Introducing this guide
      1.  
        Relationship between FCI classification and other classification methods
    2. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. Getting started
    1.  
      About classification
    2.  
      Overview of the procedure for setting up classification
    3.  
      Prerequisites for classification
    4.  
      Roles-based administration (RBA) and the classification feature
    5. How Enterprise Vault caches the items that it submits for classification
      1.  
        Limits on the size of classification files
      2.  
        Checking the cache location on the Enterprise Vault storage servers
      3.  
        Configuring Enterprise Vault to keep the classification files in the cache folder
  3. Setting up the classification properties
    1.  
      About the Enterprise Vault classification properties
    2.  
      Setting up the Enterprise Vault classification properties manually
    3.  
      Checking the Folder Usage classification property
    4.  
      How classification property values and retention categories interact
    5.  
      Setting up new values for the Enterprise Vault classification properties
    6.  
      Points to note on setting retention categories
  4. Configuring your classification rules
    1.  
      About classification rules
    2.  
      About the example classification rules
    3.  
      Importing the example rule set
    4.  
      Creating or changing classification rules
    5.  
      Supported configuration parameters for rules that use the Veritas Information Classifier method
  5. Defining and applying classification policies
    1.  
      About classification policies
    2.  
      Defining classification policies
    3.  
      About the PowerShell cmdlets for working with classification policies
    4.  
      Associating classification policies with retention plans
    5.  
      About the PowerShell cmdlets for working with retention plans
    6.  
      Applying retention plans to your Enterprise Vault archives
  6. Running classification in test mode
    1.  
      About classification test mode
    2.  
      Implementing classification test mode
    3.  
      About the PowerShell cmdlets for running classification in test mode
    4.  
      Understanding the classification test mode reports
  7. Publishing classification properties and rules across your site
    1.  
      How to publish the classification properties and rules
  8. Appendix A. Enterprise Vault properties for use in classification rules
    1.  
      About the Enterprise Vault properties
    2.  
      System properties
    3.  
      Attachment properties
    4.  
      Custom Enterprise Vault properties
    5.  
      Custom Enterprise Vault properties for File System Archiving items
    6.  
      Custom Enterprise Vault properties for SharePoint items
    7.  
      Custom Enterprise Vault properties for Compliance Accelerator-processed items
    8.  
      Custom properties for use by policy management software
    9.  
      Custom properties for Enterprise Vault SMTP Archiving
  9. Appendix B. PowerShell cmdlets for use with classification
    1.  
      About the classification cmdlets
    2.  
      Disable-EVClassification
    3.  
      Get-EVClassificationFCITags
    4.  
      Get-EVClassificationPolicy
    5.  
      Get-EVClassificationStatus
    6.  
      Get-EVClassificationTestMode
    7.  
      Import-EVClassificationFCIRules
    8.  
      New-EVClassificationPolicy
    9.  
      Publish-EVClassificationFCIRules
    10.  
      Remove-EVClassificationPolicy
    11.  
      Set-EVClassificationPolicy
    12.  
      Set-EVClassificationTestMode
  10. Appendix C. Monitoring and troubleshooting
    1.  
      Auditing
    2.  
      Checking the classification performance counters
    3.  
      Troubleshooting classification

Set-EVClassificationPolicy

Set-EVClassificationPolicy sets or updates the properties of an existing Enterprise Vault classification policy.

Set-EVClassificationPolicy is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.

Syntax

Set-EVClassificationPolicy [[-SiteId] <String>] [-Name] <String> [-Description <String>] [-DuringIndexing <Boolean>] [-DetermineRC <Boolean>] [-RCDuringDeletion <Boolean>] [-RCDuringExpiry <Boolean>] [-PreventRCDuringMove <Boolean>] [-AllowRCOnRecTypeChange <Boolean>] [<CommonParameters>]

Parameters

Table: Set-EVClassificationPolicy parameters

Parameter

Description

-SiteId

The ID of the site for which to set or update the Enterprise Vault classification policy details. If you omit this parameter, and the cmdlet cannot determine the ID by looking in the registry, then Set-EVClassificationPolicy prompts you to enter the required ID.

You can use Get-EVSite to obtain the site ID.

-Name (required)

The name of a specific Enterprise Vault classification policy whose properties you want to set or update. If you want to rename the policy then the new name must be unique, and it can contain up to 40 alphanumeric or space characters.

-Description

The description to set for the Enterprise Vault classification policy. The description can contain up to 127 alphanumeric, space, or special characters.

-DuringIndexing

Specifies whether Enterprise Vault should classify items at the point that it indexes them ($true) or not ($false). The default is $true.

This setting also determines whether Enterprise Vault reclassifies items when you rebuild the indexes.

-DetermineRC

Specifies whether to allow the classification feature to update the retention categories of items ($true) or not ($false). The default is $true.

-RCDuringDeletion

When DetermineRC is $true, specifies whether to enable classification on user deletion ($true) or not ($false). The default is $false.

You cannot set RCDuringDeletion to $true when DetermineRC is set to $false.

-RCDuringExpiry

When DetermineRC is $true, specifies whether to enable classification on automatic expiry ($true) or not ($false). The default is $false.

Note the following:

  • You cannot set RCDuringExpiry to $true when DetermineRC is set to $false.

  • You must set RCDuringExpiry to $true when DuringIndexing is $false and DetermineRC is $true.

-PreventRCDuringMove

When DetermineRC is $true, specifies whether to prevent Enterprise Vault from updating the retention categories of archived items when users perform actions that could potentially update these retention categories. For example, users may move archived items between folders to which you have applied different retention categories, or change the retention categories of items in Enterprise Vault Search, if permitted. Both actions can cause the retention categories of the items to change, potentially overriding the retention categories that the classification feature has set.

The default for PreventRCDuringMove is $false. Enterprise Vault allows user actions to update the retention categories of items, subject to site archive settings.

-AllowRCOnRecTypeChange

For use in environments where you use the Enterprise Vault records management feature to mark selected items as records.

When PreventRCDuringMove is $true (prevent user actions from updating retention categories), AllowRCOnRecTypeChange specifies whether to allow these updates in instances where this also causes the record types of the items to change. The default for AllowRCOnRecTypeChange is $true.

When PreventRCDuringMove is $false, AllowRCOnRecTypeChange has no effect.

Examples
  • Set-EVClassificationPolicy -SiteId 13E...EV.example.com -Name "Classification policy" -Description "Classification example policy"

    Updates the description of an existing Enterprise Vault classification policy that is named "Classification policy" in the specified Enterprise Vault site.

  • Set-EVClassificationPolicy -SiteId 13E...EV.example.com -Name "Classification policy" -PreventRCDuringMove $true -AllowRCOnRecTypeChange $false

    Configures the specified Enterprise Vault classification policy to prevent user actions from updating the retention categories of items, including when this will change their record type, in those archives to which you apply the policy.

Output

There is a confirmation message on completion.

Related cmdlets