JACK Wiki - Benutzerbeiträge [de]

BooleanAnd

2026-01-12T13:53:58Z

RSchypula: /* Beschreibung */

===Zugehörige Evaluatoren===
*'''ChemEvaluator'''
*'''MathEvaluator'''

===Beschreibung===
Die Funktion ''BooleanAnd'' ("&&") aus der Bool'schen Algebra vergleicht zwei Aussagen auf "true" oder "false". Der Ausdruck x && y gibt true zurück, wenn x und y beide true sind, ansonsten wird immer false zurückgegeben.

===Syntax===
x && y
and(x,y)

===Parameter===
* '''x''' - [[Boolean]]
* '''y''' - [[Boolean]]

===Return Value===
* Gibt einen Boolean zurück.

===Beispiele===
==== Standardfälle ====
1 && 1 --> returns ''true''

0 && 1 --> returns ''false''

1 && 0 --> returns ''false''

0 && 0 --> returns ''false''

(2+4==6) && (3+3==6) --> returns ''true''

==== Benutzung mit Variablen ====

[var=a] && [var=b]

===Hinweise===
* Es werden zwei boolsche Ausdrücke erwartet.
* Diese Funktion ist ein binärer Operator.

[[Kategorie:Math-Evaluatorfunktion]][[Kategorie:Chem-Evaluatorfunktion]][[Kategorie:Testfunktionen]][[Category:Operator]][[Kategorie:Booleanfunktionen]][[Kategorie:JACK2]][[Kategorie:JACK3]]

LTI Anbindung (JACK3)

2025-06-16T12:34:12Z

RSchypula: /* Einrichtung des externen Tools in Moodle */

Es besteht die Möglichkeit Jack3 auch über die LTI-Anbindung in LMS Systemen zur Verfügung zu stellen. Im Moment gibt es die Anbindung in Moodle, sodass man einen Link zu Jack3 in einem Moodle Kurs zur Verfügung stellen kann. Über diesen Link wird man dann direkt zu dem entsprechenden Kursangebot in Jack3 gelenkt. Die Anmeldung in Jack3 wird im Hintergrund durchgeführt, so dass die Lernenden dies nicht machen müssen. Die LTI-Anbindung bringt Studierende nicht in eine isolierte JACK3 Umgebung, sie können sich wie gewohnt auf dem System bewegen.

Sehen Sie im Kursangebot die Nachricht, dass LTI für ihren Server nicht konfiguriert ist, wenden Sie sich bitte an ihren JACK Administrator. JACK Administratoren haben zwei Möglichkeiten LTI für Sie bereitzustellen: entweder als globalen LTI Provider oder einen Provider pro Kursangebot. Sehen Sie im Kursangebot im Abschnitt "LTI" die Überschriften "Tool Einstellungen" und "Link Einstellungen", ist ein globaler Provider eingerichtet. Sehen Sie nur die Überschrift "Tool-Einstellungen", ist ein Provider pro Kursangebot eingestellt.

=== LTI Anbindung mit einem globalen Provider ===
Verwenden Sie diese Methode, wenn unter LTI die Überschriften "Tool Einstellungen" und "Link Einstellungen" zu finden sind. Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, sollte dies immer der Fall sein. Andernfalls kontakieren Sie bitte ihren JACK Administrator.

==== Einrichtung des externen Tools in Moodle ====
Rufen Sie den Moodle Kurs auf und klicken Sie im Menüband auf "Mehr" und wählen Sie "LTI Externe Tools".

[[Datei:Moodle extenes Tool anlegen.jpg|ohne|mini]]

Klicken Sie in Moodle dann auf "Tool hinzufügen" es öffnet sich daruf in Moodle die Seite für die Tool-Einstellungen.
Rufen Sie nun in JACK das Kursangebot welches Sie verlinken möchten auf. Scrollen Sie zum Abschnitt LTI und setzen Sie den Haken bei "Aufruf des Kursangebots über LTI erlauben". Setzen Sie die folgenden Einstellungen bei den Tool-Einstellungen in Moodle:

# Unter "Name des Tools" tragen Sie "JACK" ein.
# Unter "Tool URL" muss der Wert "URL" aus JACK eingetragen werden.
# Unter "Anwenderschlüssel" muss der Wert "Konsumenten Schlüssel" aus JACK eingetragen werden.
# Unter "Öffentliches Kennwort" muss der Wert "Konsumenten Passwort" eingetragen werden.
# Als Einstellung für "Standard-Startcontainer" empfehlen wir "Neues Fenster".
# Klappen Sie den Abschnitt "Datenschutz" aus.
## Ändern Sie den Wert bei "Anwendername an Tool übergeben" auf "Immer".
## Sofern die E-Mailadresse von Moodle nach JACK übergeben werden soll (bei Vorkursstudenten notwendig): Ändern Sie bei "E-Mail des Anwenders an Tool übergeben" den Wert auf "Immer".

[[Datei:JACK Moodle Tool Einstellungen.jpg|ohne|809x406px]]

Mit einem Klick auf "Änderungen speichern" bei den Tool-Einstellungen in Moodle ist JACK als neues Tool in ihrem Moodlekurs angelegt. Dieser Vorgang muss nur einmal pro Moodlekurs durchgeführt werden. Danach ist JACK in diesem Moodlekurs dauerhaft verfügbar.

==== Einrichten des Links zum Kursangebot ====
Um in ihrem Moodlekurs ein konkretes Kursangebot zu verlinken gehen Sie wie folgt vor:

# Schalten Sie in ihrem Moodlekurs den Bearbeitungsmodus ein. Klicken Sie dann in einem beliebigen Abschnitt auf "Material oder Aktivität anlegen".
# Im nun auftauchenden Dialog wählen Sie "JACK" als Tool aus.
# Klicken Sie in den nun angezeigten Einstellungen bearbeiten Dialog im Abschnitt Allgemeines auf "Mehr anzeigen" und kopieren Sie aus den JACK LTI Einstellungen den Wert von "Zusätzliche Parameter" in Moodle in das Feld "Angepasste Parameter".
# Mit dem Button "Speichern und anzeigen" ganz unten können Sie den LTI Link anlegen und sofort testen.

{|style="text-align:left"
|-
||[[Datei:Moodle Material anlegen.jpg|mini]]
||[[Datei:Moodle Material Einstellungen.jpg|mini]]
|-
|}

=== LTI Anbindung mit einem lokalen Provider ===
Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, können Sie diese Methode nicht verwenden. Detaillierte Informationen folgen in Kürze.

=== LTI und Sichtbarkeit von Kursangeboten ===
Bei der Anbindung mit Moodle sind auch die Sichtbarkeiten des Kursangebotes zu beachten. Dabei können folgenden Szenarien auftreten:
Das Kursangebot ist
* '''gar nicht sichtbar:''' Es kommt eine Fehlermeldung von LTI, dass kein Kursangebot zu dem Konsumentenschlüssel gefunden wurde.
* '''nicht mehr sichtbar:''' Der Lernende wird zu dem Kursangebot in Jack3 weitergeleitet und erhält dort eine Fehlermeldung, dass das Kursangebot nicht mehr sichtbar ist.
* '''nicht für diesen Lernenden sichtbar:''' Der Lernende wird zu den Kursangebot in Jack3 weitergeleitet und erhält dort die entsprechende Fehlermeldung, dass das Kursangebot nicht sichtbar ist.

[[category:Benutzerhandbuch]]

Datei:JACK Moodle Tool Einstellungen.jpg

2025-06-16T12:27:41Z

RSchypula: RSchypula lud eine neue Version von Datei:JACK Moodle Tool Einstellungen.jpg hoch

LTI Anbindung (JACK3)

2025-06-16T12:10:02Z

RSchypula: /* Einrichtung des externen Tools in Moodle */

Es besteht die Möglichkeit Jack3 auch über die LTI-Anbindung in LMS Systemen zur Verfügung zu stellen. Im Moment gibt es die Anbindung in Moodle, sodass man einen Link zu Jack3 in einem Moodle Kurs zur Verfügung stellen kann. Über diesen Link wird man dann direkt zu dem entsprechenden Kursangebot in Jack3 gelenkt. Die Anmeldung in Jack3 wird im Hintergrund durchgeführt, so dass die Lernenden dies nicht machen müssen. Die LTI-Anbindung bringt Studierende nicht in eine isolierte JACK3 Umgebung, sie können sich wie gewohnt auf dem System bewegen.

Sehen Sie im Kursangebot die Nachricht, dass LTI für ihren Server nicht konfiguriert ist, wenden Sie sich bitte an ihren JACK Administrator. JACK Administratoren haben zwei Möglichkeiten LTI für Sie bereitzustellen: entweder als globalen LTI Provider oder einen Provider pro Kursangebot. Sehen Sie im Kursangebot im Abschnitt "LTI" die Überschriften "Tool Einstellungen" und "Link Einstellungen", ist ein globaler Provider eingerichtet. Sehen Sie nur die Überschrift "Tool-Einstellungen", ist ein Provider pro Kursangebot eingestellt.

=== LTI Anbindung mit einem globalen Provider ===
Verwenden Sie diese Methode, wenn unter LTI die Überschriften "Tool Einstellungen" und "Link Einstellungen" zu finden sind. Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, sollte dies immer der Fall sein. Andernfalls kontakieren Sie bitte ihren JACK Administrator.

==== Einrichtung des externen Tools in Moodle ====
Rufen Sie den Moodle Kurs auf und klicken Sie im Menüband auf "Mehr" und wählen Sie "LTI Externe Tools".

[[Datei:Moodle extenes Tool anlegen.jpg|ohne|mini]]

Klicken Sie in Moodle dann auf "Tool hinzufügen" es öffnet sich daruf in Moodle die Seite für die Tool-Einstellungen.
Rufen Sie nun in JACK das Kursangebot welches Sie verlinken möchten auf. Scrollen Sie zum Abschnitt LTI und setzen Sie den Haken bei "Aufruf des Kursangebots über LTI erlauben". Setzen Sie die folgenden Einstellungen bei den Tool-Einstellungen in Moodle:

# Unter "Name des Tools" tragen Sie "JACK" ein.
# Unter "Tool URL" muss der Wert "URL" aus JACK eingetragen werden.
# Unter "Anwenderschlüssel" muss der Wert "Konsumenten Schlüssel" aus JACK eingetragen werden.
# Unter "Öffentliches Kennwort" muss der Wert "Konsumenten Passwort" eingetragen werden.
# Als Einstellung für "Standard-Startcontainer" empfehlen wir "Neues Fenster".
# Klappen Sie den Abschnitt "Datenschutz" aus.
## Ändern Sie den Wert bei "Anwendername an Tool übergeben" auf "Immer".
## Sofern die E-Mailadresse in JACK benötigt wird: Ändern Sie bei "E-Mail des Anwenders an Tool übergeben" den Wert auf "Immer".

[[Datei:JACK Moodle Tool Einstellungen.jpg|ohne|809x406px]]

Mit einem Klick auf "Änderungen speichern" bei den Tool-Einstellungen in Moodle ist JACK als neues Tool in ihrem Moodlekurs angelegt. Dieser Vorgang muss nur einmal pro Moodlekurs durchgeführt werden. Danach ist JACK in diesem Moodlekurs dauerhaft verfügbar.

==== Einrichten des Links zum Kursangebot ====
Um in ihrem Moodlekurs ein konkretes Kursangebot zu verlinken gehen Sie wie folgt vor:

# Schalten Sie in ihrem Moodlekurs den Bearbeitungsmodus ein. Klicken Sie dann in einem beliebigen Abschnitt auf "Material oder Aktivität anlegen".
# Im nun auftauchenden Dialog wählen Sie "JACK" als Tool aus.
# Klicken Sie in den nun angezeigten Einstellungen bearbeiten Dialog im Abschnitt Allgemeines auf "Mehr anzeigen" und kopieren Sie aus den JACK LTI Einstellungen den Wert von "Zusätzliche Parameter" in Moodle in das Feld "Angepasste Parameter".
# Mit dem Button "Speichern und anzeigen" ganz unten können Sie den LTI Link anlegen und sofort testen.

{|style="text-align:left"
|-
||[[Datei:Moodle Material anlegen.jpg|mini]]
||[[Datei:Moodle Material Einstellungen.jpg|mini]]
|-
|}

=== LTI Anbindung mit einem lokalen Provider ===
Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, können Sie diese Methode nicht verwenden. Detaillierte Informationen folgen in Kürze.

=== LTI und Sichtbarkeit von Kursangeboten ===
Bei der Anbindung mit Moodle sind auch die Sichtbarkeiten des Kursangebotes zu beachten. Dabei können folgenden Szenarien auftreten:
Das Kursangebot ist
* '''gar nicht sichtbar:''' Es kommt eine Fehlermeldung von LTI, dass kein Kursangebot zu dem Konsumentenschlüssel gefunden wurde.
* '''nicht mehr sichtbar:''' Der Lernende wird zu dem Kursangebot in Jack3 weitergeleitet und erhält dort eine Fehlermeldung, dass das Kursangebot nicht mehr sichtbar ist.
* '''nicht für diesen Lernenden sichtbar:''' Der Lernende wird zu den Kursangebot in Jack3 weitergeleitet und erhält dort die entsprechende Fehlermeldung, dass das Kursangebot nicht sichtbar ist.

[[category:Benutzerhandbuch]]

LTI Anbindung (JACK3)

2025-06-02T10:18:23Z

RSchypula: /* Einrichten des Links zum Kursangebot */

Es besteht die Möglichkeit Jack3 auch über die LTI-Anbindung in LMS Systemen zur Verfügung zu stellen. Im Moment gibt es die Anbindung in Moodle, sodass man einen Link zu Jack3 in einem Moodle Kurs zur Verfügung stellen kann. Über diesen Link wird man dann direkt zu dem entsprechenden Kursangebot in Jack3 gelenkt. Die Anmeldung in Jack3 wird im Hintergrund durchgeführt, so dass die Lernenden dies nicht machen müssen. Die LTI-Anbindung bringt Studierende nicht in eine isolierte JACK3 Umgebung, sie können sich wie gewohnt auf dem System bewegen.

Sehen Sie im Kursangebot die Nachricht, dass LTI für ihren Server nicht konfiguriert ist, wenden Sie sich bitte an ihren JACK Administrator. JACK Administratoren haben zwei Möglichkeiten LTI für Sie bereitzustellen: entweder als globalen LTI Provider oder einen Provider pro Kursangebot. Sehen Sie im Kursangebot im Abschnitt "LTI" die Überschriften "Tool Einstellungen" und "Link Einstellungen", ist ein globaler Provider eingerichtet. Sehen Sie nur die Überschrift "Tool-Einstellungen", ist ein Provider pro Kursangebot eingestellt.

=== LTI Anbindung mit einem globalen Provider ===
Verwenden Sie diese Methode, wenn unter LTI die Überschriften "Tool Einstellungen" und "Link Einstellungen" zu finden sind. Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, sollte dies immer der Fall sein. Andernfalls kontakieren Sie bitte ihren JACK Administrator.

==== Einrichtung des externen Tools in Moodle ====
Rufen Sie den Moodle Kurs auf und klicken Sie im Menüband auf "Mehr" und wählen Sie "LTI Externe Tools".

[[Datei:Moodle extenes Tool anlegen.jpg|ohne|mini]]

Klicken Sie in Moodle dann auf "Tool hinzufügen" es öffnet sich daruf in Moodle die Seite für die Tool-Einstellungen.
Rufen Sie nun in JACK das Kursangebot welches Sie verlinken möchten auf. Scrollen Sie zum Abschnitt LTI und setzen Sie den Haken bei "Aufruf des Kursangebots über LTI erlauben". Setzen Sie die folgenden Einstellungen bei den Tool-Einstellungen in Moodle:

# Unter "Name des Tools" tragen Sie "JACK" ein.
# Unter "Tool URL" muss der Wert "URL" aus JACK eingetragen werden.
# Unter "Anwenderschlüssel" muss der Wert "Konsumenten Schlüssel" aus JACK eingetragen werden.
# Unter "Öffentliches Kennwort" muss der Wert "Konsumenten Passwort" eingetragen werden.
# Als Einstellung für "Standard-Startcontainer" empfehlen wir "Neues Fenster".
# Klappen Sie den Abschnitt "Datenschutz" aus und ändern Sie den Wert bei "Anwendername an Tool übergeben" auf "Immer".

[[Datei:JACK Moodle Tool Einstellungen.jpg|ohne|809x406px]]

Mit einem Klick auf "Änderungen speichern" bei den Tool-Einstellungen in Moodle ist JACK als neues Tool in ihrem Moodlekurs angelegt. Dieser Vorgang muss nur einmal pro Moodlekurs durchgeführt werden. Danach ist JACK in diesem Moodlekurs dauerhaft verfügbar.

