Switch to unified view

a/README.md b/README.md
1
# Taverna-Provenance-Extractor v1.0
1
# Taverna-Provenance-Extractor v1.3
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
Link to the repository ``https://opensourceprojects.eu/p/timbus/context-population/extractors/taverna-extractor``
5
Link to the repository ``https://opensourceprojects.eu/p/timbus/context-population/extractors/taverna-extractor``
6
6
...
...
12
## USING THE STANDALONE CLI 
12
## USING THE STANDALONE CLI 
13
13
14
The standalone CLI version encapsulates two different features:
14
The standalone CLI version encapsulates two different features:
15
15
16
* Feature A: Converts a Taverna 2.4 worfklow to an Archimate model.
16
* Feature A: Converts a Taverna 2.4 worfklow to an Archimate model.
17
* Feature B: Accesses provenance data captured during a Taverna 2.4 workflow run, 
17
* Feature B: Updates a OWL with DROID information gathered from the provenance data of a certain workflow execution
18
  applies DROID on that capturing (to identify used file formats in the workflow) and generates 
19
  a CSV report (including e.g., file formats). Extends an existing Domain Specific Ontology (DSO) 
20
  with file format information identified by DROID.
21
18
22
### Interacting with the standalone CLI version
19
### Interacting with the standalone CLI version
23
20
24
  A   => -i,--inputFile <arg>      ...specifies the taverna t2flow (input) file. \path\to\taverna\input.t2flow
21
    -i,--inputFile <arg>    ...specifies the taverna t2flow (input) file. \path\to\taverna\input.t2flow
25
         -o,--outputFile <arg>     ...specifies the archimate (output) file. \path\to\archimate\output.archimate
22
    -o,--outputFile <arg>   ...specifies the archimate (output) file. \path\to\archimate\output.archimate
26
           
23
  
27
         
24
  -p,--provenance <\path\to\copy\provenance-trace>    ...fetching provenance information from a workflow execution
28
  B1  =>  -d,--droid <arg>       ...\path\where\to\save\droidOutputFile   
25
  
29
          
26
  -ont,--ontology-file <\path\to\myOntology.owl>  ...ontology file
30
  B2  =>  -cr,--report <arg>      ...\path\where\droidOutputFile\is\located                                   
27
    -r,--reportFile <\path\to\DroidCSVreport.csv>   ...DROID report file
31
          
28
  
32
  B3  =>  -ont,--ontology-file <arg>  ...ontology to extend. \path\to\ontology
33
          -r,--reportFile <arg>       ...generated DROID CSV report.
34
35
    (general)   -v, verbose      ...enable verbose mode
29
    (optional) -v, verbose  ...enable verbose mode
36
           
30
           
37
### Sample usage
31
### Sample usage
38
32
39
[A] Convert a Taverna Workflow to an Archimate Model:
33
[A] Convert a Taverna Workflow to an Archimate Model:
34
    INPUT: Taverna 2.4/2.5 workflow model
35
    OUTPUT: Process model of the workflow accoring to Archimate Specification
40
36
41
    java -jar TavernaExtractor.jar -i \path\to\TavernvaWorkflowInputFile.t2flow -o \path\to\ArchimateOutputFile.archimate 
37
    java -jar TavernaExtractor.jar -i \path\to\TavernvaWorkflowInputFile.t2flow -o \path\to\ArchimateOutputFile.archimate 
42
    
38
    
43
[B] Extract including file formats from Workflow and identify them with DROID. In the following the 3 necessray steps are presented:
39
[B1] Fetch provenance information for a specific workflow run:
44
    ATTENTION: Due to its DROID dependencies, make sure you are executing the TavernaExtractor.jar in the respective directory!!
40
     INPUT: directory where to store the fetched provenance information
45
41
     OUTPUT: fetched provenance data
46
[B1] Running DROID identififaction on collected Taverna Workflow Run data:
42
     
47
     INPUT: path to file which gets created.
43
  java -jar TavernaExtractor.jar -p \path\to\store\workflow\provenance\data\for\DROID\identification
48
     OUTPUT: file containing DROID identification information in a none readable form.
49
50
  java -jar TavernaExtractor.jar -d path\to\myDroidFile.droid
51
    
44
    
52
  Sample Output:
53
  ===== [ID] | [Workflow Name (Timestamp)] ===== | 2 entries found.
54
55
  [1] MusicClassificationExperiment (2013-09-25 13:11:42.488)
56
  [2] MusicClassificationExperiment (2013-09-23 10:44:43.839)
57
  Your choice:  //Enter an ID to process
58
  
59
[B2] Generate a CSV report out of a DROID profile: (CSV report is stored in the same directory as the *.droid input file)
60
     INPUT: file from step [B1].
61
     OUTPUT: file in CSV format containing DROID information in a readable form.
62
     
63
  java -jar TavernaExtractor.jar -cr path\to\myDroidFile.droid
64
  
65
[B3] Extend existing ontology with information about the used file formats in the workflow run:
45
[B2] Extend existing ontology with information about the used file formats in the workflow run:
66
     INPUT1: existing OWL file, which should be extended.
46
     INPUT1: existing OWL file, which should be extended.
67
     INPUT2: file from step [B2].
47
     INPUT2: DROID generated CSV report.
68
     OUTPUT: updates OWL file from INPUT1.
48
     OUTPUT: updates OWL file from INPUT1.
69
     
49
     
70
    java -jar TavernaExtractor.jar -ont \path\to\myOntology.owl -r \path\to\myDroidCSVreportFile.droid.csv
50
    java -jar TavernaExtractor.jar -ont \path\to\myOntology.owl -r \path\to\myDroidCSVreportFile.droid.csv
71
    
51
    
72
### Build and Execution
52
### Build and Execution
...
...
79
6. Run the executable with ``'java -jar TavernaExtractor.jar <args>'``.
59
6. Run the executable with ``'java -jar TavernaExtractor.jar <args>'``.
80
60
81
### Runtime Dependencies
61
### Runtime Dependencies
82
62
83
* JRE 1.7+
63
* JRE 1.7+
84
* Apache Ant 1.9+ for building
64
* Apache Maven 2+ (for building)
85
* DOT (comes with Graphviz)
65
* DOT (comes with Graphviz)
86
    
66
    
87
## USING THE OSGi TIMBUS testbed BUNDLE 
67
## USING THE OSGi TIMBUS testbed BUNDLE 
88
68
89
The OSGi bundle can be accessed at ``http://testbed.timbusproject.net:3001/``
69
The OSGi bundle can be accessed at ``http://testbed.timbusproject.net:3001/``