Konfiguration des Automic Web Interface

Sie haben das Automic Web Interfacebereits installiert. Nun können Sie mit den Konfigurationsaktivitäten fortfahren. Viele von ihnen sind optional.

Diese Seite beinhaltet Folgendes:

Konfigurationsschritte

Optimierung der Serverkonfigurationsgrößen » den Zugriffs auf das AWI via SSL sichernL » Anpassen des Konfigurationspfades » Login- und Benutzerauthentifizierung konfigurieren » Logging-Konfiguration im AWI » Anpassen der Benutzeroberfläche » Anpassen der Konfigurationsdateien » Den Load Balancer einrichten und Proxys konfigurieren

Optimierung der Serverkonfigurationsgrößen

Hinweise:

Serverkonfigurationsgrößen

den Zugriffs auf das AWI via SSL sichern

Tomcat

  1. Erstellen einer KeyStore-Datei für Ihre Tomcat-Installation.

    1. Öffnen Sie eine Eingabeaufforderung mit Administratorrechten und ändern Sie den Pfad zum Tomcat-Konfigurationsverzeichnis (TOMCAT_HOME/conf/).

    2. Erstellen Sie mit dem folgenden Befehl eine KeyStore-Datei mit einem selbstsignierten Zertifikat. Dies führt zur Ausgabe wie unten gezeigt (Status nach vollständiger Bearbeitung).

      Der Cursor springt in die erste Zeile, in der Sie Ihre Werte eingeben können. Bestätigen Sie nach jeder Eingabe mit der Return-Taste, um zur nächsten Zeile zu springen.

      "%JAVA_HOME%\bin\keytool" -genkey -alias tomcat -keyalg RSA -keystore tomcat-keystore.jks -storepass myTomcatKeystorePassword

      Wie lauen Ihr Vor- und Nachname?  
       [Unknown]:  localhost
      Wie lautet der Name Ihrer Unternehmenseinheit?
        [Unknown]:  YOUR_UNIT
      Wie lautet der Name Ihres Unternehmens?  
       [Unknown]:  YOUR_ORGANIZATION
      Wie lautet der Name Ihrer Stadt oder ihres Gebiets?  
       [Unknown]: YOUR_CITY
      Wie lautet der Name Ihres Bundeslands oder Kantons?
       [Unknown]: YOUR_STATE
      Was ist der aus zwei Buchstaben bestehende Ländercode für diese Einheit?
      [Unknown]: AT
      Ist CN=localhost, OU=YOUR_UNIT, O=YOUR_ORGANIZATION, L=YOUR_CITY, ST=YOUR_STATE, C=AT korrekt?
      [no]: YES

      Geben Sie das Schlüsselkennwort für <tomcat> ein
        (EINGABETASTE, wenn dies dasselbe wie das Keystore-Kennwort ist):

      Hinweise:

      • Verwenden Sie den Hostnamen/die Domäne Ihrer AWI-Instanz als Vor- und Nachnamen (in diesem Beispiel localhost).

      • Dieser Befehl erstellt eine neue KeyStore-Datei mit dem Namen tomcat-keystore.jks, geschützt mit dem Passwort myTomcatKeystorePassword, im Konfigurationsverzeichnis. Der KeyStore enthält ein selbstsigniertes Zertifikat für Ihre AWI-Instanz.

  2. Importieren Sie ein signiertes Zertifikat in den KeyStore (optional).

    Überspringen Sie diesen Schritt, wenn Sie das im vorherigen Schritt erstellte selbstsignierte Zertifikat verwenden.

    1. Verwenden Sie den folgenden Befehl, um zuerst ein Chain- oder Root-Zertifikat (falls vorhanden) in Ihren KeyStore zu importieren:

      "%JAVA_HOME%\bin\keytool" -import -alias root -keystore tomcat-keystore.jks -trustcacerts -file <Dateiname_des_Kettenzertifikats>

    2. Importieren Sie nun das Zertifikat mit diesem Befehl:

      "%JAVA_HOME%\bin\keytool" -import -alias tomcat -keystore tomcat-keystore.jks -file <Ihr_Zertifikat-Dateiname>

    3. Wichtig! Die Tomcat unterstützt nur Schlüssel und Zertifikate in den Formaten JKS, PKCS11 oder PKCS12.

    4. Um ein vorhandenes, von Ihrer eigenen Zertifizierungsstelle (Certification Authority, CA) signiertes Zertifikat in einen PKCS12-KeyStore mit OpenSSL zu importieren, führen Sie einen Befehl wie diesen aus:

      openssl pkcs12 -export -in mycert.crt -inkey mykey.key
          -out mycert.p12 -name tomcat -CAfile myCA.crt
          -caname root -chain

  3. Konfigurieren der Tomcat-Verbindung

    1. Öffnen Sie die server.xml-Datei im Konfigurationsverzeichnis Ihrer Tomcat-Instanz.

    2. Fügen Sie die folgende Connector-Konfiguration in Ihrer Konfigurationsdatei hinzu und speichern Sie sie:

      <Connector port="8443"
      protocol="Enter the current apache protocol here"
          keyAlias="tomcat" keystoreFile="conf\tomcat-keystore.jks" keystorePass="myTomcatKeystorePassword"
          maxThreads="150" SSLEnabled="true" scheme="https" secure="true"
          clientAuth="false" sslProtocol="TLS" />

    3. Geben Sie für den Parameter keystorePass das Passwort des tomcat-keystore.jks ein.

      Wichtig! Das vorherige Beispiel veranschaulicht, wie der Connector so konfiguriert wird, wie zum Zeitpunkt dieser Beschreibung vorgesehen. Prüfen Sie die Tomcat-Dokumentation auf potenzielle Änderungen und auf die neuesten Informationen bei Apache Tomcat.

    4. Starten Sie Ihre Tomcat-Instanz neu, um die Änderungen zu übernehmen.

  4. Testen Sie den Zugriff auf Ihre AWI-Instanz.

    Sie können nun über eine sichere Verbindung auf das Automic Web Interface zugreifen.

    • Als URL verwenden Sie https://IHRE_DOMAIN:8443/awi/ (Beispiel: https://localhost:8443/awi/)

    • Wenn Sie ein selbstsigniertes Zertifikat verwenden, erhalten Sie möglicherweise eine Warnung, dass die Verbindung nicht vertrauenswürdig ist, da es nicht möglich ist, die Identität zu überprüfen.

      Sie können diese Warnung nur vermeiden, wenn Sie signierte Zertifikate von einer vertrauenswürdigen Zertifizierungsstelle verwenden. Die Verschlüsselung der Verbindung ist dieselbe wie bei einem selbstsignierten Zertifikat.

      Hinweis: Sie müssen bestätigen (eine Sicherheitsausnahme hinzufügen), dass Sie das selbstsignierte Zertifikat verwenden möchten.

