Pipeline Properties

On this page

Pipeline properties can be viewed and partially edited in the Edit Pipeline dialog available when you click the Edit Pipeline Properties button on the toolbar.

Settings

Label


Required. The name for the Pipeline. Each Pipeline within a Project must have a unique name. The label must not exceed 100 characters.

Project


Required. The Project in which you save the Pipeline, displayed as <project_space>/<project_name>. All necessary resources (such as files and Accounts) should be within the same Project unless they are part of the Shared project.

This is only configurable before you save your Pipeline the first time. To change the Project later, you must move the Pipeline to a new Project or make a copy.

Parameters


Selecting this checkbox displays the Pipeline parameter values in the Pipeline Execution Statistics window on SnapLogic Dashboard, when the Pipeline is run through a Task or another Pipeline with the PipeExecute Snap.



You can define Parameters to be used during Pipeline execution. Pipeline parameters can only contain alpha-numeric characters, such as: myParam1.

To use the value of the parameter as part of an expression within a Snap, you must use the underscore character ( _ ) as a prefix to the parameter name, as in the following: 
'/out' + _myParam1 + '.json'

Parameters can also have their values defined on a Task.

You can also reference an account with an expression through Pipeline parameters, and therefore, configure multiple Pipelines to use a single account reference (credentials) through that Pipeline parameter.

Use the Pipeline Execute Snap for large Pipeline parameters

We recommend that you do not pass excessive data through Pipeline Parameters. You should use Pipeline parameters to pass metadata—not data. You can save data to a file, and then pass the file name as a Pipeline parameter. Similarly, when using the Pipeline Execute Snap, the data can be passed through the input view of the child Pipeline.

When the Capture options is selected, the first 256 bytes of the Pipeline parameter values are stored in the runtime for debug purposes. Each Snaplex node pushes information to the control plane about all the Pipelines running on the node. This data is limited to 250MB of data for all Pipelines on the JCC node.

In the 4.20 release, an additional limit is added which caps the total size of the Pipeline parameter values for one Pipeline execution (including parameters that are not captured) to 8MB. If the Pipeline parameter values exceed 8MB in size, then the Pipeline does not execute.

Expression Libraries


List of expression libraries to import. See Expression Libraries for more information.

  • Path: Path to the file that contains the expression to import. The path can be absolute or relative to the current project
  • As: The name to use for the library under the 'lib' variable. Defaults to the base name of the file.

You can use captured Pipeline parameter values and the error Pipeline parameter values to search a Pipeline in the Pipeline wall on the Dashboard. For details, see Pipeline Search/Pipeline Filter.

Open API

The Open API tab can be used to add descriptive information about the Pipeline parameters like data type and description. This information is helpful to other Pipeline developers in understanding what each of the Pipeline parameter represents. Pipeline parameters are not populated in this tab unless the Pipeline has been saved. If you have added new parameters since the last time you saved the Pipeline, save the Pipeline again to update this tab.

KeyThe name of the Pipeline parameter as given in the Parameters section (Key). 
Type

The data type of the parameter. Choose appropriately from the drop-down. The following data types are listed:

  • string
  • number
  • byte
  • binary
  • boolean
  • date
  • date-time
  • password

Default value: string

For more information regards the data types refer to Data Types.

Description

A description of the parameter, this description will be shown in the API document that is created of the Pipeline properties. Makes it easier for the user to understand the parameter.

Default value: [None]

Required

Specifies whether the parameter is required.

Default value: Not selected