KIM4charly Konfiguration (für Systembetreuer)

Über diese Anleitung

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

Hinweis: Diese Anleitung beschreibt die Konfiguration von KIM4charly. 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 Konnektor (TI), Aufrufkontext (TI).
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.

Software

Für KIM4charly benötigen Sie mindestens folgende Software-Versionen:

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.

Für Änderungen an den Ports, siehe

Erforderliche charly-Rechte

Für die Konfiguration von KIM4charly benötigt Ihr charly-Benutzer mindestens folgende Zugriffsrechte in charly:

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

 

Konfiguration

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

How-to

Hinweis: Sofern keine neuere charly-Version vorliegt, aktualisiert der charly-Updater ausschließlich den charly-Java-Server und nimmt dabei die Port-Änderungen vor. Falls eine neuere charly-Version verfügbar ist, aktualisiert der charly-Updater zusätzlich die charly-Version.

Voraussetzungen

  • Der charly-Updater liegt auf dem charly-Server (Download Windows bzw. Download macOS).
  • Der charly-Server verfügt über eine Internetverbindung.

  • Das Ausführen des charly-Updaters ist vorbereitet:

    1. Schalten Sie alle charly-Arbeitsplätze (Clients) aus.
    2. Schließen Sie auf dem charly-Server alle Programme.
    3. Führen Sie auf dem charly-Server eine Datensicherung durch.
    4. Starten Sie den charly-Server neu.
    5. Melden Sie sich mit Administratorrechten am charly-Server an.
    6. Deaktivieren Sie auf dem charly-Server den Virenscanner für den Zeitraum des Updates.

Vorgehensweise

  1. Starten Sie den charly-Updater.
  2. Folgen Sie den Anweisungen des charly-Updater-Assistenten bis zu der Maske für die Konfiguration der Ports für den SSL-Proxy sowie für den Messaging-Service.
  3. Ändern Sie den bzw. die Ports.

  4. Folgen Sie weiter den Anweisungen des charly-Updater-Assistenten.

    • Der charly-Updater führt die Port-Änderungen im charly-Java-Server durch.
  1. Öffnen Sie auf dem Server folgendes Verzeichnis:
    <charly-Installationspfad>\Solutio\Server\ncjs\
  2. Legen Sie in diesem Verzeichnis das Verzeichnis „conf2“ und darin das Verzeichnis „messaging“ an:
    <charly-Installationspfad>\Solutio\Server\ncjs\conf2\messaging\
  3. Legen Sie in dem Verzeichnis „messaging“ eine Textdatei an und benennen Sie diese mit „application.yml“.

  4. Kopieren Sie die folgende Einstellung in die application.yml:

    de.solutio.ncjs.messaging.broker.stomp.port:14712

  5. Ändern Sie den Port.

  6. Damit der Messaging-Service die fertig bearbeitete application.yml verwendet, muss der Messaging-Service gestoppt und anschließend wieder gestartet werden:

    • Windows

      1. Öffnen Sie die Administrator-Kommandozeile und geben Sie folgende Befehle ein:

        cd <charly-Installationspfad>\Solutio\Server\ncjs

      2. Stoppen Sie den Messaging-Service:

        acd.bat stop messaging

      3. Starten Sie den Messaging-Service:

        acd.bat start messaging

    • macOS

      1. Öffnen Sie das Terminal und geben Sie folgende Befehle ein:

        cd <charly-Installationspfad>/Solutio/Server/ncjs

      2. Stoppen Sie den Messaging-Service:

        sudo ./acd.sh stop messaging

      3. Starten Sie den Messaging-Service:

        sudo ./acd.sh start messaging

  7. Prüfen Sie, ob der Messaging-Service gestartet ist:

    1. Öffnen Sie ein Browserfenster.

    2. Geben Sie folgende URL ein: http://<IP des charly-Servers oder IP der charly-VM (bei Containerinstallation)>:8087

      • Das Eureka-Dashboard öffnet sich und zeigt alle registrierten und gestarteten Microservices des charly-Java-Servers. Nach ca. 1 – 2 Minuten sollte hier auch der Messaging-Service mit dem Status „UP“ gelistet sein.

In charly: Telematikinfrastruktur (TI) einrichten

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

Konfiguration des Konnektors sowie der Aufrufkontexte testen

In charly können Sie in dem Fenster Konnektor-Operationen (Menüleiste unter Hilfe > Konnektor-Operationen (TI)) verschiedene Operationen durchführen, um die Konfiguration der Telematikinfrastruktur zu testen.

How-to

Über die Status-Ampel E-Health-Service Status können Sie erkennen, ob der E-Health-Service erreichbar ist.

  • Status-Ampel: ●

    Der E-Health-Service ist erreichbar und es können Konnektor-Operationen durchgeführt werden.

  • Status-Ampel: ●

    Es erscheint ein Hinweis, dass der E-Health-Service nicht erreichbar ist oder einen Fehler meldet. Es können keine Konnektor-Operationen durchgeführt werden. Im Log-Bereich werden weitere Informationen gelistet.

