Skip to main content
Windward

Connect to Microsoft Dynamics as a Data Source

Data Source Type:

MS-Dynamics via OData
Versions Supported:  Odata version 2

 

Overview

This functionality was added in version 14.0.212.0. Windward uses the native OData service to connect to Microsoft Dynamics. OData requests are made with a URL that uses http protocol to request data, using the returned data to populate the report. However, unlike the average OData connection, MS-Dynamics requires the proper configuration of OAuth2 in order to authenticate access to the data within Dynamics. This process also requires access to an authoritative entity such as Active Directory Federation Services. Once OAuth2 is properly configured you will have access to the pieces of information that you will need to enter in order to establish a connection to your MS Dynamics as a data source.

 

The basic process at a high level:

  1. Configure OAuth2 & ADFS

  2. Enter proper information in AutoTag

  3. Connect to MS-Dynamics

 

Because a proper MS Dynamics connection assumes that your authentication is properly setup we have included a connection below to Windward's cloud based MS-Dynamics environment along with a sample connection template.  

 

If you would like to know more about how to setup your MS-Dynamics environment and the requirements involved please refer to the section after the Windward example.


Key Terms Used

 

Service URL:

This is the full OData service URI within MS-Dynamics (ends in .svc)

Client ID:

This is the OAuth ClientId you used when running the Add-AdfsClient command to register a new OAuth client. For Client ID, we suggest using a random GUID which you can generate from sites like guidgenerator.com 

Resource URI:

This is most likely your Dynamics CRM base URL. For example if your OData service URL is crm.mycompany.net:1337/a/b/c/d/odata.svc, this value should generally be crm.mycompany.net:1337

Redirect URI:

This is the Redirect URI you used when running the Add-AdfsClient command. Note: the URI you enter for Redirect URI when running the Add-AdfsClient command is not important for AutoTag which is a desktop app not a browser app. However, it is required to be sent to ADFS when making an OAuth token request and must match what ADFS has on record for your Client ID. We recommended you put in a localhost URL like this one:  http://localhost:45631/clientredirect

Authority URI:

This URI should point to your ADFS server’s base URL.

What you will need to establish this connection

 

  • A Microsoft Dynamics instance

  • The Odata service root URI (such as: http://services.odata.org/Northwind/Northwind.svc)

  • An authoritative service such as Active Directory Federation Services (Used in this example)

  • A good network connection to your Odata service. (Please note, if you are inside a corporate network and you cannot access the cloud-hosted demo data source, your firewall may be blocking you from access. Please consult with your systems or network administrator for assistance.)

High level outline of the process

1. First, Configure ADFS/OAuth2

a. You must first create a user in ADFS with the add-adfsclient command on your ADFS server

2. Then, enter the appropriate information in the DataSource Connector in AutoTag

a. Open MS-Word/Excel/PowerPoint (For this example, we will be using MS-Word)

b. Go to the “AutoTag Manager” tab on the ribbon

c. Click on Data Sources icon (Data Sources list box pops up)

d. Click “Add” (The Datasource Connector dialog box appears)

e. Fill in the appropriate information in the Datasource Connector dialog box and click OK

3. Finally, your datasource is now connected to your template.

 

Important Note

The MS-Dynamics OData wizard is not capable of creating all possible OData queries. The wizard is designed to handle 100% of the queries for 95% of our users. With this restriction, we are able to make the wizard much simpler to use.  However, any URI can be directly typed-in directly, with any level of complex query, and it will work just fine. 

Connect Your Template to Microsoft Dynamics 

Follow these steps in order to connect your template to MS-Dynamics.

Step 1

Configure ADFS & OAuth2

On the ADFS server, create an ADFS client with the add-adfsclient command  on the ADFS server. Registers an OAuth 2.0 client with AD FS. For more information on the add-adfsclient command please visit: https://technet.microsoft.com/en-us/%5Clibrary/dn479319(v=wps.630).aspx

Step 2 

Configure AutoTag

 

From MS Word, Excel or PowerPoint, navigate to the AutoTag Manager tab in the ribbon. 

 

 

Step 3

Once in the AutoTag Manager tab, click on the Data Source button. This will open the DataSources dialog box. Click Add to bring up the Datasource Connector.

 

 

 

 

Step 4

Select OData from the vendor drop down menu as shown below:

MSDOC05.PNG

 

 

Finally, fill in the details for your OData connection as show below:

 

Connect to Windward's cloud based MS-Dynamics environment via Autotag

 

Would you like to connect to our cloud based MS-Dynamics environment with your copy of AutoTag?

Great! Here is the information you will need to do so.

 

Follow Steps 1-3 as shown above, but in Step 4, enter the information below. (Note, you may be prompted to sign in to apollo-reborn-vm.cloudapp.net.)

 

OAuth prompt use Username:

demo@dynamicstest.net

Password:

demo

Service URL:

https://dynamics-crm.windward.net:33771/CRMTest/XRMServices/2011/OrganizationData.svc

Redirect URI:

http://localhost:1337/myredirect

Client ID:

abcde

 

If you are already authenticated in your active directory with the MS Dynamics connection user then your connection will be established. 

 

However if you use a different username and password to connect to your MS Dynamics instance than your currently logged in user, then you will receive a username and password prompt like the image below, where you will have to enter this information.

 

MSDOC07.png

 

Important Note: It is best practice to always assign a nickname to your datasource in the Name field. This will make your life much easier down the road when working with templates or tracking down any issues.

 

Please make sure you select “ADFS OAuth2” from the Authentication Type selector drop-down. Also, until further notice, when connecting to MS-Dynamics, always select “2” in the “Service Version” field.

 

MSDOC06.PNG


Once all of your information is properly filled in you can click OK.