Syndigo Read

Overview

You can use this Snap to read entity records based on the selected entity. The Snap allows you to specify the domain, entity type, locale, page size to retrieve, contexts, attributes, and relationships to include in the output. You can also use this Snap to output the entities information in a simple JSON format with a custom UOM separator.

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.

Syndigo Read Overview

Limitations

  • The Snap ignores the entity's relationships that do not contain relTo information while parsing the RSJSON format to the simplified JSON format.
  • The Snap parses only attributes available in the metadata of the entity for generating the simplified JSON format. It ignores any attribute that exists outside of the entity's metadata.

Known issues

  • The Syndigo Read Snap returns only up to a maximum of 2000 records of entity information, if the Page size is left empty.

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 at the most 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 Read

Example: Read things
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.

Note: This field does not support upstream values.

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 entity types from all domains that the Snap account can access.

Default value: None.

Example: product
Entity IDs String/Expression

Specify one or more entity IDs separated by a comma (,) for the Snap to retreive their entity information.

CAUTION:
  • If you leave this field empty, the Snap retrieves entity information for all entities that currently exist in the specified entity type. This may affect the Snap's (pipeline's) performance.

Default value: None.

Example: 6123a833-b5c3-f365-3674-47c3d6c47c60, c3d6c47c-b565-36c3-f374-47606123a833
Page 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.

Note: This field does not support upstream values.

Minimum value: 1

Maximum value: 2000

Default value: 100

Example: 50
Locale String/Expression

Specify one or more locales, separated by a comma (,), to retrieve the entity information. The Snap fetches only those entity attributes that have information specific to the locale.

Note:
  • If you leave this field empty, the Snap retrieves entity information for all those locales that are currently available for each entity in the input metadata.

Default value: None.

Example: en-US, fr-FR
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: Deselected
UOM separator String/Expression

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

Note: This field does not support upstream values.

Default value: ##

Example: @$%, ^$*
Include context Checkbox

Each entity's information in the Syndigo's database is associated with one or more contexts for which it was created. By default, the Snap's output contains only global attributes. Select this checkbox to include the context information in the Snap's output for each matching entity ID.

Default status: Deselected
Contexts This field set is displayed when you select the Include context checkbox. For each context, specify the Context name and Context value.
Important: If you do not specify a context in this field set after selecting the Include context checkbox, 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.

Note: This field does not support upstream values.

Default value: None.

Example: refcountrylist
Context value String/Expression

Specify the context value for the chosen context name.

Note: This field does not support upstream values.

Default value: None.

Example: France
Output attributes Use this field set if you want to retrieve only specific attributes of each matching entity.
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.

Note: This field does not support upstream values.

Default value: None.

Example: thgdisplayname,mdmid,mdmname
Relationships Use this field set ito 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.

Note: This field does not support upstream values.

Default value: None.

Example: associatedsku-sku
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