Artifact Routing

Introduction

Once you've configured your Field Flow, your next step will be to configure Artifact Routing.

Artifact Routing - Funnel Diagram

 

Artifact Routing is needed when artifacts are being created as part of an integration. In addition to knowing the repository in which artifacts should be created, Tasktop also needs to know which container (i.e. project, module, folder, etc) a given artifact should be created in. Specifying the artifact routing does this. 

(lightbulb) Initially, the artifact routing will determine where an artifact gets created. Over time, if an artifact on either side moves, Tasktop will move the artifact to the corresponding container of the new route, if this is allowed in your repository. if you are moving between lower-level containers, such as sets or folders, this is generally possible. However, Tasktop will not do so if the move on one side crosses the bounds of the top-level container (generally the high-level container, added at the collection level).

(warning) Note: If you update the artifact routing on a running integration to include additional lower-level containers, such as sets or folders, please click the 'process all artifacts' button on the Field Flow screen to ensure that all relevant updates are processed.

Instructions

To configure Artifact Routing, click the 'Artifact Routing' link on the right pane of the Integration Configuration screen:

Click 'Artifact Routing'

Static Artifact Routing

In some cases, the project an artifact resides in in the source collection can sufficiently determine which project an artifact should be created in in the target collection. In these instances, you can configure what is known as 'static artifact routing' (also known as 'explicit artifact routing').

Static artifact routes can have one or more source projects, but only a single target project.

To configure a static artifact route, use the "Route More Projects" buttons to add projects from your collections to your working space and connect them using the "Connect" button.  The directionality on the connect button refers to artifact creation.

Static Artifact Routing


In the example shown below, artifacts from the Jira Mobile Project will be created in the Flight Reservation App project in QASymphony.

Static Artifact Routing is Set

Conditional Artifact Routing 


Check out the video below to learn more about Conditional Artifact Routing:

 

(warning) Note: The video above demonstrates Conditional Artifact Routing within the context of a Create via Gateway Integration.  Create via Gateway Integrations are only available in editions that contain the Gateway add-on.  See Tasktop Editions table to determine if your edition contains this functionality. Though the video is for a Gateway Integration, the core concepts outlined in the video can be applied to any integration template.

In some cases, the project an artifact is in within the source repository does not provide enough information to determine which project the artifact should be created in within its target repository. Oftentimes, in fact, some unique characteristic of an artifact, such as a specific field value, is the factor that should be used to determine which project an artifact should be created in within the target repository.

In these instances, you will configure what is known as conditional artifact routing to determine which project each artifact is created in within your target repository. Conditional artifact routing (also known as 'dynamic artifact routing') can be used to inspect a single-select field of an artifact and, depending on its value, to route that artifact to the appropriate project in the target collection.

Conditional artifact routes can have one or more source projects, and always have multiple target projects.

Conditional Artifact Routing

To create a conditional artifact route, use the "Route More Projects" buttons to add projects from your collections to your workspace and connect them using the "Connect" button.

Notice that after you've created your conditional artifact routing group, you'll be prompted to configure your route.  Configuration Prompt

Click 'Save,' and then click 'Configure.' You'll be brought to the Conditional Artifact Routing screen. Here you'll start by selecting the model field that you would like to use to determine your artifact route. 

(lightbulb) Note: Conditional Artifact Routes can only be configured based on single-select fields in your model.

In the example below, the field "Product" contains the unique values that should determine the project an artifact will be created in in QASymphony.

Set Condition for Conditional Artifact Route

After you select the model field, you can identify one or more value to correspond to each target project. You can also use the 'Manage Values' link to select from a list of values.

 Set Conditional Route


Once you've done this, you'll see your full conditional artifact routing group:

Conditional Route is Set

You can specify how you'd like to handle artifacts that do not meet any of the conditions specified by selecting one of the options provided at the bottom of the screen:

Specify Handling for artifacts not matched by conditions above

Next Steps

Once you've configured your Artifact Routing configuration, your next step will be to review your Artifact Filtering.