Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Minor edits

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Overview

SnapLogic's Iris Integration Assistant simplifies Pipeline building, making it faster and more efficient. Iris offers the following abilities:

Table of Contents
maxLevel1
excludeOverview

Note

Iris

...

also enables you to preview Pattern Pipelines in the SnapLogic Cloud Pattern Catalog before you import them into your existing Pipelines. For more information on this feature, see Cloud Pattern Catalog.

To be able to use Iris you must first enable it. To do so:

  1. In Designer, click User Settings.
  2. Select Integration Assistant in the popup that appears.
    Image Added

  3. Click Save.
  4. The Suggested Snaps and Pipelines pane appears at the bottom of the Canvas. If this is the first time you open the Integration Assistant, then a couple of quick tips are displayed.

    Info

    Disabling Integration Assistant disables Snap and Pipeline recommendation features.


Snap Recommendation

Iris simplifies Pipeline construction by suggesting the most likely start, previous, and next Snaps in a Pipeline, based on Snap usage in current and previously-created Pipelines.

Taking into account your Org, project,

...

user profile, and current Snaps in the

...

Pipeline,

...

Iris offers intuitive and

...

personalized suggestions on the

...

start, previous and next Snaps that you may want to use. The Snap suggestions are so

...

personalized that the same Snap

...

may not have the same suggestion for the same

...

Pipeline in a different project, user profile, or Org.

Note
  • Suggestions are not displayed if:
    • An input/output view is not defined.
    • An input/output view is defined but either directly connected to another Snap or by a GoTo link.
    • An input/output view is defined but there is a disconnected Snap placed close by, which has taken up the space required to display the recommended Snaps.
  • Suggestions are also not made for error views.

How Iris Integrates with your Pipelines

Iris behaves differently depending upon the

...

Pipeline in consideration. If it is a new

...

Pipeline, it 

...

suggests a start Snap, displaying it as a ghost. The Suggested Snaps pane displays a list of suggested Snaps for the active Snap.

...

 Image RemovedImage Removed

...

Click the Snap that you want to add, and it gets added to the Canvas, displaying no longer as a ghost Snap. 

Image Added

When working with an existing Pipeline, Iris does not show a start

...

Snap; just

...

the suggestions for the active Snap. If the suggestions are not automatically shown when you hover the mouse over the Snap, press the

...

