KIM-Konfiguration in charly-Web (für Systembetreuer)

Über diese Anleitung

KIM in charly ist die Schnittstelle zwischen charly und dem KIM-Dienst.

Hinweis: Diese Anleitung beschreibt die Konfiguration von KIM in charly. Sie richtet sich an Systembetreuer und setzt Grundkenntnisse zur E-Health- Telematikinfrastruktur voraus.
Hinweis: Diese Anleitung setzt voraus, dass die Telematikinfrastruktur in der Praxis bereits eingerichtet und in charly der Konnektor sowie die Aufrufkontexte konfiguriert sind, siehe TI-Konfiguration im TI-Monitor.
Hinweis: Alle notwendigen Informationen rund um den prinzipiellen Aufbau sowie die Verwaltung des Servers, haben wir in dem Kapitel Server für Sie zusammengefasst.

 

Voraussetzungen

Telematikinfrastruktur

Für die Verwendung des KIM-Dienstes benötigen Sie folgende, von der gematik zugelassene, Komponenten und Dienste:

Tipp: Das Fachportal der gematik bietet u.a. eine Liste aller zugelassenen Komponenten und Dienste.

Ports

Übersicht der Ports, die für die Kommunikation zwischen den Komponenten erforderlich sind:

Port Beschreibung
10443 Standard für den SSL-Proxy. Wird vom charly-Updater in der Firewall geöffnet. Kann im charly-Updater umkonfiguriert werden. Führen Sie dazu den charly-Updater erneut aus.
14711 (HTTP) Standard für den Messaging-Service. Wird vom charly-Updater in der Firewall geöffnet. Kann im charly-Updater umkonfiguriert werden. Führen Sie dazu den charly-Updater erneut aus.
14712 (STOMP) Standard für den Messaging-Service. Kann in der „application.yml“-Datei des Messaging-Services geändert werden.

Konfiguration

Falls einer oder mehrere der erforderlichen Ports für KIM bereits belegt sind, konfigurieren Sie diese um:

In charly: TI-Konfiguration prüfen

Hinweis: Diese Anleitung setzt voraus, dass die Telematikinfrastruktur in der Praxis bereits eingerichtet und in charly der Konnektor sowie die Aufrufkontexte konfiguriert sind, sieheTI-Konfiguration im TI-Monitor.
Hinweis: Entsprechend der Anforderungen der IT-Sicherheitsrichtlinie empfiehlt die solutio GmbH & Co. KG die Konfiguration mittels TLS mit Zertifikatsprüfung.

In charly-Web können Sie in der Perspektive Administration > TI-Monitor u.a. die Konfiguration des Konnektors sowie der Aufrufkontexte einsehen.

KIM-Clientmodul installieren und konfigurieren

Hinweis: Das KIM-Clientmodul erhalten Sie von Ihrem KIM-Provider. Installieren Sie das KIM-Clientmodul auf dem charly-Server. Für die Installation und Konfiguration des KIM-Clientmoduls lesen Sie bitte die Dokumentation Ihres KIM-Providers.

Ports

Für das Empfangen und Senden von Nachrichten über das KIM-Clientmodul, müssen in KIM bei der Konfiguration eines KIM-Kontos entsprechend die URLs für POP3 sowie SMTP eingegeben werden.

Hinweis: Unter macOS können Ports mit einer Portnummer < 1024 vom KIM-Cientmodul nicht aufgerufen werden (auch nicht mit Admininstrator-Rechten). Bitte ändern Sie die Ports im KIM-Clientmodul für POP3 und SMTP auf eine freie Portnummer > 1024.

KIM-Konto erstellen

Die KIM-Konten erstellen Sie in charly-Web in der Perspektive Administration > KIM-Konten.

Tipp: Für möglichst automatisierte Abläufe im Praxisalltag, empfiehlt es sich, mindestens ein Praxiskonto in KIM einzurichten. Durch die Verknüpfung des Praxiskontos mit dem Praxisausweis (SMC-B), werden die folgenden Aktionen für dieses Praxiskonto i.d.R. ohne weiteres Zutun des Praxispersonals durchgeführt:
  • Synchronisierung der Postfächer
  • Entschlüsselung eingehender KIM-Nachrichten mit der SMC-B-Karte
  • Verschlüsselung ausgehender KIM-Nachrichten mit der SMC-B-Karte
  • Optionale Signierung von Anhängen mit der nonQES der SMC-B-Karte
  • Automatischer Versand von eAU und EBZ-Nachrichten, sofern das Praxiskonto bei der eAU-Erstellung für den Versand gewählt wurde.

