Projekt

Allgemein

Profil

Modules-MetaInfo » Historie » Version 17

[X] Daniel S, 11.07.2024 12:25

1 12 [E] Rocco Kreutz
{{toc}}
2
3 1 [E] Rocco Kreutz
h1. Modules-MetaInfo
4
5
Für alle Module(Forms) welche direkt ansprechbar sein müssen (Shortname URL-Link)
6 4 [E] Rocco Kreutz
* Meta-Info wird intern als JSON-Objekt gespeichert
7
* Der genaue Inhalt wird in Zukunft erweitert und die genaue Dokumentation dazu erfolgt später
8
* Derzeit soll nur {}->CMETA_SHORTNAME angepasst werden, um eigene Shortname-URL-Links generieren zukönnen
9 1 [E] Rocco Kreutz
10 4 [E] Rocco Kreutz
h4. >
11
12 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)
13 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
14 1 [E] Rocco Kreutz
** Nicht jedes Modul registriert sich
15
*** Der Exception-Dialog z.B. registriert sich nicht, da er ein Kern-Element der Anwendung ist
16
*** Andere Formulare registrieren sich nicht, da nicht vorgesehen ist, diese explizit ansprechen zu können bzw. das Verhalten zu verändern
17 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 !!!
18 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
19 2 [E] Rocco Kreutz
**** Hier handelt es sich um Komma-Separierte String-Listen von DB-Rollen
20
**** Deny hat Vorrang vor Allow
21
**** Die Auswertung berücksichtigt rekursive Rollen/Mitgliedschaften
22 3 [E] Rocco Kreutz
* Für jedes registrierte Modul ("Default-Einträge"), kann hier ein override definiert werden
23
** Um eigene/angepasste Shortname-URL-Links zu definieren bzw. Parameter anzupasssen
24
** Alle Eingenschaften anzupassen, welche auch in einem URL-Link definiert/angepasst werden können
25 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 !!!
26 6 [E] Rocco Kreutz
27
28
h4. >
29
30
* 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!
31 5 [E] Rocco Kreutz
32
!clipboard-202405071556-ae6cj.png!
33 7 [E] Rocco Kreutz
34 12 [E] Rocco Kreutz
h2. URL-Erstellen
35 7 [E] Rocco Kreutz
36
* https://<domain>:<port>/?openmodule=<shortname>&<param1_of_shortname>=<param1_value>&<param2_of_shortname>=<param1_value>
37
* <domain>: p2017srv.prodat-sql.de
38
* <port>: 8091
39
* <shortname>: abk (Module[Default]: CimW.ABK.FormProduktAuftragU.TCimWFormProduktAuftrag)
40
** Siehe obige Tabelle Spalte 'mm_shortname'
41
* <param1_of_shortname> .. <param2_of_shortname>: ab_ix
42
** Die Parameter sind in der Meta-Info aufgelistet, als Unterobjekt {}->CMETA_PARAMS
43
** {"CMETA_MODULE": "CimW.ABK.FormProduktAuftragU.TCimWFormProduktAuftrag", "CMETA_PARAMS": {"ab_ix": "ABK"}, "CMETA_SHORTNAME": "abk", "CMETA_MULTIPLE_INSTANCES_ALLOWED": true}
44 1 [E] Rocco Kreutz
** CMETA_PARAMS": {"ab_ix": "ABK"}
45 15 [X] Daniel S
46
Bsp:
47
<pre>
48 17 [X] Daniel S
{
49
	"CMETA_MODULE": "CimW.Core.FormSSQLGridU.TCimWFormSSQLGrid",
50
	"CMETA_PARAMS": {
51
		"_Info": "Variable Parameters"
52
	},
53
	"CMETA_SHORTNAME": "dyngrid",
54
	"CMETA_MULTIPLE_INSTANCES_ALLOWED": true,
55
	"caption": "Plantafel offene AG",
56
	"modal": "true",
57
	"searched": "%",
58
	"ssql": {
59
		"name": "Mobile.PT.TFormAB2Dashboard",
60
		"params": {}
61
	},
62
	"modulelinks": [
63
		{
64
			"target": "bde-task-nosel",
65
			"lookuptype": "mlcFieldname",
66
			"lookupident": "a2_n",
67
			"paramsources": "ab_ix=ab_ix;ab_op=a2_n"
68
		},
69
		{
70
			"target": "abk",
71
			"lookuptype": "mlcFieldname",
72
			"lookupident": "ab_ix",
73
			"paramsources": "ab_ix=ab_ix"
74
		}
75
	]
76
}
77 15 [X] Daniel S
</pre>
78 8 [E] Rocco Kreutz
79 9 [E] Rocco Kreutz
h2. Short-URL-Links / Overrides
80 8 [E] Rocco Kreutz
81 9 [E] Rocco Kreutz
*!!! Alle Namen in den MetaInfos sind Case-Sensitiv !!!*
82
*!!! Damit sind auch die ParameterNamen in der URL case sensitiv !!!*
83
*!!! Alle JSONWerte, welche im namen mit _info beginnen, sind nur zur dokumentation für Entwickler/Bearbeiter!!!*
84 8 [E] Rocco Kreutz
85 1 [E] Rocco Kreutz
86 9 [E] Rocco Kreutz
* Hier wurden 2 overrides definiert
87
** !clipboard-202405221544-nnbl8.png!
88
** CimW.BDE.FormBDEU.TCimWFormBDETaskOnly mit dem mmm_shortname = bde-abk
89
** CimW.Core.FormSSQLGridU.TCimWFormSSQLGrid mit dem mmm_shortname = open-op
90
** 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
91
* Zuerst den Record, für welchen ein override definiert werden soll, kopieren
92
** alle mmm_xyz Spalten
93
** mmm_default auf False setzen
94
* Danach muss mmm_metainfo angepasst werden, so wie es benötigt wird (original -> override)
95
** Hier wurden neben der Caption des Modules zusätzlich noch die Parameter umgemapped
96
** /?openmodule=bde-task&ab_ix=10000&ab_op=20 => /?openmodule=bde-abk&ABK=10000&AG=20
97
** !clipboard-202405221547-v1pet.png! !clipboard-202405221547-stxoe.png!
98
** im 2. override, wurde eine komplette Definition für ein DynGrid geacht
99
** Diesen override kann man auch im MainMenu benutzen
100
** Zusätzliche Mainmenu Eintrag, Kopie von 'Offene Arbeitsgänge'
101
** mm_ssqlname wird in diesem Falle ignoriert, da @open-op@ bereits komplett alles definiert (und definieren muss)
102
** /?openmodule=open-op
103
** !clipboard-202405221604-10evb.png!
104
** Zusätzlich sind in open-op auch Module-Links für Spalten definiert (hier 1 Spalte)
105
** !clipboard-202405221557-ifya5.png! !clipboard-202405221558-nxvo0.png!
106 1 [E] Rocco Kreutz
107 9 [E] Rocco Kreutz
h2. Ergebniss 
108
109 11 [E] Rocco Kreutz
h3. *https://p2017srv.prodat-sql.de:8088/?openmodule=bde-abk&ABK=10003&AG=10*
110 9 [E] Rocco Kreutz
111
* !clipboard-202405221617-queup.png!
112
113 10 [E] Rocco Kreutz
h3. open-op Module im MainMenu
114 13 [E] Rocco Kreutz
115 9 [E] Rocco Kreutz
* {{collapse(Aufklappen)
116
!clipboard-202405221618-6sowv.png!
117 1 [E] Rocco Kreutz
}}
118 14 [E] Rocco Kreutz
* Klick auf die Spalte/Zelle "AG-Nr" löst einen Module-Link aus: bde-abk
119 10 [E] Rocco Kreutz
* !clipboard-202405221620-kk36p.png!
120
121
h2. Meta-Info / Config
122 9 [E] Rocco Kreutz
123
* 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
124
<pre><code class="delphi">
125
  CURL_LINK              = 'openmodule';             // used for url-link, short-url-link, module-default/-custom metainfo(config)
