Multi Pipeline Function Generator

Overview

You can use this Snap to transform pipeline properties and parameters (such as pipeline name, purpose, and OpenAPI parameters) into function definitions.


Multi Pipeline Function Generator Snap Overview

Prerequisites

None.

Known issues

None.

Limitations

  • Converse and Gemini models do not support Strict mode. Therefore, they ignore this value.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap can have none or one document input view. The input can be a pipeline path from which the Snap reads the required properties.
Output This Snap has exactly one document output view. The output contains a list of function definitions.
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 (): 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 Account configuration.
  • 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: Multi Pipeline Function Generator

Example: Execute reusable pipeline logic
Pipelines Use this field set to add the pipeline assets.
Pipeline path String/Expression/Suggestion Specify the path to the pipeline from which to extract properties.
Important:
  • The value must be either a single string or a list of strings.
  • We recommend that you use an absolute path to prevent conflicts caused by pipelines with the same name in different projects. For eample,
    • Pipeline name: pipeline_1
    • Relative path: ../../shared/pipeline_2
    • Absolute path: /snaplogic/projects/shared/pipeline_1
    • List of pipeline paths/names: ["pipeline_1", "pipeline_2", "pipeline_3"]
  • Refer to the following naming rules for compatibility across all models:
    • Must start with a letter.
    • Can include letters, numbers, or underscores (_).
    • Must be between 1 and 64 characters long.
    • Spaces, dashes (-), and leading numbers are not allowed.

Default value: N/A

Example:
  • get_weather
  • getWikiURL
Strict mode Checkbox
Select this checkbox to ensure that the Snap validates the input parameters strictly according to the defined schema or constraints.
Important:
  • When the Pipeline path value is a list of strings, the strict mode setting applies to each item in the list.
  • Only certain OpenAI models support this mode. Learn more.
  • For OpenAI models that support Strict mode, selecting the checkbox ensures all function parameters are required. If any parameter is optional, the API call fails and displays an error. Refer to the OpenAI documentation for more details.
  • Converse and Gemini models do not support Strict mode. Therefore, they ignore this value.

Default status: Deselected
Aggregate input Checkbox

Select this checkbox to aggregate all incoming documents into a single input for the pipeline function.

Default status: Deselected
Snap execution 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.

Default value: Validate & Execute

Example: Execute only

Examples