PORTAL Poolkonfiguration
Former user (Deleted)
Moritz Groß
Dennis Balzuweit
Einrichtung eines Applikationspools
Innerhalb des CLARC PORTAL Servers werden Applikationen in Pools zusammengefasst. Die Zusammenfassung zu einem Pool bietet verschiedene Vorteile wie beispielsweise ein übergreifendes Session-Handling, ein gemeinsames Ressourcen-Caching oder der Querzugriff auf alle Applikationsinhalte.
Applikations-Pools werden unterhalb des folgenden Knotens im C4 verwaltet:
/clarc/Software/clarc portal daemon/Pools/<Pool>/
Jeder Pool besitzt eine Grundkonfiguration mit folgenden Möglichkeiten:
| Property | Datatype | Description | Example |
|---|---|---|---|
| Active | BOOLEAN | Aktiviert die Applikation und stellt sie entsprechend bereit. | True |
| Default | BOOLEAN | Standardpool - sollte nur zur Abwärtskompatibilität aktiviert werden. | false |
| DisplayName | UCS2STR | Anzeigename des Pools. Im Standard entspricht dies dem Namen. | MyPool |
| Description | UCS2STR | Beschreibender Text zum Pool | |
| Components | UCS2STR | Auflistung der im Pool verwendeter Portal-Komponenten mit Zeilenumbruch getrennt. Über den Wert "*" werden alle verfügbaren Komponenten dem Pool zugeordnet und stehen damit allen Applikationen zur Verfügung. Durch diese Auswahl werden alle zugehörigen JavaScripte und Stylesheets automatisch in den Applikations-Ressourcen bereitgestellt und verwendet. | * |
| SingleUserSessions | BOOLEAN | Über SingleUserSessions kann definiert werden, ob sich ein gleichnamiger Benutzer mehrfach oder lediglich einmal anmelden kann. | False |
| SessionTimeout | INTEGER | Sitzungs-Timeout in Sekunden. Macht ein Benutzer innerhalb dieser Zeitangabe keine Aktion, wird er automatisch abgemeldet. Im Standard wird der Wert aus der Basiskonfiguration verwendet. | 600 |
| CacheLeaseTime | INTEGER | Maximale Verweildauer eines Files im Cache in Sekunden nachdem es nicht mehr verwendet wurde. Wurde das File heruntergeladen, beginnt die Zeitspanne von neuem. | 86400 |
| MaxCacheSize | INTEGER | Maximale Anzahl an Dateien im Cache. 0 entspricht keiner Beschränkung. | 0 |
| MaxCacheFileSize | INTEGER | Maximale Gesamtgröße des Caches in Byte. | 1048576 |
| CompressMimeTypes | UCS2STR | Eine Liste der zu komprimierenden Inhaltsdatentypen. Je Zeile ein MimeType. | text/css application/x-javascript |
| MinCompressionQuote | BYTE | Bestimmt die minimale Kompressionsrate in Prozent für zu komprimierende Dateien im Cache. Ist die Kompressionsrate schlechter wie die hier definierte, wird die Datei nicht komprimiert. | 20 |
| StyleSheets | UCS2STR | Eine Liste der einzubindenden CSS StyleSheets. Jede Zeile entspricht einem StyleSheet. Die Stylesheets befinden sich idealerweise im entsprechenden Poolordner: <clarc>\sys\pub\pools\<Pool>\css\ Die hier aufgeführten StyleSheets gelten für alle Pool-Applikationen. | /MyPool/css/example.css |
| Style | UCS4STR | Name des Themes, das verwendet werden soll. Siehe Styles | Default |
| JavaScripts | UCS2STR | Eine Liste der einzubindenden Java Skripte. Jede Zeile entspricht einem Skript. Die Scripte befinden sich idealerweise im entsprechenden Applikationsordner: <clarc>\sys\pub\pools\<Pool>\js\ Die hier aufgeführten JavaScripts gelten für alle Pool-Applikationen. | /MyPool/js/example.js |
| Version | UCS2STR | Versionsnummer des Pools, dadurch werden in allen Applikation die JavaScript und Stylesheet Ressourcen (auch aus den Komponenten) beim automatischen Verlinken mit dieser Nummer versehen, dadurch kann browserseitiges Caching der Ressourcen überwunden werden, das sogenannte Cache-Busting. In der ausgelieferten HTML Seite sieht eine Verlinkung dann zum Beispiel so aus: <script src="./js/center.js?v=1.0.0.0"></script> | 1.0.0.0 |
Weitere Konfiguration
Unterhalb eines Pool-Knotens gibt es jeweils fünf weitere Nodes zur Definition eines Pools:
- Applications
- Configuration
- Files
- Sessions
- Templates
Applications
Definition der dem Pool zugeordneten Applikationen - siehe PORTAL Applikationskonfiguration.
Configuration
Unterhalb des Configuration Knotens können beliebige Konfigurations-Einträge erstellt werden, welche später über die Portal-Skripte abgefragt werden können.
Dies macht es sehr einfach die Portale auf andere Systeme übertragbar und konfigurierbar zu machen.
Die Pool-Konfiguration ist für alle Anwendungen zugänglich.
Wichtiger Hinweis
Lokale Applikations-Konfigurationen überschreiben die Pool-Konfigurationen.
Files
Im Bereich Files können zum Pool zugehörige Ressource-Files wie beispielsweise Java Scripte oder CSS Definitionen bereitgestellt werden. Dies ermöglicht es ein Pool selbsttragend, d.h. ohne zusätzlichen Dateien im Dateisystem, zu betreiben und zu verteilen.
Unterhalb von Files kann eine beliebige Ordnerstruktur abgebildet werden, welche beim Laden der Applikation entsprechend im Dateisystem abgebildet wird und die zugehörigen Dateien bereitstellt. Auf die Dateien kann dann entsprechend der Url der Applikation zugegriffen werden.
Der Datentyp der Properties ist immer BINARY und der Inhalt damit entsprechend BASE64 encoded.
Beispiel
Der Poolname ist mypool. Unterhalb von Files wird der C4 Ordner myfiles angelegt und folgende Properties gesetzt:
| Property | Datatype | Value |
|---|---|---|
| example.jpg | BINARY | ... |
| mydata.txt | BINARY | ... |
Der Zugriff auf die Datei example.jpg würde absolut wie folgt aussehen:
http://localhost:4520/mypool/myfiles/example.jpg
Sessions
Sessions ist ein vom System verwalteter Bereich in dem Benutzer-Sitzungen gespeichert werden.
Styles
In diesem Knoten werden Style Themes erstellt. Jeder Knoten unter diesem entspricht einem Theme für den Pool. In den Themes kann man beliebig viele Styles als Key Value Paar erstellen. Mit dem Key kann man dann in Komponenten Resources oder in den Binary Files auf den entsprechenden Wert im aktuell ausgewählten Theme zugreifen ohne wissen zu müssen welche Themes es gibt oder welches zur Zeit ausgewählt ist. Der Zugriff erfolgt über den festgelegten String "[@<Key>(<Fallback>)]", dieser wird vor der Laufzeit durch den tatsächlichen Wert im aktuell ausgewählten Theme ausgetauscht, falls dieser dort definiert ist, andernfalls wird der Fallback verwendet.
Templates
Unterhalb von Templates werden poolspezifische Seiten-Templates verwaltet. Jeder Eintrag bzw. C4 Property entspricht einem Template.
Die hier definierten Templates stehen allen Pool-Applikationen zur Verfügung.
Hinweis
Gleichnamige Applikations- bzw. Funktions Templates überladen die Pool-Templates im entsprechenden Kontext.
Aktivierung
Die vorgenommenen Änderungen werden über den C4 Button "Refresh Services" übernommen und stehen dann zur Verwendung bereit.