Die automatisierten Abläufe sind mit einem Praxiskonto möglich, da der verknüpfte Praxisausweis (SMC-B) i.d.R. dauerhaft im Kartenterminal steckt. Durch die (fast) täglichen eGK-Einlesungen befindet sich der SMC-B im Status „verified“ und erfüllt damit die Voraussetzungen für die Funktionalitäten im Praxiskonto.

Rechte

Aktion Recht Einzelrecht
    Lesen Ändern Löschen Neu
KIM-Konten-Übersicht öffnen KIM4charly Stammdaten      
KIM-Konto hinzufügen

KIM4charly Stammdaten

 
KIM-Kontogäste verwalten *

KIM4charly Stammdaten

 

  
KIM-Konto bearbeiten *

KIM4charly Stammdaten

 

  
KIM-Konto löschen *

KIM4charly Stammdaten

Zertifikat löschen*

KIM4charly Stammdaten

* Der charly-Anwender muss zusätzlich der Kontobesitzer des jeweiligen KIM-Kontos sein.

Die Zugriffsberechtigungen definieren Sie in den Stammdaten > Praxis > Gruppen > Rechte.

How-to

Tipp: Bitte beachten Sie die FAQ am Ende des Kapitels. Dort finden Sie u.a. die Standard-URLs für gängige KIM-Clientmodule.

Voraussetzungen

  • Siehe Voraussetzungen.
  • Sie sind als KIM-Nutzer mit Ihren Basisdaten im zentralen Verzeichnisdienst (VZD) eingetragen (wird durch die KZVen gepflegt).
  • Sie haben sich bei einem KIM-Provider angemeldet und eine KIM-(E-Mail-)Adresse erhalten. Diese KIM-Adresse wurde von dem KIM-Provider im zentralen VZD eingetragen.
  • Die URL für den VZD in charly-Web ist in der Perspektive Administration > TI-Monitor beim Konnektor im Feld LDAP-URL hinterlegt.
  • Sie haben von Ihrem KIM-Provider die POP3- sowie die SMTP-URL erhalten, unter denen die KIM-Kommunikation abgewickelt werden soll.

  • Sie kennen die POP3- sowie SMTP-URL des KIM-Clientmoduls.

    Hinweis: Unter macOS können Ports mit einer Portnummer < 1024 vom KIM-Cientmodul nicht aufgerufen werden (auch nicht mit Admininstrator-Rechten). Bitte ändern Sie die Ports im KIM-Clientmodul für POP3 und SMTP auf eine freie Portnummer > 1024.
  • Sie verfügen über eine freigeschaltete SMC-B- bzw. über einen freigeschaltete HBA-Karte.
  • Die SMC-B- / die HBA-Karte steckt im Kartenterminal.
  • Der Konnektor ist für den Online-Modus konfiguriert.
  • Für die KIM-Adresse ist in KIM noch kein KIM-Konto erstellt.
  • Der charly-Anwender verfügt über die Mindest-Zugriffsberechtigungen, um ein KIM-Konto hinzuzufügen. Siehe Lizenz und Rechte.

