Install and Configure the OOF Agent

To support Out of Office (OOF) feature for tenants among different organizations within the same domain, you must install the OOF agent on all Exchange Hub Transport servers.

The OOF agent includes two utilities:

  • Categorizer Override Agent: A transport agent to override the categorizer behavior on Hub Transport servers.

  • SMTP Domain Cache Task: A scheduled task to generate cache files for categorizer override agent to filter the OOF messages.

Note

The Exchange Transport service must be restarted for the installation of Categorizer Override Agent.

Tasks

  1. Deploy Categorizer Override Agent on Hub Transport Server

  2. Deploy SMTP Domain Cache Task

Deploy Categorizer Override Agent on Hub Transport Servers

Procedure W03-DWHE.97: To install CategorizerOverrideAgent.msi

  1. On EXHUB01, run CategorizerOverrideAgent.msi from the Service Provisioning\MPS\Install folder on your solution media.

  2. Follow the wizard to complete the installation. Ensure the installation directory is under the Exchange Server TransportRoles directory.

Procedure W03-DWHE.98: To install the performance counters and event source

  1. On EXHUB01, open a command prompt and change directory to the directory of CategorizerOverrideAgent.dll (in the default deployment, C:\Program Files\Microsoft\Exchange Server\TransportRoles\Agents\CategorizerOverrideAgent).

  2. Run the following command to install the performance counters and event source:

    %WINDIR%\Microsoft.NET\Framework\v2.0.50727\InstallUtil.exe CategorizerOverrideAgent.dll
    

Procedure W03-DWHE.99: To configure cache refresh time

  1. On EXHUB01, open the CategorizerOverrideAgent.dll.config file from the CategorizerOverrideAgent directory (in the default deployment, C:\Program Files\Microsoft\Exchange Server\TransportRoles\Agents\CategorizerOverrideAgent).

  2. Set the CacheRefresh value to the refresh interval (in minutes) to refresh the cache for mapping between organizations and SMTP domains. In the following example, the categorizer override agent will refresh the cache every 60 minutes, which is the default value.

    <add key="CacheRefresh" value="60"/>
    

Procedure W03-DWHE.100: To install the categorizer override agent

  1. On EXHUB01, open Exchange Management Shell, and then navigate to the directory of CategorizerOverrideAgent.dll (in the default deployment, C:\Program Files\Microsoft\Exchange Server\TransportRoles\Agents\CategorizerOverrideAgent).

  2. Run the following commands sequentially:

    Stop-Service MSExchangeTransport
    Install-TransportAgent -Name CategorizerOverrideAgent -TransportAgentFactory Microsoft.Provisioning.Utilities.TransportAgents.CategorizerOverrideAgentFactory -AssemblyPath CategorizerOverrideAgent.dll
    Enable-TransportAgent CategorizerOverrideAgent
    Start-Service MSExchangeTransport
    
  3. To verify the installation, run the following command:

    Get-TransportAgent
    

    CategorizerOverrideAgent should be returned in the list with the enabled attribute set to true.

Note

After the Exchange Transport Service restarts, the categorizer override agent will not refresh the cache until the preset refresh interval expires.

Deploy SMTP Domain Cache Task on Hub Transport Servers

Procedure W03-DWHE.101: To install SMTPDomainCacheTask.msi

  1. On EXHUB01, run SMTPDomainCacheTask.msi from the Service Provisioning\MPS\Install folder on your solution media.

  2. Follow the wizard to complete the installation.

Procedure W03-DWHE.102: To create the scheduled task

  1. On EXHUB01, run the following command at a command prompt:

    schtasks /create /S localhost /U %USER% /P %PASSWORD% /SC MINUTE /MO %MINUTES% /TN SmtpDomainCacheTask /TR "\"C:\Program Files\Microsoft Hosting\Provisioning\SmtpDomainCacheTask\SmtpDomainCacheTask.exe\""
    

    where, %USER% and %PASSWORD% should be the actual user account and password; %MINUTES% should be the schedule interval in minutes. The recommend interval is 60 minutes.

    Note

    The user account must have write permission to the directory of CategorizerOverrideAgent.dll, and have read permission to MPS PlanManager database.

  2. To verify the installation, run schtasks to ensure the scheduled task is installed successfully.

Procedure W03-DWHE.103: To configure the task settings

  1. On EXHUB01, open the SmtpDomainCacheTask.exe.config file from the SmtpDomainCacheTask directory (in the default deployment, C:\Program Files\Microsoft Hosting\Provisioning\SmtpDomainCacheTask).

  2. Under <agents>/<agent name=“CategorizerOverrideAgent”>, set the dir value to the directory of CategorizerOverrideAgent.dll (in the default deployment, C:\Program Files\Microsoft\Exchange Server\TransportRoles\Agents\CategorizerOverrideAgent).

  3. Set the MpsSqlInstance value to the SQL instance name of the MPS database (in this deployment, MPSSQLVS01).

  4. Set the CacheFilesRetentionPeriod value to the time (in hours) to keep the cache files. The default value is 24 hours, which means that SMTPDomainCacheTask will delete the cache files older than 24 hours.