CTRL (or Command, if you're using a Mac) key and click on the Snap. This informs Iris that the selected Snap is the active Snap,

...

and it fetches Snap suggestions accordingly.


Note

...

In Snaps that have multiple input/output views, such as the Copy Snap, right-click on the view and select Assistant to fetch downstream or upstream Snap suggestions.

Image Added

Enable Iris

To be able to use Iris you must first enable it. To do so:

  1. Go to User Settings.
  2. Select Integration Assistant.
    Image Removed
  3. Click Save.
  4. The Suggested Snaps pane opens to the right in your canvas. If this is the first time you open the Integration Assistant, a couple of quick tips are displayed.
Note
  • Suggestions are not displayed if:
    • an input/output view is not defined.
    • an input/output view is defined but either directly connected to another Snap or by a GoTo link.
    • an input/output view is defined but there is a disconnected Snap placed close by, which has taken up the space required to display the recommended Snaps.
  • Suggestions are also not made for error views.

Suggested Snaps Pane

Iris' suggestions are displayed in the Suggested Snaps pane. This pane is displayed on the right side of your canvas. For the suggestions to be displayed, at least one Snap has to be selected on your canvas as the active Snap. When a new pipeline is created, as a default the start Snap is considered as the active Snap, and Snap suggestions are displayed for this active Snap in the Suggested Snaps pane automatically. Hover your mouse over the end Snap to mark it as the active Snap instead, and let Iris fetch suggestions for the same.

Image Removed

Selecting a Snap from the Suggested Snaps Pane

You can select a Snap from the Suggested Snaps pane either by:

  • Clicking the Snap from the suggested list; the Snap is automatically added to the canvas and connected to the active Snap.
  • Dragging the Snap from the list onto the canvas; you have to manually place it next to the active Snap to connect it.

Every time you select a Snap, the list of previous and next Snaps is automatically refreshed.

Info

Sometimes –especially when opening an existing pipeline– Iris may not fetch Snap suggestions automatically. This is because an active Snap is not selected. To select a Snap as the active Snap, ensure that it meets the prerequisites stated above and then Command-click or Ctrl-click on the Snap. Alternatively, right-click on the Snap → Assistant.

Using Iris

Prerequisites

  • An input/output view must be enabled.
  • The input/output view must not not connected to another Snap (directly or indirectly through a GoTo link).
  • The Snap must not be blocked by another unconnected Snap blocking the placement of a suggested Snap.

Snap Suggestions for Upstream Snap

To get suggestions for previous (or upstream) Snap:

  1. Select the target Snap to mark it as the active Snap. Iris fetches a list of suggestions and displays them on the Suggested Snaps pane. It also displays the upper-most suggested Snap as a blinking ghost Snap attached to the active Snap on the canvas.
    Image Removed
  2. Click the ghost Snap on the canvas, or click the upper-most Snap displayed in the Suggested Snaps pane, to add to your pipeline.

Snap Suggestions for Downstream Snap

To get suggestions for next (or downstream) Snap:

...

Pipeline Recommendation

The Pipeline Recommendation feature of Iris enables you to get suggestions for Pipelines based on specific criteria. Use the Pipeline Recommendation feature to get Pipeline suggestions based on:

  • The name of the displayed Pipeline
  • Specific Snap sequences in the displayed Pipeline

Iris recommends Pipelines based on Pipelines in your organization, SnapLogic Cloud Pattern Catalog, and the common Pipelines in our database. Iris uses Convolutional Neural Networks (CNN) for Pipeline recommendation. The recommendations are personalized and hence, different users will see different recommendations.

Note

Once every 24 hours, Iris scans the list of Pipelines created in your Org and includes only successfully executed Pipelines to its list of potential recommendations. This means that if you create a Pipeline that doesn't execute properly, you need not worry about it showing up as a recommendation. Iris automatically filters out all unexecutable Pipelines. However, if you create a Pipeline that executes successfully, it will be available as a Pipeline recommendation within 24 hours to users who have at least Read access to the parent project.

Retrieving Pipeline Recommendations based on the name of the displayed Pipeline

When you create a Pipeline and have just an empty Canvas to start with, Iris uses just the name of the Pipeline to retrieve Pipeline recommendations that you can use to build–or replace–your Pipeline. Each Pipeline that appears in the list of Suggested Pipelines is automatically tested and successfully executed. We also use a range of other metrics to ensure that only high-quality Pipelines appear here. 

For example, in the screenshot below, the Canvas is empty, and when you hover your cursor on the Suggested Pipelines displayed, the Pipeline appears on the Canvas.

Image Added

The Pipeline Recommendation feature uses the name of the Pipeline, existing Snaps on the Canvas, and other metadata to offer suggestions from the following sources:

  • All the Pipelines to which you have access
  • Pattern Pipelines from the SnapLogic Cloud Pattern Catalog
  • Synthesized Pipelines

Use the arrow buttons that appear on the sides of the Suggested Pipelines pane to navigate through the list of Pipeline suggestions. As you add more Snaps, click the Image Added button in the pane to refresh the suggestions.

As you navigate right for more and more recommendations, you will start seeing recommendations with the Pattern: prefix. These are Pipeline Patterns provided by SnapLogic whose title words match the name that you gave to the Pipeline that you want to create. This enables you to quickly and easily use existing Pipelines Patterns in the Pipeline that you are creating.

Image Added 

Pipeline Recommendations in action

Image Added

Expression Recommendation

Iris simplifies adding expressions in expression-enabled Snaps by recommending expressions based on the input schema. To receive expression recommendations while designing your Pipelines, do the following:

  1. Validate the Pipeline to get the input schema.

  2. Receive expression recommendations based on the input schema. Iris recommends expressions based on the expressions in the Pipelines in projects where you have read access.

  3. Type a keyword in Input Schema to filter recommendations.

  4. Click on an expression to select it.

Image Added

Generating Synthesized Pipelines Using Iris

Iris enables you to get synthesized Pipelines using two or more Snaps on the Canvas as starting points. Iris will fill the gaps and generate synthesized Pipelines. For example, you could add a File Reader Snap to specify that you want to start your Pipeline with a File Reader Snap and add an HDFS Writer Snap, leaving space for a few Snaps to indicate that you want the Pipeline to end with an HDFS Writer. Iris now uses these two Snaps to generate synthesized Pipelines that start and end with the Snaps you specified:

Image Added

You can hover your mouse on each suggestion to view the Pipeline. Click on the Pipeline you want to use to replace the start and end Snaps with the suggested Pipeline.

Snap Search

Iris Snap Search enables you to search for Snaps based more on what you know about them than on what they are called. For example, you can search for 'queue' to retrieve Snaps that work with queuing technologies, such as JMS. Similarly, if you want Snaps that work with the SFTP protocol, you can now enter 'SFTP' into the Search field and retrieve such Snaps:

Note

You may need to wait for a few seconds for the search results.

Image Added

You can similarly use Iris to search for Snaps that perform specific tasks, use specific technologies, or are associated with specific keywords. If you remember the name of the Snap you want, you can directly type in the name, of course; but if you don't remember the precise name of a Snap, this feature can help you identify the Snap you want.

Note

How does this work?

For Snap search, Iris indexes SnapLogic documentation and uses keywords in specific Snap documentation pages to enrich Snap search.

Pipeline Search

Use Iris Pipeline search to look for Pipelines in your Org–and to which you have access–that contain the search string anywhere in their name. 

To search for a Pipeline,

  1. Click the Pipelines tab in the Designer and enter the string that you want to search for. The search takes a few seconds, and displays a number adjacent to those project spaces and projects that contain search results:

    Image Added

  2. You can now open each of these project spaces and projects, and only those Pipelines that are part of the search results are displayed:

    Image Added


Note

The time taken for the search results to appear is proportional to the number of Pipelines that your account can access. 

Snap Auto-configuration Recommendation

Iris simplifies configuring suggestible properties in Snaps by recommending configuration options based on Snap settings in Pipelines to which you have access. To make these suggestions, Iris analyzes execution data and extracts high-quality Pipelines and then indexes Snap configurations in such Pipelines. The suggestions are listed under Iris Recommendations in the drop-down displayed upon clicking Image Added. 

To view Snap auto-configuration recommendations:

  1. In the Designer Canvas, click on a Snap that contains suggestible properties. For example, MySQL - Select.
    The Snap Settings is displayed.
  2. Click Image Added in a suggestible property to view the configuration drop-down.

The suggestible properties are displayed under Iris Recommendations.

Image Added

Target Recommendation

Iris simplifies configuring the Target path property in the Mapper Snap by recommending suggestions for the Expression and Target path property mapping. To make these suggestions, Iris analyzes the Pipelines in your Org and extracts only high-quality Pipelines based on the success rate of the executions. Then, it uses these high-quality mappings to make the target recommendations. The suggestions are displayed upon clicking Image Added against the Target path. 

For example, you have the Expression $Emp.Emp_Personal.FirstName in one of your Pipelines. And you have set the Target path for this expression as $FirstName. Now, if you use the expression $Emp.Emp_Personal.FirstName in a new Pipeline, then Iris suggests $FirstName as one of the recommended Target paths. This helps you standardize the naming standards within your org.

The following video illustrates how Iris recommends Target path in a Mapper Snap:

Image Added