Vorgehensweise

  1. Klicken Sie den Button Konto hinzufügen.

  2. Wählen Sie den Kontotyp.

    • Wählen Sie SMC-B für ein allgemeines KIM-Konto der Praxis. Ein Praxiskonto wird mit einem Praxisausweis (SMC-B) verknüpft.
    • Wählen Sie HBA für ein personenbezogenes KIM-Konto. Ein Behandlerkonto wird mit dem Heilberufsausweis (HBA) eines Behandlers verknüpft.

  3. Geben Sie die Daten Ihres KIM-Kontos ein:

    Element Beschreibung
    Kontobesitzer

    Auswahlmöglichkeit des Besitzers. Es werden nur charly-Anwender gelistet, bei denen in den Stammdaten > Praxis > Beschäftigte die Checkbox Behandler aktiviert ist.

    • Voller Zugriff auf die KIM-Nachrichten.
    • Dürfen das KIM-Konto verwalten (bearbeiten, löschen, Kontogäste hinzufügen / entfernen). Normalerweise der Zahnarzt oder ggf. ein Systembetreuer, der das KIM-Konto im Auftrag des Zahnarztes verwaltet.
    KIM-Passwort Ihr Passwort für das KIM-Konto, wie Sie es im KIM-Clientmodul festgelegt haben.
    ICCSN

    Identifikationsnummer der Karte, mit der das KIM-Konto verknüpft ist. Sie ist nötig, um KIM-Nachrichten zu senden und zu empfangen. Wird vom KIM-Clientmodul für die Transportverschlüsselung verwendet.

    • Bei einem Praxiskonto wählen Sie die SMC-B-Karte aus der Dropdownliste oder geben Sie die ICCSN der SMC-B-Karte ein. Bei Praxiskonten werden nur SMC-B-Karten angeboten.
    • Bei einem Behandlerkonto wählen Sie die HBA-Karte aus der Dropdownliste oder geben Sie die ICCSN der HBA-Karte ein. Bei Behandlerkonten werden nur HBA-Karten angeboten.
    • Wenn die Karte noch nicht in charly vorhanden ist, kann die ICCSN auch manuell eingegeben werden.

  4. Geben Sie im Bereich Clientmodul-Verbindung die Verbindungsdaten zum KIM-Clientmodul ein.

    Element Beschreibung
    POP3

    URL, unter der das Clientmodul die KIM-Nachrichten vom POP3-Server des KIM-Providers abholt.

    Tipp: Der Standard-Port für POP3 mit TLS lautet 995. Ein abweichender Port des Clientmoduls muss dementsprechend in KIM eingetragen werden.

    Bitte beachten Sie die FAQ am Ende des Kapitels. Dort finden Sie u.a. die Standard-URLs für gängige Clientmodule.
    SMTP

    URL, unter der das Clientmodul die KIM-Nachrichten an den Mail Transfer Agent des KIM-Providers übermittelt

    Tipp: Der Standard-Port für SMTP mit TLS lautet 465. Ein abweichender Port des Clientmoduls muss dementsprechend in KIM eingetragen werden.

    Bitte beachten Sie die FAQ am Ende des Kapitels. Dort finden Sie u.a. die Standard-URLs für gängige Clientmodule.
    CA-Zertifikat [Optional] Klicken Sie auf den Button  CA-Zertifikat wählen. Navigieren Sie zu dem CA-Zertifikat, markieren Sie es und klicken Sie auf den Button Hochladen. Falls Sie das Zertifikat wieder entfernen möchten, klicken Sie direkt beim Dateinamen des Zertifikats auf das .
    Clientzertifikat [Optional] Klicken Sie auf den Button  Clientzertifikat wählen. Navigieren Sie zu dem Clientzertifikat, markieren Sie es und klicken Sie auf den Button Hochladen. Falls Sie das Zertifikat wieder entfernen möchten, klicken Sie direkt beim Dateinamen des Zertifikats auf das .
    Passwort [Optional] Geben Sie das Passwort des Clientzertifikats ein.

  5. Geben Sie im Bereich KIM-Benutzernamen die Daten ein.

    Element Beschreibung
    POP3-Benutzername

    Geben Sie in das Feld POP3-Benutzernamen den POP3-Benutzernamen aus dem KIM-Clientmodul ein.

    • Anhand der Eingabe wird automatisch die Konfiguration im Bereich „Detail-Konfiguration” vorgefüllt.
    SMTP-Benutzername

    Geben Sie in das Feld SMTP-Benutzernamen den SMTP-Benutzernamen aus dem KIM-Clientmodul ein.

    • Anhand der Eingabe wird automatisch die Konfiguration im Bereich „Detail-Konfiguration” vorgefüllt.
    KIM-Adresse

    Wird automatisch gefüllt, wenn Sie zuvor den POP3- bzw. SMTP-Benutzername eingegeben haben.

    Kann alternativ manuell eingegeben werden → erhalten Sie von Ihrem KIM-Provider.
    Aufrufkontext

    Wird automatisch gefüllt, wenn Sie zuvor den POP3- bzw. SMTP-Benutzername eingegeben haben.

    Kann alternativ manuell eingegeben werden:

    • Dynamische Ermittlung: Der Aufrufkontext wird dynamisch ermittelt.
    • Manuelle Eingabe: Füllen Sie die Felder Mandanten-ID, Client-ID und Arbeitsplatz-ID.
    • Wenn bereits Aufrufkontexte hinterlegt sind, können Sie diese ebenfalls wählen.
    Multikonnektor-Setup

    [Optional] Wird automatisch gefüllt, wenn Sie zuvor den SMTP-Benutzername eingegeben haben und darin eine Konnektor-ID enthalten ist.

    Kann alternativ manuell eingegeben werden:

    1. Aktivieren Sie den Schalter Multikonnektor-Setup.

      • Das Freitextfeld Konnektor-ID wird eingeblendet.
    2. Geben Sie die Konnektor-ID ein.
    Provider

    Wird automatisch gefüllt, wenn Sie zuvor den POP3- bzw. SMTP-Benutzername eingegeben haben.

    Kann alternativ manuell eingegeben werden:

    • Manuelle Eingabe: Füllen Sie die Felder POP3 und SMTP.

      • POP3: URL, unter der die KIM-Nachrichten vom KIM-Server abgerufen werden → erhalten Sie von Ihrem KIM-Provider
      • SMTP: URL, unter der die KIM-Nachrichten zum KIM-Server gesendet werden → erhalten Sie von Ihrem KIM-Provider
    • Dynamische Ermittlung: Der Aufrufkontext wird dynamisch ermittelt.
    Tipp: Bitte beachten Sie die FAQ am Ende des Kapitels. Dort finden Sie u.a. die Standard-URLs für gängige KIM-Provider.

  6. Klicken Sie auf Speichern.

    • Das KIM-Konto ist erstellt und wird in der Liste der KIM-Konten angezeigt.
    • In der Perspektive  Praxis >  KIM-Nachrichten können Sie mit diesem Konto KIM-Nachrichten versenden.