WebSphere

Das Verfahren zur Sicherung des Zugriffs auf das AWI hängt von dem in Ihrem Unternehmen verwendeten WebSphere-Profil ab. Weitere Informationen entnehmen Sie bitte der offiziellen IBM WebSphere-Dokumentation.

Anpassen des Konfigurationspfades

Standardmäßig befinden sich die AWI-Konfigurationsdateien im Ordner Webanwendungen auf dem WebServer. In einigen Fällen kann es sinnvoll sein, diesen Pfad zu ändern, z. B. wenn die Benutzer, die das AWI konfigurieren, keine Zugriffsrechte auf den Ordner WebServer haben sollen.

Unabhängig davon, ob Sie die Installation über das ONE Installer oder manuell durchführen, können Sie den Pfad, in dem die Konfigurationsdateien gespeichert werden sollen, anpassen. Zu diesem Zweck setzen Sie die folgenden JVM-Argumente, indem Sie sie entweder in der Java-Umgebung angeben oder die Management-Dienstprogramme Ihres WebServers verwenden:

Hinweis: Nachdem Sie dieses Argument gesetzt haben, müssen Sie den Anwendungsserver neu starten.

Login- und Benutzerauthentifizierung konfigurieren

Das Automic Web Interface bietet verschiedene Konfigurationen der Benutzerauthentifizierung, die zu unterschiedlichen Login-Optionen führen. Als Systemadministrator können Sie das AWI so konfigurieren, dass es den gewünschten Authentifizierungs- und Login-Ansatz unterstützt.

