Extractor Modules / Taverna Extractor / Diff of /README.md

Diff of /README.md [9d46ed] .. [f9a9cc]

Switch to unified view


# Taverna-Provenance-Extractor and Archimate-Converter v1.1

Link to the official website: http://www.ifs.tuwien.ac.at/dp/process/projects/tavernaExtractor.html

This program encapsulates 2 different features.

* Feature A: Converts a Taverna 2.4 worfklow to an Archimate model.
* Feature B: Accesses provenance data captured during a Taverna 2.4 workflow run, 
    applies DROID on that capturing (to identify used file formats in the workflow) and generates 
    a CSV report (including e.g., file formats). Extends an existing Domain Specific Ontology (DSO) 
    with file format information identified by DROID.

## RUNTIME DEPENDENCIES

* JRE 1.7+
* Apache Ant 1.9+ for building
* DOT (comes with Graphviz)

## HOW-TO BUILD AND EXECUTE

1. Clone the current project from https://opensourceprojects.eu/p/timbus/context-population/extractors/taverna-extractor.
2. Change in the checked-out directory.
3. Adapt the TavernaExtractor.properties file.
4. Use 'ant jar' to build the a runnable jar. 
5. Change to the 'dist' directory.
6. Run the executable with 'java -jar TavernaExtractor.jar <args>'. DO NOT run the executable from different location, due the 3rd party DROID dependencies!

## HOW-TO USE 

    A   =>  -i,--inputFile <arg>      ...specifies the taverna t2flow (input) file. \path\to\taverna\input.t2flow
            -o,--outputFile <arg>     ...specifies the archimate (output) file. \path\to\archimate\output.archimate
            -d,--dependencyDir <arg>  ...workflow dependencies directory. [OPTIONAL]
           
...
    B3  =>  -ont,--ontology-file <arg>  ...ontology to extend. \path\to\ontology
            -r,--reportFile <arg>       ...generated DROID CSV report.

            -v, verbose     ...enable verbose mode
           
## SAMPLE USAGE

[A] Convert a Taverna Workflow to an Archimate Model:

    java -jar TavernaExtractor.jar -i \path\to\TavernvaWorkflowInputFile.t2flow -o \path\to\ArchimateOutputFile.archimate 
    
...
     INPUT1: existing OWL file, which should be extended.
     INPUT2: file from step [B2].
     OUTPUT: updates OWL file from INPUT1.
     
    java -jar TavernaExtractor.jar -ont \path\to\myOntology.owl -r \path\to\myDroidCSVreportFile.droid.csv
  
  
## SUPPORTED TAVERNA ACTIVITIES

* Beanshell script
* RShell
* Tool innvocation
* Text constant
* WSDL/Rest Services

All other activities will cause an ClassNotFoundException.
To suppress that error, add the stated dependency to the classpath.
In case you have successfully executed the workflow once, 
the dependency should be available somewhere in the repository location of the Taverna installation directory.
But keep in mind: That activity won't be processed by the tool correctly!

	a/README.md		b/README.md