==== Einrichten des Links zum Kursangebot ====
Um in ihrem Moodlekurs ein konkretes Kursangebot zu verlinken gehen Sie wie folgt vor:

# Schalten Sie in ihrem Moodlekurs den Bearbeitungsmodus ein. Klicken Sie dann in einem beliebigen Abschnitt auf "Material oder Aktivität anlegen".
# Im nun auftauchenden Dialog wählen Sie "JACK" als Tool aus.
# Klicken Sie in den nun angezeigten Einstellungen bearbeiten Dialog im Abschnitt Allgemeines auf "Mehr anzeigen" und kopieren Sie aus den JACK LTI Einstellungen den Wert von "Zusätzliche Parameter" in Moodle in das Feld "Angepasste Parameter".
# Mit dem Button "Speichern und anzeigen" ganz unten können Sie den LTI Link anlegen und sofort testen.

{|style="text-align:left"
|-
||[[Datei:Moodle Material anlegen.jpg|mini]]
||[[Datei:Moodle Material Einstellungen.jpg|mini]]
|-
|}

=== LTI Anbindung mit einem lokalen Provider ===
Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, können Sie diese Methode nicht verwenden. Detaillierte Informationen folgen in Kürze.

=== LTI und Sichtbarkeit von Kursangeboten ===
Bei der Anbindung mit Moodle sind auch die Sichtbarkeiten des Kursangebotes zu beachten. Dabei können folgenden Szenarien auftreten:
Das Kursangebot ist
* '''gar nicht sichtbar:''' Es kommt eine Fehlermeldung von LTI, dass kein Kursangebot zu dem Konsumentenschlüssel gefunden wurde.
* '''nicht mehr sichtbar:''' Der Lernende wird zu dem Kursangebot in Jack3 weitergeleitet und erhält dort eine Fehlermeldung, dass das Kursangebot nicht mehr sichtbar ist.
* '''nicht für diesen Lernenden sichtbar:''' Der Lernende wird zu den Kursangebot in Jack3 weitergeleitet und erhält dort die entsprechende Fehlermeldung, dass das Kursangebot nicht sichtbar ist.

[[category:Benutzerhandbuch]]

LTI Anbindung (JACK3)

2025-06-02T10:11:38Z

RSchypula: /* Einrichten des Links zum Kursangebot */

Es besteht die Möglichkeit Jack3 auch über die LTI-Anbindung in LMS Systemen zur Verfügung zu stellen. Im Moment gibt es die Anbindung in Moodle, sodass man einen Link zu Jack3 in einem Moodle Kurs zur Verfügung stellen kann. Über diesen Link wird man dann direkt zu dem entsprechenden Kursangebot in Jack3 gelenkt. Die Anmeldung in Jack3 wird im Hintergrund durchgeführt, so dass die Lernenden dies nicht machen müssen. Die LTI-Anbindung bringt Studierende nicht in eine isolierte JACK3 Umgebung, sie können sich wie gewohnt auf dem System bewegen.

Sehen Sie im Kursangebot die Nachricht, dass LTI für ihren Server nicht konfiguriert ist, wenden Sie sich bitte an ihren JACK Administrator. JACK Administratoren haben zwei Möglichkeiten LTI für Sie bereitzustellen: entweder als globalen LTI Provider oder einen Provider pro Kursangebot. Sehen Sie im Kursangebot im Abschnitt "LTI" die Überschriften "Tool Einstellungen" und "Link Einstellungen", ist ein globaler Provider eingerichtet. Sehen Sie nur die Überschrift "Tool-Einstellungen", ist ein Provider pro Kursangebot eingestellt.

=== LTI Anbindung mit einem globalen Provider ===
Verwenden Sie diese Methode, wenn unter LTI die Überschriften "Tool Einstellungen" und "Link Einstellungen" zu finden sind. Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, sollte dies immer der Fall sein. Andernfalls kontakieren Sie bitte ihren JACK Administrator.

==== Einrichtung des externen Tools in Moodle ====
Rufen Sie den Moodle Kurs auf und klicken Sie im Menüband auf "Mehr" und wählen Sie "LTI Externe Tools".

[[Datei:Moodle extenes Tool anlegen.jpg|ohne|mini]]

Klicken Sie in Moodle dann auf "Tool hinzufügen" es öffnet sich daruf in Moodle die Seite für die Tool-Einstellungen.
Rufen Sie nun in JACK das Kursangebot welches Sie verlinken möchten auf. Scrollen Sie zum Abschnitt LTI und setzen Sie den Haken bei "Aufruf des Kursangebots über LTI erlauben". Setzen Sie die folgenden Einstellungen bei den Tool-Einstellungen in Moodle:

# Unter "Name des Tools" tragen Sie "JACK" ein.
# Unter "Tool URL" muss der Wert "URL" aus JACK eingetragen werden.
# Unter "Anwenderschlüssel" muss der Wert "Konsumenten Schlüssel" aus JACK eingetragen werden.
# Unter "Öffentliches Kennwort" muss der Wert "Konsumenten Passwort" eingetragen werden.
# Als Einstellung für "Standard-Startcontainer" empfehlen wir "Neues Fenster".
# Klappen Sie den Abschnitt "Datenschutz" aus und ändern Sie den Wert bei "Anwendername an Tool übergeben" auf "Immer".

[[Datei:JACK Moodle Tool Einstellungen.jpg|ohne|809x406px]]

Mit einem Klick auf "Änderungen speichern" bei den Tool-Einstellungen in Moodle ist JACK als neues Tool in ihrem Moodlekurs angelegt. Dieser Vorgang muss nur einmal pro Moodlekurs durchgeführt werden. Danach ist JACK in diesem Moodlekurs dauerhaft verfügbar.

==== Einrichten des Links zum Kursangebot ====
Um in ihrem Moodlekurs ein konkretes Kursangebot zu verlinken gehen Sie wie folgt vor:

# Schalten Sie in ihrem Moodlekurs den Bearbeitungsmodus ein. Klicken Sie dann in einem beliebigen Abschnitt auf "Material oder Aktivität anlegen".
# Im nun auftauchenden Dialog wählen Sie "JACK" als Tool aus.
# Klicken Sie in den nun angezeigten Einstellungen bearbeiten Dialog im Abschnitt Allgemeines auf "Mehr anzeigen" und kopieren Sie aus den JACK LTI Einstellungen den Wert von "Zusätzliche Parameter" in Moodle in das Feld "Angepasste Parameter".
# Mit dem Button "Speichern und anzeigen" ganz unten können Sie den LTI Link anlegen und sofort testen.

{|align="left"
|[[Datei:Moodle Material anlegen.jpg|mini]]
|[[Datei:Moodle Material Einstellungen.jpg|mini]]
|}
 

=== LTI Anbindung mit einem lokalen Provider ===
Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, können Sie diese Methode nicht verwenden. Detaillierte Informationen folgen in Kürze.

=== LTI und Sichtbarkeit von Kursangeboten ===
Bei der Anbindung mit Moodle sind auch die Sichtbarkeiten des Kursangebotes zu beachten. Dabei können folgenden Szenarien auftreten:
Das Kursangebot ist
* '''gar nicht sichtbar:''' Es kommt eine Fehlermeldung von LTI, dass kein Kursangebot zu dem Konsumentenschlüssel gefunden wurde.
* '''nicht mehr sichtbar:''' Der Lernende wird zu dem Kursangebot in Jack3 weitergeleitet und erhält dort eine Fehlermeldung, dass das Kursangebot nicht mehr sichtbar ist.
* '''nicht für diesen Lernenden sichtbar:''' Der Lernende wird zu den Kursangebot in Jack3 weitergeleitet und erhält dort die entsprechende Fehlermeldung, dass das Kursangebot nicht sichtbar ist.

[[category:Benutzerhandbuch]]

LTI Anbindung (JACK3)

2025-06-02T10:07:04Z

RSchypula: /* Einrichten des Links zum Kursangebot */

Es besteht die Möglichkeit Jack3 auch über die LTI-Anbindung in LMS Systemen zur Verfügung zu stellen. Im Moment gibt es die Anbindung in Moodle, sodass man einen Link zu Jack3 in einem Moodle Kurs zur Verfügung stellen kann. Über diesen Link wird man dann direkt zu dem entsprechenden Kursangebot in Jack3 gelenkt. Die Anmeldung in Jack3 wird im Hintergrund durchgeführt, so dass die Lernenden dies nicht machen müssen. Die LTI-Anbindung bringt Studierende nicht in eine isolierte JACK3 Umgebung, sie können sich wie gewohnt auf dem System bewegen.

Sehen Sie im Kursangebot die Nachricht, dass LTI für ihren Server nicht konfiguriert ist, wenden Sie sich bitte an ihren JACK Administrator. JACK Administratoren haben zwei Möglichkeiten LTI für Sie bereitzustellen: entweder als globalen LTI Provider oder einen Provider pro Kursangebot. Sehen Sie im Kursangebot im Abschnitt "LTI" die Überschriften "Tool Einstellungen" und "Link Einstellungen", ist ein globaler Provider eingerichtet. Sehen Sie nur die Überschrift "Tool-Einstellungen", ist ein Provider pro Kursangebot eingestellt.

=== LTI Anbindung mit einem globalen Provider ===
Verwenden Sie diese Methode, wenn unter LTI die Überschriften "Tool Einstellungen" und "Link Einstellungen" zu finden sind. Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, sollte dies immer der Fall sein. Andernfalls kontakieren Sie bitte ihren JACK Administrator.

==== Einrichtung des externen Tools in Moodle ====
Rufen Sie den Moodle Kurs auf und klicken Sie im Menüband auf "Mehr" und wählen Sie "LTI Externe Tools".

[[Datei:Moodle extenes Tool anlegen.jpg|ohne|mini]]

Klicken Sie in Moodle dann auf "Tool hinzufügen" es öffnet sich daruf in Moodle die Seite für die Tool-Einstellungen.
Rufen Sie nun in JACK das Kursangebot welches Sie verlinken möchten auf. Scrollen Sie zum Abschnitt LTI und setzen Sie den Haken bei "Aufruf des Kursangebots über LTI erlauben". Setzen Sie die folgenden Einstellungen bei den Tool-Einstellungen in Moodle:

# Unter "Name des Tools" tragen Sie "JACK" ein.
# Unter "Tool URL" muss der Wert "URL" aus JACK eingetragen werden.
# Unter "Anwenderschlüssel" muss der Wert "Konsumenten Schlüssel" aus JACK eingetragen werden.
# Unter "Öffentliches Kennwort" muss der Wert "Konsumenten Passwort" eingetragen werden.
# Als Einstellung für "Standard-Startcontainer" empfehlen wir "Neues Fenster".
# Klappen Sie den Abschnitt "Datenschutz" aus und ändern Sie den Wert bei "Anwendername an Tool übergeben" auf "Immer".

[[Datei:JACK Moodle Tool Einstellungen.jpg|ohne|809x406px]]

Mit einem Klick auf "Änderungen speichern" bei den Tool-Einstellungen in Moodle ist JACK als neues Tool in ihrem Moodlekurs angelegt. Dieser Vorgang muss nur einmal pro Moodlekurs durchgeführt werden. Danach ist JACK in diesem Moodlekurs dauerhaft verfügbar.

==== Einrichten des Links zum Kursangebot ====
Um in ihrem Moodlekurs ein konkretes Kursangebot zu verlinken gehen Sie wie folgt vor:

# Schalten Sie in ihrem Moodlekurs den Bearbeitungsmodus ein. Klicken Sie dann in einem beliebigen Abschnitt auf "Material oder Aktivität anlegen".
# Im nun auftauchenden Dialog wählen Sie "JACK" als Tool aus.
# Klicken Sie in den nun angezeigten Einstellungen bearbeiten Dialog im Abschnitt Allgemeines auf "Mehr anzeigen" und kopieren Sie aus den JACK LTI Einstellungen den Wert von "Zusätzliche Parameter" in Moodle in das Feld "Angepasste Parameter".
# Mit dem Button "Speichern und anzeigen" ganz unten können Sie den LTI Link anlegen und sofort testen.

{|align="left"
|[[Datei:Moodle Material anlegen.jpg|mini]]
|[[Datei:Moodle Material Einstellungen.jpg|mini]]
|}

=== LTI Anbindung mit einem lokalen Provider ===
Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, können Sie diese Methode nicht verwenden. Detaillierte Informationen folgen in Kürze.

=== LTI und Sichtbarkeit von Kursangeboten ===
Bei der Anbindung mit Moodle sind auch die Sichtbarkeiten des Kursangebotes zu beachten. Dabei können folgenden Szenarien auftreten:
Das Kursangebot ist
* '''gar nicht sichtbar:''' Es kommt eine Fehlermeldung von LTI, dass kein Kursangebot zu dem Konsumentenschlüssel gefunden wurde.
* '''nicht mehr sichtbar:''' Der Lernende wird zu dem Kursangebot in Jack3 weitergeleitet und erhält dort eine Fehlermeldung, dass das Kursangebot nicht mehr sichtbar ist.
* '''nicht für diesen Lernenden sichtbar:''' Der Lernende wird zu den Kursangebot in Jack3 weitergeleitet und erhält dort die entsprechende Fehlermeldung, dass das Kursangebot nicht sichtbar ist.

[[category:Benutzerhandbuch]]

Datei:Moodle Material Einstellungen.jpg

2025-06-02T10:06:02Z

RSchypula: RSchypula lud eine neue Version von Datei:Moodle Material Einstellungen.jpg hoch

Datei:Moodle Material Einstellungen.jpg

2025-06-02T09:40:49Z

RSchypula:

Datei:Moodle Material anlegen.jpg

2025-06-02T09:38:04Z

RSchypula:

LTI Anbindung (JACK3)

2025-06-02T09:13:02Z

RSchypula: /* Einrichtung des externen Tools */

Es besteht die Möglichkeit Jack3 auch über die LTI-Anbindung in LMS Systemen zur Verfügung zu stellen. Im Moment gibt es die Anbindung in Moodle, sodass man einen Link zu Jack3 in einem Moodle Kurs zur Verfügung stellen kann. Über diesen Link wird man dann direkt zu dem entsprechenden Kursangebot in Jack3 gelenkt. Die Anmeldung in Jack3 wird im Hintergrund durchgeführt, so dass die Lernenden dies nicht machen müssen. Die LTI-Anbindung bringt Studierende nicht in eine isolierte JACK3 Umgebung, sie können sich wie gewohnt auf dem System bewegen.

Sehen Sie im Kursangebot die Nachricht, dass LTI für ihren Server nicht konfiguriert ist, wenden Sie sich bitte an ihren JACK Administrator. JACK Administratoren haben zwei Möglichkeiten LTI für Sie bereitzustellen: entweder als globalen LTI Provider oder einen Provider pro Kursangebot. Sehen Sie im Kursangebot im Abschnitt "LTI" die Überschriften "Tool Einstellungen" und "Link Einstellungen", ist ein globaler Provider eingerichtet. Sehen Sie nur die Überschrift "Tool-Einstellungen", ist ein Provider pro Kursangebot eingestellt.

=== LTI Anbindung mit einem globalen Provider ===
Verwenden Sie diese Methode, wenn unter LTI die Überschriften "Tool Einstellungen" und "Link Einstellungen" zu finden sind. Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, sollte dies immer der Fall sein. Andernfalls kontakieren Sie bitte ihren JACK Administrator.

==== Einrichtung des externen Tools in Moodle ====
Rufen Sie den Moodle Kurs auf und klicken Sie im Menüband auf "Mehr" und wählen Sie "LTI Externe Tools".

[[Datei:Moodle extenes Tool anlegen.jpg|ohne|mini]]

Klicken Sie in Moodle dann auf "Tool hinzufügen" es öffnet sich daruf in Moodle die Seite für die Tool-Einstellungen.
Rufen Sie nun in JACK das Kursangebot welches Sie verlinken möchten auf. Scrollen Sie zum Abschnitt LTI und setzen Sie den Haken bei "Aufruf des Kursangebots über LTI erlauben". Setzen Sie die folgenden Einstellungen bei den Tool-Einstellungen in Moodle:

# Unter "Name des Tools" tragen Sie "JACK" ein.
# Unter "Tool URL" muss der Wert "URL" aus JACK eingetragen werden.
# Unter "Anwenderschlüssel" muss der Wert "Konsumenten Schlüssel" aus JACK eingetragen werden.
# Unter "Öffentliches Kennwort" muss der Wert "Konsumenten Passwort" eingetragen werden.
# Als Einstellung für "Standard-Startcontainer" empfehlen wir "Neues Fenster".
# Klappen Sie den Abschnitt "Datenschutz" aus und ändern Sie den Wert bei "Anwendername an Tool übergeben" auf "Immer".

[[Datei:JACK Moodle Tool Einstellungen.jpg|ohne|809x406px]]