Wenn sich Benutzer am AWI anmelden, wird standardmäßig der gesamte Authentifizierungsprozess von der Automation Engine abgewickelt, mit der die Instanz verbunden ist. Die AE bestätigt, ob die Benutzeranmeldeinformationen mit den Werten im zugehörigen Benutzerobjekt (USER) übereinstimmen.

Sie können auch ein Single Sign-on mit dem Kerberos- oder SAML-Protokoll aktivieren oder die parametrisierte Anmeldung aktivieren.

Das standardmäßige AWI-Login verwenden

Standardmäßig müssen die AWI-Benutzer beim Öffnen des AWI die folgenden Login-Informationen angeben:

Im Browser bleiben (außer dem Passwort) alle Anmeldedaten für Ihre nächste Anmeldung gespeichert.

Hinweis: Sie können die Session-Farbe jederzeit im Session-Menü in der Hauptmenüleiste ändern.

Single Sign-On verwenden

Wenn Sie Single Sign-On für das Automation Engine-System einrichten, müssen Benutzer sich nur einmal anmelden und müssen die Anmeldeinformationen nicht immer wieder erneut eingeben. Die Automation Engine unterstützt die Protokolle Kerberos Key Distribution Center (KDC) und die Security Assertion Markup Language 2.0 (SAML 2.0).

Sie aktivieren das Single Sign-On (SSO) in den configuration.properties Ihrer Automic Web Interface-Instanz, indem Sie die Eigenschaft sso.kdc.enabled oder sso.saml.enabled auf true setzen, abhängig davon, welches Protokoll Sie verwenden möchten. Weitere Informationen finden Sie unter configuration.properties.

Sie können auch festlegen, ob Sie die automatische Anmeldung für die Verwendung einer vollständigen oder teilweise automatischen Anmeldung aktivieren möchten:

Weitere Informationen zur SSO-, Kerberos-und SAML-Konfiguration finden Sie unter Einrichten von Single Sign-On.

Parametrisiertes Login am AWI aktivieren

Eine weitere praktische Funktion ist die Aktivierung des parametrisierten Logins durch das Einfügen der Login-Parameter in die URL, die Sie zum Starten des AWI verwenden. Dies ist hilfreich, wenn Sie oder Benutzer mehrere Verbindungen und/oder Mandanten verwenden. Sie können die verschiedenen Login-Kombinationen einfach mit einem Lesezeichen versehen. Wenn Sie die mit einem Lesezeichen versehene URL öffnen, müssen Sie nur Ihr Passwort eingeben.

  1. Setzen Sie in Ihrer AWI-Instanz die Eigenschaft parameter_login.enabled auf true in der Datei configuration.properties, siehe configuration.properties.

  2. Fügen Sie in Ihrer AWI-Start-URL die Login-Informationen hinzu, die Sie bereits im Anmeldefenster eingegeben haben möchten.

    Beispiel

    https://<AWI >/?system=ConnectionName&client=9999&name=MyUserName&department=Dept&logintype=AE(default)|KERBEROS|SAML&language=MyLanguage&autologin=true

    Hinweis: Wenn Ihr Browser nicht über ein SSL-Protokoll auf das AWI zugreift, beginnt Ihre URL mit http://.

    Als Administrator möchten Sie möglicherweise individualisierte URLs an Ihre neuen Benutzer senden.

Logging-Konfiguration im AWI

Informationen über die Art der Logdaten, die für ein CA Automic-Support-Ticket gesammelt werden müssen, finden Sie unter Vorbereiten von Logdateien für die Fehlerberichterstattung.

Wenn Fehler auftreten, können Ihnen die Logging-Informationen bei der Suche nach der Fehlerquelle helfen. Das Logging ist standardmäßig aktiviert. Sie können die Standard-Log-Ebene ändern, wenn Sie möchten, dass mehr oder weniger Ereignisse in die Logdatei geschrieben werden.

Das Logging am AWI wird vom Tomcat Logback Framework übernommen. Sie können die Log-Ebene in der logback.xml-Datei definieren. Die angegebene Log-Ebene definiert den niedrigsten Schweregrad. Sein Auftreten und das Auftreten von Ereignissen höherer Schweregrade werden protokolliert. Ein umfangreiches Logging kann sich jedoch auf die Leistung des AWI auswirken. Wenn Probleme bei der Leistung auftreten, überprüfen Sie Ihre Log-Ebene und reduzieren Sie die geschriebenen Meldungen, indem Sie bei Bedarf eine höhere Log-Ebene angeben.

