Skip to content

Commit 9801262

Browse files
AdamBanhamAdamBanham
committed
updating plugin desc
1 parent b126549 commit 9801262

File tree

2 files changed

+78
-54
lines changed

2 files changed

+78
-54
lines changed

‎readme.md‎

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This is a plugin for the ProM framework, which implements several tools
66
around xPM, a framework for process mining with exogenous data [5]. One
7-
of the main features for this plugin is an interative interface for
7+
of the main features for this plugin is an interactive interface for
88
several steps of the framework. i.e. viewing an xlog, performing decision
99
mining with exogenous data and generating Explorative Exogenous Signal
1010
Anylsis (EESA) visualisations (and ranking a collection). While this plugin
@@ -14,6 +14,32 @@ Furthermore, only a limited set of transformers and slicers are supported.
1414
Please get in contact if you require assistance with the creation of
1515
exo-panels or exo-descriptions, or non-trivial options for creating
1616
determinations in a xPM instantiation.
17+
18+
## List of GUI exposed techniques
19+
20+
Below is a list of GUI exposed techniques if the plugin is installed into
21+
a local ProM instance, i.e. using the PackageManager for ProM.
22+
23+
| GUI name | Technique | Parameters | Description | Paper |
24+
|----------|-----------|-------------|-------| --- |
25+
|Exogenous Annotated Log Preparation (XLogs)| xPM - Log Processing | Endogenous Log, Many XES Logs (Exogenous Candidates) | Given an event log and several exo-panels, this plugin allows users to define determinations as identified by xPM [1] and apply them to create an ExogenousAnnotatedLog. This plugin will convert the given xes logs into ExogenousDataset Objects. | [6] |
26+
|Exogenous Annotated Log Preparation | xPM - Log Processing | Endogenous Log, Many ExogenousDatasets | same as above | [6] |
27+
|Exogenous Annotated Log Preparation (AIIM 2022) (XLogs)| xPM - Log Processing | Endogenous Log, Many XES Logs (Exogenous Candidates) | This plugin allows users to reproduce the xPM instantition used in [6,7] | [6,7] |
28+
|Exogenous Annotated Log Preparation (AIIM 2022)| xPM - Log Processing | Endogenous Log, Many ExogenousDatasets | same as above | [6,7] |
29+
|Exogenous Annotated Log Preparation (Exemplar) (XLogs) | xPM - Log Processing | Endogenous Log, Many XES Logs (Exogenous Candidates) | Given an event log and several exo-panels, this plugin allows users to reproduce the exemplar configuration used in the repo [examplar](exemplar/readme.md) | [5] |
30+
|Exogenous Annotated Log Preparation (Exemplar)| xPM - Log Processing | Endogenous Log, Many ExogenousDatasets | same as above | [5] |
31+
|Make Log into Exogenous Dataset| xPM - Log Processing | XES Log | This plugin allows a user to create an ExogenousDataset from a parsed XES log, assuming that it was formatted appropriately [Appendix B.1.1, 5]. | [5] |
32+
|Describe Exogenous Dataset| xPM, Visualiser, | ExogenousDataset | This plugins creates a screen showing some basic information and statistics about a given ExogenousDataset | [5] |
33+
|Exogenous Annotated Log Explorer | xPM, Visualiser | ExogenousAnnotatedLog | This plugin allows users to explore an ExogenousAnnotatedLog through a GUI, including several screens to dive down to the event log of each annotated trace | [6] |
34+
|Exogenous Aware Discovery (DPN)| xPM, Visualiser, Decision Mining| ExogenousAnnotatedLog, PetriNetWithData | This plugin allows users to perform various process enhancement and discovery methods using an ExogenousAnnotatedLog and a control flow description. | [5,6] |
35+
|Exogenous Aware Discovery (PN)| same as above | ExogenousAnnotatedLog, Petrinet| same as above, but will create a dummy PetriNetWithData from the Petrinet with naively true guards | [5,6] |
36+
|Exogenous Aware Discovery (PT)| same as above | ExogenousAnnotatedLog, ProcessTree| same as above, but will unfold the ProcessTree into a Petrinet, then create a dummy PetriNetWithData from the unfolded Petrinet| [5,6] |
37+
|Exogenous Aware Discovery (APN)| same as above | ExogenousAnnotatedLog, AcceptingPetriNet| same as above, but will convert the AcceptingPetriNet into a dummy PetriNetWithData | [5,6] |
38+
|(Non) Exogenous Aware Discovery (DPN) | same as above | XLog, PetriNetWithData | same as above, but will convert the given XLog into an ExogenousAnnotatedLog with no exogenous data so that decision mining techniques can be used in the GUI form | [5,6] |
39+
40+
41+
42+
## Development
1743