Über den Button Konnektorstatus testen können Sie den TI-Status sowie den SI-Status testen:

TI-Status Der TI-Status zeigt, ob der Konnektor über den VPN-Zugangsdienst (VPN = Virtual Private Network) eine sichere Verbindung zu der zentralen Telematikinfrastruktur aufbauen kann. Der Weg in die TI wird dabei „getunnelt“.
SI-Status Der SI-Status zeigt an, ob der optionale Dienst „Sicherer Internet Service“ (SIS) für den geschützten Zugriff auf das Internet verfügbar ist. Ein Zugriff auf das Praxisnetzwerk über eingehende Verbindungen ist hierbei technologisch ausgeschlossen.

Der TI-Status und der SI-Status kennen jeweils die folgenden Zustände:

Offline Im Offline-Modus des Konnektors kann keine Verbindung zum VPN-Zugangsdienst aufgebaut werden (z.B. weil die WAN- Schnittstelle nicht angeschlossen oder die Verbindung gestört ist).
Online Im Online-Modus des Konnektors besteht eine VPN-Verbindung zur zentralen Telematikinfrastruktur oder es wird davon ausgegangen, dass diese Verbindung jederzeit aufgebaut werden kann. Der Online-Modus ist eine wichtige Voraussetzung für die Verwendung von KIM4charly.

Über den Button Dienstverzeichnis neu verbinden werden die Fachdienste, die auf dem Konnektor laufen, neu geladen und anschließend mit den Fachdienst-Namen und den Versionen im Log-Bereich gelistet.

Wenn Sie die Checkbox Details zeigen aktivieren, werden neben den Fachdienst-Namen und den Versionen der Fachdienste zusätzliche Informationen angezeigt.

Über den Button Verfügbare Kartenterminals listen werden die verfügbaren Kartenterminals mit zusätzlichen Informationen im Log-Bereich gelistet.

Über den Button Gesteckte Karten listen werden sämtliche Karten mit zusätzlichen Informationen gelistet, die in den Kartenterminals gesteckt sind.

Vorgehensweise

  1. Gehen Sie in die Menüleiste unter Hilfe > Konnektor-Operationen (TI).

    • Ein Fenster öffnet sich.
  2. Wählen Sie aus der Dropdownliste Konnektoren den Konnektor, für den Sie den Test durchführen möchten.

  3. Wählen Sie aus der Dropdownliste Aufrufkontexte den Aufrufkontext, für den Sie den Test durchführen möchten.

  4. Klicken Sie auf den gewünschten Button im Bereich Operationen.

    • Der Status wird im Log-Bereich ausgegeben.

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 KIM4charly 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.

In KIM4charly: KIM-Konto erstellen

Die KIM-Konten erstellen Sie in KIM4charly in der Ansicht Kontoverwaltung.

Tipp: Für möglichst automatisierte Abläufe im Praxisalltag, empfiehlt es sich, mindestens ein Praxiskonto in KIM4charly 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 dem SMC-B
  • Verschlüsselung ausgehender KIM-Nachrichten mit dem SMC-B
  • Optionale Signierung von Anhängen mit „Nicht“-QES
  • Automatischer Versand von eAU, 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.

How-to

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.
  • Sie haben die URL für den VZD in charly in den Stammdaten > Sonstiges > Einstellungen > E-Health-Telematikinfrastruktur > Konnektor (TI) 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 sowie über einen freigeschalteten HBA.
  • Ihr E-Health-Konnektor ist für den Online-Modus konfiguriert.
  • Für die KIM-Adresse ist in KIM4charly noch kein KIM-Konto erstellt.

Vorgehensweise

  1. Klicken Sie in charly in der Menüleiste auf Bearbeiten > KIM4charly.

    • KIM4charly öffnet sich.

  2. Klicken Sie auf den Button für die Kontoverwaltung.

  3. Um ein KIM-Konto anzulegen, klicken Sie auf den Erstellen-Button.

    • Die Ansicht zum Erstellen von KIM-Konten öffnet sich.

  4. Wählen Sie aus der Dropdownliste Typ den Kontotyp.

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

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

    Feld Beschreibung
    E-Mail-Adresse Ihre KIM-Adresse → erhalten Sie von Ihrem KIM-Provider
    Passwort Ihr Passwort für die KIM-Adresse
    Clientmodul 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 KIM4charly eingetragen werden.

    Bitte beachten Sie die FAQ am Ende des Kapitels. Dort finden Sie u.a. die Standard-URLs für gängige Clientmodule.
    Clientmodul 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 KIM4charly eingetragen werden.

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

    URL, unter der die KIM-Nachrichten vom KIM-Server abgerufen werden → erhalten Sie von Ihrem KIM-Provider

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

    URL, unter der die KIM-Nachrichten zum KIM-Server gesendet werden → erhalten Sie von Ihrem KIM-Provider

    Tipp: Bitte beachten Sie die FAQ am Ende des Kapitels. Dort finden Sie u.a. die Standard-URLs für gängige KIM-Provider.
    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 Clientmodul für die Transportverschlüsselung verwendet.

    • Bei einem Praxiskonto geben Sie die ICCSN der SMC-B-Karte ein.
    • Bei einem Behandlerkonto geben Sie die ICCSN der HBA-Karte des Behandlers ein, für den Sie das Konto erstellen.
    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). Normalerweise der Zahnarzt oder ggf. ein Systembetreuer, der das KIM-Konto im Auftrag des Zahnarztes verwaltet.
    Kontogäste

    Auswahlmöglichkeit weiterer zugriffsberechtigter Personen („Gäste“).

    • Voller Zugriff auf die KIM-Nachrichten.
    • Dürfen das KIM-Konto nicht verwalten.

  6. Klicken Sie auf Speichern.

    • Das KIM-Konto ist erstellt und wird in der Liste der KIM-Konten angezeigt.

