Versions Compared

Old Version 40

changes.mady.by.user John Brinckwirth

Saved on

compared with

New Version 41

changes.mady.by.user Ruth Stento

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel3

Overview

You can create an Ultra Task after you have created the Pipeline in SnapLogic Designer. You can create an Ultra Task in Designer or Manager. When you create an Ultra Task in Designer, the Pipeline is pre-selected when you open the Create Task dialog. When you create an Ultra Task in Manager, you must select a Pipeline to associate with the Task.

Creating an Ultra Task includes the following topics:

Creating an Ultra Task

Open the Create Task dialog doing one of the two following methods:
  • In Designer, click Image Removed to expand the toolbar, and click Image Removed  to display the drop-down menu, then select Task > Ultra Task to display the dialog:
    Image Removed
    • In Manager, navigate to the target Project, click Image Removed to display the drop-down menu, then select Task > Ultra Task to display the dialog.
    Image Removed
    In the dialog, make the following required selections:

    Name. Enter a name for the Ultra Task. This name is used in the URL when the Pipeline has unconnected inputs/outputs.

    NoteUnless otherwise noted, the names of any asset or project is limited to UTF-8 alphanumeric characters and these punctuation

    Ultra Tasks define the configuration to run an Ultra Pipeline on a Snaplex. When you activate an Ultra Task, the associated Snaplex starts one or more Pipeline instances that continuously process documents from a FeedMaster or another message queue. If you modify assets related to an active Ultra Task, in some cases, the Snaplex restarts the Pipeline instances automatically.

    For high availability and disaster recovery, you can run a Pipeline in multiple regions. To do this, create multiple Ultra Tasks for the same Pipeline using the same alias. Assign each Ultra Task to a Snaplexex in a different region. When an Ultra Pipeline in one region fails, a Snaplex in another region can run the Ultra Task by invoking the Ultra Task with the same alias. Learn more about the deployment architecture for providing high availability and disaster recovery.

    You can tune Ultra Task performance by specifying the number of Pipeline instances to run and the maximum number of documents that one instance should process at a time. Also, you can specify how many times a Pipeline can failbefore the Snaplex disables the Ultra Task. Configuration Options describes the fields that control these behaviors, Instances (per Snaplex), Max In-Flight, and Maximum Failures.

    Prerequisites

    • A Snaplex with one or more FeedMaster nodes.

    • Write permissions for the Project Space.

    • A valid Pipeline.

    Workflow

    Image Added

    Creating an Ultra Task

    1. From Designer or Manager, open the Create Task dialog:

      • In Designer with the Pipeline open, in the toolbar, click More Tools. Click Create Task and select Ultra Task:

        Image Added

      • In Manager, from the left navigation, select the Project containing the Pipeline. In the toolbar, click Create and select Task > Ultra Task.

        Image Added

        The Create Task dialog displays:

        Image Added

    2. Edit the required fields:

      1. Name. Enter a name, which can include UTF-8 alphanumeric characters and special characters !"#$%&'()*+,-.:;<=>?@[\]^_`{|}~.

  • Pipeline. Select the Pipeline to run from the Pipeline drop-down menu. This Pipeline is triggered when the Ultra Task is called. If applicable, edit any of the parameter values from the Pipeline.

    • Snaplex. Select the Snaplex on which to run the Pipeline from the Snaplex drop-down menu. The Snaplex must have a FeedMaster associated with it.
    Image Removed
    If applicable, modify the Configuration Options in the dialog window, and click Save.
  • You can activate your Ultra Task through a variety of methods.
    See Invoking Ultra Pipelines as Tasks for details about activating your Ultra Task.

    • Once activated, the associated Pipeline is started on the Snaplex using the Ultra run policy that is specified in the Task dialog window. The Ultra Pipeline consumes messages from the FeedMaster and processes input documents. The Pipeline restarts automatically after the Ultra Task or the Pipeline itself is modified and saved—including known child Pipelines and accounts that are not computed dynamically using an expression.

    Viewing Ultra Task Details

    After you create and enable your Ultra Task, you can view details about the Task.

    Open the Task Details page for your Ultra Task by clicking View Details:
    Image Removed
    On the Task Details page, view Pipeline execution information for any instance by clicking Run Details.
    Image Removed
     Navigate to the Dashboard Pipeline Wall to monitor the executions details about your Ultra Task.

    Multiexcerpt include macro
    nameDuplicate Executions
    pageCreating Scheduled Tasks

    Notifications

    You can create

      1. This name is used in the URL when the Pipeline has unconnected inputs/outputs. 

      2. Pipeline. If not already selected, click the drop-down menu and select the Pipeline to be triggered by the Ultra Task. 

        If you choose a Pipeline that contains parameters, the parameters display in the Create Task dialog, where you can modify them. In the following example, the parameter keys path, full, and table name are displayed, with their entries as the corresponding values. In the full field, the values contain nested JSON.

        Image Added

      3. Snaplex. From the drop-down menu, select a Snaplex that has a Feedmaster. 

    2. Modify the applicable optional fields as described in Configuration Options.

    3. Click Save.

    Configuration Options

    Field

    Description

    Notifications

    Enables email notifications based on the status of the Scheduled Task. If your Org supports Slack notifications, you can add Slack channels or recipients.

     To add recipients for Task

     

    To use notifications:

    1. In Notifications, enter each recipient's email address, separated by commas.

    2. If Slack notifications are configured for your Org,

    then

    1. the following fields

    support dropdown lists containing your Slack channels and users. For each field, you can also type to invoke suggested recipients in the field. 

    1. display. You can select from the dropdown list or start typing a name to find it in the list:

      • Direct Message(s). Select

    Slack recipients from the dropdown list. 

      • individuals to receive notifications.

      • Channels. Select

    Slack channels as recipients from the dropdown list

      • channels to receive notifications.

    2. Select the status

    event for which Notifications are sent

    1. that triggers notifications from the When Task has selector:

      • Started. The Task is activated.

      • Completed. The Task is completed.

      • Failed. The associated Pipeline did not execute.

      • Stopped. The associated Pipeline has stopped abruptly and the Task is no longer running.

    Recipients receive notifications based on the selections in the When Task has field.

    Ultra Task Configuration Options

    You can configure the following settings for your Ultra Task. Each field has a default value, except where indicated.

    Instances per Snaplex

    You can specify

    Instances (per Snaplex)

    Specifies how many instances of the Pipeline should be running on a Snaplex. For example, to achieve redundancy, you can configure an Ultra instance per document. 

    The default value is

    one instance per Snaplex.If the

    1.

    The Snaplex distributes instances across nodes. For example, If a Snaplex has five nodes and

    ten Ultra Task instances are actively running, then

    this value is set to 10, the Snaplex starts two instances on each node. The algorithm for distributing executions on nodes is based on

    how many

    the number of currently running Ultra Task

    Pipelines are running already

    instances. Each instance connects to the input queue, and receives notifications of message delivery as they come in.

    When multiple instances are running, the message is delivered to a single instance. If the Pipeline or node fails for any reason, then the message is unacknowledged in the queue. Consequently, when the consumer is recognized as no longer being connected, the message returns to the queue and is picked up by another instance. In the correct configuration, messages should not be lost.

    Alias

    For

    Use an alias to run an Ultra Task in multiple regions for high availability and disaster recovery

    contexts, you can provide an alias for the Task in the Alias field. Tasks must have the same Alias. 

    . Use the same alias in multiple Ultra Tasks that run the same Pipeline. When an Ultra Task in one region fails, a Snaplex in another region can run the

    Ultra Task

    Pipeline by invoking the Ultra Task that shares the Alias name. The Ultra Task that shares the Alias must be in the same project folder as the primary Ultra Task, but be deployed to different Snaplex instances.

    Bearer Token

    You can use the auto-generated bearer token as

    An automatically generated token for the HTTP Authorization header. If you clear this field,

    then requests are authenticated by

    the Pipeline

    itself

    authenticates requests. You can also

    modify

    set the

    field

    value

    as required

    yourself. 

    Max Failures 

    You can indicate the maximum number of consecutive failures in a short period of time by entering a value in the Max Failures field. When this threshold is reached, the Task is automatically disabled. 

    The default value is ten document processing failures.

    Set this value to zero if the Task should never be disabled. 

    Max In-Flight

    You can prevent an excessive number of documents from being queued on a single, slow execution. Once the execution reaches this threshold of documents being processed, requests are distributed

    Maximum Failures

    Specifies an optional threshold for a Pipeline failing to start. When the number of failures reaches the threshold, the Snaplex disables the Ultra Task. The default value is 10. Set the value to 0 to avoid having the Snaplex disable the Ultra Task. 

    During development a Pipeline can be in an invalid state and fail to start multiple times. Consider setting the value for Maximum Failures to 0 until the Pipeline is ready for production.

    Max In-Flight

    Specifies a threshold for documents to be processed on a single Pipeline instance. Once the execution reaches the threshold, the Snaplex distributes to other instances of the Ultra Pipeline.

     

     This enables you to prevent an excessive number of documents from being queued on a single, slow execution.

    Set the Max In-Flight value to the maximum number of documents that can be processed by

    an

    one instance at

    any one

    a time.

    The default value is 200 documents.

    You can set this value to one, but doing so affects performance, because a value of one would disable the prefetching of documents. Set this value Change

    Set this value higher if the Ultra Task executions take a long time.

    Pipeline Parameters

    You can specify Pipeline parameters. If you choose a Pipeline that contains Pipeline parameters to run in the Ultra Task, then these Pipeline parameters also appear in the Create Task window, where you can modify them. In the following example, the parameter keys path, full, and table name are displayed, with their entries as the corresponding values. 

    Image Removed

    In the full field, the values contain nested JSON.

    A value of 1 disables the prefetching of documents and can negatively affect performance. 

    Editing an Ultra Task

    1. Click Manager.

    2. From the left navigation, select the Project Space to which the Ultra Task belongs.

    3. Select the Tasks tab.

    4. Click the Ultra Task name. The Update Task dialog displays:

    Changing the Run Policy

    When you create an Ultra Task, Ultra is the chosen Run Policy by default. 


    Image Removed



    If you change the Run Policy setting to Triggered or Scheduled,

     the underlying Task type is modified. In such cases, you

     you must re-configure the Task.

    See Also

    Viewing Ultra Task Execution Details

    After you create and enable your Ultra Task, you can view execution details.

    1. In Manager, navigate to the Ultra Task and select Details from the dropdown menu:

    2. On the Task Details page, view execution statistics by clicking Run Details:

      Image Added


    Related Information