Mit einem Klick auf "Änderungen speichern" bei den Tool-Einstellungen in Moodle ist JACK als neues Tool in ihrem Moodlekurs angelegt. Dieser Vorgang muss nur einmal pro Moodlekurs durchgeführt werden. Danach ist JACK in diesem Moodlekurs dauerhaft verfügbar.

==== Einrichten des Links zum Kursangebot ====
Um in ihrem Moodlekurs ein konkretes Kursangebot zu verlinken gehen Sie wie folgt vor:

# Schalten Sie in ihrem Moodlekurs den Bearbeitungsmodus ein. Klicken Sie dann in einem beliebigen Abschnitt auf "Material oder Aktivität anlegen".
# Im nun auftauchenden Dialog wählen Sie "JACK" als Tool aus.
# Klicken Sie in den nun angezeigten Einstellungen auf "Mehr anzeigen" und kopieren sie den Wert "Zusätzliche Parameter" in das Feld "Angepasste Parameter" in Moodle.
# Mit dem Button "Speichern und anzeigen" ganz unten können Sie den LTI Link anlegen und sofort testen.

=== LTI Anbindung mit einem lokalen Provider ===
Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, können Sie diese Methode nicht verwenden. Detaillierte Informationen folgen in Kürze.

=== LTI und Sichtbarkeit von Kursangeboten ===
Bei der Anbindung mit Moodle sind auch die Sichtbarkeiten des Kursangebotes zu beachten. Dabei können folgenden Szenarien auftreten:
Das Kursangebot ist
* '''gar nicht sichtbar:''' Es kommt eine Fehlermeldung von LTI, dass kein Kursangebot zu dem Konsumentenschlüssel gefunden wurde.
* '''nicht mehr sichtbar:''' Der Lernende wird zu dem Kursangebot in Jack3 weitergeleitet und erhält dort eine Fehlermeldung, dass das Kursangebot nicht mehr sichtbar ist.
* '''nicht für diesen Lernenden sichtbar:''' Der Lernende wird zu den Kursangebot in Jack3 weitergeleitet und erhält dort die entsprechende Fehlermeldung, dass das Kursangebot nicht sichtbar ist.

[[category:Benutzerhandbuch]]

Datei:JACK Moodle Tool Einstellungen.jpg

2025-06-02T08:59:01Z

RSchypula:

Datei:Moodle extenes Tool anlegen.jpg

2025-06-02T08:38:42Z

RSchypula:

LTI Anbindung (JACK3)

2025-05-22T12:53:14Z

RSchypula: Punkt 6 übergabe des Anwendernamen ergänzt

Es besteht die Möglichkeit Jack3 auch über die LTI-Anbindung in LMS Systemen zur Verfügung zu stellen. Im Moment gibt es die Anbindung in Moodle, sodass man einen Link zu Jack3 in einem Moodle Kurs zur Verfügung stellen kann. Über diesen Link wird man dann direkt zu dem entsprechenden Kursangebot in Jack3 gelenkt. Die Anmeldung in Jack3 wird im Hintergrund durchgeführt, so dass die Lernenden dies nicht machen müssen. Die LTI-Anbindung bringt Studierende nicht in eine isolierte JACK3 Umgebung, sie können sich wie gewohnt auf dem System bewegen.

Sehen Sie im Kursangebot die Nachricht, dass LTI für ihren Server nicht konfiguriert ist, wenden Sie sich bitte an ihren JACK Administrator. JACK Administratoren haben zwei Möglichkeiten LTI für Sie bereitzustellen: entweder als globalen LTI Provider oder einen Provider pro Kursangebot. Sehen Sie im Kursangebot im Abschnitt "LTI" die Überschriften "Tool Einstellungen" und "Link Einstellungen", ist ein globaler Provider eingerichtet. Sehen Sie nur die Überschrift "Tool-Einstellungen", ist ein Provider pro Kursangebot eingestellt.

=== LTI Anbindung mit einem globalen Provider ===
Verwenden Sie diese Methode, wenn unter LTI die Überschriften "Tool Einstellungen" und "Link Einstellungen" zu finden sind. Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, sollte dies immer der Fall sein. Andernfalls kontakieren Sie bitte ihren JACK Administrator.

==== Einrichtung des externen Tools ====
Besuchen Sie in JACK, das Kursangebot, das Sie verlinken möchten. Die LTI Einstellungen dort sehen etwa wie folgt aus:
[[Datei:LTI Einstellungen - Globaler Provider.png|ohne|mini|496x496px]]
Wechseln Sie nun zu ihrem Moodlekurs und klicken Sie im Menüband auf "Mehr" und wählen Sie "LTI Externe Tools". Klicken Sie dann auf Tool hinzufügen. Im folgenden Dialog müssen Sie die folgenden Einstellungen vornehmen:

# Unter "Name des Tools" tragen Sie "JACK" ein.
# Unter "Tool URL" muss der Wert "URL" aus JACK eingetragen werden.
# Unter "Anwenderschlüssel" muss der Wert "Konsumenten Schlüssel" aus JACK eingetragen werden.
# Unter "Öffentliches Kennwort" muss der Wert "Konsumenten Passwort" eingetragen werden.
# Als Einstellung für "Standard-Startcontainer" empfehlen wir "Neues Fenster".
# Klappen Sie den Abschnitt "Datenschutz" aus und ändern Sie den Wert bei "Anwendername an Tool übergeben" auf "Immer"

Mit einem Klick auf "Änderungen speichern" ist JACK als neues Tool in ihrem Moodlekurs angelegt. Dieser Vorgang muss nur einmal pro Kurs in Moodle vollzogen werden. Danach ist das Tool in diesem Kurs dauerhaft verfügbar.

==== Einrichten des Links zum Kursangebot ====
Um in ihrem Moodlekurs ein konkretes Kursangebot zu verlinken gehen Sie wie folgt vor:

# Schalten Sie in ihrem Moodlekurs den Bearbeitungsmodus ein. Klicken Sie dann in einem beliebigen Abschnitt auf "Material oder Aktivität anlegen".
# Im nun auftauchenden Dialog wählen Sie "JACK" als Tool aus.
# Klicken Sie in den nun angezeigten Einstellungen auf "Mehr anzeigen" und kopieren sie den Wert "Zusätzliche Parameter" in das Feld "Angepasste Parameter" in Moodle.
# Mit dem Button "Speichern und anzeigen" ganz unten können Sie den LTI Link anlegen und sofort testen.

=== LTI Anbindung mit einem lokalen Provider ===
Wenn Sie einen Moodleserver der Uni Duisburg-Essen verwenden, können Sie diese Methode nicht verwenden. Detaillierte Informationen folgen in Kürze.

=== LTI und Sichtbarkeit von Kursangeboten ===
Bei der Anbindung mit Moodle sind auch die Sichtbarkeiten des Kursangebotes zu beachten. Dabei können folgenden Szenarien auftreten:
Das Kursangebot ist
* '''gar nicht sichtbar:''' Es kommt eine Fehlermeldung von LTI, dass kein Kursangebot zu dem Konsumentenschlüssel gefunden wurde.
* '''nicht mehr sichtbar:''' Der Lernende wird zu dem Kursangebot in Jack3 weitergeleitet und erhält dort eine Fehlermeldung, dass das Kursangebot nicht mehr sichtbar ist.
* '''nicht für diesen Lernenden sichtbar:''' Der Lernende wird zu den Kursangebot in Jack3 weitergeleitet und erhält dort die entsprechende Fehlermeldung, dass das Kursangebot nicht sichtbar ist.

[[category:Benutzerhandbuch]]

Versionshistorie (JACK3)

2024-11-08T13:34:55Z

RSchypula: /* Neue Features */

== Oktober 2024 ==

=== Version 0.14.0 ===

==== Neue Features ====

* Die Sichtung von Einreichungen wurden mit einem Labelsystem vereinfacht. So sind Einreichungen mit Kommentaren jetzt beispielsweise besser zu finden.
* Zahlen können nur von JACK automatisch validiert werden.
* Es gibt eine neue tabellarische Übersicht über bearbeitete Aufgaben
* Video lassen sich nun per Knopfdruck einfügen und einbetten.
* Es kann nun automatisch zum nächsten Aufgabenteil (der folgende in der Liste der Aufgabenteile) gesprungen werden.
* FillIn Felder können nun farblich hervorgehoben werden.
* FillIn Felder können nun in ihrer Länge begrenzt werden.
* Die Eingabe in Dropdownfelder kann nun direkt auf ihren Inhalt geprüft werden (anstelle des Index)
* In Molekülen kann nun farbig markiert werden.
* Beim Testen einer Aufgabe kann nun direkt ein neuer Versuch gestartet werden.
* Variablen müssen nun nicht mehr vorbelegt werden, sondern können via Update erstmalig belegt werden.
* Kleinere Verbesserungen bei der Registrierung wurden vorgenommen.
* Neuer Aufgabenteiltyp Gatterschaltungen

==== Verbesserungen und Fixes aus Meldungen der Community ====

* In R Teilaufgaben kann vorausgefüllter Code in einer Datei hochgeladen werden.
* Die Übergabe von Matrizen/Vektoren an R verbesert.
* Das Scrollen zu Ordnern wurde verbessert von der Brotkrumennavigation wurde verbessert

== Juli 2024 ==

=== Version 0.13.0 ===

* Die R Konsole und der R Checker verwenden nun intern den gleichen Dienst, sodass sie sich exakt gleich verhalten.
* Kursangebote können nach IP-Adressen gefiltert werden, beispielsweise um die Teilnahme auf den Campus oder die PC Hall zu beschränken.
* Das Labelsystem für Bearbeitungen wurde verbessert.

== Juni 2024 ==

=== Version 0.12.0 ===

* Im Aufgabentyp UML kann den Studierenden nun optional ein web-basierter Editor für ausgewählte Diagrammtypen bereitgestellt werden.
* Das Kursfeedback ist jetzt prominenter platziert und für Studierende deutlich besser zu finden.
* Hinweise werden nun auch korrekt gezählt, wenn "Ab hier neu bearbeiten" genutzt wurde.
* Die Einstellungen für Studierende zur Kurseinsicht wurden verbessert. Es ist jetzt auch möglich die Aufgabenliste zu verstecken.
* Sitzt Text eng an einer Lücke an, wird er nicht mehr beim Zeilenumbruch von dieser getrennt.
* Inhalte auf denen man Leserecht hat, lassen sich jetzt einfach in den eigenen Ordner kopieren.
* Die Darstellung der Aufgabenliste in Kursangeboten wurde entschlackt.
* Fehler beim Verschieben von Inhalten gelöst.

== April 2024 ==

=== Version 0.11.0 ===
Highlights in Version 0.11.0:

* In FillIn Teilaufgaben können nun auch Moleküle in Eingabefelder eingegeben werden.
* Studierende sehen jetzt den Status ihrer Aufgaben auch in der kleinen Aufgabenliste am Rand.
* Die Navigation durch die Versionen einer Aufgabe / eines Kurses wurde verbessert.
* Die verbleibende Bearbeitungszeit lässt sich jetzt durch Studierende ausblenden (Thema Prüfungsangst)
* Korrekturen lassen sich jetzt auch nach Aufgabe (anstelle nach Kursbearbeitung) durchführen.
* Es ist jetzt eine Vorschau auf die LaTeX-Ausgabe im Feedback möglich.
* Syntaktisch falsche Eingaben im Formeleditor werden jetzt bereits durch JACK moniert.
* Es kann jetzt manuelles Kursfeedback vergeben werden.
* Die Eingabe von Text in Freitextaufgaben kann nun auf eine Anzahl Zeichen oder Worte eingeschränkt werden.
* Es werden jetzt auch Tags aus JACK 2 Aufgaben importiert.

Behobene von Ihnen gemeldete Fehler:

* Umbenennen Variable, wenn Variable schon vorhanden
* Vereinheitlichen der Löschsymbole bei Feedbacks und Hinweisen
* Tag-Liste schließt sich beim scrollen
* isEmpty() wertet nicht wie im WiKi beschrieben Leerzeichen aus
* Implementierung eines Videoplayers
* Falscher Import spezifischer Stage einer Aufgabe
* Bei verschieben des Feedbacks verschwindet Feedbacktext bei ausführlichem Editor
* Inhalte verschieben funktioniert beim nachträglichen Löschen einer Aufgabe aus dem Startordner bei bereits gewähltem Zielordner nicht
* Auswahl in der Brotkrumennavigation führt immer auf den allerobersten Knoten der gesamten Ordnerstruktur
* Begrenzung der Eingabe in Freitextaufgaben

==Januar 2024==
===Version 0.10.0===
Highlights in Version 0.10.0:
* Mit dem R-Taschenrechner hat ein weiteres Hilfsmittel für Studierende Einzug in JACK gehalten.
* TinyMCE ist der neue Editor zum Bearbeiten von formatiertem Text in JACK. Er hat den CKEditor vollständig abgelöst.
* Schlägt die Variablenbelegung in einer Aufgabe fehl, so werden nun bis zu zwei weitere Versuche unternommen, die Aufgabe doch noch korrekt zu initialisieren. So führen selten auftretende Fehler nicht zur Unbearbeitbarkeit der Aufgabe für Studierende.
* Variableninhalte lassen sich nun einfach per Klick kopieren.
* Feedback in MC Aufgaben lässt sich nun auch nachträglich ändern.
* Der persönlicher Ordner kann nicht mehr direkt geteilt werden. Nur dessen Unterordner lassen sich mit anderen Nutzern teilen.
* Die Teilaufgaben einer Aufgabe lassen sich nun umsortieren.

Hinzu kommen div. kleinere Fixes, viele davon im Zusammenhang mit dem JACK 2 Importer und dem neuen Theme, das in der letzten Version hinzugekommen ist.

Ihre bearbeiteten Issues:
* Absoluter Abzug von Punkten bei Hinweisen
* Mehrere Aufgaben gleichzeitig verschieben
* Bei Verschieben des Feedbacks verschwindet Feedbacktext
* R Checker, Testfall Gruppen werden ungewollt dupliziert
* Verschieben von Aufgaben in einen anderen Ordner
* Darstellung von den Check-Boxen in MC Aufgaben
* Neues Theme: Grafik überdeckt Editieroption bei MC Stages
* Scrollbar bei Feedback innerhalb der Debug-Optionen

==Oktober 2023==
===Version 0.9.0===
Die Version enthält ein neues Theme auf Basis einer neuen Version des UI-Frameworks. Es hat sich nur die Optik leicht geändert; Bedienelemente sind nach wie vor an den vertrauten Stellen zu finden. Einzige Ausnahme: Die Kursbearbeitung für Studierende wurde leicht überarbeitet, sodass Funktionen zum Kurs beenden oder neustarten etc. jetzt hoffentlich besser platziert sind und weniger zu Verwechslungen einladen.

Dazu haben wir wie üblich ihre zahlreichen Verbesserungsvorschläge und Fehler bearbeitet:
* Formatierungsfehler bzgl. Vorzeichen behoben.
* Probleme mit mathematisch belegten Zeichen behoben.
* Problem bei der Faktorisierung in Sage behoben.
* Problem bei Summen- und Produktbildung behoben.
* Der Formeleditor kann jetzt auch f(x) verarbeiten.
* Imaginäranteil von komplexen Zahlen wird wieder erkannt.
* Probleme mit der Eulerschen Zahl behoben.
* In der Teilnehmerübersicht kann jetzt auch nach Profilfeldern wie bspw. der Matrikelnummer gefiltert werden.

==September 2023==
===Version 0.8.1===
Neuerungen in dieser Version:
* Chemische Formeln können nun asynchron geprüft werden.
* Tags von Aufgaben werden nun mit im- und exportiert.
* Mit LaTeX gesetzte Formeln können nun per Klick gezoomt werden.
* Die Namen hochgeladener Ressourcen werden nun vor Studierenden verborgen.
* Viele Detailverbesserungen in der Benutzeroberfläche.

Ihre gemeldeten Fehler und Verbesserungsvorschläge:
* Die Spaltenbreite in MCTable Aufgaben ist nun dynamisch.
* Die sporadische Sperrung der R-Konsole bei der Anforderung von Hinweisen ist nun behoben.
* Dropdownfelder und Formeleditoren beeinflussen sich nicht mehr gegenseitig.
* Feedback lässt sich auch bei mehrstufigen Aufgaben nun umbenennen.

==Mai 2023==
===Version 0.7.1===
Neuerungen in dieser Version:
* Mit dem Stufentyp MCTable kehrt ein alter Bekannter aus JACK 2 wieder in den Schoß der JACK Familie zurück.
* Der Aufgabeneditor hat jetzt ein Werkzeugmenü, über das auch der freie Moleküleditor verfügbar ist.
* Mit dem Validator haben wir ein Werkzeug hinzugefügt, dass vor typischen Fehlern und Fehlkonfigurationen in Aufgaben und Kursen warnt.
* Der Ex- und Import von Kursen ist jetzt möglich.
* Es lassen sich jetzt auch Java Aufgaben aus JACK 2 importieren.

