Workflow

These steps take you through building one workflow with registered agents placed on its steps, starting your first case, and taking it through a review step to completion.

Introduction

In the Marketplace edition, you do not create agents on the project screen. What you place on steps are agents that an administrator registered and certified in the admin console. Before you begin, make sure the following are in place.

What you need	Who provides it	How
Two registered agents for workflows, both certified	Administrator	Settings Guide
If that agent communicates externally, traffic allowed for it	Whoever operates the environment	Execution Rules and Traffic Guide
You are a user of this environment	Administrator	Settings Guide

When you create a project, a workflow comes with three steps already in place. This Quickstart runs with those three steps. It uses two certified registered agents (one each on Step 1 and Step 3).

Step	Kind	What happens here
Step 1	A step that holds agents	A registered agent does the work
Step 2	Review step	You look at the artifacts and decide whether to go on
Step 3	A step that holds agents	A registered agent finishes it (a different registered agent from the one on Step 1)

Work on a computer, with the browser window wide. These steps are written for the width at which the editor is laid out in three parts: left, middle and right.

Step 1: Create a project

Open “Projects” on the left, choose “Projects” at the top, and press “New project”
Make sure the type is “Workflow” (in the Marketplace edition, Workflow is selected from the start)
Enter a name and press “Create”

Once it is created, the editor opens straight away. “Editing tools” and a list are on the left, the diagram of the steps is in the middle (“Editing canvas”), and the settings for whatever you select are on the right (“Properties”).

Creating the project does not start anything. It runs only when you start a case, later on.

Step 2: Place registered agents on steps

Under “Editing tools” on the left, press “Add Agent”. The list switches to the list of registered agents
Select the agent you want to place. “Agent details” appears on the right; check that “Certified” is shown next to its name
Under “Place on a step”, press “1. Step 1”. “Agent placed” appears
In the same way, place the other agent on “Step 3”

When you place a registered agent for the first time, it is saved to the project on the spot. It does not go into the draft.

When you place the same agent on other steps as well

Placing an agent you have already placed on other steps as well goes into the draft. Enter the step settings for those steps after you apply at Step 5. Before you apply, they cannot be saved.

If no agent is listed, or it shows “Unavailable (not certified)”, ask an administrator to register the contract and certification (Agent Guide).

Step 3: Enter the step settings

In the diagram in the middle, select the agent placed on “Step 1”. The heading on the right becomes “Agent on this step”
Under “Basic settings” ＞ “Step settings”, enter the parameters and connections you need. Items left blank run with the agent's default values
Press “Save”. “Step settings saved” appears (you cannot press it if you have not changed anything)
Do the same for the agent on “Step 3”. If the contract of the agent on Step 3 takes an input file, choose the output of the agent on Step 1 under “Input bindings”

The output of the previous step does not pass to the next step automatically. To pass it, bind it under “Input bindings”, as in 4.

Open “References & tools” to check the summary of the contract (effect on external systems, execution limit, files, outputs).

Step 4: Make yourself the reviewer

Select “Step 2” in the diagram in the middle
Under “Check settings” on the right ＞ “Basic settings” ＞ “Reviewers”, choose your own name
Make sure “Review method” is “Stop and wait for a decision”

Without a reviewer, a case cannot start.

In the Marketplace edition, a review is not decided automatically even after the deadline passes. Until you decide, the case does not move on (Review Guide).

Step 5: Check and apply

Press “Check settings” at the top of the editor, make sure all three steps show “OK”, and close it
Press “Apply changes”, then “Apply” in “Review changes to apply”

Until you apply, the changes to the steps and to the review settings are not part of the project. The first placement of the agents and the step settings were already saved at Steps 2 and 3.

Step 6: Start a case

Go back to the project screen with “Back to the project”
Press “Start case” at the top
The screen that opens lists each placement, as in “1. Step 1 — (agent name)”. Check that the values you entered at Step 3 are filled in, and if there are instruction files, enter their contents
Press “Start”. “Case started” appears

It may take a few minutes before the agent starts working.

Step 7: Review and proceed

Open the “Workflow history” tab and press “Case details” on the row. The case screen opens
On the “Progress” tab, wait for Step 1 to finish and the case to be awaiting review. Once it is, “Open the review” appears
Press “Open the review” (opening it from “Review requests” on the left is the same)
Check “Artifacts to review” and “Next Agent”, and press “Proceed to the next step”

Once you proceed, the agent on Step 3 starts working.

If there is something you want to fix, you can fix it before proceeding. On the case screen, under “Settings & files”, use “Edit as a new version” on an artifact and the review content is replaced with the new version too (Case Guide).

Step 8: Look at the result

Under “Progress” on the case screen, check that Step 3 has finished. You can open the agent's output under “Settings & files” ＞ “Artifacts & files”
Open the “Execution history” tab on the project screen and select the run time on the row you want; the run record for that execution opens. Under “Run info” ＞ “Settings at run time”, “Runtime image” shows the digest of the image that ran

A “Completed” result in the run record means that the agent did not report that it “could not finish”. Look at the contents to check that the artifacts are what you meant.

Introduction​

Step 1: Create a project​

Step 2: Place registered agents on steps​

Step 3: Enter the step settings​

Step 4: Make yourself the reviewer​

Step 5: Check and apply​

Step 6: Start a case​

Step 7: Review and proceed​

Step 8: Look at the result​

What to read next​