In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
...
Use this account type to connect <Snap Pack name> Exchange Online Snaps with data sources that use <Account Type Name> use Exchange Online OAuth2 User accounts.
Prerequisites
Valid
client IDAzure application with all the required API permissions.
Valid
tenant URLclient ID and client secret.
- ... ..
Limitations
None.
...
Known Issues
...
None.
...
Account Settings
...
| title | Documenting 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.
| Parameter | Data Type | Description | Default Value | Example |
|---|---|---|---|---|
| Label | String | Required. Unique user-provided label for the account. | N/A | Exchange Online Account |
| Client ID | String | Required. Enter the client ID associated with your Azure application. You can create the client ID as advised by your application provider. | N/A | 1394786838725.1307264331815 |
| Client secret | String | Required. Enter the client secret associated with your account. You can create the client secret as advised by your application provider. | N/A | bec1f9242f9nsh67f2276b9ws4cadd14 |
| Access token | String | Required. Enter the access token associated with the Azure application is used to make API requests on behalf of the user associated with the client ID. | N/A | N/A |
| Refresh token | String | Required. Enter the refresh token retrieval for the application specified when setting up the account for the endpoint. There, the OAuth2 flow will be executed and the resulting refresh token can be stored in this property. If the refresh token is stored, then the access token can be refreshed automatically before it expires. | N/A | N/A |
| Access token expiration | Numeric | Enter the access token expiration value. | N/A | N/A |
| OAuth2 Endpoint | String | Required. Enter the authorization endpoint to authorize the application. | https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/authorize | https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/authorize |
| OAuth2 Token | String | Required. Enter token endpoint to get the access token. | https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token | https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token |
| Token endpoint config | Use this fieldset to provide custom properties for the OAuth2 token endpoint. Click the + or - icons to respectively add or remove configuration rows. This fieldset comprises the following fields:
| |||
| Token endpoint parameter | String | Defines an optional token endpoint parameter value. | N/A | user_scope |
| Token endpoint parameter value | String | Provides custom properties for the OAuth2 auth endpoint. | N/A | users:read |
| Auth endpoint config | Use this fieldset to provide custom properties for the OAuth2 auth endpoint. Click the + or - icons to respectively add or remove configuration rows. This fieldset comprises the following fields:
| |||
| Auth endpoint parameter | String | Defines an optional authentication parameter. | N/A | user_scope |
| Auth endpoint value | String | Defines an optional authentication parameter value. | N/A | files:write |
| Auto-refresh token | Check box | Select to refresh the token automatically using the refresh token if the property is enabled. Otherwise, the token might expire and will not be automatically refreshed. | Not selected | Selected |
Troubleshooting
Error | Reason | Resolution |
|---|
| Authentication failed |
The Pipeline ended before the batch could complete execution due to a connection error.
| . | You have entered an incorrect Client ID or Client secret. | Check and ensure that you have supplied the correct and valid Client ID and Client secret for the account and allowed the required access privileges to the application. |
| Error in Authorization: Something went wrong when authorizing this app. Invalid client_id parameter. | You have entered an incorrect Client ID. | Check and correct the Client ID entered for the account and try authorizing the app again. |
...