RS IPS Compatibility Scanner

 

Vorspiel

Der Hersteller von IPS hält den Anwender regelmäßig auf Trab, in dem bei größeren Releases einfach mal Systembefehle wegfallen, durch Neue ersetzt werden oder die Ausgabe der Ergebnisse von Systembefehlen geändert werden – wie aktuell der Wechsel von der bisherigen IPS Version 3.4 zur 4.0.

Für IP-Symcon Betreiber, deren System noch nicht so lange im Einsatz ist, stellt dies in der Regel kein gravierendes Problem dar. Auch bietet sich dadurch die Chance, sich tiefer mit dem System vertraut zu machen. Wer aber viele/komplexe Eigen- und/oder Fremd-Projekte im System hat, für den wird es dann unter Umständen sehr aufwändig bis unlösbar. Unlösbar insbesondere dann, wenn für die Fremdprojekte zum Zeitpunkt des Release-Wechsels kein Update vom Autor bereit steht und man selbst nicht so tief den Rüssel ins PHP gesteckt hat, um die Umstellungsprobleme aus eigener Kraft zu lösen.

Grundsätzlich habe ich die Erfahrung gemacht: je länger man sein IP-Symcon in Betrieb hat und je komplexer es wird, desto aufwändiger und ärgerlicher sind anstehende Release-Wechsel.

Und mit dem RS IPS Compatibility Scanner kommt jetzt die Lösung?

Natürlich nicht! ABER: dem angehenden Migranten kann eine Hilfe an die Hand gegeben werden, die bevorstehende Umstellung seiner IP-Symcon Installation auf das nächste Release gut vorzubereiten. Mit dem RS IPS Compatibility Scanner kann ich mein gesamtes System scannen, ob und mit welchen (manuellen) Vorbereitungen ich zu rechnen habe. Konkret werden alle Events und Scripte nach alten, abgekündigten Systembefehlen/Systemvariablen gescannt. Im Ergebnis wird haarklein aufgelistet,

• Welcher der betroffenen Systembefehle/Systemvariablen wurde verwendet?
• In welchem Event/Script (Objekt-ID + Objektname) ist der Fall aufgetreten?
• In welcher Code-Zeile wurde das böse Wort verwendet?
• Wie dringend ist die Bereinigung?

Im Anschluss kann man sich dann in aller Ruhe mit dem Austausch der alten Systemfunktionen vertraut machen. Das setzt natürlich a) gute PHP-Kenntnisse und b) sehr gute IP-Symcon Kenntnisse vom Anwender voraus. Dies nimmt einem dieses Scanner-Projekt nicht ab. Zu empfehlen ist hier, die gefundenen (alten) Systembefehle in der jeweiligen Migrationsanleitung des IPS-Releases zu suchen und sich von dort aus zu einer Lösung zu hangeln. Notfalls über die IP-Symcon Community oder den Hersteller.

Wer etwas versierter ist, schaut in die ‚__compatibility.inc.php‚ und findet dort den zum alten Systembefehl passenden neuen Systembefehl.

Raketen-Start

Wer es ganz eilig hat:

1. Installer-Script aus dem Download ins eigene System einbauen
2. Installer-Script ausführen
3. RS IPS Compatibility Scanner (Script “RS IPS Compatibility-Scanner„) öffnen, Script-Mindestlaufzeit auf 10000 (oder höher) setzen
4. Script manuell starten
5. 1-10 Kaffe trinken
6. Ergebnis (Meldefenster in der Konsole) auswerten

Nicht wundern: die Scriptlaufzeit ins in der Regel hoch, mitunter sehr hoch. Auf bis zu 10 Minuten (bei ca. 1000 Scripts + 1000 Events) sollte man sich da schon einstellen. Keine Angst: dem IPS-System macht das nichts – es wird für die Scriptlaufzeit nur ein PHP-Task genutzt (der damit dem Rest nicht mehr zur Verfügung steht).Das ist aber nichts gegen den evtl. danach zu investierenden Aufwand, um alle IPS-Objekte für die nachfolgende IPS-Version betriebsfähig zu halten. Hier darf man in aller Ruhe jedes einzelne Objekt manuell anfassen, den Code ändern und sich dem nächsten Objekt zuwenden…. bis alle Treffer abgearbeitet sind. Und da können von einer handvoll bis einige hundert sein. Gute Reise, gute Besserung!

Features:

Das Script läuft grundsätzlich in 2 unterschiedlichen Betriebsmodi:

1. Automatik-Modus (wenn Script durch TimerEvent gestartet):

• Macht immer einen Fullscan des Systems
• Verschickt Scan-Ergebnisse per Mail (wenn mind. eine SMPT SendMail-.Instanz vorhanden ist)
• Legt CSV-Datei im IP-Symcon Ordner ab