126
  CURL_LINK_DBRID        = 'dbrid';                  // mainmenu uses the record dbrid, otherwise used to construct CFORMINSTANCE_TYPEID
127
  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} })
128
  CURL_LINK_MODAL        = 'modal';
129
  CURL_LINK_MAINMENU     = 'mainmenu';
130
  CURL_LINK_PARAMS       = 'params';
131
  CURL_LINK_CAPTION      = 'caption';
132
  CURL_LINK_SSQL         = 'ssql';
133
  CURL_LINK_NAME         = 'name';
134
  CURL_LINK_SEARCHED     = 'searched';
135
  CURL_LINK_VALIDFROM    = 'valid_from';
136
  CURL_LINK_VALIDTO      = 'valid_to';
137
  CURL_LINK_AUTHKEY      = 'authentification_key';   // to make sure only authenicated url-links will be processed
138
  CURL_LINK_AUTHHASH     = 'authentification_hash';  // to make sure only authenicated url-links will be processed
139
140
  CURL_LINK_MODULELINKS  = 'modulelinks';            // array of objects, defining modulelinks for dbgrid-columns/SSQL
141
  CURL_LINK_LOOKUPTYPE   = 'lookuptype';
142
  CURL_LINK_LOOKUPIDENT  = 'lookupident';
143
  CURL_LINK_MODALMODE    = 'modalmode';
144
  CURL_LINK_TARGET       = 'target';
145
  CURL_LINK_PARAMSOURCES = 'paramsources';
146
</code></pre>