Ihre gemeldeten Fehler und Verbesserungsvorschläge:
* Das automatische Scrollen beim Einreichen wurde verbessert.
* Mehrere Aufgaben können nun gleichzeitig verschoben werden.
* Der Countdown funktioniert jetzt auch beim schnellen Aufgabenwechsel wieder.
* Bilder werden nun automatisch skaliert, sodass sie das Layout nicht stören.

Organisatorische Neuerungen:
* Prüfungen brauchen nun nicht mehr im Wiki eingetragen zu werden. Eine formlose E-Mail an das JACK Team reicht.
* Unser Wiki liegt jetzt auf dem Wikiserver der Universität und lässt sich nach wie vor über die bekannte Domäne jack-community.org erreichen.
* Wir werden den Issuetracker für unsere JACK Tester auf das Gitlab der Universität umziehen, um es leichter erreichbar für alle Mitarbeiterinnen und Mitarbeiter der Universität zu machen. Mehr Infos zum Umzug werden Sie bald separat erhalten.

==März 2023==
===Version 0.6.1===
Die folgenden neuen Features wurden realisiert:
* Neuer Stufentyp: Freitextaufgaben
* Neuer Stufentyp: Datei(en) hochladen
* Neuer Stufentyp: Atomorbitalschemata
* Feedbackregeln können nun eingeklappt werden
* Diverse Detailverbesserungen

Zudem haben wir einige Issues lösen können:
* Automatisches Anpassen der Größe von Bildern.
* Löschen von Tags aktiviert Speichernbutton nicht.
* Vorausgefüllter Code ist beschränkt bzgl. der Länge.
* Mehrere R-Stufen in einer Aufgabe.
* Kursbearbeitung kaputt, wenn Aufgabe daraus gelöscht wurde.
* Probleme beim Import von JACK 2 Aufgaben mit Dateianhängen.

Kleinere Änderungen gab es bei den Namensräume für Variablen:
* In den Stufentypen Java, Python und UML wurden die input Variablen nach check verschoben.
* Bei Multiple Choice Stufen wurden die Variablen mcStageCorrectTicks, mcStageIncorrectTicks und mcStageTotalTicks in den Namensraum check verschoben

==September 2022==
===Version 0.4.0===
Folgende Neuerungen sind eingeflossen:
* Aufgaben im Fehlerzustand lassen sich jetzt neustarten.
* Mehr Informationen zu Einreichungen von Studierenden
* Verbesserungen am Moleküleditor
* Verbesserungen bei der Bewertung von R-Aufgaben

Wir haben zudem die folgenden Issues gelöst:
* Import von R-Aufgaben ohne Variablen
* Verschieben von Feedback
* Formatierungsfehler bei Plus Minus
* EqualsExpression wird mit Strings angelegt
* Feedback wird in eine Concat-Umgebung konvertiert
* Tags lassen sich nicht einschalten

==Juli 2022==
===Version 0.3.0===
Folgende Issues wurden seit dem letzten Release gelöst:
* Das Duplizieren von Kursen schlägt fehl.
* Nur ein Formeleditor soll gleichzeitig sichtbar sein.
* Alignment von Antwortboxen bei MC-Aufgaben mit Bildern als Antwortmöglichkeiten.
* Darstellung lange MC-Optionen.

Außerdem gab es zahlreiche Verbesserungen im JACK 2 Importer sowie in der Benutzeroberfläche.

==Mai 2022==
===Version 0.2.0===
Neben technischen Umbauten und neuen Stufentypen, sind wieder zahlreiche Fehler behoben worden, unter anderem die folgenden Issues:
* Variable mit einleitenden $-Zeichen für LATEX-Code wird zu "
* JACK2 MC-Aufgabe mit Graphen importierbar, aber Graphen werden nicht angezeigt
* Tags in alphabetischer Reihenfolge anzeigen
* Kein Import einer JACK2 Aufgabe aus S05 nach JACK3 mit Bild
* Aufgabenimport nicht möglich
* Angabe der E-Mail Adresse oder Matrikelnummer in der Kursangebots-Statistik
* Import von Aufgaben mit einem freigegeben Account

==Februar 2022==
===Version 0.1.0===
In diesem Release wurde insbesondere der Mechanismus für Feedback-Regeln in Fill-In-Aufgaben überarbeitet, sodass beispielsweise die Überprüfung auf leere Felder deutlich bequemer erfolgen kann. Zudem haben wir das Rechtesystem erweitert, sodass eine bessere Aufteilung der Aufgaben in der Lehre ermöglicht wird. Außerdem haben wir diverse ihrer Wünsche und Fehlermeldungen bearbeitet.
* Formatierung von Variablen im Text von Aufgaben
* Auswerten von R-Aufgaben vor dem Einreichen
* Falsche Palette beim Import von JACK 2 Aufgaben
* Verbesserungen beim Layout von Kursen.
* Probleme beim Import von Aufgaben mit Bildern
* Formatierung von Variablen im Text von Aufgaben.
[[Kategorie:JACK3]]
[[Kategorie:Hauptseiten]]

Dateien (JACK3)

2024-10-30T09:51:59Z

RSchypula: /* Dateien über Sciebo verwalten */

Grundsätzlich können Dateien, die in Aufgaben genutzt werden, sowohl in JACK als auch extern verwaltet werden. Wir empfehlen ausdrücklich die Verwendung der Lösung innerhalb von JACK.

=== Dateien an eine Aufgabe anhängen ===
Beim Bearbeiten einer Aufgabe werden im Abschnitt ''Dateien'' alle Dateien, die für die Aufgabe benötigt werden, hochgeladen.

[[File:Aufgabe_Datei.JPG|center|thumb|800px|Upload einer Datei]]

Um eine Datei hochzuladen klickt man auf den Button '''Hochladen'''.

'''Wichtig:''' Erst nach dem Speichern ist die Datei auch in der Datenbank gespeichert und kann in der Aufgabe verwendet werden.

Alle Dateien einer Aufgabe werden in einer Liste der Reihenfolge nach wie sie hochgeladen wurden aufgelistet. Jede Datei hat eine eindeutige ID mit der sie an anderen Stellen referenziert werden kann. Die Datei hat einen Dateinamen. Optional kann man der Datei auch eine Beschreibung hinzufügen. Weitere Informationen in der Liste sind wann eine Datei hochgeladen wurde und von welchem Nutzer.

[[File:Dateien.PNG|center|thumb|800px|Aktionen]]
Unter den 3 Punkten gibt es drei Aktionen die dem Nutzer zur Verfügung stehen. Die Datei kann entfernt werden oder heruntergeladen werden. Zusätzlich bietet es einem die Möglichkeit eine Datei zu ersetzen. Das hat den Vorteil, dass die Datei direkt auch an allen referenzierten Stellen aktualisiert wird.

=== Dateien in Aufgabe nutzen ===
[[File:Bild-in-Text-einfuegen.jpg|center|thumb|800px|Ressource im Fließtext einfügen]]
Wenn die hochgeladene Datei z.B. ein Bild ist kann sie an jeder Stelle der Aufgabe, wo ein Fließtext ist, eingefügt werden. Hier wird das exemplarisch einmal für den Aufgabentext erklärt. Wenn der Fließtext, wie hier der Aufgabentext, erstellt wird im Editor steht der Button '''Ressource Einfügen''' zur Verfügung. Wenn man diesen anklickt bekommt man alle Dateien aufgelistet, die in dieser Aufgabe hochgeladen wurden. In dem Screenshot oben sind drei Bilder hochgeladen worden. Dem Nutzer stehen dabei zwei ''Aktionen'' zur Verfügung: Bild sichtbar einfügen [[File:Icon-Bild.jpg|25px]] oder einen Link zu der Datei einfügen [[File:Icon-Link.jpg|25px]]. In dem Screenshot unten wurde einmal exemplarisch das Bild ''x2+3.jpg'' in den zwei Varianten eingefügt. Bei der Variante Link einfügen hat man einen Link, der einem erst beim Anklicken das Bild zeigt. Bei der Variante Bild sichtbar einfügen sieht man das Bild direkt im Fließtext.
[[File:Bilder-eingefuegt.jpg|center|thumb|500px|Bild mit den zwei Varianten eingefügt]]

=== Dateien extern verwalten ===
Alternativ können Dateien auch von einer externen Quelle eingebunden werden, beispielsweise über Sciebo oder Imperia. Das hat die folgenden Vorteile:

* Sie können die Datei problemlos in mehreren Aufgaben wiederverwenden auch über unterschiedliche Server hinweg.
* Eine nachträgliche Änderung der Dateien wirkt sich auf alle Aufgaben aus, die diese Datei verwenden.

Diese Vorteile werden durch einige Nachteile erkauft:

* Sie arbeiten an der JACK Versionsverwaltung vorbei, sodass JACK Aufgabenversionen nicht mehr vollständig wiederherstellen kann. Sie sind dann immer von der Quelle der Dateien abhängig. Das ist auch und gerade für die Durchführung von Prüfungen relevant.
* Sie müssen dafür Sorge tragen, dass die Datei für die Studierenden erreichbar ist und bleibt. Das kann beispielsweise in der PC Hall durch Filterung des Internetverkehrs nicht gewährleistet sein.
* Externe Dateien können in Exporten nicht berücksichtigt werden.
Externe Dateien können über den Editor als Bilder oder Videos eingefügt werden. Das geht im der Aufgabentext und an allen anderen Stellen, an denen der WYSIWYG Editor verfügbar ist. Zum Einfügen klicken Sie einfach in der Toolbar des Editors auf den Button mit dem Bild, bzw. mit dem Play-Icon.

==== Dateien über Sciebo verwalten ====
[https://uni-duisburg-essen.sciebo.de/ Sciebo] eignet sich für die externe Verwaltung von Dateien und ist für alle Hochschulangehörigen der Univerität Duisburg-Essen verfügbar. Besonders bei Videos ist dies sinnvoll, da Videos schnell die maximale Dateigröße von JACK übersteigen. Bei Klausuren ist es jedoch nicht erlaubt Resourcen und Dienste außerhalb der Universität zu verwenden. Sie können Dateien aus Sciebo wie folgt in JACK verwenden:

# Laden Sie die Datei in Sciebo auf dem gewohnten Weg hoch.
# Klicken Sie auf das "Teilen" Symbol hinter dem Dateinamen.
# Wechseln Sie rechts in den Tab "Öffentliche Links" und klicken Sie auf "Öffentlichen Link erstellen"
# Tragen Sie optional einen Namen ein. Achten Sie darauf, dass nur "Herunterladen / Ansehen" ausgewählt ist und klicken Sie auf "Teilen".
# Mit dem ersten Symbol direkt hinter dem neu erstellten Link können Sie diesen in die Zwischenablage kopieren und dann in JACK einfügen.
# Sie können die Datei auch zum direkten Downloadlink umwandeln, indem Sie "/download" an den Link anfügen. Alternativ finden Sie vollständige Adresse zum Download auch, wenn Sie den zuvor kopierten Link besuchen unter der Vorschau der Datei. Wenn Sie Videos von Sciebo in JACK einbinden wollen, ist es notwendig /download an den Link anzufügen.

[[category:Benutzerhandbuch]]

Manuelles Feedback (JACK3)

2024-02-09T10:10:20Z

RSchypula:

In jeder Aufgabe gibt es die Möglichkeit auch manuelles Feedback zu geben. Dabei spielt es keine Rolle, ob die Aufgabe einen Checker hat und bereits vom System ein Feedback bekommen hat oder nicht. Diese Möglichkeit steht in jeder Einreichung in einem Kursangebot zur Verfügung. Manuelles Feedback ist Feedback, welches ein Lehrender (zusätzlich oder ersetzend) zum automatischen erzeugten Feedback einer Einreichung geben kann. Ein Lehrender kann dabei Punkte neu vergeben und Text schreiben.

Die folgenden Schritte muss man gehen, wenn man '''alle Lösungen aller Aufgaben zu einem Studierenden''' sehen möchte und um zu der Möglichkeit zu kommen manuelles Feedback in einer eingereichten Lösung hinzuzufügen:
# Man wählt unter dem Tab '''Verfügbare Kurse''' das entsprechende Kursangebot aus, in dem die eingereichte Lösung, die bewertet werden soll, liegt.
# Danach scrollt man die Seite bis ganz nach unten und klickt auf den Button '''Teilnehmerübersicht'''.
# Hier wählt man den entsprechenden Studierenden aus, den man bewerten möchte. Bei den drei Pünktchen am Ende der Zeile wählt man '''Zur Bearbeitung gehen''' aus.
# Auf der nächsten Seite sieht man die Details der Bearbeitung des Studierenden. Nun wählt man in der Liste der Aufgaben die Aufgabe aus, die man manuell bewerten möchte, in dem man auf das Lupen Symbol klickt.
# Jetzt sieht man die Bearbeitung einer Aufgabe eines Studierenden. Wenn man die Seite nach ganz unten scrollt ist der Button '''Manuelles Feedback''' zu sehen.
# Wenn man den Button klickt poppt folgendes Pop-Up auf:
Die folgenden Schritte muss man gehen, wenn man '''alle Lösungen einer Aufgabe''' sehen möchte und um zu der Möglichkeit zu kommen manuelles Feedback in einer eingereichten Lösung hinzuzufügen:
# Man wählt unter dem Tab '''Verfügbare Kurse''' das entsprechende Kursangebot aus, in dem die eingereichte Lösung, die bewertet werden soll, liegt.
# Danach scrollt man die Seite bis ganz nach unten und klickt auf den Button '''Bearbeitungsübersicht'''.
# Hier wählt man die entsprechende Aufgabe aus, die man bewerten möchte.
# Jetzt sieht man alle Lösungen, die zu dieser Aufgabe in diesem Kursangebot eingereicht wurden. Die Liste kann nach Benutzernamen oder Zeitpunkt sortiert werden.
# Nun wählt man in der Liste der Lösungen die Lösung aus, die man manuell bewerten möchte, in dem man auf das Lupen Symbol klickt.
# Jetzt sieht man die Bearbeitung einer Aufgabe eines Studierenden. Wenn man die Seite nach ganz unten scrollt ist der Button '''Manuelles Feedback''' zu sehen.
# Wenn man den Button klickt poppt folgendes Pop-Up auf:

<gallery mode="packed">
Manuelles_Feedback1.jpg
Manuelles_Feedback2.jpg
</gallery>

Einstellungsmöglichkeiten bei manuellen Feedback:
* Zunächst muss mit einem Haken das manuelle Feedback für diese Einreichung aktiviert werden.
* Danach hat man die Wahl, ob das automatisch erzeugte Feedback weiterhin angezeigt wird oder nicht. Der Aufgabentyp '''Freitext''' hat kein automatisch erzeugtes Feedback!
* Zur Nachverfolgung wird angezeigt, welcher Nutzer das manuelle Feedback gesetzt hat. Diese Einsicht hat der Studierende später nicht, nur Lehrende mit entsprechenden Rechten auf das Kursangebot können sehen wer das manuelle Feedback gesetzt hat.
* Im nächsten Punkt wird die Punktzahl gesetzt. Dies wird prozentual gesetzt, da das Maximum an Punkten in JACK bei 100 Punkten liegt.
* Nun gibt es die Möglichkeit einen Kommentar an die Lösung zu setzen, den nur Lehrende sehen können. Dies wird den Studierenden nicht angezeigt.
* Und zum Schluss kann man das Feedback für die Studierende für diese Einreichung schreiben.

'''Wichtiger Hinweispunkt:'''

Wenn bereits ein manuelles Feedback an einer Einreichung gesetzt wurde und ein neues an dieselbe Einreichung gesetzt wird, dann überschreibt das neue manuelle Feedback das alte. Die Studierenden sehen dann nur noch das zuletzt gesetzte manuelle Feedback an ihrer Einreichung!

GReQLJavaChecker

2023-08-24T14:08:40Z

RSchypula:

Der GReQLJavaChecker ermöglicht statische Checks auf Programmcode und verwendet dazu Abfragen auf dem Syntaxgraphen. Um einen statischen Check mit dem Checker durchzuführen, müssen die zu untersuchenden Dateien in der Liste "Source Files" ausgewählt werden und eine einzelne Datei mit Prüfregeln ("Rule File") angegeben werden. Die Regeln werden in dieser Datei im XML-Format organisiert und verwenden die Sprache GReQL für Abfragen auf dem Syntaxbaum.

=== Beispiele und Eigenschaften von Regeln ===
Als erstes Element im XML Dokument muss <checkerrules> stehen, entsprechend muss </checkerrules> als letztes Element in dem XML Dokument sein.

Zwei beispielhafte Abfragen in dieser Sprache sehen so aus:

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="2">
<query>from u : V{CompilationUnit}, x : V{WhileStatement} with
not isEmpty(u -->* x -->{WhileStatementBody}&{EmptyStatement}) or
(not isEmpty(u -->* x -->{WhileStatementBody}&{Block}) and
isEmpty(u -->* x -->{WhileStatementBody}&{Block} -->{Child}))
report u.name as "name", x.line as "line" end</query>
<feedback>In der Datei {name} besteht die while-Schleife in Zeile {line} nur aus einer
Abbruchbedingung und ist dadurch sinnlos.</feedback>
</rule>
</syntaxhighlight>

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="4">
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration} with
t.name="Miniprojekt2" and
t -->{TypeDeclarationBodyDeclarations2} m and
hasSignature(m, "public static String geometrie1(int)")
report 0 end</query>
<feedback prefix="Signaturcheck">Die Methode "public static String geometrie1(int laenge)" in
der Klasse "Miniprojekt2" fehlt. Hast du die vorgegebene Methodensignatur veraendert?</feedback>
</rule>
</syntaxhighlight>