Nächste Schritte

Voraussetzungen

  • Siehe Voraussetzungen.
  • Der charly-Anwender ist Besitzer des KIM-Kontos.
  • Der charly-Anwender verfügt über die Mindest-Zugriffsberechtigungen um Kontogäste zu verwalten. Siehe Lizenz und Rechte.

Vorgehensweise

  1. Klicken Sie auf den KIM-Kontogäste verwalten-Button  am Ende der Zeile.

    • Ein Fenster öffnet sich. Es werden alle aktiven charly-Anwender gelistet. Der Konto-Besitzer des aktuell gewählten Kontos erscheint nicht in dieser Liste.
    • Die Spalte Status zeigt, ob der charly-Anwender bereits ein Kontogast ist.

  2. Sie haben folgende Möglichkeiten:

    • Kontogast hinzufügen

      • Klicken Sie in der Tabelle bei dem charly-Anwender auf den Menü-Button  am Ende der Zeile und klicken Sie auf  Als Gast markieren.
      • Markieren Sie in der Tabelle alle charly-Anwender, für die Sie die Aktion durchführen möchten und klicken Sie in der Fußzeile auf den Button auf  Als Gast markieren.

    • Kontogast entfernen

      • Klicken Sie in der Tabelle bei dem entsprechenden charly-Anwender auf den Menü-Button  am Ende der Zeile und klicken Sie auf  Gaststatus entfernen.
      • Markieren Sie in der Tabelle charly-Anwender, für die Sie die Aktion durchführen möchten und klicken Sie in der Fußzeile auf den Button auf  Gaststatus entfernen.
      • Die Übersicht der KIM-Konten wird aktualisiert.

FAQ

Clientmodule

Hinweis: Verwenden Sie bei der Clientmodul-Konfiguration immer die feste IP-Adresse des Hostsystems, auf dem das KIM-Clientmodul installiert ist. Nicht empfohlen ist die Verwendung von localhost oder 127.0.0.1.
  Clientmodul POP3 mit TLS Clientmodul SMTP mit TLS
AKQUINET pop3s://<IP-Adresse des KIM-Clientmodul-Hostsystems>:995 smtps://<IP-Adresse des KIM-Clientmodul-Hostsystems>:465
Arvato
T-Systems
CGM pop3s://<IP-Adresse des KIM-Clientmodul-Hostsystems>:8995 smtps://IP-Adresse des KIM-Clientmodul-Hostsystems>:8465

Provider

  POP3 SMTP
