Syndigo Search

Overview

You can use this Snap to search for Syndigo entities using specific filter criteria. This Snap supports advanced filtering, sorting, and context to refine results.

Important: Snaps in Syndigo Snap Pack automatically cache and refresh model information once in every 24 hours. To reflect any changes to the model in the Snap outputs, restart the Snaplex.

keyref="snap-syndigo-search"

Limitations

  • Syndigo Search Snap does not return any search results when the UOM checkbox for an Attribute Criterion filter condition is selected with the Comparison type set to a value other than eq.
  • The Snap does not support searching for Deeply Nested Attributes.
  • If the Locale is not specified in the Value context field set, the Snap returns the property information of the matching entities without the Entity attribute information.

Known issues

None.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap has at the most one document input view. The entity or entities for which you want to retrieve the details. Mapper
Output This Snap has exactly one document output view. This Snap displays the details of the entity/entities from the Syndigo in the RSJSON or simplified JSON format. Mapper
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. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining 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

Legend:
  • Expression icon (): Allows using JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / Field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Syndigo Search

Example: Find relationships with images

Domain String/Expression/ Suggestion

A (data) domain in Syndigo refers to a large data set that covers a specific area of importance like Product data, Customer data, Asset data, or Suppplier data. Specify the domain to retrieve the entity information from. See the list of permitted domains.

Default value: None.

Example: thing

Entity String/Expression/ Suggestion

Required. Specify the entity type (category) under the chosen domains to retrieve the entity information from. The list of suggested entities is based on the specified domain. If no Domain is specified, this field suggests all entities that the Snap account can access.

Default value: None.

Example: product

Use editor for advanced criteria Checkbox

Select this checkbox to define the advanced filter criteria through a JSON input. If this checkbox is selected the Edit criteria button replaces the Filter settings field set.

Default status: Deselected

Edit criteria Button

Click this button to open the editor dialog and define the advanced filter criteria in the JSON format.

Example: You can provide the filter criteria in the editor dialog in similar lines as in the image below:

Filter settings This field set is displayed when the Use editor for advanced criteria checkbox is not selected. Use this field set to specify the advanced search criteria through the Snap UI. The filters can be based on any combination of the four criterion blocks - attributes, properties, keywords, and relationships. Each criterion block is a collection of one or more filter conditions.
Logical operator Dropdown list

Select between the AND and OR operators to apply between the different criterion blocks - attributes, properties, keywords, or relationships that you would select for the search.

Default value: OR

Example: AND

Note: This logical operator is applied at a criterion block level, where each block comprises of multiple logical groups of individual filter conditions. For example:

										"or": [
										{
										"attributesCriterion": [
										{
										"_ALL": {
										"contains": "test"
										}
										},
										{
										"mdmid": {
										"eq": "*90989"
										}
										}
										]
										},
										{
										"propertiesCriterion": [
										{
										"id": {
										"lt": 20,
										"gt": 0,
										"type": "_INTEGER"
										}
										}
										]
										}
										]
										}
									
Attributes criterion
Use the following fields to define one or more attributes-based conditions for the search.
  • Name
  • Comparison type
  • Target value
  • UOM
  • Group ID
Name String/Expression/ Suggestion

Specify the attribute name for the filter condition.

Default value: None.

Example: productid, discount, pkgheight

Comparison type Dropdown list/Expression
Select the type of comparison between the specified attribute and its (target) value for the filter condition. The permitted values are:
  • eq: Equal to the value
  • contains: Contains the value
  • exact: Exactly matches the value
  • exacts
  • startswith: Starts with the value
  • hasvalue: Contains some value (and not null)
  • gt: Greater than the value
  • gte: Greater than or equal to the value
  • lt: Lesser than the value
  • lte: Lesser than or equal to the value

Default value: hasvalue

Example: exacts, startswith, gte ( >= )

Target value String/Expression

Specify the value to compare with the specified attribute's value.

Default value: None.

Example: 23few543-n8r4-mgfr-ad7r-vnrger9nen35, 10##%, 18##inch

UOM Checkbox/Expression

Select this checkbox to filter the data based on the unit of measure (UOM) for the selected attribute.

Default status: Deselected

Group ID String/Expression

Specify the ID with which this filter condition can be grouped with other related filter conditions. You can logically group any number of these filter conditions within a criterion block based on a unique group ID to define your search filter. These filter conditions with the same Group ID will be combined using the AND operator.

Default value: None.

Example: 1, 3, 4

Properties criterion
Use the following fields to define one or more entity record properties-based conditions for the search.
  • Name
  • Comparison type
  • Target value
  • Group ID
Name String/Expression/ Suggestion

Specify the property name for the filter condition.

Default value: None.

Example: modifiedDate, modifiedService, modifiedBy, createdBy, createdService, createdDate

Comparison type Dropdown list/Expression
Select the type of comparison between the specified property and its (target) value for the filter condition.The permitted values are:
  • eq: Equal to the value
  • contains: Contains the value
  • exact: Exactly matches the value
  • exacts
  • startswith: Starts with the value
  • hasvalue: Contains some value (and not null)
  • gt: Greater than the value
  • gte: Greater than or equal to the value
  • lt: Lesser than the value
  • lte: Lesser than or equal to the value

Default value: hasvalue

Example: exacts, startswith, gte ( >= )

Target value String/Expression

Specify the value to compare with the specified property's value.

Default value: None.

Example: 23few543-n8r4-mgfr-ad7r-vnrger9nen35, 10##%, 18##inch

Group ID String/Expression

