Versions Compared

Old Version 30

changes.mady.by.user Amritesh Singh

Saved on

compared with

New Version 31

changes.mady.by.user Amritesh Singh

Saved on

Key

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

...

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 1

  • Max: 1

Generators

Entry type and key (if desired) to sort the entries.

Output

Document

  • Min: 1

  • Max: 1

Any file Formatter followed by File Writer.

List of existing entries of the selected type matching the given criteria.

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 while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Info

  • Asterisk (*): Indicates a mandatory field.

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

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

  • Add icon ((blue star)): Indicates that you can add fields in the field set.

  • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

Field Name

Field Type

Description

Label*

Default Value: Search Entries
Example: Search Entries

String

Specify a unique name for the Snap.

Entity type

Default Value: User
Example: Group

Dropdown list

Select the object to work with. Available options are:

  • User

  • Group

Filter

Default Value: N/A
Example:

  • userPrincipalName eq '53557e1139244e1f42bda066_0f8bd9c5-fa9f-4557-8529-6fca270dcbd31@Dynamicshosted.onmicrosoft.com'

  • country eq 'india'

  • "userPrincipalName eq \'" + _email + "\'"

  • "country eq \'" + _country + "\'"

  • startswith(displayName,'Dan')

  • "country eq \'" + _country + "\'" +"or "+ "userPrincipalName eq \'" + _email_2 + "\'"

String/Expression

Specify the search criteria to filter the search for the selected Entity type. Azure Expression Language must be used. 

You can use only certain attributes in the search expression based on entry type.

Learn more about framing search expressions: Supported queries, filters, and paging options. 
Learn how to filter attributes: Entity and complex type reference.

Properties

Default Value: N/A
Example: aboutMe, accountEnabled, displayName

String/Expression

Specify the properties to be displayed in the output for the user or group. You can add properties corresponding to User or Group from the following links:

Learn more about Advanced query capabilities on Azure AD directory objects.

Info

Microsoft has updated the naming conventions of the attributes. Hence, specify the property as mentioned in this document for the Snap to return the correct attributes.

For example, userState should be specified as externalUserState.

This Snap also supports $select only properties. To view the $select only properties in the output view you must specify the properties in the $select text.

Snap Execution

Default Value: 
Example: Validate & Execute

Dropdown list

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

...