PORTAL Applikationskonfiguration
Former user (Deleted)
Moritz Groß
Dennis Balzuweit
Einrichtung einer Portalapplikation
Eine Applikation entspricht einer eigenständigen Web-Anwendung, welche in einem eigenen Applikations-Pool oder im Verbund mit anderen Applikationen innerhalb eines Applikations-Pools zusammengefasst sind.
Applikationen werden unterhalb des folgenden Knotens im C4 verwaltet:
/clarc/Software/clarc portal daemon/Pools/<Pool>/Applications/<Application>
Jede Applikation besitzt eine Grundkonfiguration mit folgenden Möglichkeiten:
| Property | Datatype | Description | Example |
|---|---|---|---|
| Active | BOOLEAN | Aktiviert die Applikation und stellt sie entsprechend bereit. | True |
| Author | UCS2STR | Autor der Applikation (Metainformation). | CTO |
| Charset | UCS2STR | Verwendeter Zeichensatz der Seite. | UTF-8 |
| CleanUpScript | UCS2STR | Angabe eines Skripts welches nach Ablauf einer Benutzer-Session aufgerufen wird. | |
| DefaultFunction | UCS2STR | Standard-Funktion der Applikation - siehe "Functions". | Login |
| Description | UCS4STR | Beschreibungstext der Applikation. | Example Page |
| HTMLSpec | UCS4STR | HTML-Spezifikation. | 5.0 |
| 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>\<Application>\js\ Tipp Siehe Files Definitionen. | /MyPool/MyApplication/js/example.js |
| KeyWords | UCS4STR | Schlüsselwörter (Metainformation). | |
| Language | UCS4STR | Standard-Sprache des Portals. | DE |
| LicenseModule | UCS2STR | Optionale Angabe eines Lizenzmoduls, welches für den Betrieb benötigt wird. Die Lizenzprüfung kann entsprechend aus dem Scripting heraus geprüft werden. | |
| MetaTags | UCS4STR | Liste eigener MetaTags. | <meta name="example" content="Hello World"> |
| PeriodicScript | UCS2STR | Angabe eines Skripts, welches periodisch vom Portal-Server ausgeführt wird. | /Portal/DownloadManager/CleanUp |
| PortalClass | UCS4STR | Definiert die Klasse des Portals. Gültige Werte sind:
| EVO2PORTAL |
| Publisher | UCS2STR | Publisher des Portals (Metainformation). | CTO Balzuweit GmbH |
| StyleSheets | UCS4STR | Eine Liste der einzubindenden CSS StyleSheets. Jede Zeile entspricht einem StyleSheet. Die Stylesheets befinden sich idealerweise im entsprechenden Applikationsordner: <clarc>\sys\pub\pools\<Pool>\<Application>\css\ Tipp Siehe Files Definitionen. | /MyPool/MyApplication/css/example.css |
| TechName | UCS4STR | Technischer Name des Portals. Wird dieser Parameter nicht gesetzt gilt der Name des Portals gleichfalls als technischer Name. | example |
| Title | UCS2STR | Titel der Applikation bzw. der Webseite (<title>). | clarc Download Manager |
| TranslationApplication | UCS4STR | Name der Übersetzungsanwendung, nach diesem wird im Translationmanager gesucht. | CCCENTER |
| TranslationConnectionString | UCS4STR | Verbindung zum Translationmanager. Beim Verwenden des Spezialwertes "c4" werden die Übersetzungen unter /clarc/Classes/Translations genommen | c4 |
| UsePoolResources | BOOLEAN | Bestimmt, ob die dem übergeordneten Pool zugeordneten Ressourcen auch der Anwendung zugeordnet werden sollen. Die Standardeinstellung ist true. | True |
Weitere Konfiguration
Unterhalb eines Application-Knotens gibt es jeweils vier weitere Nodes zur Definition einer Applikation:
- Configuration
- Functions
- Files
- Templates
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 übertrag- und konfigurierbar zu machen.
Functions
Der Functions-Knoten beinhaltet jeweils einen weiteren Unterknoten für die einzelnen Funktionen des Portals. Zum Beispiel für Login, Logout, etc. Es kann jedoch auch eine gesamte Applikation mit nur einem Functions-Knotens erstellt werden.
| Property | Datatype | Description | Example |
|---|---|---|---|
| AssignedLocators | UCS2STR | Zugeordnete Ressourcenzeiger der Funktion. | /ccconnectioncheck |
| ExclusiveProcessing | BOOLEAN | Ist diese Option aktiviert, werden entsprechende Aktionen exklusiv ausgeführt. Dies bedeutet, dass die Ausführung dieser Funktion nicht parallelisiert wird. Beispielsweise für die Verwaltung von Nummernkreisen. Die Standardeinstellung ist False. | False |
| ScriptName | UCS2STR | C4 Knoten des zu verwendenden Scripts. Sollte der Pfad fehlerhaft sein, wird beim Zugriff über den Ressourcenzeiger eine Exception ausgelöst. | /Portal/ccCloud/ConnectionCheck |
| Template <Name> | UCS2STR | Optionales HTML Template. Es können beliebig viele Templates angelegt werden. Ein Template beginnt mit dem Bezeichner Template einem Blank und einem entsprechenden Namen. Z.B. "Template Example". | |
| Permissions | UCS2STR | Kommaseparierte Liste von Rollen (casesensitiv) und "Administrator", die den Zugriff auf die Funktion berechtigt. Wenn eine der angegebenen Rollen für den User vorhanden ist, dann ist ein normaler Zugriff möglich. Falls keine Berechtigung gefunden wurde, dann wird der Request mit 401 abgewiesen. Wenn die Property nicht angelegt ist findet keine Prüfung statt. | Administrator, Application_Select |
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 und die Applikation exampleapp. 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/exampleapp/myfiles/example.jpg
Aktivierung
Die vorgenommenen Änderungen werden über den C4 Button "Refresh Services" übernommen und stehen dann zur Verwendung bereit.