Specify the ID with which this filter condition can be grouped with other related filter conditions. You can logically group any number of these filter conditions within a criterion block based on a unique group ID to define your search filter. These filter conditions with the same Group ID will be combined using the AND operator.

Default value: None.

Example: 1, 3, 4

Keywords criterion
Use the following fields to define one or more keywords-based conditions for the search.
  • Keywords
  • Operator
Keywords String/Expression

Specify space-separated keywords for the search operation. You can also include wilcard symbols within these keywords

Default value: None.

Example: Ladder stool, watch*

Operator String/Expression/ Suggestion

Select between the AND and OR operators to apply between the different keywords specified for the search.

Default value: OR

Example: AND

Relationships criterion
Use the following fields to define one or more relationships-based conditions for the search.
  • Relationship
  • Type
  • Relationship attributes
Relationship String/Expression/ Suggestion

Select a relationship to include in the search for entities. Based on the Snap account specified, the suggestions for this field display the list of all permitted relationships.

Default value: None.

Example: hasimages

Type String/Expression

Specify the type of the relationship - image/document/audio/video/product to look for during the search.

Default value: None.

Example: image

Relationship attributes
Use the following fields to define one or more relationship attributes-based conditions for the search. (Attribute) Name suggestions are based on the selected Relationship and Type.
  • Name
  • Comparison type
  • Target value
  • UOM
Name String/Expression/ Suggestion

Specify an attribute name corresponding to the selected Relationship and Type for the filter condition.

Default value: None.

Example: productid, discount, pkgheight

Comparison type Dropdown list/Expression
Select the type of comparison between the specified attribute name and its (target) value for the filter condition.The permitted values are:
  • eq: Equal to the value
  • contains: Contains the value
  • exact: Exactly matches the value
  • exacts
  • startswith: Starts with the value
  • hasvalue: Contains some value (and not null)
  • gt: Greater than the value
  • gte: Greater than or equal to the value
  • lt: Lesser than the value
  • lte: Lesser than or equal to the value

Default value: hasvalue

Example: exacts, startswith, gte ( >= )

Target value String/Expression

Specify the value to compare with the specified relationship's value. If the value includes its unit of measure, make sure to include the UOM separator and select the UOM checkbox.

Default value: None.

Example: 23few543-n8r4-mgfr-ad7r-vnrger9nen35, 10##%, 18##inch

UOM Checkbox/Expression

Select this checkbox if the specified relationship attribute (and hence the target value also) support a unit of measure (UOM).

Important: The UOM -based criteria for the search currently works only when the Comparison type is eq

Default status: Deselected

Sort settings
Use the following Order by attributes and Order by properties fieldsets to define a combination of properties and attributes to sort the search results.
  • Order by attributes
    • Name: Select an attribute from the suggested attributes list.
    • Sort order: Select ASC - (ascending) or DESC - (descending)
  • Order by properties
    • Name: Select a property from the dropdown list list.
    • Sort order: Select ASC - (ascending) or DESC - (descending)
  • Type
  • Relationship attributes (fieldset)
Simplify response Checkbox

Select this checkbox to retrieve the information on the matching entities in a flattened (standard) JSON format. Also select a UOM separator to use in the JSON format.

Default status: Selected

UOM separator String/Expression

Appears when the Simplify response checkbox is selected. Specify the separator character/string to place between a value and its unit of measure (UOM) in the simplified/flattened JSON response.

Default value: ##

Example: @$%, ^$*

Context settings For each context, specify the Context name and Context value.
Important: If you do not specify a context in this field set, the Snap retrieves all available context information for the matching entities.
Context name String/Expression/ Suggestion

Specify the context name to be included in the entity's information. The list of suggested context names is based on the values specified in the Entity.

Default value: None.

Example: refcountrylist

Context value String/Expression

Specify the context value for the chosen context name.

Default value: None.

Example: France

Value context Specify the Locale and Source you want to retrieve for thre selected entity.
Locale String/Expression
Specify the locale to retrieve the entity information. The Snap fetches only those entity attributes that have information specific to the locale.
Note: If the Locale is not specified, the Snap returns only property information without the Entity attribute information.

Default value: None.

Example: fr-FR

Source String/Expression

Specify the source of the JSON information record, whether it is internal or external.

Default value: internal

Example: external

Output attributes Use this field set if you want to retrieve only specific attributes of each matching entity.
CAUTION: If the do not specify the output attributes, the Snap retrieves all output attributes for the matching entities.
Output attribute String/Expression/ Suggestion

Specify one or more entity attributes, separated by a comma (,) from the suggested list of attributes to include in the retrieved entity information. The attribute suggestions for this field correspond to the specified Entity type, if specified.

Default value: None.

Example: thgdisplayname,mdmid,mdmname

Relationships Use this field set to retrieve only specific relationships of each matching entity. Specify one relationship per row.
Important: If you do not specify a Relationship in this field set, the Snap retrieves all available relationships information for the matching entities.
Relationship String/Expression/ Suggestion

Specify the entity's relationship name from the suggested list of owned relationships to include in the retrieved entity information. The relationship suggestions for this field correspond to the specified Entity and do not include the whereused relationships.

Default value: None.

Example: associatedsku-sku

Fetch size String/Expression

Specify the number of matching entity IDs that the Snap should retreive per fetch from the input metadata (Syndigo entities list). This value must conform to the payload size limits that Syndigo has set.

Minimum value: 1

Maximum value: 2000

Default value: 100

Example: 50

Snap execution Dropdown list
Choose 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.

Default value: Validate & Execute

Example: Execute only