AKQUINET mail.akquinet.kim.telematik:995 mail.akquinet.kim.telematik:465
Arvato mail.arv.kim.telematik:995 mail.arv.kim.telematik:465
CGM <spezifische-mail-domain>:995 <spezifische-mail-domain>:465
T-Systems lb-mail.eqxffm.tsi.kim.telematik:995 lb-mail.eqxffm.tsi.kim.telematik:465

Das Protokoll der URL ist abhängig von der Clientmodul-Konfiguration:

TLS Protokoll
ohne

pop3

smtp

mit

pop3s

smtps

 

Server

charly-Java-Server

Der charly-Java-Server (ncjs) bezeichnet die Summe aller Microservices und die für deren Betrieb erforderliche Infrastruktur, welche auf dem Server der Zahnarztpraxis betrieben wird.

Hinweis: Der charly-Java-Server ist automatisch in charly enthalten und wird im Rahmen der charly-Updates laufend aktualisiert.

Installationspfad charly-Java-Server (ncjs)

Alle Komponenten des charly-Java-Servers befinden sich auf dem charly-Server unter folgendem Pfad:
<charly-Installationspfad>\Solutio\Server\ncjs

Konfigurationsdatei "application.yml"

Services werden mit Hilfe der Datei application.yml konfiguriert. Für jeden Service gibt es eine eigene „application.yml“-Datei.

Kundenspezifische Konfigurationen müssen unter ncjs in dem Verzeichnis conf2 abgelegt werden, da dieses Verzeichnis durch charly-Updates nicht überschrieben wird. Innerhalb des Verzeichnisses conf2 muss für jeden Service, für den eine kundenspezifische Konfiguration hinterlegt wird, ein weiteres Verzeichnis mit dem Namen des Service angelegt werden. Dort wird die kundenspezifische „application.yml“-Datei abgelegt.

Beispiel: Pfad einer kundenspezifischen „application.yml“-Datei mit Konfigurationen für den soldicom-Service:
\Solutio\Server\ncjs\conf2\soldicom\application.yml

Service-Registry

Die Service-Registry fasst die Services, ihre Instanzen und ihre Lokationen in einer Datenstruktur zusammen. Die Services werden unter einem logischen Namen registriert und lassen sich anschließend über diesen Namen ansprechen.

Eine Liste aller registrierter und gestarteter Services ist in charly-Web einsehbar. Diese können Sie wie folgt aufrufen:

  1. Klicken Sie im charly-Client auf den Button charly-Web rechts neben den Hauptbereichen.

    • Ein Browser-Tab öffnet sich.
  2. Klicken Sie in der Kopfleiste auf die Perspektive Administration.
  3. Klicken Sie im Navigationsbereich auf Systemstatus > Komponenten .
  4. Klicken Sie auf den Schnellfilter Alle.
    5. Tipp: Wenn Sie die Services gerade neu gestartet haben, dauert es ca. 1-2 Minuten, bis alle registrierten Microservices zur Verfügung stehen.

Alternativ können Sie auf dem Server bei einer nativen Installation in einem Browser-Fenster folgende URL eingeben: http://<IP des charly-Servers>:8087

Bei einer charly-VM-Installation geben Sie im Browser-Fenster folgende URL ein: http://<IP der charly-VM>

Hinweis: Falls Sie den Port für den discovery-Service über den charly-Updater geändert haben, geben Sie stattdessen diesen geänderten Port in der URL an. Bei einercharly-VM-Installation lautet der Port per default 11059.

Kommandozeilenwerkzeug für Serversteuerung

Alle Services werden im Rahmen eines charly-Updates durch den charly-Updater registriert und gestartet.

Tipp: Einige Funktionen zur Serversteuerung stehen in charly-Web bereits in der Perspektive Administration > Systemstatus >  Komponenten zur Verfügung. Dort können einzelne Komponenten je nach Ausbaustand direkt gestoppt oder neu gestartet werden.

Tool „ACD“

Für den Fall, dass ein Service z.B. für eine Konfigurationsänderung manuell gestoppt und wieder gestartet werden muss, gibt es das Tool ACD.

Das ACD-Tool besteht aus jeweils einer Skript-Datei für Windows (acd.bat) und macOS (acd.sh). Die Skriptdateien sind grundsätzlich in Funktion und Oberfläche identisch. Das Skript muss über die Kommandozeile im Administratormodus ausgeführt werden. Dazu muss in der Kommandozeile der Pfad zu dem Verzeichnis geöffnet sein, in dem die Skripdateien (acd.bat bzw. acd.sh) liegen.

