...
...
...
...
| Note | ||
|---|---|---|
| ||
|
In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Use You can use this Snap to ..search personal contacts.
...
Snap Type
Search Contact is a Read-type Snap that search in personal contacts.
Prerequisites
- Valid client ID
Valid Exchange Online tenant.
- A valid account with
Valid OAuth2 application with all the required API permissions.
None.
Support for Ultra Pipelines
Capture if Ultra Mode is supported. If the Snap requires certain configurations to support Ultra mention those as well.
Works in Ultra Pipelines.
...
See However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.
Limitations and Known Issues
None.
Snap
...
Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input |
Document
Binary
Binary orDocument |
|
|
Requires the |
Contact Folder and Search Keyword along with number of contacts to be fetched. | |
Output | Document |
Binary
Binary or Document
|
- ..
- ..
The EDI transaction ID and order confirmation.
Snap 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.
Field Sets
Specify advanced parameters that you want to include in the request.
This fieldset consists of the following fields:
| Retrieves and fetches you the contact details. | |||
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. | |||
Snap Settings
| Info |
|---|
|
Field Name | Field Type | Description |
|---|---|---|
Label* Default Value: Search Contact | String | Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. |
User/Shared MailBox
Default Value: N/A | String/Expression | Specify the mailbox from which you want to configure auto reply for emails received. If not provided, then the mailbox specified in the account settings is used. |
Contact Folder Default Value: N/A | String/Expression | Specify the name of the contact folder where you want to search for the email. |
Search Keyword Default Value: N/A | String/Expression | Specify a keyword to enhance your search. This will help to narrow down and make your search more precise. |
Number Of Contacts To Fetch Default Value: N/A | Integer/Expression | Specify the maximum number of contacts to be retrieved. If you leave this field blank, it fetches all contacts. |
Snap Execution
Default Value: Validate & Execute | Dropdown list | Select one of the three following modes in which the Snap executes:
|
Troubleshooting
...
Error | Reason | Resolution |
|---|
Batch execution failed
The Pipeline ended before the batch could complete execution due to a connection error.
Verify that the Batch size 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.
Examples
Excluding Fields from the Input Data Stream
We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set. This example demonstrates how we can use the <Snap Name> to achieve this result:
Select valid Contact Folder Name | You have selected invalid Contact Folder Name. | Verify and enter a valid folder name. |
Examples
To search for a contact
We use an example of searching for contact with the required details which will be retrieved from the mailbox.
...
Let us provide the required inputs to the Snap setting and look at the output confirmation.
Send Email Snap | Output |
|---|---|
 |  |
Upon execution, we see an output with the retrieval of searched contact.
Downloads
| Noteinfo | |
|---|---|
| title | Important Steps to Successfully Reuse Pipelines
|
| Attachments | ||
|---|---|---|
|
Snap Pack History
| Expand | |
|---|---|
|
...
|
...
|
...
See Also
...