Dynamics CRM REST Connection

General

In the General panel, you can specify the package that stores the Dynamics CRM REST Connection shared resource, the shared resource name, and the shared resource description.

The following table lists the configurations in the General panel of the Dynamics CRM REST Connection shared resource:

Service Configuration

In the Service Configuration panel, provide the information related to the Microsoft Dynamics CRM server to which the plug-in connects.

The following table lists the configurations in the Service Configuration panel of the Dynamics CRM REST Connection shared resource:

Field	Module Property?	Description
Deployment Type	No	Two types of deployments are supported: Online: Used for connecting to the Microsoft Dynamics CRM online server. On-Premises: Used for connecting to the local Microsoft Dynamics CRM server. If a self-signed SSL certificate is used to establish a connection between the Microsoft Dynamics CRM On-Premises server and the plug-in, use Java Keytool to import the self-signed SSL certificate into the JRE global truststore; the cacerts JRE global truststore file is in the TIBCO_HOME/tibcojre64/version_number/lib/security directory.
Authentication Type	No	The authentication types that are supported by the plug-in. The types depend on the deployment type that you select. If you select the Online deployment, the plug-in supports only OAuth authentication. Important: Register your application with Microsoft Azure Active Directory before you can use OAuth authentication to connect to the Microsoft Dynamics CRM online server. For more information, see Registering a New Application in Azure Directory. Note: The plug-in supports OAuth 2.0 authorization protocol for all the palette activities that are supported by Dynamics CRM on-premise. Note: To mitigate the DynamicsCRMREST plug-in request failures when encountered with 5xx Errors while connecting to Azure AD and DynamicsCRM Online servers, accessToken cache interval and retry mechanism is introduced with the help of new system properties. For more details, see Properties for accessToken Cache Interval and Retry Mechanism. If you select the On-Premises deployment, the plug-in supports two types of authentication: NTLM and Kerberos.
Grant Type	No	The grant type to authenticate user access when you select Online deployment. Two types of grant types are supported: Password Credentials Client Credentials The default value is Password Credentials. Note: Projects created in versions before version 6.7.0 of the plug-in support only password credentials grant type.
User Name	Yes	The user name used to connect to the Microsoft Dynamics CRM server. Note: This field is not visible for Client Credentials grant type.
Password	Yes	The password used to connect to the Microsoft Dynamics CRM server. Note: This field is not visible for Client Credentials grant type.
Service Root URL	Yes	The URL for the service root that provides access to the business data and metadata for your organization. Note: You can either type the URL for the service root manually or find it automatically by using Discover Service.
Timeout (sec)	Yes	The timeout value in seconds that applies to the communication with the Microsoft Dynamics CRM server. The default timeout value is 1800 seconds.
The following fields are displayed only when the Kerberos authentication is selected.
LoginModule File	Yes	Click the icon to locate the LoginModule file. The file contains the configuration information of the login properties in the Java Authentication Authorization Service (JAAS).
Kerberos File	Yes	Click the icon to locate the Kerberos file. The file contains the realm and server configuration information.
The following fields are displayed only when the OAuth authentication is selected.
Tenant ID	Yes	The unique ID of your Microsoft Azure Active Directory with which you have registered your application. Tip: To know the Tenant ID, in Microsoft Azure, click App registrations and click Endpoints. In the fields that are displayed, the string value after host name in the OAUTH 2.0 TOKEN ENDPOINT field is known as Tenant ID. You can copy the OAuth 2.0 Token Endpoint field value by clicking the icon beside it.
Client ID	Yes	The unique ID of the application that you want to connect to the Microsoft Dynamics CRM Online server. This is application-specific and is unique for each application. Note: The application must be of native type when the grant type is Password Credentials; and it must be of Web app / API type when grant type is Client Credentials. Tip: To know the Client ID, in Microsoft Azure, click App registrations, and in the list of registered applications, select a specific registered application. In the application pane, the value assigned under Application ID is known as Client ID.
Client SecretKey	Yes	One of the passwords for your Web app / API application that you want to use to connect to the Microsoft Dynamics CRM Online server. Note: Shown only when Grant type is Client Credentials. Note: A Web app / API application can have one or more passwords that can be used as a secret key while obtaining OAuth2.0 keys. Note: To generate a new password in Microsoft Azure, Click App registrations in the Azure portal. Select the registered application. In the applications pane, click the Settings icon. In the Settings pane, click Keys. In the Keys pane, under Passwords section, enter details in the Description column and choose a value for Expires from the drop-down menu. Click Save. After the key is generated, copy it, and save it because the key value is never displayed again.

Proxy Configuration

In the Proxy Configuration panel, you can provide the information related to the proxy server to access Microsoft Dynamics CRM REST endpoints outside of a firewall.

The following table lists the configurations in the Proxy Configuration panel of the Dynamics CRM REST Connection shared resource:

Test Connection

Click Test Connection to test whether the specified configuration fields result in a valid connection to the Microsoft Dynamics CRM server.

Properties for accessToken Cache Interval and Retry Mechanism

• com.tibco.bw.palette.dynamicscrmrest.accesstokencacheinterval - Provide the value in Seconds. The default value is 3570 seconds. The access token is fetched once the value is elapsed.
• com.tibco.bw.palette.dynamicscrmrest.retryinterval - Provide the value in Milli-seconds. The default value is 30000 milliseconds. The plug-in sleeps for provided time before retrying the request to servers.
• com.tibco.bw.palette.dynamicscrmrest.numberofretries - Provide the value in positive number (Greater than 0). The default value is 60. The plug-in retries until the provided value is elapsed.

To set the properties in Business Studio:

1. In Run Configurations dialog; configure the following as VM Arguments:

-Dcom.tibco.bw.palette.dynamicscrmrest.accesstokencacheinterval-Dcom.tibco.bw.palette.dynamicscrmrest.retryinterval-Dom.tibco.bw.palette.dynamicscrmrest.numberofretries.

For example,

-Dcom.tibco.bw.palette.dynamicscrmrest.accesstokencacheinterval=3000-Dcom.tibco.bw.palette.dynamicscrmrest.retryinterval=30000-Dcom.tibco.bw.palette.dynamicscrmrest.numberofretries=60

To set the properties at Run time in Tibco Cloud:

For details on steps to set the accessToken cache interval and retry mechanism properties, namely: com.tibco.bw.palette.dynamicscrmrest.accesstokencacheinterval, com.tibco.bw.palette.dynamicscrmrest.retryinterval, and com.tibco.bw.palette.dynamicscrmrest.numberofretries. For more details, see the "Setting and Overriding the BusinessWorks Engine and Logger Properties" topic in the TIBCO Cloud Integration Documentation.

If the properties input values provided are less than or equal to zero (<=0), then the plug-in ignores those values and instead opts for the default values.