Mit Packs und Plug-ins arbeiten

Als Administratorkönnen Sie Packs und Plug-ins installieren, um die CDA-Funktionalität zu verbessern und Integrationen in Drittanbieterprodukte zu ermöglichen. Packs und Plug-ins, die in AWI integriert sind, können über die Benutzeroberfläche (mit dem Plugin-Manager-Plug-in) oder über die Package Manager-CLI verwaltet werden.

Wichtig! Ab Version 12.3 können Action Packs in zwei unterschiedlichen Formaten importiert und exportiert werden: .xml und .json. Sie können festlegen, welches Format verwendet werden soll, indem Sie es im Parameter PACKS_COMPATIBILITY_MODE der UC_CLIENT_SETTINGS (Plugin Manager) angeben, oder indem Sie die entsprechende Option im Befehl apm download (Package Manager) hinzufügen.

Weitere Informationen finden Sie hier:

Grafische Darstellung der Abhängigkeiten von Action Builder, Package Manager, Plugin Manager, Inhalts-Artefakten und Marketplace

Diese Seite beinhaltet Folgendes:

Packs anzeigen

Packs anzeigen (GUI)

Auf Packs kann zugegriffen werden:

Hinweis:

Packs anzeigen (CLI)

  1. Aktualisieren Sie den Package Manager-Index, um neue und geänderte Packs aus dem lokalen Repository zu holen:

    apm update

  2. Suchen Sie nach einem Pack im lokalen Repository:

    apm search [<beliebiger Teil des Paketnamens>]

    Beispiel

    apm search Siebel

    Hinweise:

    • Wenn [< beliebiger Teil des Paketnamens>] nicht angegeben ist, werden alle verfügbaren Pakete angezeigt.
    • Um eine vollständige Liste der installierten Packs zu erhalten, geben Sie den folgenden Befehl ein: apm list

Anzeige der Release Notes eines Packs

Eine kurze Beschreibung der Release Notes eines Packs (neue Funktionen, Fehlerbehebungen und bekannte Probleme) wird im Fenster Details der Packs-Ansicht (Administration-Perspektive) angezeigt, nachdem ein Pack ausgewählt wurde. Diese Informationen helfen Ihnen dabei, zu entscheiden, ob Sie die neueste Version eines Packs installieren möchten.

Voraussetzungen:

Hinweis: Besuchen Sie https://downloads.automic.com/, um die vollständige Beschreibung der Release Notes zu lesen.

Packs installieren

Hinweise:

Ein Pack vom Marketplace herunterladen und installieren (GUI)

Wichtig! Diese Methode kann nur zum Installieren von Paketen verwendet werden, die im GIT-Index verfügbar sind.

  1. Öffnen Sie die Administration-Perspektive.
  2. Wählen Sie die Registerkarte Packs aus.
  3. Wählen Sie ein oder mehrere Packs aus der Liste aus.
  4. Klicken Sie in der Symbolleiste auf die Schaltfläche Installieren. Die Packs werden von . https://marketplace.automic.com/ heruntergeladen
  5. Aktivieren Sie das Kontrollkästchen Abhängigkeiten ignorieren, wenn Sie mögliche Abhängigkeiten von anderen Packs ignorieren möchten.

Ein Pack aus einer Datei installieren (GUI)

  1. Laden Sie das Pack, das Sie installieren möchten, von https://marketplace.automic.com/ herunter, und speichern Sie es in einem lokalen Ordner.

    Hinweis: Um die Action Packs auf dem Marketplace zu finden, suchen Sie nach ihren beschreibenden Namen (zum Beispiel: Json Action Pack).

  2. Öffnen Sie die Administration-Perspektive in AWI.
  3. Wählen Sie die Registerkarte Packs aus.
  4. Klicken Sie in der Symbolleiste auf die Schaltfläche Von Datei installieren.
  5. Klicken Sie auf die Schaltfläche Hochladen, navigieren Sie zu dem Speicherort, an den Sie das Pack heruntergeladen haben (.zip-Datei), und folgen Sie den Anweisungen des Assistenten.
  6. Aktivieren Sie das Kontrollkästchen Abhängigkeiten ignorieren, wenn Sie mögliche Abhängigkeiten von anderen Packs ignorieren möchten.

