On this Page
| Table of Contents | ||||
|---|---|---|---|---|
|
| Note |
|---|
The Task Execute Snap is being phased out in favor of the Pipeline Execute Snap. To execute a SnapLogic Pipeline that is exposed as a REST service, use the REST Get Snap instead. |
Snap type: | Flow | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description: | This Snap lets you execute predefined triggered tasks. A task can be selected from the current project or from the Shared project using the suggest functionality of the task property. A path of another project can be copied directly into the property value if needed, however the user executing the task must have permissions on the project where the task resides.
A batch size can be defined if multiple documents need to be streamed to the underlying pipeline of the task. Task parameters can be defined to allow passing parameters to the underlying pipeline of the task. The task parameter is suggestible and will return the parameter names of the underlying pipeline if any are defined. The parameter value can either be a constant value (= disabled) or can come from the input view or a pipeline parameter of the current pipeline (= enabled).
| |||||||||||||
| Prerequisites: | None | |||||||||||||
| Support and limitations: | Works in Ultra Task Pipelines if Batch size is set to 1. | |||||||||||||
| Account: | Accounts are not used with this Snap. | |||||||||||||
| Views: |
| |||||||||||||
Settings | ||||||||||||||
Label | Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. | |||||||||||||
Use On-Premises URL | Required. If selected, the on-premises URL of the task will be be used to invoke Child Pipeline execution. Selecting this checkbox avoids sending data through the cloud.
| |||||||||||||
Task | Required. This setting allows the execution of a predefined triggered task. The task can be created in SnapLogic Manager for any given pipeline. Parameters of the pipeline can be passed in as variables using the Task parameter section of the Snap. Documents that are passed into the Snap are being streamed in the form of batches. The batch size controls how much memory is being used by the Snap. The data is transmitted encoded so that data formats such as LocalDate and DateTime can be preserved without having to parse them afterwards. The task must be either in Shared or in the project where the pipeline resides. Example: /Snaplogic/shared/feed task | |||||||||||||
Batch size | This setting defines the batch size of the request. The incoming documents will be accumulated in a list up to the defined batch size before it is submitted to the endpoint. The last document of the batch is used to provide the task parameter values if the batch size is set > 1. Example: 1000 | |||||||||||||
Task parameters | This setting lets you define task parameters and their values. A task parameter refers to the pipeline parameter of the underlying pipeline. Example:
| |||||||||||||
|
| |||||||||||||
Example
Use the attached pipeline, feed , as a sample. Next, use the task sample pipeline as the parent pipeline that will call the task.
The task, feed task, has to be created manually either in Shared or in the project where task sample resides. The task must be defined as a triggered task. Once completed, the suggest capability of the Task Execute Snap can be used to refer to the task and its parameters.
You can also find more information on the SnapLogic blog at: SnapLogic Tips and Tricks: Understanding the Task Execute Snap.
Downloads
| Multiexcerpt include macro | ||||
|---|---|---|---|---|
|
| Attachments | ||
|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|