Switch to unified view

a/README.md b/README.md
1
Taverna-Provenance-Extractor and Archimate-Converter v1.0
1
Taverna-Provenance-Extractor and Archimate-Converter v1.0
2
2
3
This program encapsulates four different features.
3
This program encapsulates two different features.
4
4
5
Feature A: Converts a Taverna 2.4 worfklow to an Archimate model.
5
Feature A: Converts a Taverna 2.4 worfklow to an Archimate model.
6
Feature B: Accesses provenance data captured during a Taverna 2.4 workflow run, 
6
Feature B: Accesses provenance data captured during a Taverna 2.4 workflow run, 
7
    applies DROID on that capturing (to identify used file formats in the workflow) and generates 
7
    applies DROID on that capturing (to identify used file formats in the workflow) and generates 
8
    a CSV report (including e.g., file formats). Extends an existing Domain Specific Ontology (DSO) 
8
    a CSV report (including e.g., file formats). Extends an existing Domain Specific Ontology (DSO) 
...
...
12
12
13
- JRE 1.6+
13
- JRE 1.6+
14
- Apache Ant 1.9+ for building
14
- Apache Ant 1.9+ for building
15
- DOT (comes with Graphviz)
15
- DOT (comes with Graphviz)
16
16
17
17
===== HOW-TO BUILD =====
18
===== HOW-TO BUILD =====
18
19
19
(1) Checkout the current project from https://olymp.ifs.tuwien.ac.at/svn/dp/timbus_development/TavernaExtractor.
20
(1) Checkout the current project from https://olymp.ifs.tuwien.ac.at/svn/dp/timbus_development/TavernaExtractor.
20
(2) Change in the checked-out directory.
21
(2) Change in the checked-out directory.
21
(3) Use 'ant jar' to build the a runnable jar. 
22
(3) Use 'ant jar' to build the a runnable jar. 
...
...
23
(5) Adapt the TavernaExtractor.properties file.
24
(5) Adapt the TavernaExtractor.properties file.
24
(6) Run the executable with 'java -jar TavernaExtractor.jar <args>'.
25
(6) Run the executable with 'java -jar TavernaExtractor.jar <args>'.
25
26
26
===== HOW-TO USE =====
27
===== HOW-TO USE =====
27
28
28
  A   =>  -i,--inputFile <arg>      ...specifies the taverna t2flow (input) file. \path\to\taverna\input.t2flow
29
- A =>    -i,--inputFile <arg>    path\to\taverna\input.t2flow
29
          -o,--outputFile <arg>     ...specifies the archimate (output) file. \path\to\archimate\output.archimate
30
  -o,--outputFile <arg>   path\to\archimate\output.archimate
30
         -d,--dependencyDir <arg>  ...workflow dependencies directory. [OPTIONAL]
31
    -d,--dependencyDir <arg>  workflow dependencies directory [OPTIONAL]
31
           
32
           
32
           
33
           
33
  B1   => -d,--droid <arg>       ...\path\where\to\save\droidOutputFile    
34
- B1 =>   -d,--droid <arg>  path\where\to\save\droidOutputFile 
34
            
35
            
35
  B2   => -cr,--report <arg>        ...\path\where\droidOutputFile\is\located                                      
36
- B2 =>   -cr,--report <arg>    path\where\droidOutputFile\is\located                                      
36
            
37
            
37
  B3   => -ont,--ontology-file <arg>  ...ontology to extend. \path\to\ontology
38
- B3 =>   -ont,--ontology-file <arg>    path\to\ontology
38
         -r,--reportFile <arg>       ...generated DROID CSV report.
39
    -r,--reportFile <arg>   path\togenerated\DROID\CSVreport
39
40
40
         -v, verbose   ...enable verbose mode
41
    -v, verbose enable verbose mode
41
           
42
           
42
===== SAMPLE USAGE =====
43
===== SAMPLE USAGE =====
43
44
44
[A] Convert a Taverna Workflow to an Archimate Model:
45
[A] Convert a Taverna Workflow to an Archimate Model:
45
46
...
...
58
    
59
    
59
[B2] Generate a CSV report of a DROID profile: (CSV report is stored in the same directory as the *.droid input file)
60
[B2] Generate a CSV report of a DROID profile: (CSV report is stored in the same directory as the *.droid input file)
60
61
61
    -cr path\to\myDroidFile.droid
62
    -cr path\to\myDroidFile.droid
62
    
63
    
63
[C] Extend existing ontology with information about the used file formats in the workflow run:
64
[B3] Extend existing ontology with information about the used file formats in the workflow run:
64
65
65
    -ont \path\to\myOntology.owl -r \path\to\myDroidCSVreportFile.droid.csv
66
    -ont \path\to\myOntology.owl -r \path\to\myDroidCSVreportFile.droid.csv
66
67