Clientscripte als Powershell-Scripte erstellen

Mit Hilfe von Clientscripten können Sie benutzerdefinierte Werte setzen, die Sie dann in mypDeploy für Filter, automatische Zuordnungen und ähnliches nutzen können.

Diese Scripte wurden Ihnen bisher nur von der CebiCon GmbH zur Verfügung gestellt und konnten nicht bearbeitet werden.

Ab Version 3.9.8.0 von mypDeploy können Sie selber benutzerdefinierte Werte mit Powershell-Scripten setzen.

Formaler Aufbau

Damit Ihr Clientscript als Powershell-Script erkannt wird, muss es mit dieser Powershell-Kommentarzeile beginnen:

# mypDeploy PowerShell Script

Danach können Sie mit beliebigem Powershell-Code fortfahren.

Einstiegs-Funktion

Jedes von Ihnen erstellte Powershell-Script muss einen Einstiegspunkte mit fix vorgegebenem Funktionsnamen definieren:

• Function PS-GetClientProperties

Parameter

Im Gegensatz zu anderen mypDeploy-Scripten verfügen Clientscripte nicht über Parameter.

Powershell-Erweiterungen

Wir haben für Sie eine Cmdlet-Erweiterung bereitgestellt, die Sie in Ihrem Powershell-Script benutzen können, um mypDeploy Namen, Inhalt und Datentyp einer Clienteigenschaft zu übergeben.

Generelle Syntax:

CSL_ReturnValue "<PropertyName>","PropertyValue”,”PropertyType”

PropertyName und PropertyValue müssen angegeben werden; PropertyType ist ein optionaler Parameter.

• In “PropertyName” definieren Sie den Namen/Bezeichnung Ihrer Clienteigenschaft.

• In PropertyValue” tragen Sie den Wert ein, den Sie dieser Clienteigenschaft zuweisen möchten.

• In PropertyType können Sie festlegen, welchen Datentyp die Eigenschaft hat.
  Zulässige Werte:

  • Bool (True/False)

  • Integer (beliebige Ganzzahl)

  • Date (in der Form TT.MM.JJJJ)

  • Time (in der Form HH:MM:SS)

  • DateTime (in der Form TT.MM.JJJJ, HH:MM:SS)

  • Version (in der Form W.X.Y.Z)

  • IpAddress (in der Form xxx.xxx.xxx.xxx)

  • IpAddressV6 (in der Form a:b:c:d:e:f:g:h)

Wird kein Parameter PropertyType mitgegeben, wird der Inhalt als Text behandelt.

Beispiele:

CSL_ReturnValue “neue_Texteigenschaft”, ”eine neue Clienteigenschaft”

CSL_ReturnValue “neue_Datumseigenschaft”, ”01.01.1990”, “Date”

CSL_ReturnValue “neue_DateTime_Eigenschaft”, ”01.01.2000, 12:00:00”, “DateTime”

Rückmeldung an mypDeploy

Das Setzen der Clienteigenschaften erfolgt über die o.g. Erweiterung.

Sie steuern innerhalb Ihrer Powershell-Funktion, wie der mypDeployClientService die Ausführung der Clientscripte bewertet.

• Verlassen Sie Ihre Funktion mit einem ExitCode 0 (oder wenn die Funktion normal beendet wird setzt die PS diesen implizit) verlassen, wird der mypDeployClientService die Scriptausführung als erfolgreich werten und mit der Verarbeitung fortfahren.

• Setzen Sie in Ihrer Funktion über Exit(), Return() oder Throw'' explizit einen terminierenden Fehler innerhalb der Powershell-Funktion, wird der mypDeployClientService die Scriptausführung als fehlerhaft werten, einen Protokolleintrag in der Datei “ClientProperties.log” im temporären Systemverzeichnis (i.d.R. c:\windows\temp) erstellen und die Verarbeitung fortsetzen. Im Protokolleintrag erhalten Sie entweder den via Throw'' gesetzten Fehlertext oder (wenn Sie die Funktion über Exit/Return verlassen) den Inhalt von $Error[0].
  
  

Laden von Clientscripten

Über “Aktion/Serverseitig verwaltete Scripte” können Sie Ihre Clientscripte speichern, ändern und wieder laden.

Open

Wählen Sie für das Herunterladen/Hochladen jeweils ein Verzeichnis aus.

Clientscripte werden immer in Gänze exportiert und importiert; alle bereits in der Datenbank gespeicherten Scripte werden hierbei überschrieben. Wenn Sie ein einzelnes Script ändern wollen, laden Sie zunächst die Scripte in ein Verzeichnis, führen dort die Änderungen durch und laden anschließend das Verzeichnis wieder hoch.

Beim Hochladen aus einem Verzeichnis findet eine formale Prüfung der Scripte statt. Falls eines der Scripte den Formalen Kriterien nicht genügt erhalten Sie einen entsprechenden Fehlermeldung mit einem Hinweis, wie der Fehler zu korrigieren ist. Im folgenden Beispiel fehlt dem Powershell-Script der erforderliche Einsprungspunkt:

Open

Sonstige Hinweise