sM-Client Projekt - sM-Client Releases

sM-Client Projekt
Aktualisierungsinstruktionen von R4.x auf R5.0
Draft Version
SSK / BSV eAHV/IV
Version:
0.1
Publication Date:
27. September 2011
sM-Client Projekt
Draft Version
Akutalisierung Instruktionen für 5.x
COPYRIGHT
© Copyright – 2013 Cambridge Technology Partners. All Rights Reserved.
No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system or
translated into any language in any form by any means without the written permission of Cambridge
Technology Partners SA.
While every precaution has been taken in the preparation of this document, Cambridge Technology
Partners assumes no responsibility for errors, omissions, or for damages resulting from the use of the
information herein.
Products or corporate names may be trademarks or registered trademarks of other companies and are
used only for the explanation and to the owner’s benefit, without intent to infringe.
Erstellt:
14. März 2013
von Cambridge Technology Partners © 2011
2 / 10
sM-Client Projekt
Draft Version
Akutalisierung Instruktionen für 5.x
INHALTSVERZEICHNIS
1.1
1.2
1.3
1.4
ZWECK DES DOKUMENTS .............................................................................................................................. 5
ÜBERSICHT .................................................................................................................................................. 5
AKTUALISIERUNG ......................................................................................................................................... 5
INSTALLATION VON HORNETQ (SM-CLIENT QUEUE) ....................................................................................... 6
Erstellt:
14. März 2013
von Cambridge Technology Partners © 2011
3 / 10
sM-Client Projekt
Draft Version
Akutalisierung Instruktionen für 5.x
DOKUMENTENVERWALTUNG
Historie
Version
Geändert
Beschreibung
Datum
0.1
Sylvain
Berthouzoz
First version
14.03.2013
0.2
Sylvain
Berthouzoz
Konfiguration sM-Client Queue eingefügt
Aktualisierung Elm Config
24.04.2013
0.3
Sylvain
Berthouzoz
Global-config nur für einen Mandant
10.06.2013
0.4
Sylvain
Berthouzoz
Logging Konfiguration
01.11.2013
Validator
Referenzen
ID
01
Name
Version
Dokument
Installations-Handbuch
V5.0.1
Installations-Handbuch_sM-Client_5.0.1.pdf
Erstellt:
14. März 2013
von Cambridge Technology Partners © 2011
4 / 10
sM-Client Projekt
Finale Version
AKTUALISIERUNGSINSTRUKTIONEN
AKTUALISIERUNGSINSTRUKTIONEN
FÜR R5.x
1 AKTUALISIERUNGSINSTRUKTIONEN
FÜR R5.X
1.1 Zweck des Dokuments
Das nachfolgende Dokument beschreibt sämtliche notwendigen Installationsschritte und Konfigurationen,
um den sM-Client von R4.x auf R5.0 (Release 2013 April) zu aktualisieren.
Sollten Sie eine ältere Version des sM-Client verwenden, müssen sie zuerst auf die Version 4.x
aktualisieren.
Im Release 5.x sind die wichtigsten Neuheiten:

Performanz Verbesserungen bei Audit-Trail

Performanz Verbesserungen bei der Validierung von Sammelmeldungen (eCH-0058v4
Meldungen, ELM Meldungen)

PDF und/oder CSV Generierung via Triage Regle jetzt möglich für ELM Meldungen

Support von JBoss EAP 6
1.2 Übersicht
Die Aktualisierung des sM-Clients erfordert verschiedene Installationsschritte. Es werden Windows-,
Linux- und Unix-Betriebssysteme unterstützt.
Es sind folgende Teile zu aktualisieren:






sM-Client WAR-File
Installation von sM-Client Queue
global-config.properties, Konfiguration von sM-Client Queue
sM-Client Datenbank, für den Eintrag der global-config.properties
Ablage
(Optional, falls ELM Meldungen benutzt sind) Elm Konfiguration aktualisieren
1.3 Aktualisierung
1)
2)
3)
4)
5)
6)
Erstellt:
JBoss oder Tomcat stoppen
Installation von sM-Client Queue. Siehe Kap. 1.4
sM-Client Datenbank. Siehe Kap. 1.4.1
global-config.properties. Konfiguration von sM-Client Queue , Siehe Kap. 1.4.2
(Optional) Elm Konfiguration aktualisieren, Siehe Kap 1.5
Logging Konfiguration setzen, Siehe Kap 1.6, notwendig für den Support und die PDFGenerierung
14. März 2013
von Cambridge Technology Partners © 2011
5 / 10
sM-Client Projekt
Finale Version
AKTUALISIERUNGSINSTRUKTIONEN
AKTUALISIERUNGSINSTRUKTIONEN
FÜR R5.x
7) WAR-Datei ersetzen
a. alte Version von smclient.war löschen von JBOSS_HOME/Server/default/deploy
oder TOMCAT_HOME/webapps
b. neue Version herunterladen. (smclient-r5.0.0.war for mysql)
c. WAR-File ins Verzeichnis JBOSS_HOME/Server/default/deploy kopieren oder im
TOMCAT_HOME/webapps und im smclient.war umbenennen für Tomcat
8) Neue Ablage installieren
a. Neue Ablage herunterladen
b. Den gesamten Inhalt des Ordners <smclientbase>\interface\repository löschen
c. Den Inhalt der heruntergeladenen ZIP-Datei in den Ordner
<smclientbase>\interface\repository entpacken
d. Schreib- und Leserechte für den sM-Client auf die 4 Verzeichnisse prüfen
9) sM-Client Queue starten
10) JBoss oder Tomcat starten
Bitte beachten Sie, dass bei einem Download mittels Internet Explorer, die File-Extension von .war auf
.zip geändert werden kann. In diesem Falle ist nach erfolgtem Download einfach die Endung wieder in
.war zu ändern. Das heruntergeladene File darf nicht mittels Win-Zip (oder ähnlichen Programmen)
ausgepackt werden.
1.4 Installation von HornetQ (sM-Client Queue)
HornetQ 2.2.14 kann aus dem Internet heruntergeladen (http://www.jboss.org/hornetq/downloads.html)
werden.
Die Installation erfolgt entsprechend der Installationsanweisung von HornetQ
(http://docs.jboss.org/hornetq/2.2.14.Final/quickstart-guide/en/html/index.html).
Es ist zu beachten, dass Standartmässig die Stand-alone non-clustered Variante verwendet werden
sollte.
1.4.1
Anpassung in der sM-Client Datenbank
Die folgende Abfrage ist gültig für MySQL, Oracle und MSSQL
Bitte setzen sie den korrekten Pfad zu den global-config.properties Datei (Datei wird im nàchsten Schritt
erstellt) NUR FÜR EINEN MANDANT (auch mit mehrere Mandanten soll diese Konfiguration nur bei
einen Mandant gesetzt werden)
INSERT INTO configuration (domain_id, keycolumn, confvalue,
sedexid ) VALUES ((select id from domain where name like
'smclient'), 'global-config.location',
'C:/smclientbase/config/global-config.properties', 'yourSedexId'
);
1.4.2
global-config.properties
jms.queue.name.standard
Erstellt:
14. März 2013
Name der JMS Standard Queue. Wird erzeugt falls
von Cambridge Technology Partners © 2011
6 / 10
sM-Client Projekt
Finale Version
AKTUALISIERUNGSINSTRUKTIONEN
AKTUALISIERUNGSINSTRUKTIONEN
FÜR R5.x
sie nicht vorhanden ist.
jms.queue.name.priority
Name der JMS Priority Queue. Wird erzeugt falls
sie nicht vorhanden ist.
jms.queue.name.result
Name der JMS Resultat Queue. Wird erzeugt falls
sie nicht vorhanden ist.
jms.context.url
Verbindungs-URL um mit sM-Client Queue zu
kommunizieren. Zu beachten ist, dass der
entsprechende JMS Port im sM-Client Queue
Startscript konfiguriert wird.
jms.rmi.url
Verbindungs-URL um mit sM-Client Queue zu
kommunizieren. Zu beachten ist, dass der
entsprechende JMX Port im sM-Client Queue
Startscript konfiguriert wird.
jms.sub.step.timeout.in.minute
Timeout eines Teilschrittes in Minuten.
Beispielkonfiguration:
#defines the name of the standard task queue
jms.queue.name.standard=/queue/standardMessage
#defines the name of the priority task queue
jms.queue.name.priority=/queue/priorityMessage
#defines the name of the result task queue
jms.queue.name.result=/queue/resultMessage
#defines the connection sting for the jms context of the JMS
provider.
jms.context.url=jnp://localhost:1100
#defines the rmi connection string of the JMS provider.
jms.rmi.url=service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi
#defines the timeout for a sub step in a jms task.
jms.sub.step.timeout.in.minute=5
1.4.3 Konfiguration sM-Client Queue
Es müssen ein paar konfigurationen in HornetQ vorgenommen werden um mit dem sM-Client Core
kommunizieren zu können. Die JMS, JMX und RMI Port Konfigurationen siehe Installation Wizard
müssen manuell in der run.bat /run.sh vorgenommen werden. Zu beachten ist, dass der JMS und JMX
Port im sM-Client Core gleich konfiguriert werden müssen. Die Memory Limits können auch in dieser
Datei vom Standard 1G auf 256M verkleinert werden.
Line in der Datei die zu ändern ist:
set JVM_ARGS=%CLUSTER_PROPS% -Djnp.port=1100 -Djnp.rmiPort=1101 Dcom.sun.management.jmxremote.port=3000 Dcom.sun.management.jmxremote.ssl=false Dcom.sun.management.jmxremote.authenticate=false Dcom.sun.management.jmxremote.local.only=true -XX:+UseParallelGC
Erstellt:
14. März 2013
von Cambridge Technology Partners © 2011
7 / 10
sM-Client Projekt
Finale Version
AKTUALISIERUNGSINSTRUKTIONEN
AKTUALISIERUNGSINSTRUKTIONEN
FÜR R5.x
-XX:+AggressiveOpts -XX:+UseFastAccessorMethods -Xms256M -Xmx256M
-Dhornetq.config.dir=%CONFIG_DIR% Djava.util.logging.config.file=%CONFIG_DIR%\logging.properties Djava.library.path=.
In diesem Beispiel werden die Ports und das Memory folgendermassen gesetzt:

JMS Port 1100

JMX Port 3000

RMI Port 1101
Minimum und Maximum Memory auf 256M
1.5 (Optional) Elm Konfiguration aktualisieren
Prüfen Sie im message-handler-elm.properties dass die Kombination den Eigenschaften
[base.dir.adapter] +[adapter.receipt.location] zu den Sedex Adapter Quittung Verzeichnis verlinkt. Zum
Beispiel
#configuration of swissdec adapter
#working directory of swissdec adapter all directories below are
relative to base directory
base.dir.adapter=C:\\smclientbase/adapterSwissdec
#...(other properties)…
#directory for technical receipts
adapter.receipt.location=../adapter/receipts/
1.6 Logging
Das Logging kann wie folgt konfiguriert werden:
JAVA_OPTS="-Dlog4j.configuration=file:///C:/smclientbase/config/log.config"
Die JAVA_OPTS können entweder in der Kommandozeile oder den Umgebungsvariablen gesetzt werden.
In log.config kann dann das Logging wie folgt konfiguriert werden:
log4j.rootCategory=INFO, console, R
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%X{sedexId} - %m%n
log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
log4j.appender.R.File=C:/smclientbase/log/smclient.log
# Roll file per day
log4j.appender.R.DatePattern='.'yyyy-MM-dd
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d [%-5p] %C{1} : %X{sedexId} %m%n
Erstellt:
14. März 2013
von Cambridge Technology Partners © 2011
8 / 10
sM-Client Projekt
Finale Version
AKTUALISIERUNGSINSTRUKTIONEN
AKTUALISIERUNGSINSTRUKTIONEN
FÜR R5.x
Im Datei log.config ist auch den logging level konfiguriert. Hier ist es auf INFO gesetzt. Mögliche werte
sind

TRACE

DEBUG

INFO

WARN

ERROR
TRACE level produziert eine grosse Menge von Information und sollte nicht auf einem Produktion System
benutzt werden. Der sM-Client benutzt nur die Levels von DEBUG bis ERROR. Es ist möglich, den
logging Level nur für den sM-Client auf DEBUG zu setzen, dafür soll die folgende Zeile eingefügt werden:
log4j.logger.ch.admin.smclient=DEBUG
und/oder nur für die XML Validierung von Meldungen. Detaillierte XML Fehler sind nur im DEBUG
angezeigt
log4j.logger.ch.admin.smclient.service.MessageValidator=DEBUG
Und weil FOP (PDF Generierung) bei ELM Meldungen viel Log Einträge produziert kann der LOG Level
auf ERROR gesetzt werden
log4j.logger.org.apache.fop=ERROR
Erstellt:
14. März 2013
von Cambridge Technology Partners © 2011
9 / 10
Cambridge Technology Partners (Switzerland) S.A.
Nyon
27 Ch. de Précossy
CH-1260 Nyon
Tel:
Fax:
+41 (0)22 306 4646
+41 (0)22 306 4647
Zurich
Office Center 1
Flughafenstrasse 90
8058 Zürich-Flughafen
Tel:
Fax:
+41 (0)43 456 2300
+41 (0)43 456 2301
Basel
Barfüsserplatz 3
CH-4051 Basel
Tel:
+41 (0) 61 271 9140