Die Skriptdateien befinden sich unter: \Solutio\Server\ncjs.

Aufruf

Der Aufruf beginnt immer mit der Angabe des Skripts gefolgt von dem eigentlichen Befehl. Die Syntax lautet wie folgt:

 

Es gibt Befehle, die für alle bekannten Services gleichzeitig durchgeführt werden und Befehle, mit denen Sie nur einen bestimmten Service ansprechen. Für diese „Einzelbefehle“ müssen Sie den Namen des Services angeben. Die Namen der Services finden Sie heraus, indem Sie in der Kommandozeile folgenden Befehl eingeben:

 

Als Ergebnis erhalten Sie eine Liste aller bekannten Services.

Beispiel: Im Folgenden ein Beispiel für den auth-Service. Der Name ist die Angabe hinter Name. In diesem Fall auth: 
     Name: auth
   Memory: 32m/256m
 Filename: auth-service-app-1.3.0-SNAPSHOT.jar
Full name: NCJS Auth
    State: RUNNING

 

Mit dem Namen können Sie nun einen „Einzelbefehl“ für den auth-Service absetzen.

Beispiel: Der auth-Service mit dem Namen auth soll über ACD gestoppt werden.

  • Windows 

    acd.bat stop auth

  • macOS 

    sudo ./acd.sh stop auth

Befehle

Befehl Beschreibung
list Listet alle bekannten Services mit folgenden Informationen: Name, Speicher, Dateiname, voller Name und Status.
register Registriert einen Service als Systemdienst. Der Name des Services muss angegeben werden.
registerall Funktioniert wie der Befehl register, wird jedoch für alle bekannten Services ausgeführt.
start Startet einen Service. Der Name des Service muss angegeben werden. Um den Start-Befehl erfolgreich auszuführen, muss der Service bereits registriert sein.
startall Funktioniert wie der Befehl start, wird jedoch für alle bekannten Services ausgeführt. Um den Start-Befehl erfolgreich auszuführen, müssen die Services bereits registriert sein.
stop Stoppt einen Service als Systemdienst. Der Name des Service muss angegeben werden.
stopall Funktioniert wie der Befehl stop, wird jedoch für alle bekannten Services ausgeführt.
unregister Meldet einen Service als Systemdienst ab. Der Name des Service muss angegeben werden. Falls der Service noch läuft, führt diesen Befehl vor dem unregister ein stop durch.
unregisterall Funktioniert wie der Befehl unregister, wird jedoch für alle bekannten Services ausgeführt. Für Services, die noch laufen, führt diesen Befehl vor dem unregister ein stop durch.
enabledelayed [Windows] Aktiviert dauerhaft den verzögerten automatischen Start der NCJS-Windows-Dienste kurz nach dem Hochfahren von Windows. Die Einstellung wird in der Konfiguration gespeichert und bei der Registrierung der Dienste verwendet.
disabledelayed [Windows] Aktiviert dauerhaft den sofortigen automatischen Start der NCJS-Windows-Dienste beim Hochfahren von Windows. Die Einstellung wird in der Konfiguration gespeichert und bei der Registrierung der Dienste verwendet.

How-to

Windows

Voraussetzungen

  • Sie haben Zugriff auf den charly-Server.
  • Sie kennen das Administrator-Passwort.

Vorgehensweise

  1. Drücken Sie die Windows-Taste.

  2. Geben Sie in das Suchfeld folgendes ein: cmd.

    • Die Eingabeaufforderung wird gefunden.

  3. Wählen Sie „Als Administrator ausführen“.

    • Die Eingabeaufforderung wird im Administrator-Modus geöffnet.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>\Solutio\Server\ncjs
    Beispiel: Wenn charly auf Ihrem Server auf dem Laufwerk S:\ installiert ist: 

    cd S:\Solutio\Server\ncjs\

  5. Stoppen Sie die Microservices mit folgendem Befehl:

    acd.bat stopall

  6. Drücken Sie die Enter-Taste.

    • Die Microservices werden gestoppt.

Alle Microservices starten

Die Vorgehensweise ist dieselbe, wie beim Stoppen der Microservices. Einziger Unterschied ist der Befehl, mit dem Sie die Microservices starten:

acd.bat startall
Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Diese Funktionalität benötigen Sie beispielsweise, um für einen Microservice eine kundenspezifische Konfiguration in der Konfigurationsdatei (application.yml) zu hinterlegen.

Voraussetzungen

Vorgehensweise

  1. Drücken Sie die Windows-Taste.

  2. Geben Sie in das Suchfeld folgendes ein: cmd.

    • Die Eingabeaufforderung wird gefunden.

  3. Wählen Sie „Als Administrator ausführen“.

    • Die Eingabeaufforderung wird im Administrator-Modus geöffnet.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>\Solutio\Server\ncjs
    Beispiel: Wenn charly auf Ihrem Server auf dem Laufwerk S:\ installiert ist: 

    cd S:\Solutio\Server\ncjs\

  5. Stoppen Sie den Microservice mit folgendem Befehl:

    acd.bat stop <Short Name>
    Beispiel: 

    acd.bat stop ehkp

  6. Drücken Sie die Enter-Taste.

    • Der Microservice wird gestoppt.

Einzelnen Microservice starten

Die Vorgehensweise ist dieselbe, wie beim Stoppen des Microservices. Einziger Unterschied ist der Befehl, mit dem Sie den Microservice starten:

acd.bat start <Short Name>
Beispiel: 

acd.bat start ehkp

Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Beim Deregistrieren, wird der Microservice zuvor automatisch gestoppt.

Voraussetzungen

Vorgehensweise

  1. Drücken Sie die Windows-Taste.

  2. Geben Sie in das Suchfeld folgendes ein: cmd.

    • Die Eingabeaufforderung wird gefunden.

  3. Wählen Sie „Als Administrator ausführen“.

    • Die Eingabeaufforderung wird im Administrator-Modus geöffnet.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>\Solutio\Server\ncjs
    Beispiel: Wenn charly auf Ihrem Server auf dem Laufwerk S:\ installiert ist: 

    cd S:\Solutio\Server\ncjs\

  5. Deregistrieren Sie den Microservice mit folgendem Befehl:

    acd.bat unregister <Short Name>
    Beispiel: 

    acd.bat unregister ehkp

  6. Drücken Sie die Enter-Taste.

    • Der Microservice wird deregistriert.

Einzelnen Microservice registrieren

Die Vorgehensweise ist dieselbe, wie beim Deregistrieren des Microservices. Einziger Unterschied ist der Befehl, mit dem Sie den Microservice registrieren:

acd.bat register <Short Name>
Beispiel: 

acd.bat register ehkp

Einzelnen Microservice starten 

acd.bat start <Short Name>
Beispiel: 

acd.bat start ehkp

Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Voraussetzungen

  • Sie haben Zugriff auf den charly-Server.
  • Sie kennen das Administrator-Passwort.

Vorgehensweise

  1. Drücken Sie die Windows-Taste.

  2. Geben Sie in das Suchfeld folgendes ein: cmd.

    • Die Eingabeaufforderung wird gefunden.

  3. Wählen Sie „Als Administrator ausführen“.

    • Die Eingabeaufforderung wird im Administrator-Modus geöffnet.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>\Solutio\Server\ncjs
    Beispiel: Wenn charly auf Ihrem Server auf dem Laufwerk S:\ installiert ist: 

    cd S:\Solutio\Server\ncjs\

  5. Geben Sie folgenden Befehl ein:

    acd.bat list
    • Als Ergebnis erhalten Sie eine Liste aller bekannten Microservices.

Mac

Voraussetzungen

  • Sie haben Zugriff auf den charly-Server.
  • Sie kennen das Administrator-Passwort.

Vorgehensweise

  1. Klicken Sie im Finder in der Menüleiste auf die Suchlupe.

    • Die Spotlight-Suche öffnet sich.

  2. Geben Sie „terminal“ ein.

    • Die Terminal.app wird gefunden.

  3. Wählen Sie die Terminal.app.

    • Das Terminal öffnet sich.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>/Solutio/Server/ncjs
    Beispiel: Wenn charly auf Ihrem Server unter Applications (Programme) installiert ist 

    cd Applications/Solutio/Server/ncjs

  5. Stoppen Sie die Microservices mit folgendem Befehl:

    sudo ./acd.sh stopall

  6. Drücken Sie die Enter-Taste.

    • Die Microservices werden gestoppt.

