Examples of using the SCUFL2 API.
As this code is meant only as examples that you can extend and modify, the groupId and package name are org.apache.taverna.examples, which should be changed in your application.
Note that while these examples are presented as command line tools for ease of testing, they are not recommended for general command line usage. Instead, see the tavlang tool.
To build, you'll need Maven 3.0.5 or newer, and run
mvn clean install
To run the examples, see the folder target/scufl2-examples which has a bin/ executable for each of the below tools. Note that these tools require the provided bin/ and lib/ folder structure.
This tool lists a tree of the processor names in the workflows of the given bundle.
C:\Users\stain\workspace\scufl2-examples> target\scufl2-examples\bin\processornames examples/helloworld.t2flow + Hello_World - hello C:\Users\stain\workspace\scufl2-examples> target\scufl2-examples\bin\processornames examples/helloanyone.t2flow + Hello_Anyone - Concatenate_two_strings - hello
See the source code for org.apache.taverna.examples.ProcessorNames for how this is implemented.
This tool lists the URIs of the types of services (activities) used in the workflow.
C:\Users\stain\workspace\scufl2-examples> target\scufl2-examples\bin\servicetypes examples/helloanyone.t2flow http://ns.taverna.org.uk/2010/activity/beanshell http://ns.taverna.org.uk/2010/activity/constant
See the source code for org.apache.taverna.examples.ServiceTypes for how this is implemented.
This tool shows how to construct a workflow from scratch and save it as a SCUFL2 wfbundle.
C:\Users\stain\workspace\scufl2-examples> target\scufl2-examples\bin\workflowmaker
Written to C:\Users\stain\AppData\Local\Temp\test6264603033381329995.wfbundle
WorkflowBundle '4fdb73e3-a5c6-41a8-aafb-32f67ca552b2'
MainWorkflow 'Echotest'
Workflow 'Echotest'
In 'in1'
Out 'out1'
Processor 'p'
In 'pIn'
Out 'pOut'
Links
'in1' -> 'p:pIn'
'p:pOut' -> 'out1'
MainProfile 'default'
Profile 'default'
Activity 'myBeanshell'
Type <http://ns.taverna.org.uk/2010/activity/beanshell>
In 'in1'
Out 'out1'
ProcessorBinding '434e7226-1d7f-498d-a19f-75be9f38f266'
Activity 'myBeanshell'
Processor 'Echotest:p'
InputPortBindings
'pIn' -> 'in1'
OutputPortBindings
'out1' -> 'pOut'
Configuration 'beanshellConf'
Type <http://ns.taverna.org.uk/2010/activity/beanshell#Config>
Configures 'activity/myBeanshell'
Property <http://ns.taverna.org.uk/2010/activity/beanshell#script>
'''out1 = in1'''
See the source code for WorkflowMaker for how this is implemented.
This tool shows how to convert a .t2flow file to a SCUFL2 .wfbundle.
C:\Users\stain\workspace\scufl2-examples> rm helloworld.wfbundle
C:\Users\stain\workspace\scufl2-examples> target\scufl2-examples\bin\t2flowtowfbu
C:\Users\stain\workspace\scufl2-examples> unzip -t helloworld.wfbundle
Archive: helloworld.wfbundle
testing: mimetype OK
testing: META-INF/ OK
testing: META-INF/manifest.xml OK
testing: history/ OK
testing: history/8781d5f4-d0ba-48a8-a1d1-14281bd8a917.t2flow OK
testing: workflow/ OK
testing: workflow/Hello_World.rdf OK
testing: profile/ OK
testing: profile/taverna-2.2.0.rdf OK
testing: annotation/ OK
testing: annotation/0c2f3c2c-7b5f-49cc-a448-92d707da3795.rdf OK
testing: annotation/48c04fe7-90f8-42f2-be61-a0480aa826d1.rdf OK
testing: annotation/9558f2e4-b629-4d1d-a62e-8c0dd39d7746.rdf OK
testing: workflowBundle.rdf OK
testing: META-INF/container.xml OK
No errors detected in compressed data of helloworld.wfbundle.
See the source code for ConvertT2flowToWorkflowBundle.java for how this is implemented.
The included files helloworld.wfbundle and helloanyone.wfbundle are examples of converting helloworld.t2flow and helloanyone.t2flow
This tool exports a JSON structure of the workflow, including basic annotations on workflows, ports, processors, nested workflows and revision log of the workflows.
Usage:
c:\Users\stain\src\scufl2-examples> target\scufl2-examples\bin\jsonexport -h Export workflow structore as JSON. Usage: jsonexport [filename] ... If the filename is - the workflow will be read from STDIN and JSON written to STDOUT. Otherwise, the file is read as a workflow (t2flow, workflow bundle) and written as JSON to a file with the .json extension. Multiple filenames can be given. JSON filenames are written to STDOUT
Converting multiple files:
c:\Users\stain\src\scufl2-examples> target\scufl2-examples\bin\jsonexport examples/helloworld.t2flow examples/helloanyone.wfbundle examples/helloworld.json examples/helloanyone.json
See the converted examples/helloworld.json and examples/helloanyone.json.
Example using STDIN/STDOUT:
c:\Users\stain\src\scufl2-examples> target\scufl2-examples\bin\jsonexport - < examples/helloworld.t2flow
{ "@context" : [ "https://w3id.org/scufl2/context", { "@base" : "http://ns.taverna.org.uk/2010/workflowBundle/8781d5f4-d0ba-48a8-a1d1-14281bd8a917/" } ], "id" : "http://ns.taverna.org.uk/2010/workflowBundle/8781d5f4-d0ba-48a8-a1d1-14281bd8a917/", "workflow" : { "id" : "workflow/Hello_World/", "name" : "Hello_World", "revisions" : [ { "id" : "http://ns.taverna.org.uk/2010/workflow/8781d5f4-d0ba-48a8-a1d1-14281bd8a917/", "generatedAtTime" : "2012-01-03T15:12:21Z" } ], "inputs" : [ ], "outputs" : [ { "name" : "greeting", "id" : "workflow/Hello_World/out/greeting" } ], "processors" : [ { "id" : "workflow/Hello_World/processor/hello/", "name" : "hello", "inputs" : [ ], "outputs" : [ { "name" : "value", "id" : "workflow/Hello_World/processor/hello/out/value", "depth" : 0 } ] } ], "datalinks" : [ { "receivesFrom" : "workflow/Hello_World/processor/hello/out/value", "sendsTo" : "workflow/Hello_World/out/greeting" } ], "controllinks" : [ ], "http://purl.org/dc/terms/description" : "One of the simplest workflows possible. No workflow input ports, a single workflow output port \"greeting\", outputting \"Hello, world!\" as produced by the String Constant \"hello\".", "http://purl.org/dc/elements/1.1/creator" : "Stian Soiland-Reyes", "http://purl.org/dc/terms/title" : "Hello World" } }
This JSON export is also available as application/json using the WorkflowBundleIO API if taverna-scufl2-examples is on the class path.