Skip to content

Create Hello World Workflow Tutorial

Chris Churas edited this page Dec 29, 2017 · 24 revisions

This tutorial provides instructions on how to create this "Hello World" Kepler workflow

Display Connected

WARNING: When annotating parameters in Kepler use all lowercase for parameter keywords ie: allowedworkspacefiletypes=foo..

Step 1 -- Initial setup

Download, install and launch Kepler.

Step 2 -- Add a Director

In the Search Components text field enter DDF Director (circled in green) and click the Search button (circled in red). This should update the left pane and show the DDF Director as seen below.

Director Search

The DDF Director should be listed in the left pane (pointed to by red arrow). Drag the DDF Director to the canvas as seen below

Director Drag

Step 3 -- Add Rectangles

In the Search Components text field enter Rectangle and click the Search button. Drag 4 of these Rectangles onto the canvas as seen below. Be sure to resize and position roughly in a similar fashion.

Four Rectangles

Step 4 -- Label Rectangles

Move mouse over the upper right rectangle and right click to bring up a sub menu. Select Customize Name out of the menu and rename the Name and Display name to Workflow Name (circled in green). Also check the Show name check box (circled in red). When finished click Commit button

Label Workflow Name

After clicking Commit the Rectangle should now have the label Workflow Name as seen below

Labeled Workflow Name

Using the same technique change the names for all the other Rectangles to the following:

  • For the right center Rectangle change its name to Description
  • For the bottom right Rectangle change its name to Release Notes
  • For the left Rectangle change its name to User Settable Parameter

Labeled Rectangles

Step 5 -- Add Annotations

In the Search Components text field enter Annotation and click the Search button. Drag an Annotation into each of the four boxes as seen below. When dragging the Annotation first drop it outside the the Rectangle, deselect it, then reselect and drag into the Rectangle

Annotated Rectangles

Step 6 -- Update Annotations

Double click on the Annotation in the Workflow Name Rectangle A dialog like the one should appear:

Annotated Rectangles

Replace the Double click to edit text. with Hello World and click Commit to save which should look like this:

Hello World Named

Now do the same for the other Annotations as follows:

  • For the Annotation in Description setting it to the following

    This workflow prints the value of the parameter to a display actor

  • For the Annotation in the Release Notes enter the following

    -- First revistion

  • For the Annotation in the User Settable Parameter enter the following on 2 lines

       type=text
       help=Example text field
    

WARNING: When annotating parameters in [Kepler][kepler] use all lowercase for parameter keywords ie: allowedworkspacefiletypes=foo..

Here is a screenshot of the workflow with all of the above changes:

All Rectangles Annotated

Make sure the Annotation is within the Rectangles and if needed resize the Rectangles

Step 7 -- Add Parameter

In the Search Components text field enter StringParameter and click the Search button. Drag a StringParameter into the User Settable Parameter Rectangle. When dragging the StringParameter first drop it outside the the Rectangle, deselect it, then reselect and drag into the Rectangle

String Parameter

Right click on the StringParameter that was just added and select Customize Name in the submenu. Set the Name to myparam and the Display Name to My Parameter Click Commit when finished.

All Rectangles Annotated

Double click on the My Parameter and set the value in the text field to hello and click OK

String Parameter Value

Here is what the workflow should look like:

String Parameter Done

Step 8 -- Add String Constant

In the Search Components text field enter String Constant and click the Search button. Drag a String Constant onto the Canvas.

String Constant

Double click on the String Constant on the canvas which will bring up the following dialog. Change NONE to 1 and set value to $myparam world as seen below and click OK

String Constant Set

When done the workflow should look like this:

String Constant Done

Step 9 -- Add Display Parameter

In the Search Components text field enter Display and click the Search button. Drag a Display onto the Canvas and put it to the right of the String Constant as seen in the figure below. Scrolling may be needed to find the Display actor.

Display

Connect the String Constant by holding a left click on the black arrow head (circled in red) and dragging the mouse to the other clear arrow head on the Display actor (circled in green). The figure below shows this action in mid drag

Display Connect

When completed the workflow should look like this:

Display Connected

Step 10 -- Run

Click the Run icon (circled in red) to try out the workflow.

Run

If successful, this dialog should appear

Run Dialog

Congratulations on creating your first workflow. Be sure to save the workflow by going to File->Save in the menu. Here is a copy of "Hello World" Workflow