sm-client Projekt Aktualisierungsinstruktionen von R3.x auf R4.1.x Draft Version SSK / BSV eahv/iv

Transkript

1 Aktualisierungsinstruktionen von R3.x auf R4.1.x Draft Version SSK / BSV eahv/iv Version: 0.2 Publication Date: 27. September 2011

2 Akutalisierung Instruktionen für 4.x Draft Version COPYRIGHT Copyright 2012 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: 25. Januar 2011 von Cambridge Technology Partners / 12

3 Draft Version Akutalisierung Instruktionen für 4.x INHALTSVERZEICHNIS 1 FÜR R4.X ZWECK DES DOKUMENTS ÜBERSICHT AKTUALISIERUNG KONFIGURATION VON ECH0058V4 DOMAIN... 6 Erstellt: 25. Januar 2011 von Cambridge Technology Partners / 12

4 Akutalisierung Instruktionen für 4.x Draft Version DOKUMENTENVERWALTUNG Historie Version Geändert Beschreibung Datum Validator 0.1 Sylvain Berthouzoz 0.2 Christian Wattinger First version CW Input from AWK SB Referenzen ID Name Version Dokument 01 Installations-Handbuch V3.1 Installations-Handbuch_sM-Client_3.1.pdf Erstellt: 25. Januar 2011 von Cambridge Technology Partners / 12

5 1 FÜR R4.X 1.1 Zweck des Dokuments Das nachfolgende Dokument beschreibt sämtliche notwendigen Installationsschritte und Konfigurationen, um den sm-client von R3.x auf R4.1.1 (Release 2012 Oktober) zu aktualisieren. Sollten Sie eine ältere Version des sm-client verwenden, müssen sie zuerst auf die Version 3.x aktualisieren. Im Release 4.x sind die wichtigsten Neuheiten: Teilausgefüllte Meldungen Support von ech-0058v4 Meldungen Support von ELM Meldungen Die Möglichkeit, ein Skript auszuführen für jede empfangene und gesendete Meldungen. Die Multi-Domainfähigkeit erlaubt den sm-client verschiedene Prozesse zu unterstützen. Im Release 3.0 wurden als erste zusätzliche Domain die eschkg Meldungen implementiert. Die ech-0058v4 Meldungen sind auch als eine neue Domain implementiert 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 (Optional) message-handler-ech0058v4.properties [nur von 3.x auf 4.1.1] (Optional) message-handler-elm.properties (Optional)sM-Client Datenbank, für die Konfiguration von ech0058v4 Meldungen und/oder von ELM Meldungen Ablage Anpassungen an rules.xml für die Monitoring Meldungen 1.3 Aktualisierung 1) JBoss oder Tomcat stoppen 2) Optional. Konfiguration von ech0058v4 Meldungen. Siehe Kap. 1.4 [nur von 3.x auf 4.1] 3) Optional. Konfiguration von ELM Meldungen. Siehe Kap. 1.5 Erstellt: 25. Januar 2011 von Cambridge Technology Partners / 12

6 4) Optional. Installation von Swissdec Adapter für die ELM Meldungen, Siehe Swissdec Dokumentation 5) Überprüfen Sie die Konfiguration des Arbeitsspeichers. Es muss mindestens -Xms512m Xmx1024m -XX:MaxPermSize=512m. (Siehe Installationshandbuch v.1.8 Kap.4.1.2) 6) Rules.xml anpassen, siehe Kapitel 1.6 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-r4.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) 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 Konfiguration der ech0058v4 Domain 1) Diese Konfiguration ist nur notwendig, um ech0058v4 Meldungen zu verschicken oder zu empfangen. Erstellen der ech0058v4 Domain in der Datenbank: insert into domain (name) values ('ech0058v4'); 2) Einbinden der Konfigurationsdatei (Passen Sie zuerst Ihren sedexid und den Pfad an): INSERT INTO configuration VALUES('messagehandler.location','C:/smclientbase/config/message-handlerech0058v4.properties','yourSedexId', (select id from domain where name like 'ech0058v4')); 3) Jede neue Domain braucht auch eigene Verzeichnisse, deshalb gibt es ein messagehandler.properties pro Domain, in welchen im Minimum die Verzeichnisse definiert sein müssen, damit der sm-client den richtigen Prozess startet. #Message handler ech0058v4 configuration #base directory for messages all directories below are relative to #base directory base.dir.smclient.interface=c:\\smclientbase/interface/ #location for sent files sent.location=sent/ #location form messages to be send Erstellt: 25. Januar 2011 von Cambridge Technology Partners / 12

7 outbox.location=outbox/ #location for incoming messages inbox.location=inbox/ #location for deleted messages deleted.location=deleted/ #location for exported messages exported.location=exported/ #location of failed messages failed.location=failed/ #failed to send it could not be send by the smclient failed.tosend.location=failed/failed_to_send/ #failed to transmit means that in the send the sedex client could not transmit the message failed.transmit.location=failed/failed_to_transmit/ #configuration of sedex adapter #working directory of sedex adapter all directories below are relative to base directory base.dir.adapter=c:\\smclientbase/adapter/ #directory for incoming messages adapter.inbox.location=inbox/ #directory for technical receipts adapter.receipt.location=receipts/ #directory for outgoing messages adapter.outbox.location=outbox/ 1.5 Konfiguration der ELM Domain Hauptkonfiguration Wichtig: Dieses Domain braucht den Swissdec Adapter (sda). Der sda muss vorher installiert werden. Siehe dafür Benutzerhandbuch swissdec Adapter Diese Konfiguration ist nur notwendig, um ELM (Swissdec Quellensteuer und Lohnausweis) Meldungen zu verschicken oder zu empfangen. 1) Erstellen der ELM Domain in der Datenbank: insert into domain (name) values ('elm'); 2) Einbinden der Konfigurationsdatei (Passen Sie zuerst Ihre sedexid und den Pfad an): INSERT INTO configuration VALUES('messagehandler.location','C:/smclientbase/config/message-handlerelm.properties','yourSedexId', (select id from domain where name like 'elm')); Erstellt: 25. Januar 2011 von Cambridge Technology Partners / 12

8 3) Jede neue Domain kann auch eigene Verzeichnisse brauchen, deshalb gibt es ein messagehandler.properties pro Domain, in welchen im Minimum die Verzeichnisse definiert sein müssen, damit der sm-client den richtigen Prozess startet. Die Verzeichnisse hier müssen mit den sda konfigurierte Verzeichnissen übereinstimmen. Wichtig: Die Verzeichnisse müssen vor dem Start des sm-client vorhanden sein. Siehe die Tabelle unten für die Abhängigkeiten zwischen sm-client und sda. #Message handler ELM configuration elm.timeout.days=60 #base directory for messages all directories below are relative to base directory base.dir.smclient.interface=c:\\smclientbase/interface #location for sent files sent.location=elm/sent/ #location form messages to be send outbox.location=elm/outbox/ #location for incoming messages inbox.location=inbox/post_box #location for deleted messages deleted.location=elm/deleted/ #location for exported messages exported.location=elm/exported/ #location of failed messages failed.location=failed/ #failed to send it could not be send by the smclient failed.tosend.location=failed/failed_to_send/ #failed to transmit means that in the send the sedex client could not transmit the message failed.transmit.location=failed/failed_to_transmit/ #configuration of swissdec adapter #working directory of swissdec adapter all directories below are relative to base directory base.dir.adapter=c:\\smclientbase/adapterswissdec #base.dir.adapter=//vboxsvr/temp #directory for incoming messages adapter.inbox.location=inbox/ #directory for outgoing messages adapter.outbox.location=outbox/ ##specific for swissdecadapter and ELM domain adapter.failed.receive=failed/ adapter.sent.location=sent/ adapter.failed.transmit.location=failed_to_transmit #configuration of sedex adapter #base directory is taken from 'base.dir.adapter' of the default (smclient) domain (message-handler.properties) #used for forwarding to commune. #directory for outgoing messages sedex.adapter.outbox.location=outbox/ Erstellt: 25. Januar 2011 von Cambridge Technology Partners / 12

9 #zip elm message when forwarding to commune. If not set, it won't be zipped. forward.message.zipped=true Die folgende Tabelle beschreibt die Abhängigkeiten zwischen der Konfiguration des sm-client und sda. sm-client Message-handler-elm.properties Im sm-client sind diese Verzeichnisse relativ zu base.dir.adapter adapter.inbox.location adapter.outbox.location adapter.failed.receive adapter.sent.location adapter.failed.transmit.location Swissdec Adapter swissdecadapter.properties sda braucht absoluten Pfad in der Konfigurationsdatei released.filesystem.parent.xml result.filesystem.parent.xml failed.filesystem.parent.xml sent.filesystem.parent.xml undeliverable.filesystem.parent.xml Konfiguration der kantonalen Ablage Die kantonale Ablage ist gebraucht nur für die Weiterleitung von Quellensteuer (qst) Meldungen von Kanton zu einer Gemeinde via Sedex. 1) Zuerst sollen dafür den Datei repository.properties ergänzt werden: #FOR ELM domain only ablage.cantonal.base.dir=c:/smclientbase/interface/cantonal_reposi tory cantonal.message.list=participants_list/message-list.xml cantonal.message.participants.list=participants_list/messageparticipants-list.xml cantonal.participants.list=participants_list/participants-list.xml cantonal.xsd_xslt=xsd_xslt 2) In message-list.xml der kantonalen Ablage wird definiert den Meldungstyp von qst Meldungen für Sedex. Die gelben Werte müssen für Ihre Umgebung angepasst werden. Meldungstyp muss zuerst bei Sedex registriert werden. (Siehe Sedex handbuch und Sedex Betrieb) <?xml version="1.0" encoding="utf-8"?> <messages xmlns:xsi=" xsi:nonamespaceschemalocation="message-list.xsd"> <message type="9999" subtype="000909" informservice="false" sendwithoutprotocolreceipt="false" domain="elm"> <redirectfrom type="elm" subtype="qst" /> <name>elm </name> <version number=" <valid_from> </valid_from> <valid_to> </valid_to> </version> </message> </messages> Erstellt: 25. Januar 2011 von Cambridge Technology Partners / 12

10 3) In participants-list.xml der kantonalen Ablage sollen die Gemeinde konfiguriert werden. Wenn eine Gemeinde die Weiterleitung nicht braucht, löschen Sie den Attribute municipalityid von dieser Gemeinde. Die gelben Werte müssen angepasst werden. <?xml version="1.0" encoding="utf-8"?> <participants xmlns:xsi=" xsi:nonamespaceschemalocation="participants-list.xsd"> <participant sedexid="99-zh-99" municipalityid="1234"> <shortname>musterdorf</shortname> <longname>gemeinde Musterdorf</longName> </participant> <participant sedexid="99-zh-98" municipalityid="4321"> <shortname>musterdorf 2</shortName> <longname>gemeinde Musterdorf 2</longName> </participant> </participants> 4) In message-participants-list.xml definiert dann welche Teilnehmer die Meldungen empfangen dürfen. Hier sollen also Ihre sedexid und auch die Gemeinden von Schritt 3 participants-list.xml liegen. Meldungstyp und Meldungsubtyp müssen den Werten im message-list.xml aus Schritt 2 übereinstimmen. <?xml version="1.0" encoding="utf-8"?> <groups xmlns:xsi=" xsi:nonamespaceschemalocation="message-participants-list.xsd"> <group name="elm-1"> <participant sedexid="99-zh-98"/> <participant sedexid="99-zh-99"/> <participant sedexid="t "/> <participant sedexid="t "/> <message type="9999" subtype="000909"/> </group> </groups> 1.6 Triage-Regel für das Monitoring Monitoring-Meldungen werden täglich von smc-monitoring.ctp-consulting.com verschickt. Damit diese Meldungen die Fachapplikationen nicht stören, muss eine Triage Regel im File rules.xml erstellt werden (Siehe auch im Installations-Handbuch). Diese Regel setzt via den Meldungstyp für empfangene Meldungen an: Für BSV Meldungstyp 2991 Für SSK Meldungstyp 3991 Erstellt: 25. Januar 2011 von Cambridge Technology Partners / 12

11 1.6.1 SSK: Beispiel-Regel zur Monitoring-Meldung für SSK im File rules.xml : Bitte destinationfolder an Ihre lokale Installation anpassen und das Verzeichnis erstellen. <!-- Siehe Kapitel für die komplette Konfiguration --> <rule> <criteria> <messagetype>3991</messagetype> </criteria> <destinationfolder>c:/smclientbase/interface/inbox/monitorin g</destinationfolder> <usecase>receive</usecase> </rule> BSV: Beispiel-Regel zur Monitoring-Meldung für BSV im File rules.xml : Bitte destinationfolder an Ihre lokale Installation anpassen und das Verzeichnis erstellen. <!-- Siehe Kapitel für die komplette Konfiguration --> <rule> <criteria> <messagetype>2991</messagetype> </criteria> <destinationfolder>c:/smclientbase/interface/inbox/monitorin g</destinationfolder> <usecase>receive</usecase> </rule> Erstellt: 25. Januar 2011 von Cambridge Technology Partners / 12

12 Cambridge Technology Partners (Switzerland) S.A. Nyon 27 Ch. de Précossy CH-1260 Nyon Tel: +41 (0) Fax: +41 (0) Zurich Office Center 1 Flughafenstrasse Zürich-Flughafen Tel: +41 (0) Fax: +41 (0) Basel Barfüsserplatz 3 CH-4051 Basel Tel: +41 (0)