Nach Abschluss der Installation befindet sich das neue Action Pack im Ordner PACKAGES der Process Assembly-Perspektive.

Einige Packs können AWI-Plug-ins enthalten, die zusammen mit dem Pack installiert werden. Um zu überprüfen, ob das Plug-in korrekt registriert wurde, melden Sie sich vom AWI ab und wieder an, wählen den Pfeil im Bereich mit den Benutzer- und Session-Informationen aus (obere rechte Ecke) und wählen Info.

About section in the Web interface showing plugin is installed

Weitere Informationen finden Sie unter Ein- und Ausloggen.

Hinweise:

Ein Pack installieren (CLI)

Verwenden Sie diesen Befehl, um ein Pack von Ihrem lokalen Dateisystem auf einem AE-Zielmandanten zu installieren.

Verwenden Sie den folgenden Befehl, um ein Pack zu installieren:

apm install [option] <Pack-Name>

Alternativ können Sie ein Pack auch aus einer Datei installieren:

apm install --from-file <Pfad zum Paketarchiv oder -verzeichnis>

Dabei kann [option] eine der folgenden sein:

Hinweise:

Beispiele

Single-Pack-Installation:

apm install --from-file C:\Pack.Bond_PCK.AUTOMIC_BOND_1_0_0+build.164.zip

Multiple-Pack-Installation:

apm install PCK.AUTOMIC_HTTP PCK.AUTOMIC_FTP -H automicdev -S AUTOMIC -p 1234 -c 123

Wichtig! Die Installation eines Packs kann auf eine begrenzte Anzahl von Mandanten beschränkt sein. Sie können die Option -c <Nummer> verwenden, um den Zielmandanten der Installation zu ändern, oder den folgenden Befehl eingeben, um die Mandantenprüfung zu umgehen: --ignore-client-restriction.

Ein Pack hochladen (CLI)

Hochladen von Packs aus dem Arbeitsverzeichnis auf den Automation Engine-Mandanten.

Wichtig! Im aktuellen Arbeitsverzeichnis muss die Datei package.yml vorhanden sein. Wenn die Datei nicht vorhanden ist, rufen Sie den folgenden Befehl auf, um sie zu erstellen: apm init <Pack_Name>

apm upload [Option]

Dabei kann [option] eine der folgenden sein:

Packs aktualisieren

Ein Pack aktualisieren (GUI)

Wichtig! Diese Methode kann nur zum Aktualisieren von Packs verwendet werden, die im GIT-Index verfügbar sind.

Tipp: Verwenden Sie die Option Aktualisierungen im Version-Filter, um die Packs anzuzeigen, für die eine Aktualisierung verfügbar ist.

  1. Öffnen Sie die Administration-Perspektive.
  2. Wählen Sie die Registerkarte Packs aus.
  3. Wählen Sie ein oder mehrere Packs aus der Liste aus.
  4. Klicken Sie in der Symbolleiste auf die Schaltfläche Aktualisieren. Die neueste Version wird von https://marketplace.automic.com/ heruntergeladen.
  5. Aktivieren Sie das Kontrollkästchen Abhängigkeiten ignorieren, wenn Sie mögliche Abhängigkeiten von anderen Packs ignorieren möchten.
  6. Klicken Sie auf Aktualisieren.

Hinweise:

Ein Pack aktualisieren (CLI)

Verwenden Sie die folgenden Befehle, um Packs zu aktualisieren:

Befehl zum Aktualisieren des Packindex (nur einmal ausführen):

Wichtig! Das Aktualisieren eines Packs kann auf eine reduzierte Anzahl von Mandanten beschränkt sein. Sie können die Option -c <Nummer> verwenden, um den Zielmandanten der Installation zu ändern, oder den folgenden Befehl eingeben, um die Mandantenprüfung zu umgehen: --ignore-client-restriction.

Hinweise:

Packs erstellen

Folgende Schritte sollten vor dem Erstellen eines Action Packs definiert werden:

Die folgende Grafik veranschaulicht den typischen Workflow beim Erstellen eines Action Packs:

Grafik, die den typischen Workflow bei der Erstellung von Action Packs darstellt

Ein Pack erstellen (GUI)

  1. Klicken Sie in der Process Assembly-Perspektive auf die Registerkarte Packs in der Seitenleiste.
  2. Wählen Sie Action Pack hinzufügen. Das Dialogfeld New Action Pack wird angezeigt.
  3. Geben Sie einen Titel für das Action Pack ein. Der Name des Action Packs wird automatisch vorgeschlagen und besteht aus den folgenden Teilen:

  4. Wählen Sie Action Pack hinzufügen.

Hinweise:

Einen Build für ein Pack erstellen (CLI)

Verwenden Sie diesen Befehl, um einen Build für ein Pack in der AE zu erstellen, sodass es auf andere Systeme übertragen werden kann.

apm build [option] <Paket_Name>

Beispiel:

apm build PCK.AUTOMIC_SHARED -o tar -d /home/deploy/pmRepo -bm xml

Dabei kann [option] eine der folgenden sein:

Wichtig! Dieser Befehl überschreibt die in PACKS_COMPATIBILITY_MODE definierte Einstellung.

Vorlagen-Action-Packs für Komponenten-Workflows erstellen

Vorlagen für Komponenten-Workflows können auf unterschiedlichen CDA-Systemen mit dem CA AutomicPackage Manager ganz einfach verteilt und installiert werden.

Hinweis: Der Action Buildermuss installiert und konfiguriert sein.

Ein Vorlagen-Action-Packs für Komponenten-Workflows erstellen (GUI)

  1. Erstellen Sie die Action Pack-Struktur:
    1. Wechseln Sie zur Process Assembly-Perspektive und klicken Sie auf die Registerkarte Packs in der Seitenleiste.
    2. Klicken Sie auf Action Pack hinzufügen. Das Fenster Neues Action Pack wird angezeigt.

    3. Geben Sie einen Titel für das Action Pack ein (zum Beispiel: Komponenten-Workflow-Vorlage). Der Name für das Action Pack wird automatisch vorgeschlagen.

    4. Klicken Sie auf Action Pack hinzufügen.
  2. Bereinigen Sie die Action Pack-Metadaten, und definieren Sie sie:
    1. Wechseln Sie zum Explorer.
    2. Navigieren Sie zu dem Action Pack, das sich im Unterordner PACKAGES befindet.
    3. Löschen Sie die folgenden Ordner:
      • AKTIONEN
      • RESOURCES und seine Unterordner
      • SOURCE (dieser Ordner sollte nur gelöscht werden, wenn er nicht benötigt wird). Die Unter-Workflows (SOURCE/SHARED/JOBP) und PrompSets (SOURCE/SHARED/PROMPTSETS) sind hier gespeichert).
    4. Löschen Sie das VARA-Objekt, das sich im CONFIG-Ordner befindet (z. B. PCK_CUSTOM_COMPONENT_WORKFLOW_TEMPLATE.PUB.PROMPT_EXTERNAL.MAP).
    5. Fügen Sie ein neues XML VARA-Objekt hinzu:
      1. Klicken Sie auf Objekt hinzufügen.
      2. Geben Sie ihm den Namen PCK.<pack-name>.PUB.INTERFACE (z. B. PCK.CUSTOM_COMPONENT_WORKFLOW_TEMPLATE.PUB.INTERFACE)
      3. Optional können Sie einen Titel eingeben.
      4. Klicken Sie auf Umbenennen.

      5. Klicken Sie auf Schlüssel hinzufügen, um einen Schlüssel hinzuzufügen, und geben Sie ihm den Namen Interface.

      6. Klicken Sie auf den neuen Schlüssel, und fügen Sie die folgende XML-Struktur hinzu, um die Workflow-Vorlagen mit den entsprechenden Einstellungen für den benutzerdefinierten Komponententyp aufzulisten:

        <interface>

        <templates>

        <add-templatekey="ARA.INSTALL.<CustomType>(.DEFAULT)">PCK.<pack-name>.PUB.TEMPLATE.INSTALL.<WF-name>(.DEFAULT)</add-template>

        <add-templatekey="ARA.UNINSTALL.<CustomType>(.DEFAULT)">PCK.<pack-name>.PUB.TEMPLATE.UNINSTALL.<WF-name>(.DEFAULT)</add-template>

        </templates>

        Zum Beispiel:

        Install key=<add-templatekey ="ARA.INSTALL.TOMCAT.DEFAULT">PCK.CUSTOM_COMPONENT_WORKFLOW_TEMPLATE.PUB.TEMPLATE.INSTALL</add-template>

    6. Wechseln Sie zum Action Pack-Hauptordner (z. B. PCK.CUSTOM_COMPONENT_WORKFLOW_TEMPLATE).
    7. Öffnen Sie das Metadaten-VARA-Objekt (z. B. PCK.CUSTOM_COMPONENT_WORKFLOW_TEMPLATE.PUB.VAR.METADATA) und definieren Sie die Dateien gegebenenfalls neu.
      1.  Geben Sie in der Zeile Abhängigkeiten ein abhängiges Action Pack ein. (Ein Action Pack ist abhängig von einem anderen, wenn Aktionen dieses Action Packs innerhalb des Vorlagen-Workflows verwendet werden.)
      2. Geben Sie optional eine Beschreibung für das Action Pack ein.

    8. Öffnen Sie den Ordner DOCUMENTATION und doppelklicken Sie auf das DOCU-Objekt PUB.DOC.

    9. Klicken Sie auf die Registerkarte Dokumentation und geben Sie allgemeine Informationen ein, die für die Verwendung des Action Packs hilfreich sein können.

    10. Öffnen Sie zurück im Ordner DOCUMENTATION das DOCU-Objekt PUB.LICENSES und gebe Sie für die Lizenzierung relevante Informationen ein (z. B. dieses Action Pack darf nicht verändert werden).
  3. Vorlagen-Workflows erstellen:
    1. Öffnen Sie den Ordner TEMPLATES.
    2. Klicken Sie auf Objekt hinzufügen.
    3. Öffnen Sie das Workflow (_FLOWS)-Objekt und wählen Sie COMPONENT_FLOW Workflow.
    4. Klicken Sie auf Objekt hinzufügen. Das Dialogfeld Objekt umbenennen wird angezeigt.
    5. Geben Sie die gleichen Namen ein, wie im XML VARA-Objekt angegeben, und legen Sie den Titel entsprechend fest.

    6. Verwenden Sie die Process Assembly, um die Vorlagen-Workflows zu entwerfen, indem Sie die gewünschten Aktionen per Drag-and-Drop in den Workflow ziehen und die Parameter festlegen.

      Hinweis: Eine Kopie eines vorhandenen Komponenten-Workflows kann als Ausgangspunkt für den Entwurf einer Workflow-Vorlage verwendet werden.

      Wichtig! Die Schlüssel, die im Schnittstellen-XML angegeben sind, müssen der zuvor genannten Struktur entsprechen. Workflow-Namen müssen auch den Namenskonventionen entsprechen.

  4. Das Action Pack exportieren (siehe Packs exportieren)

    Dieses Action Pack kann verwendet werden, um die erstellte Workflow-Vorlage in einem anderen CDA-System zu installieren.

    Hinweis: Vorlagen können nur in demselben AE/ARA-System verwendet werden, in dem das Action Pack erstellt wurde, wenn sie über den Package Manager installiert werden.

Packs exportieren

Packs können in der Process Assembly-Perspektive exportiert und in einem anderen Mandanten oder System wiederverwendet werden.

Wichtig!

Ein Action Pack exportieren

  1. Klicken Sie auf der Seite Packs in der Process Assembly-Perspektive mit der rechten Maustaste auf das entsprechende Action Pack und wählen Sie Export.

  2. Wählen Sie im Fenster Pack exportieren die Option Export, um das Pack automatisch zu validieren und zu erstellen.

  3. Wählen Sie Download, um das Pack herunterzuladen und ein Ziel auszuwählen.

Vor dem Export des Action Packs wird eine semantische Prüfung durchgeführt, um sicherzustellen, dass die Aktionen korrekt definiert sind. Die folgenden Eigenschaften werden überprüft:

Tipp: Exportieren Sie keine Action Packs mit einem fest im Code definierten Agenten/Login-Satz.

Hinweis: Sie können die Exportmethode im Parameter PACKS_COMPATIBILITY_MODE der UC_CLIENT_SETTINGS konfigurieren (siehe: UC_CLIENT_SETTINGS - Verschiedene Mandanteneinstellungen).

Ein Application Pack exportieren (GUI)

Anwendungen, die bereits zu einem Application Pack hinzugefügt wurden, können exportiert werden.

Ein Pack herunterladen (CLI)

Verwenden Sie diesen Befehl, um Packs vom Automation Engine-Mandanten in das Arbeitsverzeichnis herunterzuladen.

Wichtig! Im aktuellen Arbeitsverzeichnis muss die Datei package.yml vorhanden sein. Wenn die Datei nicht vorhanden ist, rufen Sie den folgenden Befehl auf, um sie zu erstellen: apm init <Pack_Name>

apm download [option]

Dabei kann [option] eine der folgenden sein:

Packs klonen

Die Funktion "Klonen" von Action Builder ermöglicht es Ihnen, Zeit zu sparen, wenn Sie Pakete erstellen, die bestehenden Pakete ähnlich sind.

Wichtig!

Hinweis: Das Klonen eines Action Packs führt dazu, dass alle Aktionen und Objekte, die direkt zu ihm gehören (Includes, PromptSets, Workflows), kopiert werden.

Packs klonen

  1. Klicken Sie auf der Seite Packs in der Perspektive Process Assembly mit der rechten Maustaste auf das entsprechende Action Pack und wählen Sie Klonen.

  2. (Optional) Ändern Sie den Titel für das geklonte Action Pack.

    Tipp: Geben Sie einen beschreibenden Namen ein. Der Titel hilft Ihnen und anderen Benutzern, den Zweck des Aktions Packs besser zu erkennen.

  3. Geben Sie einen Namen ein. Das System fügt automatisch ein Präfix hinzu, um den Namenskonventionen der Action Packs zu entsprechen.

    Hinweis: Präfixe können in der Datei action.builder konfiguriert werden.

Das geklonte Action Pack wird in der Liste angezeigt.

Packs löschen

Ein Pack löschen (GUI)

  1. Wählen Sie auf der Seite Packs der Administration-Perspektive das Pack aus, das entfernt werden soll. Halten Sie die Strg-Taste gedrückt, um mehrere Packs auszuwählen.
  2. Klicken Sie in der Symbolleiste auf die Schaltfläche Löschen.
  3. Aktivieren Sie das Kontrollkästchen Abhängigkeiten ignorieren, wenn Sie mögliche Abhängigkeiten von anderen Packs ignorieren möchten.
  4. Klicken Sie auf Ja

Hinweis:

Ein Pack löschen (CLI)

Verwenden Sie die folgenden Befehle, um Packs zu entfernen:

Dabei kann [option] eine der folgenden sein:

Hilfe erhalten und weitere Befehle (CLI)

Weitere Informationen zu Sub-Befehlen, Optionen und Syntax finden Sie in der integrierten Hilfe.

Befehlsstruktur

Die APM CLI verwendet eine mehrteilige Struktur. Jeder Befehl besteht aus:

Alle APM-Befehle haben folgende Syntax:

apm <Befehl> [Option] [<Argumente>]

Passwörter

Passwörter können mit den folgenden Befehlen angegeben werden: -pw oder --password.

Wichtig! Die Werte werden während der Eingabe nicht in der Kommandozeile angezeigt.

Allgemeine Optionen

Die folgenden Optionen sind für alle APM Befehle verfügbar:

Allgemeine Optionen für Automation Engine Verbindungsbefehle

Hilfe zu einem Befehl abrufen

Weitere Informationen zu Befehlen erhalten Sie durch den Aufruf von apm <Befehl> -h oder apm <Befehl> --help.

Weitere Befehle finden

Um eine Liste der verfügbaren Befehle zu erhalten, rufen Sie apm -h oder apm --help auf.

Analyse und Anzeige aktueller Umgebungsprobleme

apm doctor check

Beheben Sie aktuelle Umgebungsprobleme, die vom Doctor Check Command erkannt wurden

apm doctor fix

Hinweis: Erweiterte Packs: Führen Sie diesen Befehl aus, wenn Sie nach fehlenden Hooks und VARA-Objekten von Basis-Packs suchen und diese aktualisieren möchten.

Inhalt des Packs anzeigen

apm show [option] <pack_name>

Dabei kann [option] eine der folgenden sein:

Siehe auch: