Modules-MetaInfo » Historie » Revision 16
Revision 15 ([X] Daniel S, 11.07.2024 11:33) → Revision 16/17 ([X] Daniel S, 11.07.2024 11:55)
{{toc}}
h1. Modules-MetaInfo
Für alle Module(Forms) welche direkt ansprechbar sein müssen (Shortname URL-Link)
* Meta-Info wird intern als JSON-Objekt gespeichert
* Der genaue Inhalt wird in Zukunft erweitert und die genaue Dokumentation dazu erfolgt später
* Derzeit soll nur {}->CMETA_SHORTNAME angepasst werden, um eigene Shortname-URL-Links generieren zukönnen
h4. >
* Alle Module (Forms) generieren intern Meta-Info ("siehe auch":https://redmine.prodat-sql.de/projects/prodat-v12-public/wiki/DynGrid_als_URL)
* 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
** Nicht jedes Modul registriert sich
*** Der Exception-Dialog z.B. registriert sich nicht, da er ein Kern-Element der Anwendung ist
*** Andere Formulare registrieren sich nicht, da nicht vorgesehen ist, diese explizit ansprechen zu können bzw. das Verhalten zu verändern
** Diese Einträge werden mit mmm_default = True geschrieben, im Gegensatz dazu werden von Benutzern definerte Einträge mit mmm_default = False geschrieben !!!
*** Alle Default-Einträge dürfen nicht editiert werden, mit Ausnahme der Spalten mmm_access_roles_allow und mmm_access_roles_deny
**** Hier handelt es sich um Komma-Separierte String-Listen von DB-Rollen
**** Deny hat Vorrang vor Allow
**** Die Auswertung berücksichtigt rekursive Rollen/Mitgliedschaften
* Für jedes registrierte Modul ("Default-Einträge"), kann hier ein override definiert werden
** Um eigene/angepasste Shortname-URL-Links zu definieren bzw. Parameter anzupasssen
** Alle Eingenschaften anzupassen, welche auch in einem URL-Link definiert/angepasst werden können
** Die Spalte mmm_metainfo muss korrekt gesetzt sein, am einfachsten geht dies, indem man den Wert des zugehörigen Default-Eintrages kopiert !!!
h4. >
* 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!
!clipboard-202405071556-ae6cj.png!
h2. URL-Erstellen
* https://<domain>:<port>/?openmodule=<shortname>&<param1_of_shortname>=<param1_value>&<param2_of_shortname>=<param1_value>
* <domain>: p2017srv.prodat-sql.de
* <port>: 8091
* <shortname>: abk (Module[Default]: CimW.ABK.FormProduktAuftragU.TCimWFormProduktAuftrag)
** Siehe obige Tabelle Spalte 'mm_shortname'
* <param1_of_shortname> .. <param2_of_shortname>: ab_ix
** Die Parameter sind in der Meta-Info aufgelistet, als Unterobjekt {}->CMETA_PARAMS
** {"CMETA_MODULE": "CimW.ABK.FormProduktAuftragU.TCimWFormProduktAuftrag", "CMETA_PARAMS": {"ab_ix": "ABK"}, "CMETA_SHORTNAME": "abk", "CMETA_MULTIPLE_INSTANCES_ALLOWED": true}
** CMETA_PARAMS": {"ab_ix": "ABK"}
Bsp:
<pre>
"caption": "Plantafel offene AG",
"modal": "true",
"searched": "%", "%DANIEL%",
"ssql": {
"name": "Mobile.PT.TFormAB2Dashboard",
"params": {
}
}
,
"modulelinks":[{"target":"bde-task-nosel", "lookuptype":"mlcFieldname","lookupident":"a2_n", "paramSources":"ab_ix=ab_ix;ab_op=a2_n"}
,{"target":"abk", "lookuptype":"mlcFieldname","lookupident":"ab_ix", "paramSources":"ab_ix=ab_ix"}]
</pre>
h2. Short-URL-Links / Overrides
*!!! Alle Namen in den MetaInfos sind Case-Sensitiv !!!*
*!!! Damit sind auch die ParameterNamen in der URL case sensitiv !!!*
*!!! Alle JSONWerte, welche im namen mit _info beginnen, sind nur zur dokumentation für Entwickler/Bearbeiter!!!*
* Hier wurden 2 overrides definiert
** !clipboard-202405221544-nnbl8.png!
** CimW.BDE.FormBDEU.TCimWFormBDETaskOnly mit dem mmm_shortname = bde-abk
** CimW.Core.FormSSQLGridU.TCimWFormSSQLGrid mit dem mmm_shortname = open-op
** 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
* Zuerst den Record, für welchen ein override definiert werden soll, kopieren
** alle mmm_xyz Spalten
** mmm_default auf False setzen
* Danach muss mmm_metainfo angepasst werden, so wie es benötigt wird (original -> override)
** Hier wurden neben der Caption des Modules zusätzlich noch die Parameter umgemapped
** /?openmodule=bde-task&ab_ix=10000&ab_op=20 => /?openmodule=bde-abk&ABK=10000&AG=20
** !clipboard-202405221547-v1pet.png! !clipboard-202405221547-stxoe.png!
** im 2. override, wurde eine komplette Definition für ein DynGrid geacht
** Diesen override kann man auch im MainMenu benutzen
** Zusätzliche Mainmenu Eintrag, Kopie von 'Offene Arbeitsgänge'
** mm_ssqlname wird in diesem Falle ignoriert, da @open-op@ bereits komplett alles definiert (und definieren muss)
** /?openmodule=open-op
** !clipboard-202405221604-10evb.png!
** Zusätzlich sind in open-op auch Module-Links für Spalten definiert (hier 1 Spalte)
** !clipboard-202405221557-ifya5.png! !clipboard-202405221558-nxvo0.png!
h2. Ergebniss
h3. *https://p2017srv.prodat-sql.de:8088/?openmodule=bde-abk&ABK=10003&AG=10*
* !clipboard-202405221617-queup.png!
h3. open-op Module im MainMenu
* {{collapse(Aufklappen)
!clipboard-202405221618-6sowv.png!
}}
* Klick auf die Spalte/Zelle "AG-Nr" löst einen Module-Link aus: bde-abk
* !clipboard-202405221620-kk36p.png!
h2. Meta-Info / Config
* 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
<pre><code class="delphi">
CURL_LINK = 'openmodule'; // used for url-link, short-url-link, module-default/-custom metainfo(config)
CURL_LINK_DBRID = 'dbrid'; // mainmenu uses the record dbrid, otherwise used to construct CFORMINSTANCE_TYPEID
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} })
CURL_LINK_MODAL = 'modal';
CURL_LINK_MAINMENU = 'mainmenu';
CURL_LINK_PARAMS = 'params';
CURL_LINK_CAPTION = 'caption';
CURL_LINK_SSQL = 'ssql';
CURL_LINK_NAME = 'name';
CURL_LINK_SEARCHED = 'searched';
CURL_LINK_VALIDFROM = 'valid_from';
CURL_LINK_VALIDTO = 'valid_to';
CURL_LINK_AUTHKEY = 'authentification_key'; // to make sure only authenicated url-links will be processed
CURL_LINK_AUTHHASH = 'authentification_hash'; // to make sure only authenicated url-links will be processed
CURL_LINK_MODULELINKS = 'modulelinks'; // array of objects, defining modulelinks for dbgrid-columns/SSQL
CURL_LINK_LOOKUPTYPE = 'lookuptype';
CURL_LINK_LOOKUPIDENT = 'lookupident';
CURL_LINK_MODALMODE = 'modalmode';
CURL_LINK_TARGET = 'target';
CURL_LINK_PARAMSOURCES = 'paramsources';
</code></pre>