Das Logging umfasst die folgenden Dateien:

Log-Ebenen

Die verfügbaren Werte der Log-Ebenen (von oben nach unten) sind:

Log-Ebene wechseln

Das Logging ist standardmäßig auf DEBUG eingestellt, aber bei Bedarf können Sie die Log-Ebene in der Konfigurationsdatei logback.xml ändern, die Sie im Ordner ...\<AWI>\config Ihres Anwendungsservers finden.

Wichtig! Ändern Sie keine weiteren Parameter in dieser Datei. Das Ändern anderer Parameter kann verhindern, dass CA Automic Situationen untersucht, die Fehler verursachen.

Die Log-Ebene ist im <root>-Element durch das Element level="[log_level]"> definiert. Das <root>-Element enthält das Element <appender-ref>, das spezifiziert, dass dieses <root>-Element den LOGGER-Appender definiert. Der LOGGER-Appender ist die Komponente, die die Logging-Ereignisse in die Logdatei schreibt.

Log-Ebene wechseln

  1. Wechseln Sie zum Ordner webapps\<AWI>\config und öffnen Sie die Datei logback.xml.
  2. Suchen Sie nach dem <root>-Element.

    Hinweis: Sie können das <root>-Element am leichtesten finden, indem Sie nach ref="LOGGER" suchen. Das <root> Element steht eine Zeile darüber.

  3. Ändern Sie die Log-Ebene für den Root-Appender, indem Sie das Attribut level="[log_level]" auf die unterste Log-Ebene setzen, für die Meldungen in die Logdatei geschrieben werden sollen. Weitere Informationen finden Sie unter Log-Ebenen.
  4. Damit die Änderungen wirksam werden, müssen Sie den Anwendungsserver stoppen und neu starten.

Beispiel

Im folgenden Beispiel wird die Log-Ebene auf "DEBUG" (Standardwert) gesetzt. Wenn Sie sie auf "INFO" ändern, werden weniger Meldungen in die Datei geschrieben, da unkritische Logmeldungen ignoriert werden.

<!-- Hier wird die Log-Ebene festgelegt. Mögliche Werte: TRACE, DEBUG, INFO, WARN, ERROR

          DEBUG wird für Test- und Entwicklungsinstanzen empfohlen.

          INFO wird für Produktionsinstanzen empfohlen.

-->

<root level="DEBUG">

          <appender-ref ref="LOGGER" />

</root>

AWI-Logdateien

Die Logdateien befinden sich im Ordner logs Ihres Anwendungsservers und heißen <host name>_ECC_Log.##.TXT:

Die aktuelle Logdatei ist eine .txt-Datei, ältere Logdateien werden in .zip-Archive komprimiert.

