Exportieren und Importieren von Integrationen und Mikroapps
Mit dem Mikroappsdienst können Sie Integrationen und Mikroapps leicht exportieren und importieren.
Die Exportfunktion ermöglicht Folgendes:
- Export der Integration allein, mit allen Mikroapps oder mit ausgewählten Mikroapps.
- Export einzelner Mikroapps aus einer bestehenden Integration.
Die Importfunktion ermöglicht Folgendes:
- Import einer Integration, mit allen Mikroapps.
- Import einzelner Mikroapps aus einer bestehenden Exportdatei, zusätzlich zu neuen Versionen aktueller Mikroapps.
Vorteile
Der Import und Export von Integrationen und Mikroapps eignet sich für folgende Szenarios:
- Backup und Wiederherstellen vorhandener Integrationen und Mikroapps.
- Schnellere Entwicklung zusätzlicher Mikroapps für Integrationen.
- Test neuer Konfigurationen ohne Beeinträchtigung von Produktionsintegrationen.
- Sicheres Testen von Lösungsansätzen bei der Problembehandlung.
- Zusammenarbeit mit anderen Mikroapps-Entwicklern in Ihrer Organisation oder der breiteren Entwickler-Community auf der Citrix Mikroappsplattform.
Export-Feature
Das Export-Feature verpackt die diversen Einstellungen und Konfigurationen in einer MAPP-Datei. Diese Datei kann in die Mikroapps-Administratorkonsole importiert werden. Es gibt zwei Arten von MAPP-Dateien: Eine für Integrationen und eine für Mikroapps.
Hinweis:
Die Exportdatei enthält keine sensiblen Daten wie Benutzer-IDs, Kennwörter, OAuth-Client-IDs und geheime Clientschlüssel.
MAPP-Konfigurationsdateien für vorlagenbasierten Integrationen enthalten Folgendes:
- Synchronisierungszeitplan und -konfigurationen
- Tabellen
- Optionen für “Schema bearbeiten”
- Ausgewählte Attribute
- Filter und Filterabfragen
- Beziehungen
- Aktionen
- Konfiguration
- Integrationsname
- Connectorparameter
- Dienst-URL
- Dienstauthentifizierung
- Benutzername
- Kennwort
- Benutzerauthentifizierungsmethode
- Andere Parameter
- On-Premises-Konfiguration
- Protokollierung
Hinweis:
Mikroapps werden exportiert, jedoch ohne zuvor konfigurierte Abonnenten. Abonnenten müssen nach dem Importieren der Mikroapp neu konfiguriert werden. Weitere Informationen finden Sie unter Zuweisen von Abonnenten.
MAPP-Konfigurationsdateien für HTTP-Integrationen enthalten Folgendes:
- Laden von Daten
- Datenendpunkte (auch verkettete untergeordnete Endpunkte)
- Tabellen
- Beziehungen
- Dienstaktionen
- Konfiguration
- Integrationsname
- Connectorparameter
- Basis-URL
- Symbol
- On-Premises-Instanz
- Dienstauthentifizierung
- Authentifizierungsmethode
- Dienstaktionsauthentifizierung
- Separate Benutzerauthentifizierung in Aktionen verwenden
- Authentifizierungsmethode
- Protokollierung
MAPP-Konfigurationsdateien für Mikroapps enthalten Folgendes:
- Eigenschaften
- Name
- Beschreibung
- Symbol
- Aktion
- (Aktionsseite)
- Benachrichtigungen
- Name
- Auslöser
- Umschaltflächen
- Inhalt
- Aktionsschaltflächen
- Zielseite
- Einstellungen
- Bedingungen
- Ablaufbedingungen
- Name
- Seiten
- Alle Seiteneigenschaften und -aktionen
- Alle Seitenformatierungen
- Alle Seitenkomponenten und -einstellungen
- Alle aufgerufenen Aktionen
- Lokalisierung
- Alle Lokalisierungseinstellungen
- Metadaten
- Identifizierung der Integration, die zum Erstellen Ihrer Mikroapp verwendet wurde.
- Eine Zuordnungsstruktur von Mikroappkomponenten zum Integrationsdatencachelayer muss die korrekte Zuordnung zur neuen Integration ermöglichen.
- Abonnenteneinstellungen werden nicht exportiert.
Exportieren einer Konfiguration
Führen Sie folgende Schritte aus, um eine Konfigurationsdatei zu exportieren:
- Öffnen Sie die Mikroapps-Verwaltungskonsole und suchen Sie die Integration, die Sie exportieren möchten.
- Klicken Sie auf das Menü dieser Integration (…) und wählen Sie Integration exportieren.
- Geben Sie optional einen Anbieter und eine Beschreibung ein.
- Aktivieren oder deaktivieren Sie die ausgewählten Mikroapps, die Sie in die Exportdatei aufnehmen möchten.
- Wählen Sie Exportieren.
- Speichern Sie die resultierende MAPP-Datei an einem sicheren Speicherort. Die Konfigurationsdatei für die Integration wird im MAPP-Dateiformat auf Ihre lokale Maschine exportiert.
Exportieren einer Mikroapp
Führen Sie folgende Schritte aus, um eine Mikroappdatei zu exportieren:
- Öffnen Sie die Mikroapps-Verwaltungskonsole und suchen Sie die Integration, aus der Sie die Mikroapp exportieren möchten.
- Klicken Sie auf das Menü der zu exportierenden Mikroapp (…) und wählen Sie Exportieren.
- Speichern Sie die resultierende MAPP-Datei an einem sicheren Speicherort. Die Konfigurationsdatei für die Integration wird im MAPP-Dateiformat auf Ihre lokale Maschine exportiert.
Import-Feature
Berücksichtigen Sie beim Import Ihrer Integrationskonfigurationen und Mikroapps Folgendes, bevor Sie den Export/Import-Workflow starten:
- Zustand der Integration nach dem Import.
- Je nach Art der exportierten Integration und den konfigurierten Einstellungen muss die Integrationskonfiguration aktualisiert werden.
- Nach dem Import wird unter Umständen im Integrationsstatus die Warnung Authentifizierungskonfiguration erforderlich angezeigt. Sie müssen die Authentifizierungsanmeldeinformationen erneut konfigurieren, damit der Import erfolgreich ist.
- Synchronisierung, Zwischenspeicherung oder andere Aktionen sind erst nach Aktualisierung der Dienstanmeldeinformationen möglich.
OAuth
Berücksichtigen Sie Folgendes beim Export und Import von Integrationen und Mikroapps, die OAuth verwenden, bevor Sie den Export/Import-Workflow starten:
- Bei Integrationen mit OAuth, die für Dienstkonten oder Dienstaktionen konfiguriert sind, wird die Integration ohne geheime Clientschlüssel exportiert.
- Dies führt zu Problemen bei Authentifizierungsschemata mit OAuth, die das Dienstauthentifizierungsschema und das Dienstaktionsauthentifizierungsschema enthalten können.
- Synchronisierung oder Aktionen sind erst nach Aktualisierung der Dienstanmeldeinformationen möglich.
- Eine erneute Authentifizierung ist erforderlich, um aktualisierte Zugriffstoken vom Kerndatensystem (System of Record, SoR) zu erhalten.
Führen Sie folgende Schritte aus, um die OAuth-Anmeldeinformationen einzugeben:
- Suchen Sie in der Mikroapps-Administratorkonsole die neu importierte Integration.
- Klicken Sie auf das Menü dieser Integration (…) und wählen Sie “Bearbeiten”.
- Klicken Sie links auf “Eigenschaften”.
- Geben Sie die fehlenden Kennwörter und Geheimnisse ein und authentifizieren Sie OAuth erneut.
Einschränkungen für den Import von Mikroapps
Mikroapps werden innerhalb von Integrationen erstellt. Die Integration, die das übergeordnete Element einer Mikroapp ist, wird als Ausgangsintegration bezeichnet. Wenn Sie eine Mikroapp importieren, kann der Import in dieselbe Ausgangsintegration oder eine andere Integration oder Zielintegration erfolgen. Es gibt erhebliche Einschränkungen, die beim Importieren von Mikroapps in Zielintegrationen zu berücksichtigen sind.
Bekannte Auswirkungen beim Importieren von Mikroapps:
- Alle vorhandenen Benachrichtigungen (auch Feedkarten genannt) werden gelöscht, wenn die ursprüngliche Mikroapp gelöscht wird.
- Neue Feedkarten und Pushbenachrichtigungen werden generiert, sobald die neue Integration erneut synchronisiert wurde (vollständig oder inkrementell).
- Mikroapps können nur in eine Zielintegration mit demselben Integrationstyp wie die Ausgangsintegration (vorlagenbasierte Integration oder HTTP-Integration) importiert werden.
Hinweis:
Auch wenn die Datenstruktur (auch Schema genannt) in Ausgangs- und Zielintegration gleich ist, kann die Datenstruktur der Mikroapp vom Import-Feature nicht an einen anderen Integrationstyp angepasst werden.
Die Zielintegration hat eine übereinstimmende Datenbankstruktur mit der Ausgangsintegration:
- Wenn einige zwischengespeicherte Tabellen in der Zielintegration fehlen (abweichendes Schema), wird die Mikroapp als falsch konfiguriert importiert.
- Stellen Sie sicher, dass Ausgangs- und Zielintegration dasselbe Schema verwenden, um Konfigurationsfehler zu vermeiden.
- Navigieren Sie durch die Integrationsschemata, um zu überprüfen, ob die von der Mikroapp erforderlichen Tabellen im Schema enthalten sind.
Mikroappvorlagenschema
Führen Sie folgende Schritte aus, um das Schema einer vorlagenbasierten Integration anzuzeigen:
- Melden Sie sich an der Mikroapps-Verwaltungskonsole an und suchen Sie die Integration, die Sie anzeigen möchten.
- Klicken Sie auf das Menü (…) und wählen Sie “Bearbeiten”.
- Wählen Sie im linken Menü “Tabellen” und klicken Sie auf die Schaltfläche, um das Schema zu bearbeiten.
- Überprüfen Sie die Tabellen und vergleichen Sie die Ausgangs- und Zielschemata. Dadurch wird sichergestellt, dass identische Tabellen und Entitäten im Mikroapps-Datencache synchronisiert werden.
Mikroappstatus nach dem Import
Beim Importieren von Mikroapps gelten folgende Bedingungen:
- Die Mikroapp hat keine Abonnenten. Abonnenten müssen manuell neu erstellt werden.
- Es werden keine Benachrichtigungen für diese Mikroapp erstellt, bis alle Abonnenten eingerichtet sind und die nächste Synchronisierung erfolgt.
- Benachrichtigungen werden automatisch generiert (in der Regel nach der nächsten Synchronisierung) und basieren auf dem festgelegten Benachrichtigungsauslöser.
Schrittfolge für den Konfigurationsimport
Führen Sie folgende Schritte aus, um eine Konfiguration zu importieren:
- Öffnen Sie die Mikroapps-Verwaltungskonsole und klicken Sie oben in der Verwaltungskonsole auf Integration hinzufügen.
- Wählen Sie den Integrationstyp aus, den Sie hinzufügen möchten.
- Wählen Sie neben der Option zum Import einer zuvor konfigurierten Integration die Schaltfläche Weiter.
- Ziehen Sie die MAPP-Datei Ihrer Integration oder wählen Sie Durchsuchen, um die Datei an einem bestimmten Speicherort auszuwählen.
- Bei Auswahl der falschen Datei können Sie auf den Link “Entfernen” klicken, um sie zu entfernen. Andernfalls klicken Sie auf Importieren.
- Die Integration wird neben allen anderen Integrationen in der Administatorkonsole angezeigt.
Nächste Schritte:
- Fügen Sie der neuen Integration fehlende Anmeldeinformationen hinzu.
- Fügen Sie den neuen Mikroapps Abonnenten hinzu.
- Löschen Sie die ursprüngliche Integration in der Zielumgebung.
Importieren einer Mikroapp in eine vorhandene Integration
Hinweis:
Mikroapps enthalten Verweise auf die Datenstruktur der Integration, mit deren Hilfe sie erstellt wurden. Daher dürfen Mikroapps nur innerhalb einer kompatiblen Zielintegration importiert werden.
Importieren einer neuen Mikroapp in eine vorhandene Zielintegration:
- Öffnen Sie die Mikroapps-Administratorkonsole und suchen Sie die Zielintegration.
- Wählen Sie das Menü der Zielintegration (…) und klicken Sie auf Mikroapp importieren.
- Ziehen Sie die MAPP-Datei Ihrer Integration oder wählen Sie Durchsuchen, um die Datei an einem bestimmten Speicherort auszuwählen.
- Bei Auswahl der falschen Datei können Sie auf den Link “Entfernen” klicken, um sie zu entfernen. Andernfalls klicken Sie auf Importieren.
- Die Mikroapp wird zusammen mit allen anderen Mikroapps für die Integration angezeigt.
Nächste Schritte:
- Fügen Sie den neuen Mikroapps Abonnenten hinzu.
Importieren einer neuen Mikroappversion
Sie können eine Mikroapp im Optionsmenü (…) der Mikroapp auf eine neuere Version aktualisieren.
- Wählen Sie auf der Seite “Mikroappintegrationen” die Option Neue Version importieren für die gewünschte Mikroapp aus.
-
Ziehen Sie Ihre neue Mikroapp und wählen Sie Importieren.
(Optional) Wählen Sie Vorhandene Feedkarten löschen, um die alte Mikroappversion komplett aus dem System zu entfernen. Wenn Sie diese Option nicht auswählen, verbleibt die alte Mikroappversion im System und wird mit “EOL” (Ende des Lebenszyklus) markiert. Die neue Version ist als aktive Mikroapp eingerichtet. Es wird empfohlen, alte Mikroapps nicht zu löschen, damit erstellte Feedkarten weiterhin korrekt funktionieren.
- Klicken Sie auf Importieren.
Ihre neue Mikroapp wird importiert.
Nächste Schritte:
- Fügen Sie den neuen Mikroapps Abonnenten hinzu.
- Ende des Lebenszyklus (EOL): Sie können für eine Mikroapp manuell “Ende des Lebenszyklus” festlegen. Zum Anzeigen der EOL-Umschaltfläche klicken Sie zum Bearbeiten auf die Mikroapp und wählen “Eigenschaften”.
Aktualisieren einer Integration
Führen Sie folgende Schritte aus, um eine Integration zu aktualisieren:
- Öffnen Sie die Mikroapps-Verwaltungskonsole und klicken Sie oben in der Verwaltungskonsole auf Integration ugraden.
- Wählen Sie den Integrationstyp aus, den Sie hinzufügen möchten.
- Ziehen Sie die MAPP-Datei Ihrer Integration oder wählen Sie Durchsuchen, um die Datei an einem bestimmten Speicherort auszuwählen.
- Bei Auswahl der falschen Datei können Sie auf den Link “Entfernen” klicken, um sie zu entfernen. Klicken Sie andernfalls auf Aktualisieren.
- Die Integration wird neben allen anderen Integrationen in der Administatorkonsole angezeigt.
Überlegungen zum Aktualisieren der Integration
- Es werden nur HTTP-Integrationen unterstützt.
- Zu den akzeptierten Datenstrukturen gehören neue Tabellen, neue Spalten in vorhandenen Tabellen und neue Beziehungen. Es sind keine Änderungen zulässig für:
- Tabellen (Entfernen einer Tabelle oder Ändern von Tabellennamen, Primärschlüsseln).
- Spalten (Entfernen einer Spalte oder Ändern von Spaltennamen, Datentypen, Primärschlüsseln, eindeutiger Einschränkung, Zulassen von Nullwerten).
- Beziehungen (keinerlei Entfernen oder Ändern möglich).
- Wenn Teile der alten Struktur nicht mehr benötigt werden, können Sie die Datenstrukturen leer lassen oder Werte mithilfe von Skripting definieren.
- Das Entfernen von Ziel-Dienstaktionen ist nicht zulässig. Die Validierung gilt für die UUID einer Dienstaktion und ihre Definition, einschließlich Parametern und so weiter.
- Wenn Änderungen an Dienstaktionen erforderlich sind, müssen Sie diese Dienstaktionen neu konfigurieren und jede Mikroapp aktualisieren, damit die aktualisierte Dienstaktion aufgerufen wird.
Nach dem erfolgreichen Aktualisieren einer Integration wurden folgende Elemente vollständig ersetzt:
- alle Datenendpunkte und Webhook-Definitionen.
- Dienstaktionen (entspricht dem Beibehalten der alten Aktionen beim Hinzufügen der neu konfigurierten Aktionen).
- Alle im Rahmen des HTTP-Integrationsskripting erstellten Skripts.
Nach dem Upgrade:
- Eine vollständige Synchronisierung ist erforderlich, um die neu eingeschlossenen Tabellen und Spalten in den Cache zu laden. Bis zur abgeschlossenen Synchronisierung funktioniert die App möglicherweise nicht ordnungsgemäß (aufgrund fehlender Daten).
- Es werden nur Integrationsentitäten, Beziehungen, Datenendpunkte, Skripts und Dienstaktionen importiert und für das Integrationsupgrade verfügbar gemacht (keine Eigenschaften, Autorisierung usw.).