Die obere Regel ist vom Typ "absence", d.h. sie definiert einen Codestruktur, die nicht in der untersuchten Lösung vorkommen soll. Als Abfrage wird eine Struktur aus Elementen des Syntaxbaums definiert. Als Meldung wird ein String definiert, der zur Fehlerliste hinzugefügt wird, wenn die in der Abfrage definierte Struktur gefunden wird. Dabei dienen {name} und {line} als Platzhalter für Werte, die in der Abfrage in der report-Klausel ausgegeben wurden. Die zweite Regel ist vom Typ "presence" und definiert folglich eine Codestruktur, die in der untersuchten Lösung vorkommen soll. D.h., in diesem Fall wird die definierte Fehlermeldung ausgegeben, wenn die in der Abfrage definierte Struktur nicht auftritt. Folglich können in dieser Regel auch keine Platzhalter in der Ausgabe verwendet werden.

Die Funktion <code>hasSignature</code> ist eine spezielle, von JACK bereitgestellte Erweiterung der GReQL-Syntax, die eine bequeme Überprüfung von Methodensignaturen ermöglicht. Wie im Beispiel dargestellt, braucht die übergebene Zeichenkette keine vollständige Methodensignatur zu sein, sondern es reicht die Angabe der zu überprüfenden Bestandteile. D.h., Namen der Methodenparameter können ebenso entfallen wie Modifier oder der Rückgabetyp. Es ist allerdings nicht möglich, nur Modifier anzugeben und keinen Rückgabetyp.

''→ Weitere Beispiele:'' [[GReQL Regeln]]

=== Auswertung eines Regelsatzes ===
Bei der Durchführung des statischen Checks wird zunächst der abstrakte Syntaxgraph der abgegebenen Lösung erzeugt und anschließend alle Regeln angewendet. Alle erzeugten Fehlernachrichten werden als Ausgabe des statischen Tests gesammelt. Die vergebene Punktzahl ergibt sich aus den Punkten der einzelnen Regeln, wobei die Gesamtsumme der Punkte in der Regeldatei stets auf 100 normiert wird. D.h., im oben gezeigten Beispiel erhält eine korrekte Lösung 100 Punkte, während eine Lösung, die die erste Regel verletzt, nur 67 Punkte erhält. Tritt während des Checks ein technischer Fehler auf, wird der Check abgebrochen und die Lösung mit einem "internal error" als fehlerhaft markiert.

=== Versionsunterschiede ===
Je nach eingesetzter Checker-Version müssen einige Abfragen zur Code-Struktur leicht unterschiedlich formuliert werden. Dies betrifft insbesondere die beiden Checker-Versionen, die in JACK 2 und JACK 3 zum Einsatz kommen.

{| class="wikitable"
|-
! Art der Änderung !! Alt (insb. JACK 2) !! Neu (insb. JACK 3 und Moodle-Plugin)
|-
| Geänderter Kantentyp || <code>TypeDeclarationBodyDeclarations2</code> || <code>TypeDeclarationBodyDeclarations1</code>
|-
| Geänderter Kantentyp || <code>TypeDeclarationSuperclassType2</code> || <code>TypeDeclarationSuperclassType</code>
|-
| Geänderter Kantentyp || <code>ParameterizedTypeTypeArguments1</code> <code>ParameterizedTypeTypeArguments2</code> || <code>ParameterizedTypeTypeArguments</code>
|-
| Geänderter Kantentyp || <code>TypeDeclarationSuperInterfaceTypes1</code> <code>TypeDeclarationSuperInterfaceTypes2</code> || <code>TypeDeclarationSuperInterfaceTypes</code>
|-
| Erweiterte Funktion || Die Funktion <code>hasSignature</code> kann nicht auf geworfene Exceptions prüfen || Die Prüfung ist möglich
|}

==Tools==
[[Media:GReQL-Referencecard.pdf|GReQL-Referencecard]]

[[category:Checker]]

GReQLJavaChecker

2023-08-24T14:08:14Z

RSchypula: Kleine Ergänzung das checkerrules Element am Anfang stehen muss

Der GReQLJavaChecker ermöglicht statische Checks auf Programmcode und verwendet dazu Abfragen auf dem Syntaxgraphen. Um einen statischen Check mit dem Checker durchzuführen, müssen die zu untersuchenden Dateien in der Liste "Source Files" ausgewählt werden und eine einzelne Datei mit Prüfregeln ("Rule File") angegeben werden. Die Regeln werden in dieser Datei im XML-Format organisiert und verwenden die Sprache GReQL für Abfragen auf dem Syntaxbaum.

=== Beispiele und Eigenschaften von Regeln ===
Als erstes Element im XML Dokument muss <checkerrules> stehen, entsprechend muss </checkerrules> als letztes Element in dem XMl Dokument sein.

Zwei beispielhafte Abfragen in dieser Sprache sehen so aus:

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="2">
<query>from u : V{CompilationUnit}, x : V{WhileStatement} with
not isEmpty(u -->* x -->{WhileStatementBody}&{EmptyStatement}) or
(not isEmpty(u -->* x -->{WhileStatementBody}&{Block}) and
isEmpty(u -->* x -->{WhileStatementBody}&{Block} -->{Child}))
report u.name as "name", x.line as "line" end</query>
<feedback>In der Datei {name} besteht die while-Schleife in Zeile {line} nur aus einer
Abbruchbedingung und ist dadurch sinnlos.</feedback>
</rule>
</syntaxhighlight>

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="4">
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration} with
t.name="Miniprojekt2" and
t -->{TypeDeclarationBodyDeclarations2} m and
hasSignature(m, "public static String geometrie1(int)")
report 0 end</query>
<feedback prefix="Signaturcheck">Die Methode "public static String geometrie1(int laenge)" in
der Klasse "Miniprojekt2" fehlt. Hast du die vorgegebene Methodensignatur veraendert?</feedback>
</rule>
</syntaxhighlight>

Die obere Regel ist vom Typ "absence", d.h. sie definiert einen Codestruktur, die nicht in der untersuchten Lösung vorkommen soll. Als Abfrage wird eine Struktur aus Elementen des Syntaxbaums definiert. Als Meldung wird ein String definiert, der zur Fehlerliste hinzugefügt wird, wenn die in der Abfrage definierte Struktur gefunden wird. Dabei dienen {name} und {line} als Platzhalter für Werte, die in der Abfrage in der report-Klausel ausgegeben wurden. Die zweite Regel ist vom Typ "presence" und definiert folglich eine Codestruktur, die in der untersuchten Lösung vorkommen soll. D.h., in diesem Fall wird die definierte Fehlermeldung ausgegeben, wenn die in der Abfrage definierte Struktur nicht auftritt. Folglich können in dieser Regel auch keine Platzhalter in der Ausgabe verwendet werden.

Die Funktion <code>hasSignature</code> ist eine spezielle, von JACK bereitgestellte Erweiterung der GReQL-Syntax, die eine bequeme Überprüfung von Methodensignaturen ermöglicht. Wie im Beispiel dargestellt, braucht die übergebene Zeichenkette keine vollständige Methodensignatur zu sein, sondern es reicht die Angabe der zu überprüfenden Bestandteile. D.h., Namen der Methodenparameter können ebenso entfallen wie Modifier oder der Rückgabetyp. Es ist allerdings nicht möglich, nur Modifier anzugeben und keinen Rückgabetyp.

''→ Weitere Beispiele:'' [[GReQL Regeln]]

=== Auswertung eines Regelsatzes ===
Bei der Durchführung des statischen Checks wird zunächst der abstrakte Syntaxgraph der abgegebenen Lösung erzeugt und anschließend alle Regeln angewendet. Alle erzeugten Fehlernachrichten werden als Ausgabe des statischen Tests gesammelt. Die vergebene Punktzahl ergibt sich aus den Punkten der einzelnen Regeln, wobei die Gesamtsumme der Punkte in der Regeldatei stets auf 100 normiert wird. D.h., im oben gezeigten Beispiel erhält eine korrekte Lösung 100 Punkte, während eine Lösung, die die erste Regel verletzt, nur 67 Punkte erhält. Tritt während des Checks ein technischer Fehler auf, wird der Check abgebrochen und die Lösung mit einem "internal error" als fehlerhaft markiert.

=== Versionsunterschiede ===
Je nach eingesetzter Checker-Version müssen einige Abfragen zur Code-Struktur leicht unterschiedlich formuliert werden. Dies betrifft insbesondere die beiden Checker-Versionen, die in JACK 2 und JACK 3 zum Einsatz kommen.

{| class="wikitable"
|-
! Art der Änderung !! Alt (insb. JACK 2) !! Neu (insb. JACK 3 und Moodle-Plugin)
|-
| Geänderter Kantentyp || <code>TypeDeclarationBodyDeclarations2</code> || <code>TypeDeclarationBodyDeclarations1</code>
|-
| Geänderter Kantentyp || <code>TypeDeclarationSuperclassType2</code> || <code>TypeDeclarationSuperclassType</code>
|-
| Geänderter Kantentyp || <code>ParameterizedTypeTypeArguments1</code> <code>ParameterizedTypeTypeArguments2</code> || <code>ParameterizedTypeTypeArguments</code>
|-
| Geänderter Kantentyp || <code>TypeDeclarationSuperInterfaceTypes1</code> <code>TypeDeclarationSuperInterfaceTypes2</code> || <code>TypeDeclarationSuperInterfaceTypes</code>
|-
| Erweiterte Funktion || Die Funktion <code>hasSignature</code> kann nicht auf geworfene Exceptions prüfen || Die Prüfung ist möglich
|}

==Tools==
[[Media:GReQL-Referencecard.pdf|GReQL-Referencecard]]

[[category:Checker]]

GReQL Regeln

2023-08-24T13:55:59Z

RSchypula: Anpassung der Kantentypen auf JACK3 GReQL Regeln

== Beispiele für statische Prüfregeln für Java-Code ==
=== Codestil ===
<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="0">
<query>from x : V{MethodDeclaration}
with
x.name=capitalizeFirst(x.name) and
x.constructor="false"
report 0 end
</query>
<feedback prefix="Hinweis (ohne Punktabzug)">Du verwendest Methodennamen, die mit einem Großbuchstaben beginnen. Das ist möglich, aber es entspricht nicht dem üblichen Programmierstil für Java.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach groß geschriebenen Methodennamen.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="0">
<query>from x : V{TypeDeclaration}
with
not (x.name=capitalizeFirst(x.name))
report 0 end
</query>
<feedback prefix="Hinweis (ohne Punktabzug)">Du verwendest Klassennamen, die nicht mit einem Großbuchstaben beginnen. Das ist möglich, aber es entspricht nicht dem üblichen Programmierstil für Java.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach klein geschriebenen Klassennamen.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="0">
<query>from x : V{VariableDeclarationFragment}
with
x.name=capitalizeFirst(x.name) and
isEmpty(from m : V{Modifier} with x <--&{FieldDeclaration} --> m and m.name="final" report m end)
report 0 end
</query>
<feedback prefix="Hinweis (ohne Punktabzug)">Du verwendest Variablennamen, die mit einem Großbuchstaben beginnen. Das ist möglich, aber es entspricht nicht dem üblichen Programmierstil für Java.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach groß geschriebenen Variablennamen, wobei als "final" deklarierte Klassenvariablen ausgelassen werden.

=== Einfache Inhalte ===
<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="2">
<query>from m : V{MethodDeclaration}, s : V{StringLiteral}
with
m.name="m" and
m -->{Child}* s and
s.content = "\"Zeichenkette\""
report 0 end
</query>
<feedback>Deine Lösung verwendet nicht den String "Zeichenkette".</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht in der Methode <code>m</code> nach einem String-Literal mit einem vorgegebenen Inhalt.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="2">
<query>from m : V{MethodDeclaration}, s : V{StringLiteral}
with
m.name="m" and
m -->{Child}* s and
stringLength(s.content) > 4
report s.line as "line" end
</query>
<feedback>Du verwendest in Zeile {line} ein festes String-Literal. Ist deine Lösung allgemeingültig?</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht in der Methode <code>m</code> nach einem String-Literal der Länge 4 oder länger (inklusive Anführungszeichen) und meldet es mit Angabe der Zeilennummer als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="0">
<query>from p : V{PackageDeclaration}
report 0 end
</query>
<feedback prefix="Paketdefinition">Deine Lösung beinhaltet eine package-Angabe. Bitte entferne diese.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach Paketdefinitionen und meldet diese als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="1">
<query> from p : V{ImportDeclaration}
report 0 end
</query>
<feedback prefix="Importdefinition"> Deine Lösung beinhaltet eine import-Angabe. Bitte entferne diese.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach Importdefinitionen und meldet diese als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="1">
<query>from u : V{CompilationUnit}, x : V{MethodInvocation}, y : V{SimpleName}
with
u -->* x -->{ElementExpression} y and
x.name="exit" and
y.name="System"
report u.name as "name", x.line as "line" end
</query>
<feedback>Der Aufruf von "System.exit()" in der Datei {name} in Zeile {line} ist nicht gestattet.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach Aufrufen von <code>System.exit()</code> und melde diese unter Angabe von Klasse und Zeilennummer als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="1">
<query>from x : V{MethodInvocation}, y, z : V{SimpleName}
with
x -->{ElementExpression}&{QualifiedName} -->{QualifiedNameName} y and
x -->{ElementExpression}&{QualifiedName} -->{QualifiedNameQualifier} z and
(x.name="print" or x.name="println") and
y.name="out" and z.name="System"
report x.line as "line" end
</query>
<feedback>You have a print statement in line {line}. Are you sure you want to print to console instead of returning?</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach Aufrufen von <code>System.out.print()</code> oder <code>System.out.println()</code> und melde diese unter Angabe von Klasse und Zeilennummer als Fehler.

=== Kontrollstrukturen ===
<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="4">
<query>from m : V{MethodDeclaration}
with
m.name="m" and
isEmpty(m -->{Child}*&{WhileStatement}) and
isEmpty(m -->{Child}*&{DoStatement}) and
isEmpty(m -->{Child}*&{ForStatement}) and
isEmpty(m -->{Child}*&{EnhancedForStatement})
report 0 end
</query>
<feedback>In der Methode "m()" wird kein Schleifenkonstrukt verwendet.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Methode <code>m</code> ein beliebiges Schleifenkonstrukt enthält.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="2">
<query>from u : V{CompilationUnit}, x : V{IfStatement}
with
( not isEmpty(u -->* x -->{IfStatementThenStatement}&{EmptyStatement}) or
(not isEmpty(u -->* x -->{IfStatementThenStatement}&{Block}) and isEmpty(u -->* x -->{IfStatementThenStatement}&{Block} -->{Child}))
) and
( not isEmpty(u -->* x -->{IfStatementElseStatement}&{EmptyStatement}) or
(not isEmpty(u -->* x -->{IfStatementElseStatement}&{Block}) and isEmpty(u -->* x -->{IfStatementElseStatement}&{Block} -->{Child}))
)
report u.name as "name", x.line as "line" end
</query>
<feedback>In der Datei {name} enthält das if-Statement in Zeile {line} in beiden Zweigen keinen Code und ist dadurch sinnlos.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach einer if-Anweisung, die nur leere Zweige enthält und meldet eine solche Anweisung als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="2">
<query>from u : V{CompilationUnit}, x : V{IfStatement}
with
not isEmpty(u -->* x -->{IfStatementThenStatement}&{EmptyStatement}) and
isEmpty(x -->{IfStatementElseStatement}&{Statement})
report u.name as "name", x.line as "line" end
</query>
<feedback>In der Datei {name} endet das if-Statement in Zeile {line} hinter der Bedingung sofort mit einem Semikolon. Die Bedingung ist dadurch wirkungslos und die folgende Anweisung wird immer ausgeführt.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach einer if-Anweisung, die keine Zweige enthält und meldet eine solche Anweisung als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="2">
<query>from u : V{CompilationUnit}, x : V{WhileStatement}
with
not isEmpty(u -->* x -->{WhileStatementBody}&{EmptyStatement}) or
(not isEmpty(u -->* x -->{WhileStatementBody}&{Block}) and
isEmpty(u -->* x -->{WhileStatementBody}&{Block} -->{Child}))
report u.name as "name", x.line as "line" end
</query>
<feedback>In der Datei {name} besteht die while-Schleife in Zeile {line} nur aus einer Abbruchbedingung und ist dadurch sinnlos.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach einer while-Schleife, die nur aus einer Abbruchbedingung besteht und meldet eine solche Schleife als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="1">
<query>from m : V{MethodDeclaration}, n : V{MethodDeclaration}
with
m (-->{Child}*&{MethodInvocation} -->{Access}&{MethodDeclaration})* n and
n -->{Child}*&{MethodInvocation} -->{Access} m and
m.name="m"
report 0 end
</query>
<feedback prefix="Rekursionscheck"> Die Methode "m()" enthält nicht die geforderte Rekursion.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Methode <code>m</code> rekursiv arbeitet. Dabei ist es egal, ob sich die Methode direkt selber aufruft, oder über einen oder mehrere Zwischenschritte aufgerufen wird.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from m : V{MethodDeclaration}
with
m (-->{Child}*&{MethodInvocation} -->{Access}&{MethodDeclaration}) m and
m.name="m"
report 0 end
</query>
<feedback prefix="Rekursionscheck">Die Methode "m()" enthält nicht die geforderte Rekursion.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Methode <code>m</code> rekursiv arbeitet und sich insbesondere ohne Zwischenschritte über andere Methoden selber wieder aufruft.

