Versions Compared

Old Version 3

changes.mady.by.user Shilpa

Saved on

compared with

New Version Current

changes.mady.by.user Gouri Bhagchandani

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents

...

maxLevel2
absoluteUrltrue

Overview

Use You can use this account type to connect connect the MS Dynamics 365 for Sales Snap Pack with data sources that use Dynamics 365 OAuth2 for Online Account.

You can configure an MS Dynamics 365 for Sales account in SnapLogic from Designer or Manager. In Designer, when working on pipelines, every Snap that needs an account prompts you to either create a new account or use an existing account. These accounts can be created in or used from:

  • Your private project folder: This folder contains the pipelines that will use the account.
  • Your project space’s shared folder: This folder is accessible to all the users that belong to the Project Space.
  • The global shared folder: This folder is accessible to all the users within an organization in the SnapLogic instance.

The steps required to create an account in any of these cases remain the same.

Note

As of now, this Snap pack supports only OAUTH2 accounts for Dynamics 365 Sales online.

Prerequisites

  • Valid client ID.
  • Valid tenant URL.
  • ...
  • ...

Limitations

None.

Known Issues

None

Account Settings

Image Removed

...

titleDocumenting Fields Based On Data Type/UI Element

**Delete Before Publishing**

Choose from the following sentences to document specific field types.

...

  • <State what the field contains>. Available options are: <bullet list of LoVs>
    The Salesforce API to be used. Available options are:...
  • Select the <category> that you want to use. Available options are...
    * Option 1<italicized>: <third person singular form of the verb>
    * Option 2<italicized>: <third person singular form of the verb>
    Select the API that you want to use. Available options are:
    Bulk API: Sends the Snap execution request details as a bulk API call.
    REST API: ...
  • Indicates.... Available options are:
    Indicates how the Snap must be executed. Available options are:
    * Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.
    * Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.
    * Disabled: Disables the Snap and, by extension, its downstream Snaps.

Check boxes:

  • If selected, <Snap behavior>.
    If selected, an empty file is written when the incoming document has no data.
  • If selected, <behavior>. If not selected/Otherwise, <behavior>
    Use "If not selected" if the first sentence is long.
    If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
    If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.
  • Select to <action>
    Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
    Select to execute the Pipeline during validation.

Text Fields

  • Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
    The name of the account.
    The account ID that you want to use to log in to the endpoint.
    Required if IAM Role is selected.
    Do not use this field if you are using batch processing.

Numeric Text Fields

  • Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
    The number of records in a batch.
    The number of seconds for which you want the Snap to wait between retries.
    The number of seconds for which the Snap waits between retries.
    Use the following special values:
    * 0: Disables batching.
    * 1: Includes all documents in a single request.

...

Required. Unique user-provided label for the account.

...

Troubleshooting

...

Account validation failed

...

The Pipeline ended before the batch could complete execution due to a connection error.

Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.

See Also

...

use OAuth2 with Dynamics 365. This account supports both on-premise and cloud instances.

Prerequisites

  • Valid application with all the required API permissions.

  • Valid client ID and client secret.

Limitations and Known Issues

None.

Account Settings

...

Info

  • Asterisk ( * ): Indicates a mandatory field.

  • Suggestion icon (Image Added): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ( Image Added): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon (Image Added): Indicates that you can add fields in the fieldset.

  • Remove icon (Image Added): Indicates that you can remove fields from the fieldset.

Field Name

Field Type

Description

Label*

Default Value: N/A
Example: MS Dynamics 365 For Sales

String

Specify a unique user-provided label for the account.


Dynamics Organization URL*

Default Value: N/A
Example: https://abcxyzcompany.api.crm.dynamics.com/api/data/v8.2/


String/Expression

Specify the URL for the MS Dynamics 365 For Sales WebAPI endpoint.  Although the URL is editable, query parameters should not be placed within the URL, as that will not work with the supporting libraries. The Query Parameter fields must be explicitly used, such as search filters.

Client ID*

Default Value: N/A
Example: 9ee09921-7b72-432d-b552-a21e8a1ab143

String

Specify the client ID associated with your Azure application. You can create the client ID as advised by your application provider.


Client secret

Default Value: N/A
Example: bec1f9242f9nsh67f2276b9ws4cadd14

String

Specify the client secret associated with your account. You can create the client secret as advised by your application provider.


Access token

Default Value: N/A
Example: 768901

String

Auto-generated after authorization. 

Specify the access token associated with the Azure portal application is used to make API requests on behalf of the user associated with the client ID.


Refresh token

Default Value: N/A
Example: 87566779

String

Auto-generated after authorization. 

Specify the refresh token is associated with your account. If the refresh token is stored, then the access token can be refreshed automatically before it expires.


Access token expiration

Default Value: N/A
Example:20

Integer

Specify the access token expiration value.


Header authenticated

Default Value: Not selected
Example: Selected

Checkbox

Select this checkbox to indicate that the endpoint uses bearer header authentication.


OAuth2 Endpoint*

Default Value: https://login.microsoftonline.com/<tenant>/oauth2/authorize
Example: 
https://login.microsoftonline.com/yourcompany.onmicrosoft.com/oauth2/authorize

String

Specify the URL of the endpoint that authorizes the application. 


OAuth2 Token*

Default Value: https://login.microsoftonline.com/<tenant>/oauth2/token
Example:
https://login.microsoftonline.com/yourcompany.onmicrosoft.com/oauth2/token

String

Specify the URL of the endpoint that retrieves the token for an authenticated account.


Grant Type

Default Value: authorization_code
Example: client_credentials

Dropdown list

Select the grant type for authorization. Available options are:

  • authorization_code: Authenticates using credentials (username and password), which return to the client through a redirect URL. The application then receives the authorization code from the URL and uses it to request an access token.

  • client_credentials: Obtains an access token for the client ID and client secret through the token endpoint URL.

Token endpoint config



Use this field set to provide custom properties for the OAuth2 token endpoint. 

Token endpoint parameter*

Default Value: N/A
Example: response-type

String

Specify the token endpoint parameter.


Token endpoint parameter value*

Default Value: N/A
Example: code

String

Specify the value associated with the endpoint parameter defined above.


Auth endpoint config





Use this field set to provide custom properties for the OAuth2 auth endpoint.

Authentication parameter*

Default Value: N/A
Example: scope


String

Specify the authorization endpoint parameter.


Authentication parameter value*

Default Value: N/A
Example: offline_access app.Read.All

String

Specify the value associated with the authorization endpoint parameter defined above.


Auto-refresh token


Default Value: Not Selected
Example: N/A

Checkbox

Select this checkbox to refresh the token automatically, using the refresh token, when the token is due for expiry. The token refresh does not happen automatically if this checkbox is not selected.


How to video

Configure a Microsoft Dynamics 365 OAuth2 Account in the SnapLogic IIP Designer

Configure Dynamics 365 for Sales.mp4

Learn how to Configure an Application in the Azure Portal for OAuth2 Account

Snap Pack History

Expand

Insert excerpt
Microsoft Dynamics 365 for Sales Snap Pack
Microsoft Dynamics 365 for Sales Snap Pack
nameMS Dynamics 365 for Sales_SPH
nopaneltrue

...