1844
The development cycle for this plugin, is that only
1945
[major releases](https://github.com/promworkbench/ExogenousData/releases)
@@ -271,6 +297,14 @@ Furthermore, for each exo-panel and slicer, a popup can be used to showcase an I
271297

272298
![Exogenous Aware Enhancement - Popout](docs/screens/Exogenous_Aware_Enhancement_popout.png)
273299

300+
## Investigating exogenous influences using stochastic process mining
301+
302+
TODO
303+
- fill out section with
304+
- discovery for exo-slpn
305+
- conformance checking for exo-slpn
306+
- visualisation tools for exo-slpn
307+
274308
### Ranking a collection of EESA visualisation
275309

276310

@@ -315,3 +349,11 @@ approach", IEEE Access, vol. 12, pp. 60 276–60 298, 2024
315349
<br>
316350
[5] A. Banham, "Process mining with exogenous data", PhD Thesis, Queensland
317351
university of techonology, 2024.
352+
<br>
353+
[6] A. Banham, S. J. J. Leemans, M. T. Wynn, and R. Andrews, “xPM: A framework for
354+
process mining with exogenous data,” in ICPM Workshops, ser. Lecture Notes in Business
355+
Information Processing, vol. 433, Springer, 2021, pp. 85–97
356+
<br>
357+
[7] A. Banham, S. J. J. Leemans, M. T. Wynn, R. Andrews, K. B. Laupland, and L. Shinners,
358+
“xPM: Enhancing exogenous data visibility,” Artif. Intell. Medicine, vol. 133,
359+
p. 102 409, 2022

‎src/org/processmining/qut/exogenousdata/ExogenousDataPlugins.java‎

Lines changed: 35 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77

88
import javax.swing.JComponent;
99

10-
import org.apache.commons.lang.NotImplementedException;
1110
import org.deckfour.xes.model.XLog;
1211
import org.processmining.acceptingpetrinet.models.AcceptingPetriNet;
1312
import org.processmining.contexts.uitopia.UIPluginContext;
@@ -258,6 +257,17 @@ public ExogenousDiscoveryInvestigator NonExogenousDiscovery_DPN(
258257
return edi;
259258
}
260259

260+
public static final String ExogenousAwareDiscoveryHelp = ""
261+
+ "This plugin allows users to perform various process enhancement"
262+
+ " and discovery "
263+
+ "methods using an xlog and a control flow description. "
264+
+ " Such as performing decision mining and then exploring "
265+
+ "annotated transition guards using a visual format."
266+
+ "<br> See "
267+
+ " <a href=\"https://youtu.be/iSklEeNUJSc\" target=\"_blank\">"
268+
+ "https://youtu.be/iSklEeNUJSc</a> for a walkthough of tooling."
269+
+ version;
270+
261271
@Plugin(
262272
name = "Exogenous Aware Discovery (DPN)",
263273
parameterLabels = {"Exogenous Annotated Log (xlog)","Control Flow (DPN)"},
@@ -266,14 +276,7 @@ public ExogenousDiscoveryInvestigator NonExogenousDiscovery_DPN(
266276
categories={PluginCategory.Analytics, PluginCategory.Enhancement,
267277
PluginCategory.Discovery
268278
},
269-
help="This plugin allows users to perform various process discovery "
270-
+ "methods using an xlog and a control flow description. "
271-
+ " Such as performing decision mining and then exploring "
272-
+ "annotated transition guards using a visual format."
273-
+ "<br> See "
274-
+ " <a href=\"https://youtu.be/iSklEeNUJSc\" target=\"_blank\">"
275-
+ "https://youtu.be/iSklEeNUJSc</a> for a walkthough of tooling."
276-
+ version,
279+
help=ExogenousAwareDiscoveryHelp,
277280
userAccessible = true
278281
)
279282
@UITopiaVariant(
@@ -305,14 +308,7 @@ public ExogenousDiscoveryInvestigator ExogenousDiscovery_DPN(
305308
categories={PluginCategory.Analytics, PluginCategory.Enhancement,
306309
PluginCategory.Discovery
307310
},
308-
help="This plugin allows users to perform various process discovery "
309-
+ "methods using an xlog and a control flow description. "
310-
+ " Such as performing decision mining and then exploring "
311-
+ "annotated transition guards using a visual format."
312-
+ "<br> See "
313-
+ " <a href=\"https://youtu.be/iSklEeNUJSc\" target=\"_blank\">"
314-
+ "https://youtu.be/iSklEeNUJSc</a> for a walkthough of tooling."
315-
+ version,
311+
help=ExogenousAwareDiscoveryHelp,
316312
userAccessible = true
317313
)
318314
@UITopiaVariant(
@@ -348,14 +344,7 @@ public ExogenousDiscoveryInvestigator ExogenousDiscovery_PN(
348344
categories={PluginCategory.Analytics, PluginCategory.Enhancement,
349345
PluginCategory.Discovery
350346
},
351-
help="This plugin allows users to perform various process discovery "
352-
+ "methods using an xlog and a control flow description. "
353-
+ " Such as performing decision mining and then exploring "
354-
+ "annotated transition guards using a visual format."
355-
+ "<br> See "
356-
+ " <a href=\"https://youtu.be/iSklEeNUJSc\" target=\"_blank\">"
357-
+ "https://youtu.be/iSklEeNUJSc</a> for a walkthough of tooling."
358-
+ version,
347+
help=ExogenousAwareDiscoveryHelp,
359348
userAccessible = true
360349
)
361350
@UITopiaVariant(
@@ -398,14 +387,7 @@ public ExogenousDiscoveryInvestigator ExogenousDiscovery_PT(
398387
categories={PluginCategory.Analytics, PluginCategory.Enhancement,
399388
PluginCategory.Discovery
400389
},
401-
help="This plugin allows users to perform various process discovery "
402-
+ "methods using an xlog and a control flow description. "
403-
+ " Such as performing decision mining and then exploring "
404-
+ "annotated transition guards using a visual format."
405-
+ "<br> See "
406-
+ " <a href=\"https://youtu.be/iSklEeNUJSc\" target=\"_blank\">"
407-
+ "https://youtu.be/iSklEeNUJSc</a> for a walkthough of tooling."
408-
+ version,
390+
help=ExogenousAwareDiscoveryHelp,
409391
userAccessible = true
410392
)
411393
@UITopiaVariant(
@@ -457,26 +439,26 @@ public JComponent exogenousDiscoveryViewing(final UIPluginContext context,
457439
return edi;
458440
}
459441

460-
@Plugin(
461-
name = "Exogenous Aware Enhancement",
462-
parameterLabels = {"Exogenous Annotated Log", "xDPN",},
463-
categories={PluginCategory.Analytics, PluginCategory.Enhancement},
464-
help="This plugin allows users to build and extract EESA visualisations."
465-
+ " This plugin is currently under construction, and as such"
466-
+ " is not fully implemented for use via a GUI."
467-
+ version,
468-
returnLabels = {}, returnTypes = {}, userAccessible = true
469-
)
470-
@UITopiaVariant(
471-
affiliation = authorAff,
472-
author = authora,
473-
email = authorEmail,
474-
pack = packageName
475-
)
476-
public void exogenousEnhancement(final UIPluginContext context,
477-
final XLog exogenous, final PetriNetWithData model) throws Throwable {
478-
throw new NotImplementedException("Still under construction...");
479-
}
442+
// @Plugin(
443+
// name = "Exogenous Aware Enhancement",
444+
// parameterLabels = {"Exogenous Annotated Log", "xDPN",},
445+
// categories={PluginCategory.Analytics, PluginCategory.Enhancement},
446+
// help="This plugin allows users to build and extract EESA visualisations."
447+
// + " This plugin is currently under construction, and as such"
448+
// + " is not fully implemented for use via a GUI."
449+
// + version,
450+
// returnLabels = {}, returnTypes = {}, userAccessible = true
451+
// )
452+
// @UITopiaVariant(
453+
// affiliation = authorAff,
454+
// author = authora,
455+
// email = authorEmail,
456+
// pack = packageName
457+
// )
458+
// public void exogenousEnhancement(final UIPluginContext context,
459+
// final XLog exogenous, final PetriNetWithData model) throws Throwable {
460+
// throw new NotImplementedException("Still under construction...");
461+
// }
480462

481463
@Plugin(
482464
name = "Make Log into Exogenous Dataset",

0 commit comments

Comments
 (0)