2. Knowledge Base
  3. Integrationshandbuch
  4. Grundlagen
  5. Portalseiten

Portalseiten

Grundlagen GPCBD
Zurück
Portal öffnen

Benutzen Sie die Funktion oxomi.openPortal um das gesamte OXOMI Portal in einem Overlay zu öffnen.

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
withMenu boolean

Ermöglicht das Öffnen des Portals mit oder ohne Navigation.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
Beispiel:
oxomi.openPortal();

Portal öffnen - Showcase

Parameter

Ausführen Mit Beispieldaten ausführen
Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(withMenu) Ermöglicht das Öffnen des Portals mit oder ohne Navigation.
Mit Beispieldaten ausführen Ausführen

Ausgabebereich

Portalseite öffnen

Verwenden Sie die Funktion oxomi.openPage um eine Portalseite in einem Overlay zu öffnen.

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
page string

Gibt den Code der Portalseite an, die geöffnet werden soll.

withMenu boolean

Zeigt das Navigationsmenü der Portalseite an.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird false als Default-Wert verwendet.
Beispiel:
oxomi.openPage({ page: 'news' });

Portalseite öffnen - Showcase

Parameter

Ausführen Mit Beispieldaten ausführen
Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(page) Gibt den Code der Portalseite an, die geöffnet werden soll.
(withMenu) Zeigt das Navigationsmenü der Portalseite an.
Mit Beispieldaten ausführen Ausführen

Ausgabebereich

Portalseite anzeigen

Die Funktion oxomi.portalPage ermöglicht es, eine Portalseite direkt in die aktuelle Seite einzubetten.

Die nachfolgende Tabelle enthält eine Übersicht über die verfügbaren Parameter. Fett gedruckte Parameter sind Pflichtparameter. Die Beschreibung der Parameter enthält Informationen über den Typ des Parameters, die möglichen Werte und die Bedeutung sowie weitere Verwendungshinweise.

Parameter Parametertyp Beschreibung
page string

Gibt den Code der Portalseite an, die angezeigt werden soll.

target string

Gibt das Ziel-Element an, in welches die gerenderte Portalseite eingefügt wird.

Hinweis:

  • Wird der Parameter nicht angegeben, so wird #oxomi-page als Default-Wert verwendet.
Beispiel:
oxomi.portalPage({ target: '#oxomiPortalPage', page: 'news' });

Portalseite anzeigen - Showcase

Parameter

Ausführen Mit Beispieldaten ausführen
Initialisierungsparameter
(portal)
Bitte geben Sie hier den Portal-Code beziehungsweise die Portal-ID an. Hier finden Sie weitere Informationen.
(user) Bitte geben Sie hier den Benutzernamen eines Portalbenutzers ein. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
(roles) Bitte geben Sie hier wahlweise die Portallrollen an, um den Zugriff auf die Inhalte zu steuern. Hier finden Sie weitere Informationen.
(accessToken) Für die externe Authentifizierung kann ein im integrierenden System generierter Access-Token eingesetzt werden. Benutzen Sie den Access-Token Rechner, um Ihren individuellen Access-Token zu berechnen. Diese Eingabe wird zum Pflichtfeld, falls das entsprechende Portal Login-geschützt ist. Hier finden Sie weitere Informationen.
Hauptparameter
(page) Geben Sie hier den Code der Portalseite an, die angezeigt werden soll.
Mit Beispieldaten ausführen Ausführen

Ausgabebereich