Hinweis: Als Administrator können Sie auch das Schreiben von Trace-Dateien (ähnlich benannt wie die Logdateien (<Host name>_ECC_TRACE.##)) in diesen Ordner aktivieren, um die Ursache eines Fehlers zu finden.

Anpassen der Benutzeroberfläche

Standardmäßig hat die AWI-Oberfläche das CA Automic-Logo im Anmeldedialog und in der Kopfzeile. Alle Seiten verwenden die Standardfarbe Gold sowie Schwarz- und Grautöne. Sie können die Farbe und das Logo anpassen, um die Marke Ihres Unternehmens widerzuspiegeln.

Ändern des Logos

  1. Bereiten Sie Ihre Logo-Datei vor. Achten Sie darauf, dass die Bildgröße nicht größer ist als:

    • Breite: 96 px

    • Höhe: 70 px

  2. Kopieren Sie logo.png in den Ordner …\<AWI>\config\theme.

  3. Fügen Sie den Konfigurationsparameter logo.filename = logo.png zur Datei "color.properties" hinzu, um das neue Logo anzugeben.

  4. Je nachdem, wie Ihr Logo aussieht, können Sie eine weiße Box hinzufügen, um es vom dunklen Hintergrund zu unterscheiden. Fügen Sie dazu den Parameter white.background = true in die Datei "color.properties" ein.

    Hinweis: Wenn Sie die Änderungen bei der nächsten Anmeldung am AWI nicht sehen, starten Sie den Tomcat-Webserver neu.

Ändern des Farbschemas

  1. Öffnen Sie die Datei colors.properties, die sich im Ordner …\webapps\<AWI>\config\theme befindet. Weitere Informationen finden Sie unter colors.properties.

  2. Geben Sie im Hauptfarbenparameter den RGB-Farbcode an. Stellen Sie sicher, dass davor ein Rautezeichen (#) und danach ein Semikolon (;) steht.

    Geben Sie beispielsweise "maincolor = #fac800;" für das Standardgold ein.

    Hinweis: Wenn Sie die Änderungen bei der nächsten Anmeldung am AWI nicht sehen, starten Sie den Tomcat-Webserver neu.

Anpassen der Konfigurationsdateien

Es gibt eine Reihe von obligatorischen und optionalen Konfigurationsdateien, die Sie anpassen müssen.

Wichtig! Die Konfigurationsdateien, die hier nicht angeführt werden, sollten nicht verändert werden.

Nach der Installation und Konfiguration des AWI können Sie mit der Einrichtung Ihres Systems beginnen oder mit der Installation anderer Plug-ins und Komponenten fortfahren.

Weitere Informationen finden Sie unter Voraussetzungen und Installationstypen.

Den Load Balancer einrichten und Proxys konfigurieren

Sie können das Automic Web Interface über jede Art von Proxy im allgemeinen Sinne nutzen, sei es für TLS-Terminierung, Lastausgleich, Redundanz oder all dies gleichzeitig.

Ein einzelner, leistungsstarker Server kann den in AWI erwarteten Verkehr in einer Automation Engine-Hochleistungsinstallation verarbeiten. Aus diesem Grund müssen Sie keine Load Balancer einrichten, um die Leistung des Automic Web Interface zu verbessern.

Wenn Sie jedoch Hochverfügbarkeit wünschen, müssen verschiedene AWI-Instanzen auf unterschiedlichen Hosts ausgeführt werden.

In diesem Fall benötigen Sie einen Load Balancer, um den Datenverkehr umzuleiten, falls eine der AWI-Instanzen fehlschlägt.

Tipp: Es wird empfohlen, eine Hot/Hot-Konfiguration mit zwei Instanzen zu verwenden, die beide den Datenverkehr gemeinsam bedienen. Eine Umschaltung sollte nur erfolgen, wenn der eine Server ausfällt. Außerdem muss jede Instanz in der Lage sein, den gesamten Datenverkehr zu verarbeiten. Wenn die andere Instanz fehlschlägt, würde diejenige, die ihre Aufgaben übernimmt, überlastet. Wenn ein einzelner Server aus irgendeinem Grund den Ladevorgang nicht verarbeiten kann, können Sie weitere Instanzen hinzufügen, um Fehler zu beheben. Zum Beispiel vier oder fünf Instanzen statt der erforderlichen drei.

Anforderungen an Load Balancer

Statusprüfung

Wenn Ihr Load Balancer Statusprüfungen über zusätzliche http-Eingabeaufforderungen durchführt, stellen Sie sicher, dass der entsprechende Pfad verwendet wird. Wenn Ihr AWI beispielsweise über https://myawiserver/awi erreichbar ist, sollte die Statusprüfung https://myawiserver/awi/check aufrufen. 

Diese URL gibt eine Antwort mit dem Statuscode 200 zurück, wenn das AWI

Upgrades

Ein Load Balancer oder Proxy kann sehr nützlich sein, um beim Abschluss eines Zero Downtime Upgrade transparent zwischen zwei Versionen des AWI zu wechseln. Weitere Informationen finden Sie unter Zero Downtime Upgrade.

WebSockets

Bei Tomcat verwendet das AWI WebSockets als effiziente Möglichkeit, um Informationen an den Mandanten zu senden. Wenn Sie Weblogic oder Websphere verwenden, greift das AWI auf langes Polling zurück. 

Hinweise:

Tipps:

Engpässe lokalisieren

AWI zeigt Ladeindikatoren an, während auf Antworten auf Backend-Eingabeaufforderungen gewartet wird. Mögliche Engpasssymptome sind: