|
<< Click to Display Table of Contents >> RayQC > 2026.3 > User Guide > Appendices Grundlegende Struktur externer Plug-ins |
Wie bereits im Abschnitt Plug-ins dieses Dokuments beschrieben, besteht ein externes Plug-in aus zwei grundlegenden Elementen: der Skript Datei und der beschreibenden Manifest-Datei.
Quellcode, der als Plug-in-Skript für RayQC verwendet werden soll, muss eine Reihe von Mindestanforderungen erfüllen, um korrekt integriert werden zu können:
•Externe Plug-ins müssen gültige PowerShell-.ps1-Dateien sein. (Um andere Dateien wie ausführbare Dateien zu starten, kann der interne Befehlsplug-in verwendet werden.)
•Parameterdefinitionen in Skript- und Manifest-Datei müssen übereinstimmen
Jedes Plug-in-Skript, das Benutzer in Kombination mit RayQC Checklisten verwenden möchten, muss mit einer Manifest-XML-Datei geliefert werden, die gegen die RayQC Plug-in-Schemadefinition gültig ist. Die Definitionsdatei ManifestSchema.xsd ist im Stammverzeichnis des Anwendungsinstallationsverzeichnisses verfügbar (z. B. C:\Program Files (x86)\RayQC\). Öffnen Sie diese Datei in einem geeigneten Editor Ihrer Wahl, um die Anforderungen für eine minimale RayQC Plug-in-Manifest-Datei einzusehen:
•XML-Version muss 1.0 oder höher sein
•Kodierung muss utf-8 sein
•Stammknoten muss <pluginData> sein
•<pluginData> muss ein nicht-leeres Attribut name haben
•<pluginData> Attribut description muss genau einmal vorhanden sein, darf aber leer sein
•<pluginData> muss ein nicht-leeres Attribut version haben
•<pluginData> muss ein nicht-leeres Attribut FileName haben
•<pluginData> darf ein nicht-leeres Attribut Encrypted haben
•<pluginData> muss ein nicht-leeres Attribut PowerShellVersion haben
•<pluginData> Kind-Element <Function> muss genau einmal vorhanden sein
•<Function> muss ein oder mehrere Kind-Elemente <FunctionParameters> enthalten
•<FunctionParameters> muss ein nicht-leeres Attribut FunctionName haben
•<FunctionParameters> Attribut <description> muss genau einmal vorhanden sein, darf aber leer sein
•<FunctionParameters> Kind-Element <Parameters> muss genau einmal vorhanden sein
•Mindestens ein Kind-Element von <Parameters> aus den folgenden Optionen muss vorhanden sein
o<BooleanParameter> : Erwartet einen Boolean-Eingabewert (true/false)
▪<Name> : Name des Parameters
▪<Description> : Benutzerdefinierte Beschreibung des Parameters
▪<IsOptional> : Wenn auf „true" gesetzt, ist die Eingabe für diesen Parameter optional
▪<Default> : Standardparameterwert
o<StringParameter> : Erwartet eine Zeichenfolge als Eingabeparameter
▪<Name> : Name des Parameters
▪<Description> : Benutzerdefinierte Beschreibung des Parameters
▪<IsOptional> : Wenn auf „true" gesetzt, ist die Eingabe für diesen Parameter optional
▪<Default> : Standardparameterwert
▪<RegexString>: Regulärer Ausdruck
▪<ValidationMessage> : Validierungsmeldung, die angezeigt wird, wenn die Zeichenfolge den regulären Ausdruck nicht erfüllt
o<NumberParameter> : Erwartet einen Ganzzahl-Wert zwischen Min und Max
▪<Name> : Name des Parameters
▪<Description> : Benutzerdefinierte Beschreibung des Parameters
▪<IsOptional> : Wenn auf „true" gesetzt, ist die Eingabe für diesen Parameter optional
▪<Default> : Standard-Ganzzahl-Parameterwert
▪<Min> : Minimaler Ganzzahl-Eingabewert
▪<Max> : Maximaler Ganzzahl-Eingabewert
▪<Increment> : Inkrementwert
o<MultiStringParameter> : Ermöglicht dem Benutzer, aus einem Dropdown eine Zeichenfolge auszuwählen, die als Parameter bereitgestellt wird
▪<Name> : Name des Parameters
▪<Description> : Benutzerdefinierte Beschreibung des Parameters
▪<IsOptional> : Wenn auf „true" gesetzt, ist die Eingabe für diesen Parameter optional
▪<Default> : Standard-Zeichenfolge aus der Zeichenfolgenliste
▪<StringList> : Liste der definierten Zeichenfolgen. z. B. <string1/> <string2/> <string3/>
Gemäß dieser Beschreibung ist der folgende Manifest-Datei-Quellcode gültig:
<?xml version="1.0" encoding="utf-8"?> <pluginData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Name /> <Description /> <Version /> <Filename /> <PowerShellVersion /> <Functions> <FunctionParameters> <FunctionName /> <Description /> <Parameters /> </FunctionParameters> </Functions> </plug-inData> |
Eine Manifest-Datei ohne produktiven Inhalt kann zwar gültig sein, ist aber gleichzeitig definitiv nutzlos. Um die erforderlichen und optionalen Elemente und Verschachtelungen von RayQC Plug-in-Manifest-Dateien zu verstehen, wird dringend empfohlen, die Beispiel-Plug-ins und ihre Manifest-Dateien zu überprüfen, die im RayQC Anwendungsinstallationsverzeichnis verfügbar sind (z. B. C:\Program Files (x86)\RayQC\Samples\).