Write custom code for Microsoft Dynamics CRM 2013 for Outlook

 

Applies To: Dynamics CRM 2013

There are two Microsoft Office Outlook clients for Microsoft Dynamics CRM:

  • Microsoft Dynamics CRM for Microsoft Office Outlook

  • Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access

Microsoft Dynamics CRM for Microsoft Office Outlook can only be used when you are connected to the Microsoft Dynamics CRM server through an Internet connection. It enables multiple users to access Microsoft Dynamics CRM through Microsoft Outlook on the same computer with rich integration with Microsoft Outlook, including synchronization and mail merge and other features.

Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access supports offline use. Users interact with their CRM data exactly like they do in CRM for Outlook, but they can continue to access the data while disconnected from the Internet. To support offline use, Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access uses a local version of the Microsoft Dynamics CRM server hosted on a local Web server (also known as Cassini). This local Web server can only be used for the local instance of Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access to access Microsoft Dynamics CRM. A Microsoft SQL Server 2008 Express Edition database provides data storage. When Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access is synchronized, any data modifications and customizations applied on the server are transferred to the local Microsoft Dynamics CRM application. For more information about customizing the filters used for synchronizing entity data, see Offline and Outlook filters and templates.

Microsoft Dynamics CRM contains the assembly Microsoft.Crm.Outlook.Sdk, which you can use when customizing Microsoft Outlook. This includes methods to determine which client is being used and whether the user is online or offline. You can use these criteria to disable functionality that requires a connection to the network.

Workflows are not included in Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access, but plug-ins can be deployed that will function while offline. Workflows and plug-ins are applied when the user synchronizes data.

Methods

The following table lists the methods that are available in CrmOutlookService:

Instance Method

Description

GoOffline

Takes Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access into an offline state and triggers a synchronization of the offline database with the online server. This method cannot be called from a plug-in.

GoOnline

Synchronizes Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access with the online Microsoft Dynamics CRM server. This method cannot be called from a plug-in.

SetOffline

Sets Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access into an offline state without triggering a synchronization of the offline database with the online server.

Sync

Triggers a synchronization event between Microsoft Outlook and the Microsoft Dynamics CRM server.

Properties

The following table lists the properties available in CrmOutlookService:

Instance Property

Description

IsCrmClientLoaded

Gets a value that indicates whether CRM for Outlook is loaded by Microsoft Outlook.

IsCrmClientOffline

Gets a value that indicates whether Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access is offline.

IsCrmDesktopClient

Gets a value that indicates whether CRM for Outlook is installed.

ServerUri

Gets the server URI to use to connect to the Microsoft Dynamics CRM server based on the state of CRM for Outlook.

State

Gets the state of Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access.

See Also

Microsoft.Crm.Outlook.Sdk
Extend Microsoft Dynamics CRM 2013 for Outlook
Offline and Outlook filters and templates
Sample: Use Outlook methods