=== Methoden ===
<syntaxhighlight lang="xml" line="1">
<rule type="presence" points="4">
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations1} m and
hasSignature(m, "public static String method(int)")
report 0 end
</query>
<feedback prefix="Signaturcheck">Die Methode "public static String method(int param)" in der Klasse "A" fehlt. Hast du die vorgegebene Methodensignatur veraendert?</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A eine Methode mit einer bestimmten Signatur enthält, wobei der Name des Methodenparameters unerheblich ist.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="4">
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations1} m and
hasSignature(m, "int method()") and
isEmpty(m -->{Child}&{Modifier})
report 0 end
</query>
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}, mo : V{Modifier}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations1} m and
hasSignature(m, "int method()") and
m --> mo and not (mo.name="private")
report 0 end
</query>
<feedback prefix="Signaturcheck">Die Methode "int method()" in der Klasse "A" fehlt oder ist mit dem Modifier "private" versehen. Hast du die vorgegebene Methodensignatur veraendert?</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A eine Methode mit einer bestimmten Signatur enthält, die nicht mit dem Modifier private versehen ist.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="1">
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}, pt : V{ParameterizedType}, ptt : V{SimpleType}, pta : V{SimpleType}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations1} m and
m.name="m" and
m -->{MethodDeclarationReturnType} pt and
pt -->{ParameterizedTypeType} ptt and
ptt.name="B" and
pt -->{ParameterizedTypeTypeArguments} pta and
pta.name="C"
report 0 end
</query>
<feedback prefix="Signatur">Der Methode "public B<C> m()" in der Klasse "A" fehlt. Hast du die vorgegebene Methodensignatur veraendert?</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A eine Methode m mit parametrisierten Rückgabetyp B<C> enthält.

=== Vererbungshierarchie ===
<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from t : V{TypeDeclaration}, st : V{SimpleType}
with
t.name="A" and
st.name="B" and
t -->{TypeDeclarationSuperclassType} st
report 0 end
</query>
<feedback prefix="Typhierarchie">A ist nicht als Unterklasse von B modelliert.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A direkte Unterklasse von Klasse B ist.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="1">
<query>from t : V{TypeDeclaration}, st : V{SimpleType}
with
t.name="A" and
t -->{TypeDeclarationSuperInterfaceTypes} st and
st.name="B"
report 0 end
</query>
<feedback prefix="Typhierarchie">A implementiert nicht das Interface B.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A das Interface B implementiert.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="1">
<query>from t : V{TypeDeclaration}, pt : V{ParameterizedType}, ptt : V{SimpleType}, pta : V{SimpleType}
with
t.name="A" and
t -->{TypeDeclarationSuperInterfaceTypes} pt and
pt -->{ParameterizedTypeType} ptt and
ptt.name="B" and
pt -->{ParameterizedTypeTypeArguments} pta and
pta.name="C"
report 0 end
</query>
<feedback prefix="Typhierarchie">A implementiert nicht das Interface B<C>.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A das Interface B<C> implementiert.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="3">
<query>from u : V{TypeDeclaration}, s : V{SimpleType}
with
((u -->{TypeDeclarationSuperclassType} s and s.name="Thread") or
(u -->{TypeDeclarationSuperInterfaceTypes} s and s.name="Runnable")) and
u.name="A"
report 0 end
</query>
<feedback>In der Klasse "A" sollte entweder das Interface "Runnable" implementieren oder von "Thread" erben.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A das Interface Runnable implementiert oder von Thread erbt.

=== Aufrufbeziehungen ===
<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from u : V{TypeDeclaration}, x : V{MethodInvocation}, y : V{SimpleName}
with
u -->* x -->{ElementExpression} y and
u.name="A" and
x.name="m" and
y.name="B"
report 0 end
</query>
<feedback>In der Klasse "A" sollte "B.m()" aufgerufen werden.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A eine Methode B.m aufruft.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from u : V{TypeDeclaration}, x : V{MethodInvocation}, y : V{SimpleName}, z : V{VariableDeclarationStatement}, f : V{VariableDeclarationFragment}, t : V{SimpleType}
with
u -->* x -->{ElementExpression} y and
u -->* z -->{VariableDeclarationStatementType} t and
u -->* z -->{VariableDeclarationStatementFragments} f and
u.name="A" and
x.name="m" and
y.name=f.name and
t.name="B"
report 0 end
</query>
<feedback>In der Klasse "A" sollte "m()" auf einem Objekt vom Typ "B" aufgerufen werden.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A Methode m auf einem Objekt vom Typ B aufruft.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="4">
<query>from u : V{TypeDeclaration}, m : V{MethodDeclaration}, x : V{ClassInstanceCreation}, t : V{SimpleType}
with
u -->{Child}* m -->* x -->{ClassInstanceCreationType} t and
u.name="A" and
m.name="m" and
t.name="B"
report 0 end
</query>
<feedback>In der Klasse "A" muss in Methode m() mindestens eine Instanz von "B" erzeugt werden.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A in Methode m eine Instanz von Klasse B erstellt.

== Beispiele für statische Prüfregeln für UML-Modelle im XMI2-Format ==
=== Klassendiagramme ===
<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="11">
<query>from x,y : V{Class}
with
x --> V{Property} --> V{Association} <-- V{Property} <-- y and
isDefined(x.name) and x.name="A" and
isDefined(y.name) and y.name="B"
report 1 end
</query>
<feedback>Das Diagramm enthält keine Beziehung zwischen einem "A" und einem "B" oder keine Klassen mit diesen Namen.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob das Modell zwei Klassen "A" und "B" enthält, die über eine Assoziation verbunden sind.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="0">
<query>from x,y : V{Class}
with
x --> V{Property} --> V{Association} <-- V{Property} <-- y and
isDefined(x.name) and x.name="A" and
isDefined(y.name) and y.name="B"
report 1 end
</query>
<feedback prefix="Hinweis">Im Diagramm sind die "B" eines "A" als eigene Klasse abgebildet. Das kannst du durch eine bessere Modellierung vermeiden.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft ebenfalls, ob das Modell zwei Klassen "A" und "B" enthält, die über eine Assoziation verbunden sind, definiert dies aber als unerwünschte Situation mit entsprechendem Feedback.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="11">
<query>from x,y : V{Class}, z: V{Property}
with
x --> z and
z --> V{Association} <-- V{Property} <-- y and
isDefined(x.name) and x.name="A" and
isDefined(y.name) and y.name="B" and
isDefined(z.lower) and z.lower="1" and (not isDefined(z.upper) or z.upper="1")
report 1 end
</query>
<feedback>Das Diagramm enthält keine Beziehung zwischen einem "A" und einem "B" mit der Kardinalität 1 oder keine Klassen mit diesen Namen.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob das Modell zwei Klassen "A" und "B" enthält, die über eine Assoziation mit Kardinalität 1 (jedes A kennt genau ein B) verbunden sind.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from a,b : V{Class}, p: V{Property}
with
isEmpty(a -->&{Property} -->&{Association}) and
b --> p and
isDefined(p.aggregation) and p.aggregation="composite"
report 1 end
</query>
<feedback>Es sollte im Diagramm zwei Klassen geben, bei denen die eine keine weiteren Bestandteile hat, während die andere weitere Bestandteile gemäß der Komposition hat.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob es im Modell eine Klasse ohne ausgehende Assoziationen gibt und eine weitere, die mindestens eine ausgehende Komposition hat.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from x : V{Class}, y : V{Property}, z : V{PrimitiveType}
with
isDefined(x.name) and x.name="A" and
x --> y and
isDefined(y.name) and y.name="b" and
y --> z and
isDefined(z.name) and z.name="String"
report 1 end
</query>
<feedback>Ein "A" soll ein Attribut für die Eigenschaft "b" bereitstellen.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob es im Modell eine Klasse "A" mit dem Attribut "b" vom Typ "String" gibt.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from x : V{Class}, y : V{Operation}, z: V{Parameter}
with
isDefined(x.name) and x.name="A" and
x --> y and
isDefined(y.name) and stringLevenshteinDistance(y.name, "ausführen")<3 and
y --> z
report 1 end
</query>
<feedback>Ein "A" soll eine Methode bereitstellen, mit der sie etwas ausführen kann.</feedback>
</rule>
</syntaxhighlight>
Diese Regel prüft, ob es im Modell eine Klasse "A" mit einer Operation gibt, deren Name "ausführen" oder ähnlich lautet.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="4">
<query>let c := count(from y : V{Operation} with isDefined(y.name) report y end) in
from x : set(1)
with
c<>7
report c as "count" end
</query>
<feedback>Das Diagramm sollte genau 7 Methoden enthalten, enthält aber {count}.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob das Modell genau 7 Methoden enthält und gibt im Falle einer anderen Anzahl diese im Feedback mit aus.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from x : V{Class}
with
isDefined(x.name) and x.name=A" and
x.isAbstract and
not isEmpty(x <--&{Generalization})
report 1 end
</query>
<feedback>Das Diagramm sollte eine abstrakte Klasse "A" enthalten, von der mindestens eine Klasse erbt.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob das Modell eine abstrakte Klasse "A" enthält, auf die in mindestens einer Generalisierung verwiesen wird.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from a,b,c,d : V{Class}
with
isDefined(a.name) and a.name="A" and
isDefined(b.name) and b.name="B" and
isDefined(c.name) and c.name="C" and
isDefined(d.name) and d.name="D" and
a --> V{Generalization} --> d and
b --> V{Generalization} --> d and
c --> V{Generalization} --> d
report 1 end
</query>
<feedback>Das Diagramm sollte Klassen "A", "B" und "C" enthalten, die von einer gemeinsamen Oberklasse "D" erben.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob das Modell eine Klasse "D" enthält, die drei direkte Unterklassen "A", "B" und "C" hat.

== Beispiele für statische Prüfregeln für EPML ==
<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from x: V{Event}
with
isEmpty(x <--)
report 0 end
</query>
<feedback prefix="Fehlerhafte Grundelemente">Es gibt kein Startevent.</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob der gegebene Graph kein Startevent hat.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="5">
<query> from x,y: V{Event}
with
isEmpty(x <--) and
isEmpty(y <--) and
not (x=y)
report 0 end
</query>
<feedback prefix="Fehlerhafte Grundelemente">Es gibt mehr als ein Startevent.</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob der gegebene Graph mehr als ein Startevent hat.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="3">
<query> from x,y: V{Element, ^Connector}
with
not (x.name="") and
x.name = y.name and
not (x = y)
report x.name as "name" end
</query>
<feedback prefix="Anmerkung zur Namensgebung">Es gibt mindestens zwei Elemente mit demselben Namen ("{name}").</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob es der Graph Elemente mit demselben Namen besitzt.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="4">
<query>from x: V{Element, ^Connector}, y1, y2 : V{Element}
with
x --> y1 and
x --> y2 and
not (y1=y2)
report x.name as "xName", x.id as "xID" end
</query>
<feedback prefix="Fehlerhafte Grundstruktur">Das Element "{xName}" (ID {xID}) hat mehr als einen Ausgang.</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob ein Event oder Funktion mehr als einen Ausgang hat.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="4">
<query>from x: V{Connector}, y: V{Connector}
with
not (x.name="") and
not (y.name="") and
x --> y
report x.name as "xName", y.name as "yName", x.id as "xID", y.id as "yID" end
</query>
<feedback prefix="Fehlerhafte Grundstruktur">Es dürfen keine zwei Konnektoren direkt aufeinander folgen. Es folgt jedoch "{yName}" (ID {yID}) direkt auf "{xName}" (ID {xID}).</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob 2 Konnektoren aufeinander folgen.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="1">
<query>from x: V{Element, ^Connector}
with
contains(x.name, " and ") or
contains(x.name, "+") or
contains(x.name, " und ")
report x.name as "name" end
</query>
<feedback prefix="Anmerkung zur Namensgebung">Der Name "{name}" sieht danach aus, als wenn hier zwei Events bzw. Funktionen in einem Element zusammengefasst wurden.</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob der Graph möglicherweise Zeichen bzw. Wörter besitzt die mehrere Funktionen/Events in einem Element verbinden.

[[Category:R-GReQL]]

GReQL Regeln

2023-08-24T13:45:10Z

RSchypula: /* Methoden */

== Beispiele für statische Prüfregeln für Java-Code ==
=== Codestil ===
<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="0">
<query>from x : V{MethodDeclaration}
with
x.name=capitalizeFirst(x.name) and
x.constructor="false"
report 0 end
</query>
<feedback prefix="Hinweis (ohne Punktabzug)">Du verwendest Methodennamen, die mit einem Großbuchstaben beginnen. Das ist möglich, aber es entspricht nicht dem üblichen Programmierstil für Java.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach groß geschriebenen Methodennamen.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="0">
<query>from x : V{TypeDeclaration}
with
not (x.name=capitalizeFirst(x.name))
report 0 end
</query>
<feedback prefix="Hinweis (ohne Punktabzug)">Du verwendest Klassennamen, die nicht mit einem Großbuchstaben beginnen. Das ist möglich, aber es entspricht nicht dem üblichen Programmierstil für Java.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach klein geschriebenen Klassennamen.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="0">
<query>from x : V{VariableDeclarationFragment}
with
x.name=capitalizeFirst(x.name) and
isEmpty(from m : V{Modifier} with x <--&{FieldDeclaration} --> m and m.name="final" report m end)
report 0 end
</query>
<feedback prefix="Hinweis (ohne Punktabzug)">Du verwendest Variablennamen, die mit einem Großbuchstaben beginnen. Das ist möglich, aber es entspricht nicht dem üblichen Programmierstil für Java.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach groß geschriebenen Variablennamen, wobei als "final" deklarierte Klassenvariablen ausgelassen werden.

=== Einfache Inhalte ===
<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="2">
<query>from m : V{MethodDeclaration}, s : V{StringLiteral}
with
m.name="m" and
m -->{Child}* s and
s.content = "\"Zeichenkette\""
report 0 end
</query>
<feedback>Deine Lösung verwendet nicht den String "Zeichenkette".</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht in der Methode <code>m</code> nach einem String-Literal mit einem vorgegebenen Inhalt.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="2">
<query>from m : V{MethodDeclaration}, s : V{StringLiteral}
with
m.name="m" and
m -->{Child}* s and
stringLength(s.content) > 4
report s.line as "line" end
</query>
<feedback>Du verwendest in Zeile {line} ein festes String-Literal. Ist deine Lösung allgemeingültig?</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht in der Methode <code>m</code> nach einem String-Literal der Länge 4 oder länger (inklusive Anführungszeichen) und meldet es mit Angabe der Zeilennummer als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="0">
<query>from p : V{PackageDeclaration}
report 0 end
</query>
<feedback prefix="Paketdefinition">Deine Lösung beinhaltet eine package-Angabe. Bitte entferne diese.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach Paketdefinitionen und meldet diese als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="1">
<query> from p : V{ImportDeclaration}
report 0 end
</query>
<feedback prefix="Importdefinition"> Deine Lösung beinhaltet eine import-Angabe. Bitte entferne diese.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach Importdefinitionen und meldet diese als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="1">
<query>from u : V{CompilationUnit}, x : V{MethodInvocation}, y : V{SimpleName}
with
u -->* x -->{ElementExpression} y and
x.name="exit" and
y.name="System"
report u.name as "name", x.line as "line" end
</query>
<feedback>Der Aufruf von "System.exit()" in der Datei {name} in Zeile {line} ist nicht gestattet.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach Aufrufen von <code>System.exit()</code> und melde diese unter Angabe von Klasse und Zeilennummer als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="1">
<query>from x : V{MethodInvocation}, y, z : V{SimpleName}
with
x -->{ElementExpression}&{QualifiedName} -->{QualifiedNameName} y and
x -->{ElementExpression}&{QualifiedName} -->{QualifiedNameQualifier} z and
(x.name="print" or x.name="println") and
y.name="out" and z.name="System"
report x.line as "line" end
</query>
<feedback>You have a print statement in line {line}. Are you sure you want to print to console instead of returning?</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach Aufrufen von <code>System.out.print()</code> oder <code>System.out.println()</code> und melde diese unter Angabe von Klasse und Zeilennummer als Fehler.