Alle Microservices starten

Die Vorgehensweise ist dieselbe, wie beim Stoppen der Microservices. Einziger Unterschied ist der Befehl, mit dem Sie die Microservices starten:

sudo ./acd.sh startall
Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Diese Funktionalität benötigen Sie beispielsweise, um für einen Microservice eine kundenspezifische Konfiguration in der Konfigurationsdatei (application.yml) zu hinterlegen.

Voraussetzungen

Vorgehensweise

  1. Klicken Sie im Finder in der Menüleiste auf die Suchlupe.

    • Die Spotlight-Suche öffnet sich.

  2. Geben Sie „terminal“ ein.

    • Die Terminal.app wird gefunden.

  3. Wählen Sie die Terminal.app.

    • Das Terminal öffnet sich.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>/Solutio/Server/ncjs
    Beispiel: Wenn charly auf Ihrem Server unter Applications (Programme) installiert ist 

    cd Applications/Solutio/Server/ncjs

  5. Stoppen Sie den Microservice mit folgendem Befehl:

    sudo ./acd.sh stop <Short Name>
    Beispiel: 

    sudo ./acd.sh stop ehkp

  6. Drücken Sie die Enter-Taste.

    • Der Microservice wird gestoppt.

Einzelnen Microservice starten

Die Vorgehensweise ist dieselbe, wie beim Stoppen des Microservices. Einziger Unterschied ist der Befehl, mit dem Sie den Microservice starten:

sudo ./acd.sh start <Short Name>
Beispiel: 

sudo ./acd.sh start ehkp

Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Beim Deregistrieren, wird der Microservice zuvor automatisch gestoppt.

Voraussetzungen

Vorgehensweise

  1. Klicken Sie im Finder in der Menüleiste auf die Suchlupe.

    • Die Spotlight-Suche öffnet sich.

  2. Geben Sie „terminal“ ein.

    • Die Terminal.app wird gefunden.

  3. Wählen Sie die Terminal.app.

    • Das Terminal öffnet sich.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>/Solutio/Server/ncjs
    Beispiel: Wenn charly auf Ihrem Server unter Applications (Programme) installiert ist 

    cd Applications/Solutio/Server/ncjs

  5. Deregistrieren Sie den Microservice mit folgendem Befehl:

    sudo ./acd.sh unregister <Short Name>
    Beispiel: 

    sudo ./acd.sh unregister ehkp

  6. Drücken Sie die Enter-Taste.

    • Der Microservice wird deregistriert.

Einzelnen Microservice registrieren

Die Vorgehensweise ist dieselbe, wie beim Deregistrieren des Microservices. Einziger Unterschied ist der Befehl, mit dem Sie den Microservice registrieren:

sudo ./acd.sh register <Short Name>
Beispiel: 

sudo ./acd.sh register ehkp

Einzelnen Microservice starten 

sudo ./acd.sh start <Short Name>
Beispiel: 

sudo ./acd.sh start ehkp

Hinweis: Der Start der Microservices dauert ca. 1-2 Minuten.
Tipp:

Wenn die Kommandozeile bzw. das Terminal noch geöffnet sind und Sie sich noch in dem ncjs-Verzeichnis befinden, können Sie den Befehl zum Starten der Services direkt ausführen. Prüfen, ob die Microservices gestartet sind. Sie können an zwei Stellen prüfen, ob die Microservices gestartet sind.

Voraussetzungen

  • Sie haben Zugriff auf den charly-Server.
  • Sie kennen das Administrator-Passwort.

Vorgehensweise

  1. Klicken Sie im Finder in der Menüleiste auf die Suchlupe.

    • Die Spotlight-Suche öffnet sich.

  2. Geben Sie „terminal“ ein.

    • Die Terminal.app wird gefunden.

  3. Wählen Sie die Terminal.app.

    • Das Terminal öffnet sich.

  4. Navigieren Sie zum ncjs-Verzeichnis:

    cd <charly-Installationspfad>/Solutio/Server/ncjs
    Beispiel: Wenn charly auf Ihrem Server unter Applications (Programme) installiert ist 

    cd Applications/Solutio/Server/ncjs

  5. Geben Sie folgenden Befehl ein:

    sudo ./acd.sh list
    • Als Ergebnis erhalten Sie eine Liste aller bekannten Microservices.