Enterprise Vault™ Classification using the Veritas Information Classifier

Last Published:
Product(s): Enterprise Vault (12.5)
  1. About this guide
    1. Introducing this guide
      1.  
        Relationship between the Veritas Information Classifier and other classification methods
    2.  
      What's in this guide
    3. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. Preparing Enterprise Vault for classification
    1.  
      About the preparatory steps
    2.  
      What you need
    3.  
      Checking the cache location on the Enterprise Vault storage servers
    4.  
      Setting up the Data Access account
    5.  
      Enabling the Veritas Information Classifier on all Enterprise Vault servers
    6.  
      Configuring the Veritas Information Classifier for secure client connections
  3. Setting up Veritas Information Classifier policies
    1.  
      Introducing the Veritas Information Classifier
    2.  
      Opening the Veritas Information Classifier
    3.  
      Finding your way around
    4.  
      Analyzing sample content for policy matches
    5. About policies
      1.  
        Creating or editing policies
      2.  
        About policy conditions
      3.  
        Enabling or disabling policies
      4.  
        Exporting or importing policies
      5.  
        Resetting policies
      6.  
        Deleting policies
    6. About patterns
      1.  
        Creating or editing patterns
      2.  
        Exporting or importing patterns
      3.  
        Deleting patterns
    7. About tags
      1.  
        Creating or editing tags
      2.  
        Exporting or importing tags
      3.  
        About the Enterprise Vault index properties
      4.  
        How classification property values and retention categories interact
      5.  
        Points to note on setting retention categories
      6.  
        Deleting tags
  4. Defining and applying Enterprise Vault classification policies
    1.  
      About Enterprise Vault classification policies
    2. Defining classification policies
      1.  
        Configuring classification policies to assign retention categories with the shortest duration
    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
  5. 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
  6. Using classification with smart partitions
    1.  
      About smart partitions
    2.  
      How Enterprise Vault determines whether to archive an item to a smart partition
    3.  
      Setting up smart partitions
    4.  
      Verifying that Enterprise Vault has archived items to smart partitions
  7. Appendix A. Enterprise Vault properties for use in custom field searches
    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
  8. Appendix B. PowerShell cmdlets for use with classification
    1.  
      About the classification cmdlets
    2.  
      Disable-EVClassification
    3.  
      Get-EVClassificationPolicy
    4.  
      Get-EVClassificationStatus
    5.  
      Get-EVClassificationTestMode
    6.  
      Get-EVClassificationVICTags
    7.  
      Initialize-EVClassificationVIC
    8.  
      New-EVClassificationPolicy
    9.  
      Remove-EVClassificationPolicy
    10.  
      Set-EVClassificationPolicy
    11.  
      Set-EVClassificationTestMode
  9. Appendix C. Classification cache folder
    1.  
      How Enterprise Vault caches the items that it submits for classification
    2.  
      Limits on the size of classification files
    3.  
      Configuring Enterprise Vault to keep the classification files in the cache folder
  10. Appendix D. Migrating from FCI classification to the Veritas Information Classifier
    1.  
      Converting FCI classification rules for use with the Veritas Information Classifier
  11. Appendix E. Monitoring and troubleshooting
    1.  
      Auditing
    2.  
      Checking the classification performance counters
    3.  
      Troubleshooting classification
    4.  
      Searching archives for items that the Veritas Information Classifier has classified

New-EVClassificationPolicy

New-EVClassificationPolicy creates an Enterprise Vault classification policy for a site.

New-EVClassificationPolicy is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.

Syntax

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

Parameters

Table: New-EVClassificationPolicy parameters

Parameter

Description

-SiteId

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

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

-Name (required)

The name of the Enterprise Vault classification policy. The 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.

-DuringArchivingIndexing

Specifies whether Enterprise Vault should classify items during archiving/indexing ($true) or not ($false). The default is $true.

This setting also determines whether Enterprise Vault reclassifies items when you rebuild the indexes. Note that if you have chosen to archive classified items to smart partitions, reclassifying the items does not cause them to move from one smart partition to another. These items remain on the smart partition to which Enterprise Vault originally archived them.

For example, suppose that you have associated the classification tag "PII" with one smart partition and the tag "Credit-Card" with another smart partition. An item that Enterprise Vault archived to the partition that is associated with the "PII" tag remains on this partition, even if Enterprise Vault subsequently reclassifies the item with the "Credit-Card" tag.

-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 DuringArchivingIndexing 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

  • New-EVClassificationPolicy -SiteId 13E...EV.example.com -Name "Classification policy" -Description "Classification policy created using PowerShell"

    Creates an Enterprise Vault classification policy that is named "Classification policy" in the specified Enterprise Vault site. The new policy has the description "Classification policy created using PowerShell".

  • New-EVClassificationPolicy -Name "Classification policy" -DuringArchivingIndexing $true -DetermineRC $false

    Creates an Enterprise Vault classification policy that is named "Classification policy". This policy does classify items during archiving/indexing but does not use classification to determine their retention categories.

  • New-EVClassificationPolicy -Name "Classification policy" -PreventRCDuringMove $true

    Creates an Enterprise Vault classification policy to classify items during archiving/indexing and allow the classification feature to update the retention categories of items. The policy prevents Enterprise Vault from updating the retention categories of items when users perform actions that could potentially update these retention categories, except when this will change the record type of the items.

Output

This cmdlet returns an object of type Symantec.EnterpriseVault.Admin.ClassificationPolicy, which has the following properties.

Table: New-EVClassificationPolicy properties

Name

Type

Description

Name

String

The name of the Enterprise Vault classification policy.

EntryId

String

The directory entry ID of the Enterprise Vault classification policy.

IsADefaultPolicy

Boolean

Whether the Enterprise Vault classification policy is a default policy.

DuringArchivingIndexing

Boolean

Whether to classify items during archiving/indexing, and reclassify them during an index rebuild.

DetermineRC

Boolean

Whether classification is used to determine the retention category.

RCDuringDeletion

Boolean

Whether items are classified during user deletion.

RCDuringExpiry

Boolean

Whether items are classified during automatic expiry.

PreventRCDuringMove

Boolean

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.

AllowRCOnRecTypeChange

Boolean

Whether to allow user actions to update retention categories in instances where this also causes the record types of the items to change (for example, from Temporary to Permanent).

Description

String

The description of the Enterprise Vault classification policy.

SiteId

String

The site ID to which the Enterprise Vault classification policy belongs.

Identity

Number

The identity number of the Enterprise Vault classification policy.

Related cmdlets