=== Kontrollstrukturen ===
<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="4">
<query>from m : V{MethodDeclaration}
with
m.name="m" and
isEmpty(m -->{Child}*&{WhileStatement}) and
isEmpty(m -->{Child}*&{DoStatement}) and
isEmpty(m -->{Child}*&{ForStatement}) and
isEmpty(m -->{Child}*&{EnhancedForStatement})
report 0 end
</query>
<feedback>In der Methode "m()" wird kein Schleifenkonstrukt verwendet.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Methode <code>m</code> ein beliebiges Schleifenkonstrukt enthält.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="2">
<query>from u : V{CompilationUnit}, x : V{IfStatement}
with
( not isEmpty(u -->* x -->{IfStatementThenStatement}&{EmptyStatement}) or
(not isEmpty(u -->* x -->{IfStatementThenStatement}&{Block}) and isEmpty(u -->* x -->{IfStatementThenStatement}&{Block} -->{Child}))
) and
( not isEmpty(u -->* x -->{IfStatementElseStatement}&{EmptyStatement}) or
(not isEmpty(u -->* x -->{IfStatementElseStatement}&{Block}) and isEmpty(u -->* x -->{IfStatementElseStatement}&{Block} -->{Child}))
)
report u.name as "name", x.line as "line" end
</query>
<feedback>In der Datei {name} enthält das if-Statement in Zeile {line} in beiden Zweigen keinen Code und ist dadurch sinnlos.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach einer if-Anweisung, die nur leere Zweige enthält und meldet eine solche Anweisung als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="2">
<query>from u : V{CompilationUnit}, x : V{IfStatement}
with
not isEmpty(u -->* x -->{IfStatementThenStatement}&{EmptyStatement}) and
isEmpty(x -->{IfStatementElseStatement}&{Statement})
report u.name as "name", x.line as "line" end
</query>
<feedback>In der Datei {name} endet das if-Statement in Zeile {line} hinter der Bedingung sofort mit einem Semikolon. Die Bedingung ist dadurch wirkungslos und die folgende Anweisung wird immer ausgeführt.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach einer if-Anweisung, die keine Zweige enthält und meldet eine solche Anweisung als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="2">
<query>from u : V{CompilationUnit}, x : V{WhileStatement}
with
not isEmpty(u -->* x -->{WhileStatementBody}&{EmptyStatement}) or
(not isEmpty(u -->* x -->{WhileStatementBody}&{Block}) and
isEmpty(u -->* x -->{WhileStatementBody}&{Block} -->{Child}))
report u.name as "name", x.line as "line" end
</query>
<feedback>In der Datei {name} besteht die while-Schleife in Zeile {line} nur aus einer Abbruchbedingung und ist dadurch sinnlos.</feedback>
</rule>
</syntaxhighlight>
Diese Regel sucht nach einer while-Schleife, die nur aus einer Abbruchbedingung besteht und meldet eine solche Schleife als Fehler.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="1">
<query>from m : V{MethodDeclaration}, n : V{MethodDeclaration}
with
m (-->{Child}*&{MethodInvocation} -->{Access}&{MethodDeclaration})* n and
n -->{Child}*&{MethodInvocation} -->{Access} m and
m.name="m"
report 0 end
</query>
<feedback prefix="Rekursionscheck"> Die Methode "m()" enthält nicht die geforderte Rekursion.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Methode <code>m</code> rekursiv arbeitet. Dabei ist es egal, ob sich die Methode direkt selber aufruft, oder über einen oder mehrere Zwischenschritte aufgerufen wird.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from m : V{MethodDeclaration}
with
m (-->{Child}*&{MethodInvocation} -->{Access}&{MethodDeclaration}) m and
m.name="m"
report 0 end
</query>
<feedback prefix="Rekursionscheck">Die Methode "m()" enthält nicht die geforderte Rekursion.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Methode <code>m</code> rekursiv arbeitet und sich insbesondere ohne Zwischenschritte über andere Methoden selber wieder aufruft.

=== Methoden ===
<syntaxhighlight lang="xml" line="1">
<rule type="presence" points="4">
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations1} m and
hasSignature(m, "public static String method(int)")
report 0 end
</query>
<feedback prefix="Signaturcheck">Die Methode "public static String method(int param)" in der Klasse "A" fehlt. Hast du die vorgegebene Methodensignatur veraendert?</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A eine Methode mit einer bestimmten Signatur enthält, wobei der Name des Methodenparameters unerheblich ist.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="4">
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations2} m and
hasSignature(m, "int method()") and
isEmpty(m -->{Child}&{Modifier})
report 0 end
</query>
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}, mo : V{Modifier}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations2} m and
hasSignature(m, "int method()") and
m --> mo and not (mo.name="private")
report 0 end
</query>
<feedback prefix="Signaturcheck">Die Methode "int method()" in der Klasse "A" fehlt oder ist mit dem Modifier "private" versehen. Hast du die vorgegebene Methodensignatur veraendert?</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A eine Methode mit einer bestimmten Signatur enthält, die nicht mit dem Modifier private versehen ist.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="1">
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}, pt : V{ParameterizedType}, ptt : V{SimpleType}, pta : V{SimpleType}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations2} m and
m.name="m" and
m -->{MethodDeclarationReturnType} pt and
pt -->{ParameterizedTypeType} ptt and
ptt.name="B" and
pt -->{ParameterizedTypeTypeArguments1} pta and
pta.name="C"
report 0 end
</query>
<feedback prefix="Signatur">Der Methode "public B<C> m()" in der Klasse "A" fehlt. Hast du die vorgegebene Methodensignatur veraendert?</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A eine Methode m mit parametrisierten Rückgabetyp B<C> enthält.

=== Vererbungshierarchie ===
<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from t : V{TypeDeclaration}, st : V{SimpleType}
with
t.name="A" and
st.name="B" and
t -->{TypeDeclarationSuperclassType2} st
report 0 end
</query>
<feedback prefix="Typhierarchie">A ist nicht als Unterklasse von B modelliert.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A direkte Unterklasse von Klasse B ist.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="1">
<query>from t : V{TypeDeclaration}, st : V{SimpleType}
with
t.name="A" and
t -->{TypeDeclarationSuperInterfaceTypes2} st and
st.name="B"
report 0 end
</query>
<feedback prefix="Typhierarchie">A implementiert nicht das Interface B.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A das Interface B implementiert.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="1">
<query>from t : V{TypeDeclaration}, pt : V{ParameterizedType}, ptt : V{SimpleType}, pta : V{SimpleType}
with
t.name="A" and
t -->{TypeDeclarationSuperInterfaceTypes1} pt and
pt -->{ParameterizedTypeType} ptt and
ptt.name="B" and
pt -->{ParameterizedTypeTypeArguments1} pta and
pta.name="C"
report 0 end
</query>
<feedback prefix="Typhierarchie">A implementiert nicht das Interface B<C>.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A das Interface B<C> implementiert.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="3">
<query>from u : V{TypeDeclaration}, s : V{SimpleType}
with
((u -->{TypeDeclarationSuperclassType2} s and s.name="Thread") or
(u -->{TypeDeclarationSuperInterfaceTypes2} s and s.name="Runnable")) and
u.name="A"
report 0 end
</query>
<feedback>In der Klasse "A" sollte entweder das Interface "Runnable" implementieren oder von "Thread" erben.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A das Interface Runnable implementiert oder von Thread erbt.

=== Aufrufbeziehungen ===
<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from u : V{TypeDeclaration}, x : V{MethodInvocation}, y : V{SimpleName}
with
u -->* x -->{ElementExpression} y and
u.name="A" and
x.name="m" and
y.name="B"
report 0 end
</query>
<feedback>In der Klasse "A" sollte "B.m()" aufgerufen werden.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A eine Methode B.m aufruft.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from u : V{TypeDeclaration}, x : V{MethodInvocation}, y : V{SimpleName}, z : V{VariableDeclarationStatement}, f : V{VariableDeclarationFragment}, t : V{SimpleType}
with
u -->* x -->{ElementExpression} y and
u -->* z -->{VariableDeclarationStatementType} t and
u -->* z -->{VariableDeclarationStatementFragments} f and
u.name="A" and
x.name="m" and
y.name=f.name and
t.name="B"
report 0 end
</query>
<feedback>In der Klasse "A" sollte "m()" auf einem Objekt vom Typ "B" aufgerufen werden.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A Methode m auf einem Objekt vom Typ B aufruft.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="4">
<query>from u : V{TypeDeclaration}, m : V{MethodDeclaration}, x : V{ClassInstanceCreation}, t : V{SimpleType}
with
u -->{Child}* m -->* x -->{ClassInstanceCreationType} t and
u.name="A" and
m.name="m" and
t.name="B"
report 0 end
</query>
<feedback>In der Klasse "A" muss in Methode m() mindestens eine Instanz von "B" erzeugt werden.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob Klasse A in Methode m eine Instanz von Klasse B erstellt.

== Beispiele für statische Prüfregeln für UML-Modelle im XMI2-Format ==
=== Klassendiagramme ===
<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="11">
<query>from x,y : V{Class}
with
x --> V{Property} --> V{Association} <-- V{Property} <-- y and
isDefined(x.name) and x.name="A" and
isDefined(y.name) and y.name="B"
report 1 end
</query>
<feedback>Das Diagramm enthält keine Beziehung zwischen einem "A" und einem "B" oder keine Klassen mit diesen Namen.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob das Modell zwei Klassen "A" und "B" enthält, die über eine Assoziation verbunden sind.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="0">
<query>from x,y : V{Class}
with
x --> V{Property} --> V{Association} <-- V{Property} <-- y and
isDefined(x.name) and x.name="A" and
isDefined(y.name) and y.name="B"
report 1 end
</query>
<feedback prefix="Hinweis">Im Diagramm sind die "B" eines "A" als eigene Klasse abgebildet. Das kannst du durch eine bessere Modellierung vermeiden.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft ebenfalls, ob das Modell zwei Klassen "A" und "B" enthält, die über eine Assoziation verbunden sind, definiert dies aber als unerwünschte Situation mit entsprechendem Feedback.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="11">
<query>from x,y : V{Class}, z: V{Property}
with
x --> z and
z --> V{Association} <-- V{Property} <-- y and
isDefined(x.name) and x.name="A" and
isDefined(y.name) and y.name="B" and
isDefined(z.lower) and z.lower="1" and (not isDefined(z.upper) or z.upper="1")
report 1 end
</query>
<feedback>Das Diagramm enthält keine Beziehung zwischen einem "A" und einem "B" mit der Kardinalität 1 oder keine Klassen mit diesen Namen.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob das Modell zwei Klassen "A" und "B" enthält, die über eine Assoziation mit Kardinalität 1 (jedes A kennt genau ein B) verbunden sind.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from a,b : V{Class}, p: V{Property}
with
isEmpty(a -->&{Property} -->&{Association}) and
b --> p and
isDefined(p.aggregation) and p.aggregation="composite"
report 1 end
</query>
<feedback>Es sollte im Diagramm zwei Klassen geben, bei denen die eine keine weiteren Bestandteile hat, während die andere weitere Bestandteile gemäß der Komposition hat.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob es im Modell eine Klasse ohne ausgehende Assoziationen gibt und eine weitere, die mindestens eine ausgehende Komposition hat.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from x : V{Class}, y : V{Property}, z : V{PrimitiveType}
with
isDefined(x.name) and x.name="A" and
x --> y and
isDefined(y.name) and y.name="b" and
y --> z and
isDefined(z.name) and z.name="String"
report 1 end
</query>
<feedback>Ein "A" soll ein Attribut für die Eigenschaft "b" bereitstellen.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob es im Modell eine Klasse "A" mit dem Attribut "b" vom Typ "String" gibt.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from x : V{Class}, y : V{Operation}, z: V{Parameter}
with
isDefined(x.name) and x.name="A" and
x --> y and
isDefined(y.name) and stringLevenshteinDistance(y.name, "ausführen")<3 and
y --> z
report 1 end
</query>
<feedback>Ein "A" soll eine Methode bereitstellen, mit der sie etwas ausführen kann.</feedback>
</rule>
</syntaxhighlight>
Diese Regel prüft, ob es im Modell eine Klasse "A" mit einer Operation gibt, deren Name "ausführen" oder ähnlich lautet.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="4">
<query>let c := count(from y : V{Operation} with isDefined(y.name) report y end) in
from x : set(1)
with
c<>7
report c as "count" end
</query>
<feedback>Das Diagramm sollte genau 7 Methoden enthalten, enthält aber {count}.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob das Modell genau 7 Methoden enthält und gibt im Falle einer anderen Anzahl diese im Feedback mit aus.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from x : V{Class}
with
isDefined(x.name) and x.name=A" and
x.isAbstract and
not isEmpty(x <--&{Generalization})
report 1 end
</query>
<feedback>Das Diagramm sollte eine abstrakte Klasse "A" enthalten, von der mindestens eine Klasse erbt.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob das Modell eine abstrakte Klasse "A" enthält, auf die in mindestens einer Generalisierung verwiesen wird.

<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from a,b,c,d : V{Class}
with
isDefined(a.name) and a.name="A" and
isDefined(b.name) and b.name="B" and
isDefined(c.name) and c.name="C" and
isDefined(d.name) and d.name="D" and
a --> V{Generalization} --> d and
b --> V{Generalization} --> d and
c --> V{Generalization} --> d
report 1 end
</query>
<feedback>Das Diagramm sollte Klassen "A", "B" und "C" enthalten, die von einer gemeinsamen Oberklasse "D" erben.</feedback>
</rule>
</syntaxhighlight>
Diese Regel überprüft, ob das Modell eine Klasse "D" enthält, die drei direkte Unterklassen "A", "B" und "C" hat.

== Beispiele für statische Prüfregeln für EPML ==
<syntaxhighlight lang="xml" line='line'>
<rule type="presence" points="5">
<query>from x: V{Event}
with
isEmpty(x <--)
report 0 end
</query>
<feedback prefix="Fehlerhafte Grundelemente">Es gibt kein Startevent.</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob der gegebene Graph kein Startevent hat.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="5">
<query> from x,y: V{Event}
with
isEmpty(x <--) and
isEmpty(y <--) and
not (x=y)
report 0 end
</query>
<feedback prefix="Fehlerhafte Grundelemente">Es gibt mehr als ein Startevent.</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob der gegebene Graph mehr als ein Startevent hat.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="3">
<query> from x,y: V{Element, ^Connector}
with
not (x.name="") and
x.name = y.name and
not (x = y)
report x.name as "name" end
</query>
<feedback prefix="Anmerkung zur Namensgebung">Es gibt mindestens zwei Elemente mit demselben Namen ("{name}").</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob es der Graph Elemente mit demselben Namen besitzt.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="4">
<query>from x: V{Element, ^Connector}, y1, y2 : V{Element}
with
x --> y1 and
x --> y2 and
not (y1=y2)
report x.name as "xName", x.id as "xID" end
</query>
<feedback prefix="Fehlerhafte Grundstruktur">Das Element "{xName}" (ID {xID}) hat mehr als einen Ausgang.</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob ein Event oder Funktion mehr als einen Ausgang hat.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="4">
<query>from x: V{Connector}, y: V{Connector}
with
not (x.name="") and
not (y.name="") and
x --> y
report x.name as "xName", y.name as "yName", x.id as "xID", y.id as "yID" end
</query>
<feedback prefix="Fehlerhafte Grundstruktur">Es dürfen keine zwei Konnektoren direkt aufeinander folgen. Es folgt jedoch "{yName}" (ID {yID}) direkt auf "{xName}" (ID {xID}).</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob 2 Konnektoren aufeinander folgen.