FAQ

Clientmodule

  Clientmodul POP3 mit TLS Clientmodul SMTP mit TLS
AKQUINET pop3s://<IP-Adresse des Hostsystems des KIM-Clientmoduls>:995 smtps://<IP-Adresse des Hostsystems des KIM-Clientmoduls>:465
Arvato
T-Systems
CGM pop3s://<IP-Adresse des Hostsystems des KIM-Clientmoduls>:8995 smtps://<IP-Adresse des Hostsystems des KIM-Clientmoduls>:8465

Provider

  Provider POP3 mit TLS Provider SMTP mit TLS
AKQUINET pop3s://mail.akquinet.kim.telematik:995 smtps://mail.akquinet.kim.telematik:465
Arvato pop3s://mail.arv.kim.telematik:995 smtps://mail.arv.kim.telematik:465
CGM pop3s://<spezifische-mail-domain>:995 smtps://<spezifische-mail-domain>:465
T-Systems pop3s://100.102.1.169:995 smtps://100.102.1.169:465
Hinweis: Verwenden Sie bei der Client-Konfiguration immer die feste IP Adresse des charly-Servers oder der charly-VM (bei Containerinstallation).

Das Protokoll der URL ist abhängig von der Clientmodul- bzw. Provider-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"

ncjs-Services werden mit Hilfe der Datei application.yml konfiguriert. Für jeden ncjs-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 ncjs-Service, für den eine kundenspezifische Konfiguration hinterlegt wird, ein weiteres Verzeichnis mit dem Namen des ncjs-Service angelegt werden. Dort wird die kundenspezifische „application.yml“-Datei abgelegt.

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

Service-Registry

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

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

  1. Klicken Sie im charly-Client auf den Buttoncharly-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.
  4. Klicken Sie im Arbeitsbereich auf Services und auf den Schnellfilter Alle.
    5. Tipp: Wenn Sie die ncjs-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 Container-Installation geben Sie im Browser-Fenster folgende URL ein: http://<IP der charly-VM>

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

Kommandozeilenwerkzeug für Serversteuerung

Alle ncjs-Services werden im Rahmen eines charly-Updates durch den charly-Updater registriert und gestartet. Für den Fall, dass ein ncjs-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 ncjs-Services gleichzeitig durchgeführt werden und Befehle, mit denen Sie nur einen bestimmten ncjs-Service ansprechen. Für diese „Einzelbefehle“ müssen Sie den Namen des ncjs-Services angeben. Die Namen der ncjs-Services finden Sie heraus, indem Sie in der Kommandozeile folgenden Befehl eingeben:

 

Als Ergebnis erhalten Sie eine Liste aller bekannten ncjs-Services.

Beispiel: Im Folgenden ein Beispiel für den ncjs-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 ncjs-auth-Service absetzen.

Beispiel: Der ncjs-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 ncjs-Services mit folgenden Informationen: Name, Speicher, Dateiname, voller Name und Status.
register Registriert einen ncjs-Service als Systemdienst. Der Name des ncjs-Services muss angegeben werden.
registerall Funktioniert wie der Befehl register, wird jedoch für alle bekannten ncjs-Services ausgeführt.
start Startet einen ncjs-Service. Der Name des ncjs-Service muss angegeben werden. Um den Start-Befehl erfolgreich auszuführen, muss der ncjs-Service bereits registriert sein.
startall Funktioniert wie der Befehl start, wird jedoch für alle bekannten ncjs-Services ausgeführt. Um den Start-Befehl erfolgreich auszuführen, müssen die ncjs-Services bereits registriert sein.
stop Stoppt einen ncjs-Service als Systemdienst. Der Name des ncjs-Service muss angegeben werden.
stopall Funktioniert wie der Befehl stop, wird jedoch für alle bekannten ncjs-Services ausgeführt.
unregister Meldet einen ncjs-Service als Systemdienst ab. Der Name des ncjs-Service muss angegeben werden. Falls der ncjs-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 ncjs-Services ausgeführt. Für ncjs-Services, die noch laufen, führt diesen Befehl vor dem unregister ein stop durch.

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.