Zusammensetzung des Parameter-Array $modul_param

 Im Parameter-Array $modul_param für die Funktion modul_extmod sind alle Informationen enthalten, die für die Steuerung des Submoduls selber und für Steuerung des Zugriffs auf die Datenbank von außen nötig sind. Diese Bestandteile des Arrays sind in Tabelle zusammengefasst.

 

english Schlüssel german english zugehöriger Wert des Attributs 'paramkey' in der Relation 'workflow_extmod_param' german english Beschreibung german

english id german english String, mandatory. Wie alle anderen Submodule, muss auch diesem Submodul eine im Workflow-Schritt eindeutige ID zugewiesen werden, damit die Ablaufsteuerung funktioniert. german

english extmod_id german english String, mandatory. Über diese ID wird festgelegt, für welches externe Modul die Werte bestimmt sind, die in die Relation 'workflow_extmod_param' eingetragen werden. Das externe Modul kann mit Hilfe dieser ID seine Werte auslesen. german

english aufruf_id german english String, mandatory. Über diese ID wird festgelegt, für welchen Aufruf des externen Moduls die Werte bestimmt sind, die in die Relation 'workflow_extmod_param' eingetragen werden. Das externe Modul kann mit Hilfe dieser ID die zur Aufrufsituation passenden Werte auslesen. german

english user german english String. Eine durch Kommata getrennte Liste von Benutzern, die Zugriff auf die Views und temporären Tabellen erhalten sollen. german

english insert german 3749english table_insert_list und

table_get_attribs german english Array. Enthält Informationen zu einem oder mehreren Views. Diese Views können im externen Modul zum Einfügen oder Aktualisieren von Tupeln verwendet werden. german

english check german english table_check german english Array. Wie 'insert', aber kann nur Informationen zu genau einem View aufnehmen. Dieser View kann im externen Modul zur Überprüfung von eingegebenen Werten verwendet werden. german

english new_tupel german english table_new german english Array. Enthält alle Informationen zur Erzeugung einer temporären Tabelle. Diese kann im externen Modul verwendet werden um neue Tupel aufzunehmen. german

english usertext german english Array. Texte, die am Anfang und Ende des Submoduls ausgegeben werden. Siehe german

Zur Tabelle sind noch folgende Bemerkungen zu machen:

• extmod_id, aufruf_id: Die Relation workflow_extmod_param enthält Einträge für die verschiedenen externen Module, auch aus unterschiedlichen Workflows. Damit die Einträge den richtigen externen Modulen zugeordnet werden können, wird in der Relation immer die Workflownummer und die extmod_id mit abgespeichert. Unter Umständen wird ein externes Modul mehrmals in einem Workflow benutzt. Beispielsweise kann ein Anmeldungs-Modul für eine Vorlesungs- und eine Klausuranmeldung verwendet werden. Damit klar ist für welchen Verwendungszweck die Werte in workflow_extmod_param bestimmt sind, wird eine Aufruf-ID eingetragen. Über die Attribute workflownummer, extmod_id und aufruf_id kann das externe Modul so ``seine'' Parameter aus der Relation heraus holen.
• user: Sind in insert, check oder new_tupel Benutzer definiert, wird der Eintrag in 'user' für den zugehörigen View bzw. temporäre Tabelle ignoriert. Der String 'user' kann deshalb als eine Art Default aufgefasst werden. Gruppen werden durch ein vor dem Gruppennamen stehendes ``group'' gekennzeichnet.

Darüberhinaus können wie eingangs erwähnt beliebige Werte über die Relation workflow_extmod_param an das externe Modul übergeben werden. Die zugehörigen Schlüssel im Array beginnen alle mit ``ext_'' und sind in Tabelle beschrieben. Das ``ext_'' wird vor dem Eintrag in die Relation workflow_extmod_param entfernt. Die Schlüssel beziehen sich fast alle auf die aus DBTable-Submodul (Abschnitt 4.3) bekannten Schlüssel. Ihre genaue Verwendung sollte man deshalb dort nachschlagen. Allerdings kann der Modul-Programmierer die Schlüssel auch für andere Zwecke ``missbrauchen''.

 

english Schlüssel german english Beschreibung german

english ext_texte german english Array. Enthält Texte, die im externen Modul ausgegeben werden sollen. Dies ist besonders dann sinnvoll, wenn ein Modul in verschiedenen Situationen verwendet werden soll. german

english ext_form_param german english Array. Parameter für Formulare. german

english ext_cols german english Array. Liste von Feldern, die angezeigt werden sollen. Für die Views gedacht. german

english ext_tmp_table_cols german english Array. Liste von Feldern, die angezeigt werden sollen. Für die temporäre Tabelle gedacht. german

english ext_table_param german english Array. Parameter für Tabellen german

english ext_values german english Array. Durch den Modulu-Programmierer vorgegebene Werte german

english ext_dataconversion german english Array. Datenkonvertierungsfunktionen, die auf die angegebenen Felder angewendet werden sollen. german

Zur Tabelle sind noch folgenden Bemerkungen nötig:

• ext_texte: Beginnt der Schlüssel eines Textes mit ``html`` wird der Text vor dem Eintrag in workflow_extmod_param für HTML vorbereitet (z. B. Umlautkodierung: ä -> ä). Als Schlüssel können ansonsten beliebige Strings verwendet werden, beispielsweise für Titel, Überschriften und Meldungen.
• ext_form_param: Lookup-Queries werden vor dem Eintrag in workflow_extmod_param aufgelöst, da davon ausgegangen werden muss, dass dies aus dem externen Modul heraus wegen fehlender DB-Rechte nicht möglich ist.

Das folgende Beispiel erzeugt noch keine Views oder temporäre Tabellen. Es werden lediglich die Texte in ext_texte in die Relation workflow_extmod_param eingetragen. Dabei wird der Text mit dem Schlüssel ``htmltext'' für HTML kodiert. Die Einträge in die Relation sind für ein externes Modul mit der ID ``extmod1'' unter einem Aufruf mit der ID ``test'' bestimmt.

• []$modul_param = array( 

    id=>"steuerung_extmod", 

    extmod_id=>"extmod1", 

    aufruf_id=>"test", 

    usertext=>array( 

      htmlpre=>"<h4>Eintragen und Löschen von 

        Tupeln in workflow_extmod_param</h4>", 

    ), 

    ext_texte=>array( 

      titel=>"Externes Modul", 

      htmltext=>"Möglicher Aufruf des externen Moduls", 

    ), 

  ); 
  

  modul_extmod($modul_param);