Set-CsArchivingConfiguration [-Identity <XdsIdentity>] [-ArchiveDuplicateMessages <$true | $false>] [-BlockOnArchiveFailure <$true | $false>] [-CachePurgingInterval <UInt32>] [-Confirm [<SwitchParameter>]] [-EnableArchiving <None | ImOnly | ImAndWebConf>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-KeepArchivingDataForDays <UInt32>] [-PurgeExportedArchivesOnly <$true | $false>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]

Set-CsArchivingConfiguration [-ArchiveDuplicateMessages <$true | $false>] [-BlockOnArchiveFailure <$true | $false>] [-CachePurgingInterval <UInt32>] [-Confirm [<SwitchParameter>]] [-EnableArchiving <None | ImOnly | ImAndWebConf>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-KeepArchivingDataForDays <UInt32>] [-PurgeExportedArchivesOnly <$true | $false>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]

Parameters

Many organizations find it useful to keep a transcript of all the IM sessions and Web conferences their users participate in. For other organizations, it’s mandatory to keep such transcripts; for example, many organizations in the financial world are required by law to keep copies of all their electronic communications.

In order to archive instant messages, you must set up at least one Archiving Server. After the Archiving Server is set up, you must perform two additional steps. First, you need to enable IM at the global scope (for details, see the Set-CsArchivingConfiguration topic). Optionally, you can also configure custom archiving settings for different sites. If you do this, keep in mind that site settings always take precedence over global settings. For example, suppose your global archiving configuration enables archiving, but the site configuration settings for Redmond disable archiving. In that case, users in the Redmond site will not have their IM session transcripts archived because the site settings (disable archiving) override the global settings (enable archiving).

Second, you must use archiving policies to indicate which users will have their IM sessions archived. What happens if you enable archiving, but do not assign any users a policy that specifies that their IM sessions should be archived? Literally, nothing happens: IM sessions will not be archived unless a policy is in force that requires IM sessions to be archived. For more information, type "Get-Help Set-CsArchivingPolicy -full" (without the quote marks) from the Microsoft Windows PowerShell command line interface.

When you install Communications Server 2010, a collection of global archiving settings will be created for you; by default, these settings will apply to your entire organization. Alternatively, you can use the New-CsArchivingConfiguration cmdlet to create custom configuration settings on a site-by-site basis. Either way, you can use the Set-CsArchivingConfiguration cmdlet to modify the property values of an existing collection or archiving configuration settings.

Set-CsArchivingConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.Archiving.ArchivingSettings object.

-------------------------- Example 1 --------------------------

	Copy Code
Set-CsArchivingConfiguration -Identity site:Redmond -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30

In the preceding example, Set-CsArchivingConfiguration is used to modify two properties of the archiving configuration settings that have the Identity site:Redmond. The command uses the parameter ArchiveDuplicateMessages to set the property ArchiveDuplicateMessages to False; this prevents the server from archiving the same instant message session multiple times. The command also uses the KeepArchivingDataForDays parameter to configure the server to keep instant messages for 30 days.

-------------------------- Example 2 --------------------------

	Copy Code
Get-CsArchivingConfiguration -Filter "site:*" | Set-CsArchivingConfiguration -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30

Example 2 is a variation of the first example: in this case, however, the values of the ArchiveDuplicateMessages and KeepArchivingDataForDays properties are modified for all the archiving settings that have been configured at the site scope. To carry out this task, the command first uses Get-CsArchivingConfiguration and the Filter parameter to return a collection of all the archiving settings configured at the site scope. The filter value "site:*" ensures that only settings that have an Identity that begins with the characters "site:" are returned. The filtered collection is then piped to Set-CsArchivingConfiguration, which modifies property values for each item in the collection.

-------------------------- Example 3 --------------------------

	Copy Code
Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -eq "ImAndWebConf"} | Set-CsArchivingConfiguration -EnableArchiving "ImOnly"}

In Example 3, all of the archiving configuration settings that allow both IM session and Web conferencing archiving are modified; after the command completes, those settings will allow only for IM session archiving. To do this, the command first calls Get-CsArchivingConfiguration without any parameters in order to return a collection of all the archiving configuration settings currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the EnableArchiving property is equal to (-eq) "ImAndWebConf". This filtered collection is then piped to Set-CsArchivingConfiguration, which takes each item in the collection and changes the value of EnableArchiving to "ImOnly".