Projekt

Allgemein

Profil

Modules-MetaInfo » Historie » Version 11

[E] Rocco Kreutz, 22.05.2024 16:25

1 1 [E] Rocco Kreutz
h1. Modules-MetaInfo
2
3
Für alle Module(Forms) welche direkt ansprechbar sein müssen (Shortname URL-Link)
4 4 [E] Rocco Kreutz
* Meta-Info wird intern als JSON-Objekt gespeichert
5
* Der genaue Inhalt wird in Zukunft erweitert und die genaue Dokumentation dazu erfolgt später
6
* Derzeit soll nur {}->CMETA_SHORTNAME angepasst werden, um eigene Shortname-URL-Links generieren zukönnen
7 1 [E] Rocco Kreutz
8 4 [E] Rocco Kreutz
h4. >
9
10 1 [E] Rocco Kreutz
* Alle Module (Forms) generieren intern Meta-Info ("siehe auch":https://redmine.prodat-sql.de/projects/prodat-v12-public/wiki/DynGrid_als_URL)
11 6 [E] Rocco Kreutz
* Diese Informationen werden im "Admin Area" Tab "Make URL-Link" Button "Write Default Meta-Info" in die Datenbank geschrieben, für alle Module welche sich im Programm registriert haben
12 1 [E] Rocco Kreutz
** Nicht jedes Modul registriert sich
13
*** Der Exception-Dialog z.B. registriert sich nicht, da er ein Kern-Element der Anwendung ist
14
*** Andere Formulare registrieren sich nicht, da nicht vorgesehen ist, diese explizit ansprechen zu können bzw. das Verhalten zu verändern
15 2 [E] Rocco Kreutz
** Diese Einträge werden mit mmm_default = True geschrieben, im Gegensatz dazu werden von Benutzern definerte Einträge mit mmm_default = False geschrieben !!!
16 1 [E] Rocco Kreutz
*** Alle Default-Einträge dürfen nicht editiert werden, mit Ausnahme der Spalten mmm_access_roles_allow und mmm_access_roles_deny
17 2 [E] Rocco Kreutz
**** Hier handelt es sich um Komma-Separierte String-Listen von DB-Rollen
18
**** Deny hat Vorrang vor Allow
19
**** Die Auswertung berücksichtigt rekursive Rollen/Mitgliedschaften
20 3 [E] Rocco Kreutz
* Für jedes registrierte Modul ("Default-Einträge"), kann hier ein override definiert werden
21
** Um eigene/angepasste Shortname-URL-Links zu definieren bzw. Parameter anzupasssen
22
** Alle Eingenschaften anzupassen, welche auch in einem URL-Link definiert/angepasst werden können
23 1 [E] Rocco Kreutz
** Die Spalte mmm_metainfo muss korrekt gesetzt sein, am einfachsten geht dies, indem man den Wert des zugehörigen Default-Eintrages kopiert !!!
24 6 [E] Rocco Kreutz
25
26
h4. >
27
28
* All diese Anpassungen bzgl. Modulen können gemacht sofern die Default-Einträge in der Tabelle public.modulesmeta_mobile stehen. Was im Moment MANUELL gemacht werden muss!
29 5 [E] Rocco Kreutz
30
!clipboard-202405071556-ae6cj.png!
31 7 [E] Rocco Kreutz
32
33
h3. URL-Erstellen
34
35
* https://<domain>:<port>/?openmodule=<shortname>&<param1_of_shortname>=<param1_value>&<param2_of_shortname>=<param1_value>
36
* <domain>: p2017srv.prodat-sql.de
37
* <port>: 8091
38
* <shortname>: abk (Module[Default]: CimW.ABK.FormProduktAuftragU.TCimWFormProduktAuftrag)
39
** Siehe obige Tabelle Spalte 'mm_shortname'
40
* <param1_of_shortname> .. <param2_of_shortname>: ab_ix
41
** Die Parameter sind in der Meta-Info aufgelistet, als Unterobjekt {}->CMETA_PARAMS
42
** {"CMETA_MODULE": "CimW.ABK.FormProduktAuftragU.TCimWFormProduktAuftrag", "CMETA_PARAMS": {"ab_ix": "ABK"}, "CMETA_SHORTNAME": "abk", "CMETA_MULTIPLE_INSTANCES_ALLOWED": true}
43
** CMETA_PARAMS": {"ab_ix": "ABK"}
44 8 [E] Rocco Kreutz
45 9 [E] Rocco Kreutz
h2. Short-URL-Links / Overrides
46 8 [E] Rocco Kreutz
47 9 [E] Rocco Kreutz
*!!! Alle Namen in den MetaInfos sind Case-Sensitiv !!!*
48
*!!! Damit sind auch die ParameterNamen in der URL case sensitiv !!!*
49
*!!! Alle JSONWerte, welche im namen mit _info beginnen, sind nur zur dokumentation für Entwickler/Bearbeiter!!!*
50 8 [E] Rocco Kreutz
51 1 [E] Rocco Kreutz
52 9 [E] Rocco Kreutz
* Hier wurden 2 overrides definiert
53
** !clipboard-202405221544-nnbl8.png!
54
** CimW.BDE.FormBDEU.TCimWFormBDETaskOnly mit dem mmm_shortname = bde-abk
55
** CimW.Core.FormSSQLGridU.TCimWFormSSQLGrid mit dem mmm_shortname = open-op
56
** Dadurch kann auf das BDE-Modul mittels /?openmodule=bde-abk zugegriffen werden (oder als Module-Link) bzw. auf das DynGrid-Modul mittels /?openmodule=open-op
57
* Zuerst den Record, für welchen ein override definiert werden soll, kopieren
58
** alle mmm_xyz Spalten
59
** mmm_default auf False setzen
60
* Danach muss mmm_metainfo angepasst werden, so wie es benötigt wird (original -> override)
61
** Hier wurden neben der Caption des Modules zusätzlich noch die Parameter umgemapped
62
** /?openmodule=bde-task&ab_ix=10000&ab_op=20 => /?openmodule=bde-abk&ABK=10000&AG=20
63
** !clipboard-202405221547-v1pet.png! !clipboard-202405221547-stxoe.png!
64
** im 2. override, wurde eine komplette Definition für ein DynGrid geacht
65
** Diesen override kann man auch im MainMenu benutzen
66
** Zusätzliche Mainmenu Eintrag, Kopie von 'Offene Arbeitsgänge'
67
** mm_ssqlname wird in diesem Falle ignoriert, da @open-op@ bereits komplett alles definiert (und definieren muss)
68
** /?openmodule=open-op
69
** !clipboard-202405221604-10evb.png!
70
** Zusätzlich sind in open-op auch Module-Links für Spalten definiert (hier 1 Spalte)
71
** !clipboard-202405221557-ifya5.png! !clipboard-202405221558-nxvo0.png!
72 1 [E] Rocco Kreutz
73 9 [E] Rocco Kreutz
h2. Ergebniss 
74
75 11 [E] Rocco Kreutz
h3. *https://p2017srv.prodat-sql.de:8088/?openmodule=bde-abk&ABK=10003&AG=10*
76 9 [E] Rocco Kreutz
77
* !clipboard-202405221617-queup.png!
78
79 10 [E] Rocco Kreutz
h3. open-op Module im MainMenu
80 9 [E] Rocco Kreutz
* {{collapse(Aufklappen)
81
!clipboard-202405221618-6sowv.png!
82 1 [E] Rocco Kreutz
}}
83 10 [E] Rocco Kreutz
* Klick auf die Spalte/Zelle "AG-Nr" löst einen Module-Link us: bde-abk
84
* !clipboard-202405221620-kk36p.png!
85
86
h2. Meta-Info / Config
87 9 [E] Rocco Kreutz
88
* CURL_LINK_VALIDFROM, CURL_LINK_VALIDTO, CURL_LINK_AUTHKEY, CURL_LINK_AUTHHASH werden nur für 'echte' URL-Links benutzt (komplettes JSONObject als URL-Param, mit
89
<pre><code class="delphi">
90
  CURL_LINK              = 'openmodule';             // used for url-link, short-url-link, module-default/-custom metainfo(config)
91
  CURL_LINK_DBRID        = 'dbrid';                  // mainmenu uses the record dbrid, otherwise used to construct CFORMINSTANCE_TYPEID
92
  CURL_LINK_CLASS        = 'class';                  // this is actually only used for "real" url-links: /?CURL_LINK=Authenticated(CURL_LINK_AUTHKEY, CURL_LINK_AUTHHASH, {CURL_LINK: {JSONOBJECT} })
93
  CURL_LINK_MODAL        = 'modal';
94
  CURL_LINK_MAINMENU     = 'mainmenu';
95
  CURL_LINK_PARAMS       = 'params';
96
  CURL_LINK_CAPTION      = 'caption';
97
  CURL_LINK_SSQL         = 'ssql';
98
  CURL_LINK_NAME         = 'name';
99
  CURL_LINK_SEARCHED     = 'searched';
100
  CURL_LINK_VALIDFROM    = 'valid_from';
101
  CURL_LINK_VALIDTO      = 'valid_to';
102
  CURL_LINK_AUTHKEY      = 'authentification_key';   // to make sure only authenicated url-links will be processed
103
  CURL_LINK_AUTHHASH     = 'authentification_hash';  // to make sure only authenicated url-links will be processed
104
105
  CURL_LINK_MODULELINKS  = 'modulelinks';            // array of objects, defining modulelinks for dbgrid-columns/SSQL
106
  CURL_LINK_LOOKUPTYPE   = 'lookuptype';
107
  CURL_LINK_LOOKUPIDENT  = 'lookupident';
108
  CURL_LINK_MODALMODE    = 'modalmode';
109
  CURL_LINK_TARGET       = 'target';
110
  CURL_LINK_PARAMSOURCES = 'paramsources';
111
</code></pre>