<syntaxhighlight lang="xml" line='line'>
<rule type="absence" points="1">
<query>from x: V{Element, ^Connector}
with
contains(x.name, " and ") or
contains(x.name, "+") or
contains(x.name, " und ")
report x.name as "name" end
</query>
<feedback prefix="Anmerkung zur Namensgebung">Der Name "{name}" sieht danach aus, als wenn hier zwei Events bzw. Funktionen in einem Element zusammengefasst wurden.</feedback>
</rule>
</syntaxhighlight>
Diese Regel testet, ob der Graph möglicherweise Zeichen bzw. Wörter besitzt die mehrere Funktionen/Events in einem Element verbinden.

[[Category:R-GReQL]]

Kursangebot (Studierendensicht)

2019-10-04T09:58:47Z

RSchypula:

{{Vorlage:Warnung|Warnung=Diese Seite beschreibt die Kursanmelung im JACK3 System. JACK3 ist derzeit noch in Entwicklung und noch nicht für die Benutzung freigegeben.}}

[[category:JACK3]][[category:Anleitung]]

JACK3

2019-09-27T12:17:07Z

RSchypula:

JACK 3 ist die neuste Version des JACK Systems welches sich derzeit noch in Entwicklung befindet. Von dieser Seite aus wird auf die künftigen Funktionen des JACK 3 Systems verlinkt.

'''JACK 3 Funktionen für Lehrende'''

* [[JACK3:Anmeldung|Anmeldung JACK 3]]
* [[JACK3:Übersicht|Übersicht JACK 3]]
* Aufgaben erstellen
** Aufgabenordner
** Allgemeine Aufgaben Funktionen
** Hinweise
** Mehrstufige Aufgabe
** Multiple Choice Aufgabe
** Fill-In Aufgabe
** Variablen
* Aufgabenbearbeitung einsehen
* Kurs
* Kursangebot
* Kursanmeldung
 

'''JACK 3 Funktionen für Lernende'''
* [[JACK3:Anmeldung|Anmeldung JACK 3]]
* Kurs auswählen
* Aufgabe bearbeiten
** Multiple Choice Aufgabe
** Fill-In Aufgabe
** Formulareditor

JACK3

2019-09-26T14:39:48Z

RSchypula:

JACK3

2019-09-26T14:05:14Z

RSchypula:

JACK3

2019-09-26T14:01:18Z

RSchypula:

JACK3

2019-09-26T13:34:45Z

RSchypula: Die Seite wurde neu angelegt: „JACK 3 ist die neuste Version des JACK Systems welches sich derzeit noch in Entwicklung befindet. Von dieser Seite aus wird auf die künftigen Funktionen des J…“

JACK 3 ist die neuste Version des JACK Systems welches sich derzeit noch in Entwicklung befindet. Von dieser Seite aus wird auf die künftigen Funktionen des JACK 3 Systems verlinkt.

'''JACK 3 Funktionen'''

* Anmeldung JACK 3
* Inhalte erstellen
** Ordner
** Eine Aufgabe erstellen
** Multiple Choice Aufgabe
** Fill-In Aufgabe

GReQL Regeln

2018-07-09T10:02:41Z

RSchypula: /* Beispiele für statische Prüfregeln für Java-Code */

== Beispiele für statische Prüfregeln für Java-Code ==
=== Codestil ===
<rule type="absence" points="0">
<query>from x : V{MethodDeclaration}
with
x.name=capitalizeFirst(x.name) and
x.constructor="false"
report 0 end
</query>
<feedback prefix="Hinweis (ohne Punktabzug)">Du verwendest Methodennamen, die mit einem Großbuchstaben beginnen. Das ist möglich, aber es entspricht nicht dem üblichen Programmierstil für Java.</feedback>
</rule>
Diese Regel sucht nach groß geschriebenen Methodennamen.

<rule type="absence" points="0">
<query>from x : V{TypeDeclaration}
with
not (x.name=capitalizeFirst(x.name))
report 0 end
</query>
<feedback prefix="Hinweis (ohne Punktabzug)">Du verwendest Klassennamen, die nicht mit einem Großbuchstaben beginnen. Das ist möglich, aber es entspricht nicht dem üblichen Programmierstil für Java.</feedback>
</rule>
Diese Regel sucht nach klein geschriebenen Klassennamen.

<rule type="absence" points="0">
<query>from x : V{VariableDeclarationFragment}
with
x.name=capitalizeFirst(x.name) and
isEmpty(from m : V{Modifier} with x <nowiki>&lt;--&amp;{FieldDeclaration} --&gt;</nowiki> m and m.name="final" report m end)
report 0 end
</query>
<feedback prefix="Hinweis (ohne Punktabzug)">Du verwendest Variablennamen, die mit einem Großbuchstaben beginnen. Das ist möglich, aber es entspricht nicht dem üblichen Programmierstil für Java.</feedback>
</rule>
Diese Regel sucht nach groß geschriebenen Variablennamen, wobei als "final" deklarierte Klassenvariablen ausgelassen werden.

=== Einfache Inhalte ===
<rule type="presence" points="2">
<query>from m : V{MethodDeclaration}, s : V{StringLiteral}
with
m.name="m" and
m -->{Child}* s and
s.content = "\"Zeichenkette\""
report 0 end
</query>
<feedback>Deine Lösung verwendet nicht den String "Zeichenkette".</feedback>
</rule>
Diese Regel sucht in der Methode <code>m</code> nach einem String-Literal mit einem vorgegebenen Inhalt.

<rule type="absence" points="2">
<query>from m : V{MethodDeclaration}, s : V{StringLiteral}
with
m.name="m" and
m -->{Child}* s and
stringLength(s.content) > 4
report s.line as "line" end
</query>
<feedback>Du verwendest in Zeile {line} ein festes String-Literal. Ist deine Lösung allgemeingültig?</feedback>
</rule>
Diese Regel sucht in der Methode <code>m</code> nach einem String-Literal der Länge 4 oder länger (inklusive Anführungszeichen) und meldet es mit Angabe der Zeilennummer als Fehler.

<rule type="absence" points="0">
<query>from p : V{PackageDeclaration}
report 0 end
</query>
<feedback prefix="Paketdefinition">Deine Lösung beinhaltet eine package-Angabe. Bitte entferne diese.</feedback>
</rule>
Diese Regel sucht nach Paketdefinitionen und meldet diese als Fehler.

<rule type="absence" points="1">
<query>from u : V{CompilationUnit}, x : V{MethodInvocation}, y : V{SimpleName}
with
u -->* x -->{ElementExpression} y and
x.name="exit" and
y.name="System"
report u.name as "name", x.line as "line" end
</query>
<feedback>Der Aufruf von "System.exit()" in der Datei {name} in Zeile {line} ist nicht gestattet.</feedback>
</rule>
Diese Regel sucht nach Aufrufen von System.exit() und melde diese unter Angabe von Klasse und Zeilennummer als Fehler.

=== Kontrollstrukturen ===
<rule type="absence" points="4">
<query>from m : V{MethodDeclaration}
with
m.name="m" and
isEmpty(m -->{Child}*&{WhileStatement}) and
isEmpty(m -->{Child}*&{DoStatement}) and
isEmpty(m -->{Child}*&{ForStatement}) and
isEmpty(m -->{Child}*&{EnhancedForStatement})
report 0 end
</query>
<feedback>In der Methode "m()" wird kein Schleifenkonstrukt verwendet.</feedback>
</rule>
Diese Regel überprüft, ob Methode <code>m</code> ein beliebiges Schleifenkonstrukt enthält.

<rule type="absence" points="2">
<query>from u : V{CompilationUnit}, x : V{IfStatement}
with
( not isEmpty(u -->* x -->{IfStatementThenStatement}&{EmptyStatement}) or
(not isEmpty(u -->* x -->{IfStatementThenStatement}&{Block}) and isEmpty(u -->* x -->{IfStatementThenStatement}&{Block} -->{Child}))
) and
( not isEmpty(u -->* x -->{IfStatementElseStatement}&{EmptyStatement}) or
(not isEmpty(u -->* x -->{IfStatementElseStatement}&{Block}) and isEmpty(u -->* x -->{IfStatementElseStatement}&{Block} -->{Child}))
)
report u.name as "name", x.line as "line" end
</query>
<feedback>In der Datei {name} enthält das if-Statement in Zeile {line} in beiden Zweigen keinen Code und ist dadurch sinnlos.</feedback>
</rule>
Diese Regel sucht nach einer if-Anweisung, die nur leere Zweige enthält und meldet eine solche Anweisung als Fehler.

<rule type="absence" points="2">
<query>from u : V{CompilationUnit}, x : V{IfStatement}
with
not isEmpty(u -->* x -->{IfStatementThenStatement}&{EmptyStatement}) and
isEmpty(x -->{IfStatementElseStatement}&{Statement})
report u.name as "name", x.line as "line" end
</query>
<feedback>In der Datei {name} endet das if-Statement in Zeile {line} hinter der Bedingung sofort mit einem Semikolon. Die Bedingung ist dadurch wirkungslos und die folgende Anweisung wird immer ausgeführt.</feedback>
</rule>
Diese Regel sucht nach einer if-Anweisung, die keine Zweige enthält und meldet eine solche Anweisung als Fehler.

<rule type="absence" points="2">
<query>from u : V{CompilationUnit}, x : V{WhileStatement}
with
not isEmpty(u -->* x -->{WhileStatementBody}&{EmptyStatement}) or
(not isEmpty(u -->* x -->{WhileStatementBody}&{Block}) and
isEmpty(u -->* x -->{WhileStatementBody}&{Block} -->{Child}))
report u.name as "name", x.line as "line" end
</query>
<feedback>In der Datei {name} besteht die while-Schleife in Zeile {line} nur aus einer Abbruchbedingung und ist dadurch sinnlos.</feedback>
</rule>
Diese Regel sucht nach einer while-Schleife, die nur aus einer Abbruchbedingung besteht und meldet eine solche Schleife als Fehler.

<rule type="presence" points="1">
<query>from m : V{MethodDeclaration}, n : V{MethodDeclaration}
with
m (-->{Child}*&{MethodInvocation} -->{Access}&{MethodDeclaration})* n and
n -->{Child}*&{MethodInvocation} -->{Access} m and
m.name="m"
report 0 end
</query>
<feedback prefix="Rekursionscheck"> Die Methode "m()" enthält nicht die geforderte Rekursion.</feedback>
</rule>
Diese Regel überprüft, ob Methode <code>m</code> rekursiv arbeitet. Dabei ist es egal, ob sich die Methode direkt selber aufruft, oder über einen oder mehrere Zwischenschritte aufgerufen wird.

<rule type="presence" points="5">
<query>from m : V{MethodDeclaration}
with
m (-->{Child}*&{MethodInvocation} -->{Access}&{MethodDeclaration}) m and
m.name="m"
report 0 end
</query>
<feedback prefix="Rekursionscheck">Die Methode "m()" enthält nicht die geforderte Rekursion.</feedback>
</rule>
Diese Regel überprüft, ob Methode <code>m</code> rekursiv arbeitet und sich insbesondere ohne Zwischenschritte über andere Methoden selber wieder aufruft.

=== Methoden ===
<rule type="presence" points="4">
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations2} m and
hasSignature(m, "public static String method(int)")
report 0 end
</query>
<feedback prefix="Signaturcheck">Die Methode "public static String method(int param)" in der Klasse "A" fehlt. Hast du die vorgegebene Methodensignatur veraendert?</feedback>
</rule>
Diese Regel überprüft, ob Klasse A eine Methode mit einer bestimmten Signatur enthält, wobei der Name des Methodenparameters unerheblich ist.

<rule type="presence" points="4">
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations2} m and
hasSignature(m, "int method()") and
isEmpty(m -->{Child}&{Modifier})
report 0 end
</query>
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}, mo : V{Modifier}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations2} m and
hasSignature(m, "int method()") and
m --> mo and not (mo.name="private")
report 0 end
</query>
<feedback prefix="Signaturcheck">Die Methode "int method()" in der Klasse "A" fehlt oder ist mit dem Modifier "private" versehen. Hast du die vorgegebene Methodensignatur veraendert?</feedback>
</rule>
Diese Regel überprüft, ob Klasse A eine Methode mit einer bestimmten Signatur enthält, die nicht mit dem Modifier private versehen ist.

<rule type="presence" points="1">
<query>from t : V{TypeDeclaration}, m : V{MethodDeclaration}, pt : V{ParameterizedType}, ptt : V{SimpleType}, pta : V{SimpleType}
with
t.name="A" and
t -->{TypeDeclarationBodyDeclarations2} m and
m.name="m" and
m -->{MethodDeclarationReturnType} pt and
pt -->{ParameterizedTypeType} ptt and
ptt.name="B" and
pt -->{ParameterizedTypeTypeArguments1} pta and
pta.name="C"
report 0 end
</query>
<feedback prefix="Signatur">Der Methode "public B<C> m()" in der Klasse "A" fehlt. Hast du die vorgegebene Methodensignatur veraendert?</feedback>
</rule>
Diese Regel überprüft, ob Klasse A eine Methode m mit parametrisierten Rückgabetyp B<C> enthält.

=== Vererbungshierarchie ===
<rule type="presence" points="5">
<query>from t : V{TypeDeclaration}, st : V{SimpleType}
with
t.name="A" and
st.name="B" and
t -->{TypeDeclarationSuperclassType2} st
report 0 end
</query>
<feedback prefix="Typhierarchie">A ist nicht als Unterklasse von B modelliert.</feedback>
</rule>
Diese Regel überprüft, ob Klasse A direkte Unterklasse von Klasse B ist.

<rule type="presence" points="1">
<query>from t : V{TypeDeclaration}, st : V{SimpleType}
with
t.name="A" and
t -->{TypeDeclarationSuperInterfaceTypes2} st and
st.name="B"
report 0 end
</query>
<feedback prefix="Typhierarchie">A implementiert nicht das Interface B.</feedback>
</rule>
Diese Regel überprüft, ob Klasse A das Interface B implementiert.

<rule type="presence" points="1">
<query>from t : V{TypeDeclaration}, pt : V{ParameterizedType}, ptt : V{SimpleType}, pta : V{SimpleType}
with
t.name="A" and
t -->{TypeDeclarationSuperInterfaceTypes1} pt and
pt -->{ParameterizedTypeType} ptt and
ptt.name="B" and
pt -->{ParameterizedTypeTypeArguments1} pta and
pta.name="C"
report 0 end
</query>
<feedback prefix="Typhierarchie">A implementiert nicht das Interface B<C>.</feedback>
</rule>
Diese Regel überprüft, ob Klasse A das Interface B<C> implementiert.

<rule type="presence" points="3">
<query>from u : V{TypeDeclaration}, s : V{SimpleType}
with
((u -->{TypeDeclarationSuperclassType2} s and s.name="Thread") or
(u -->{TypeDeclarationSuperInterfaceTypes2} s and s.name="Runnable")) and
u.name="A"
report 0 end
</query>
<feedback>In der Klasse "A" sollte entweder das Interface "Runnable" implementieren oder von "Thread" erben.</feedback>
</rule>
Diese Regel überprüft, ob Klasse A das Interface Runnable implementiert oder von Thread erbt.

=== Aufrufbeziehungen ===
<rule type="presence" points="5">
<query>from u : V{TypeDeclaration}, x : V{MethodInvocation}, y : V{SimpleName}
with
u -->* x -->{ElementExpression} y and
u.name="A" and
x.name="m" and
y.name="B"
report 0 end
</query>
<feedback>In der Klasse "A" sollte "B.m()" aufgerufen werden.</feedback>
</rule>
Diese Regel überprüft, ob Klasse A eine Methode B.m aufruft.

<rule type="presence" points="5">
<query>from u : V{TypeDeclaration}, x : V{MethodInvocation}, y : V{SimpleName}, z : V{VariableDeclarationStatement}, f : V{VariableDeclarationFragment}, t : V{SimpleType}
with
u -->* x -->{ElementExpression} y and
u -->* z -->{VariableDeclarationStatementType} t and
u -->* z -->{VariableDeclarationStatementFragments} f and
u.name="A" and
x.name="m" and
y.name=f.name and
t.name="B"
report 0 end
</query>
<feedback>In der Klasse "A" sollte "m()" auf einem Objekt vom Typ "B" aufgerufen werden.</feedback>
</rule>
Diese Regel überprüft, ob Klasse A Methode m auf einem Objekt vom Typ B aufruft.

<rule type="presence" points="4">
<query>from u : V{TypeDeclaration}, m : V{MethodDeclaration}, x : V{ClassInstanceCreation}, t : V{SimpleType}
with
u -->{Child}* m -->* x -->{ClassInstanceCreationType} t and
u.name="A" and
m.name="m" and
t.name="B"
report 0 end
</query>
<feedback>In der Klasse "A" muss in Methode m() mindestens eine Instanz von "B" erzeugt werden.</feedback>
</rule>
Diese Regel überprüft, ob Klasse A in Methode m eine Instanz von Klasse B erstellt.