2. Manueller Modus (manuell gestartetes Script):

• Macht Teil- oder Fullscan (je nach Konfiguration) des IPS-Systems
• Zeigt Scan-Ergebnisse im Script-Meldefenster
• Legt CSV legt CSV-Datei im IP-Symcon Ordner ab (nur bei Fullscan)

Konfiguration

Der ambitionierte IPS-User wird sich auch diverse Möglichkeiten wünschen, das Scanergebnis zu beeinflussen. Das hat der Programm-Autor glücklicherweise vorhergesehen und diverse Möglichkeiten eingebaut. Als Frisch-User muss man sich nicht zwingend damit auseinandersetzen. Aber spätestens nach einem Scanergebnis mit mehreren hundert Treffern wird man sich sehr gerne mit diesem Möglichkeiten beschäftigen *breitgrins*

 

1. ‚RS IPS Compatibility Selektoren-Container‚:  bietet die Möglichkeit, zusätzlich nach selbst definierten Suchbegriffen (politisch korrekt: Selektoren)im Code zu suchen
2. ‚RS IPS Compatibility Ausschluss-Container‚: bietet die Möglichkeit, zusätzlich nach selbst definierten Suchbegriffen im Code zu suchen, die im Scan-Ergebnis erscheinen sollen, wo aber keine Code-Korrektur erforderlich ist
3. ‚RS IPS Compatibility BlackSheep-Container‚: bietet die Möglichkeit, Objekt-ID’s, komplette Teilbäume oder in Objektnamen vorkommende Suchbegriffe vom Systemscan auszuschließen

Eine detaillierte Beschreibung, welche Bedeutung die Einträge in den jeweiligen Containern haben, mit welcher Syntax diese eingepflegt werden und welche Auswirkungen die Einpflege auf den späteren Systemscan hat, ist in den entsprechenden Containern enthalten.

Scan fertig, watt nu?

Tool-Unterstützung

Dem Download liegt weiterhin eine Excel-Tabelle bei, mit deren Hilfe die Scan-Ergebnisse besser visualisiert werden können. Eine Kurzbeschreibung zum Umgang mit diesem Tool ist im Excel-Workshet enthalten. Der Gedanke ist hier, dem User zu helfen, die Problemfälle strukturiert durchzugehen, in dem er die in der Excel-Tabelle visualisierten Scan-Ergebnisse auf einem Bildschirm darstellt, während er auf dem anderen Bildschirm in der IPS-Konsole die entsprechenden Objekte bearbeitet.

 

IPS-Versionen

Gemäß des Script-Konzepts (Identifizieren alter Systembefehle auf Basis der ‚__compatibility.inc.php‚) ist der RS IPS Compatibility Scanner ein gutes Systemwerkzeug, um das eigene IPS-System (aktuell 3.4) auf den nächsten anstehenden Release-Wechsel (dann IPS 4.0) zu scannen. Wenn man einige Details beachtet, sollte das genauso für ältere und zukünftig erscheinende IPS-Releases funktionieren. Da das Projekt nur ganz wenige IPS-Systembefehle nutzt, ist die Wahrscheinlichkeit sehr hoch, dass das Tool zukunftssicher ist.

Getestet habe ich sowohl das Script selbst als auch die Installations-Routine unter IPS 3.4 (Windows) und 4.0 (Windows + Linux, Stand Jan. 2016) – in allen Fällen funktioniert es fehlerfrei und problemlos.

Installation

Das Installer-Script aus dem Download in ein neues IPS-Script einkopieren und ausführen. Das Projekt ist damit installiert und betriebsbereit. In den Containern kann man nun eigene Suchbegriffe eingeben, muss man aber nicht. Zum Start eines System-Scans dann manuell das Script ‚RS IPS Compatibility-Scanner‚ starten.

Möchte man den Scanner regelmäßig und unbeaufsichtigt laufen lassen, so kann man manuell den mitgelieferten Timer konfigurieren und aktivieren. Der RS IPS Compatibility-Scanner läuft dann selbständig durch, legt die Scan-Ergebnisse als .csv im IP-Symcon Rootverzeichnis ab und schickt die Scanergebnisse (incl. CSV) an die erste, im System konfigurierte SMTP-SendMail – Instanz. So hat man nun statt der (früher mal üblichen) Tageszeitung nun den Scanbericht auf dem Frühstückstisch. Kann auch weiterBILDen.

Weitere Versionsinfos

• Version 1.2: klick
• Version 1.3: klick

Download

Der Download wird für eingeloggte User unterhalb dieses Beitrages sichtbar

 

---