1	Taverna-Provenance-Extractor and Archimate-Converter v1.0	1	# Taverna-Provenance-Extractor and Archimate-Converter v1.1
2		2
3	Link to the official website: http://www.ifs.tuwien.ac.at/dp/process/projects/tavernaExtractor.html	3	Link to the official website: http://www.ifs.tuwien.ac.at/dp/process/projects/tavernaExtractor.html
4		4
5	This program encapsulates 2 different features.	5	This program encapsulates 2 different features.
6		6
7	Feature A: Converts a Taverna 2.4 worfklow to an Archimate model.	7	* Feature A: Converts a Taverna 2.4 worfklow to an Archimate model.
8	Feature B: Accesses provenance data captured during a Taverna 2.4 workflow run,	8	* Feature B: Accesses provenance data captured during a Taverna 2.4 workflow run,
9	applies DROID on that capturing (to identify used file formats in the workflow) and generates	9	applies DROID on that capturing (to identify used file formats in the workflow) and generates
10	a CSV report (including e.g., file formats). Extends an existing Domain Specific Ontology (DSO)	10	a CSV report (including e.g., file formats). Extends an existing Domain Specific Ontology (DSO)
11	with file format information identified by DROID.	11	with file format information identified by DROID.
12		12
13	===== RUNTIME DEPENDENCIES =====	13	## RUNTIME DEPENDENCIES
14		14
15	- JRE 1.6+	15	* JRE 1.7+
16	- Apache Ant 1.9+ for building	16	* Apache Ant 1.9+ for building
17	- DOT (comes with Graphviz)	17	* DOT (comes with Graphviz)
18		18
19	===== HOW-TO BUILD AND EXECUTE =====	19	## HOW-TO BUILD AND EXECUTE
20		20
21	(1) Clone the current project from https://opensourceprojects.eu/p/timbus/context-population/extractors/taverna-extractor.	21	1. Clone the current project from https://opensourceprojects.eu/p/timbus/context-population/extractors/taverna-extractor.
22	(2) Change in the checked-out directory.	22	2. Change in the checked-out directory.
23	(3) Adapt the TavernaExtractor.properties file.	23	3. Adapt the TavernaExtractor.properties file.
24	(4) Use 'ant jar' to build the a runnable jar.	24	4. Use 'ant jar' to build the a runnable jar.
25	(5) Change to the 'dist' directory.	25	5. Change to the 'dist' directory.
26	(6) Run the executable with 'java -jar TavernaExtractor.jar <args>'. DO NOT run the executable from different location, due the 3rd party DROID dependencies!	26	6. Run the executable with 'java -jar TavernaExtractor.jar <args>'. DO NOT run the executable from different location, due the 3rd party DROID dependencies!
27		27
28	===== HOW-TO USE =====	28	## HOW-TO USE
29		29
30	A => -i,--inputFile <arg> ...specifies the taverna t2flow (input) file. \path\to\taverna\input.t2flow	30	A => -i,--inputFile <arg> ...specifies the taverna t2flow (input) file. \path\to\taverna\input.t2flow
31	-o,--outputFile <arg> ...specifies the archimate (output) file. \path\to\archimate\output.archimate	31	-o,--outputFile <arg> ...specifies the archimate (output) file. \path\to\archimate\output.archimate
32	-d,--dependencyDir <arg> ...workflow dependencies directory. [OPTIONAL]	32	-d,--dependencyDir <arg> ...workflow dependencies directory. [OPTIONAL]
33		33
	...		...
39	B3 => -ont,--ontology-file <arg> ...ontology to extend. \path\to\ontology	39	B3 => -ont,--ontology-file <arg> ...ontology to extend. \path\to\ontology
40	-r,--reportFile <arg> ...generated DROID CSV report.	40	-r,--reportFile <arg> ...generated DROID CSV report.
41		41
42	-v, verbose ...enable verbose mode	42	-v, verbose ...enable verbose mode
43		43
44	===== SAMPLE USAGE =====	44	## SAMPLE USAGE
45		45
46	[A] Convert a Taverna Workflow to an Archimate Model:	46	[A] Convert a Taverna Workflow to an Archimate Model:
47		47
48	java -jar TavernaExtractor.jar -i \path\to\TavernvaWorkflowInputFile.t2flow -o \path\to\ArchimateOutputFile.archimate	48	java -jar TavernaExtractor.jar -i \path\to\TavernvaWorkflowInputFile.t2flow -o \path\to\ArchimateOutputFile.archimate
49		49
	...		...
73	INPUT1: existing OWL file, which should be extended.	73	INPUT1: existing OWL file, which should be extended.
74	INPUT2: file from step [B2].	74	INPUT2: file from step [B2].
75	OUTPUT: updates OWL file from INPUT1.	75	OUTPUT: updates OWL file from INPUT1.
76		76
77	java -jar TavernaExtractor.jar -ont \path\to\myOntology.owl -r \path\to\myDroidCSVreportFile.droid.csv	77	java -jar TavernaExtractor.jar -ont \path\to\myOntology.owl -r \path\to\myDroidCSVreportFile.droid.csv
		78
		79
		80	## SUPPORTED TAVERNA ACTIVITIES
78		81
		82	* Beanshell script
		83	* RShell
		84	* Tool innvocation
		85	* Text constant
		86	* WSDL/Rest Services
		87
		88	All other activities will cause an ClassNotFoundException.
		89	To suppress that error, add the stated dependency to the classpath.
		90	In case you have successfully executed the workflow once,
		91	the dependency should be available somewhere in the repository location of the Taverna installation directory.
		92	But keep in mind: That activity won't be processed by the tool correctly!