Nutzung der Integration
Anleitung
In der folgenden Videoanleitung wird die Verwendung des -Connectors beschrieben:
Einrichtung
Diese Anleitung führt Sie durch die Einrichtung und Ausführung des Connectors.
Integrationspaket installieren
Sie erhalten Zugriff auf das Integrations-AEM-Paket. Es gibt zwei Möglichkeiten, die Integration zu installieren:
- Paketinstallation - einfach und weniger aufwändig.
- POM-Installation - Erweiterter, kann aber bei der Verwendung von AEM Cloud Manager und beim Upgrade der Integration nützlich sein.
Package-Installation
Um das Paket zu installieren, laden Sie es mit dem Link in der Onboarding-E-Mail herunter. Detaillierte Anweisungen zum Installieren eines AEM-Pakets finden Sie hier.
POM-Installation
Gehen Sie wie folgt vor, um den Connector in Ihr POM aufzunehmen. Ersetzen Sie Ihren Benutzernamen und Ihr Kennwort durch die in der Onboarding-E-Mail erhaltenen.
-
Fügen Sie der
.cloudmanager/maven/settings.xml
-Datei in Ihrem Projekt oder~/.m2/settings.xml
auf Ihrem Computer Folgendes hinzu. Ersetzen SieYOUR_USERNAME
durch den Benutzernamen undYOUR_PASSWORD
mit dem Kennwort, das in der Onboarding-E-Mail angegeben ist.note important IMPORTANT Wenn Sie Cloud Manager verwenden, besteht der sichere Ansatz darin, die hier für kennwortgeschützte MavenRepositorys beschriebenen Schritte. code language-none <settings> ... <servers> ... <server> <id>repo.ea.adobe.net</id> <username>YOUR_USERNAME</username> <password>YOUR_PASSWORD</password> <filePermissions>BucketOwnerFullControl</filePermissions> <configuration> <wagonProvider>s3</wagonProvider> </configuration> </server> ... </servers> ... </settings>
-
Fügen Sie der
pom.xml
des Projekts Folgendes hinzu:code language-none <project> ... <build> ... <extensions> ... <extension> <groupId>com.allogy.maven.wagon</groupId> <artifactId>maven-s3-wagon</artifactId> <version>1.2.0</version> </extension> ... </extensions> ... </build> ... <repositories> ... <repository> <id>repo.ea.adobe.net</id> <url>s3://repo.ea.adobe.net/release</url> <releases> <enabled>true</enabled> </releases> </repository> ... </repositories> ... </project>
-
Fügen Sie der
all/pom.xml
des Projekts Folgendes hinzu. Ersetzen Sieproject.dependencies.dependency.version
durch die entsprechende Version undproject.build.plugins.plugin.configuration.embeddeds.embedded.target
Sie durch den richtigen Pfad.code language-none <project> ... <build> ... <plugins> ... <plugin> <groupId>org.apache.jackrabbit</groupId> <artifactId>filevault-package-maven-plugin</artifactId> ... <configuration> ... <embeddeds> ... <embedded> <groupId>com.adobe.acs.aemveeva</groupId> <artifactId>aem-veeva-connector.all</artifactId> <type>zip</type> <target>/apps/APP_NAME-packages/application/install</target> </embedded> ... </embeddeds> </configuration> </plugin> ... </plugins> ... </build> ... <dependencies> ... <dependency> <groupId>com.adobe.acs.aemveeva</groupId> <artifactId>aem-veeva-connector.all</artifactId> <version>1.0.5</version> <type>zip</type> </dependency> ... </dependencies> ... </project>
Cloud-Konfiguration
Diese Integration wird durch Erstellen eines Cloud-Konfigurationsordners konfiguriert, in dem der Connector ausgeführt werden soll. Führen Sie die folgenden Schritte aus, um eine Cloud-Konfiguration zu erstellen:
-
Navigieren Sie zur Veeva-Cloud-Konfiguration.
-
Erstellen Sie eine neue Veeva-Cloud-Konfiguration im entsprechenden Ordner und füllen Sie die wie in den nächsten Abschnitten beschrieben.
Registerkarte „Konfiguration“
Füllen Sie auf der Registerkarte Konfiguration Folgendes aus:
- Erforderlich. Titel der Connector-Konfiguration für Veeva Vault. Dies kann ein beliebiger Wert sein. (z. B.
Veeva Vault Configuration
) - Erforderlich. Die Domain-URL der Veeva-Instanz (z. B.
https://my-instance.veevavault.com/
) - Erforderlich. ClientID zum Aufrufen der Veeva Vault-API erforderlich. Dies kann ein beliebiger Wert sein und wird hauptsächlich zum Debugging verwendet. (z. B.
adobe-aem-vvtechpartner
) - Erforderlich. Veeva Vault-Benutzername. Siehe Veeva-Benutzererstellung.
- Erforderlich. Veeva Vault-Kennwort. Siehe Veeva-Benutzererstellung.
Registerkarte Adobe IO
Wenn das Projekt PDF oder Bilder für -Seiten generieren muss, ist diese Registerkarte erforderlich. Füllen Sie Folgendes auf der Registerkarte „Adobe IO“ aus:
Registerkarte
- Erforderlich. Der Adobe IO-Endpunkt für die Erstellung von PDF-Images, der in der Onboarding-E-Mail bereitgestellt wurde. (z. B.
https://my-namespace.adobeioruntime.net/api/v1/web/aem-veeva-serverless-0.0.2/trigger-action.json
) - Erforderlich. Der Aktionsname für die Erstellung des Seitenbilds. Dieser Wert muss
aem-veeva-integration/get-image-async
sein. - Erforderlich. Der Aktionsname für die Erstellung von HTML-Bildern. Dieser Wert muss
aem-veeva-integration/get-pdf-async-new
sein. - Erforderlich. Der Adobe-IO-Endpunkt , um den Status der Generierung abzurufen, die in der Onboarding-E-Mail bereitgestellt wurde.(z. B.
https://my-namespace.adobeioruntime.net/api/v1/web/aem-veeva-serverless-0.0.2/get-state-value
) - Erforderlich. AEM-Benutzername, der von Adobe-IO verwendet wird. Siehe AEM-Benutzererstellung.
- Erforderlich. AEM-Kennwort, das von Adobe IO verwendet wird. Siehe AEM-Benutzererstellung.
- Optional. Die standardmäßige Zeitüberschreitung besteht darin, die Seite bis zu einem bestimmten Zeitpunkt reagieren zu lassen, nach dem der AIO-Service keine Antwort mehr abrufen möchte. Der Standardwert ist
30000
. - Optional. Verzögerung ist, nachdem die Seite mit 200 geantwortet hat, damit sich das Rendern aller Bilder verzögert, bevor ein Screenshot erstellt wird. Der Standardwert ist
2000
. - Optional. Die von Screenshot/PDF generierte URL ist nach dem konfigurierten Wert in Sekunden abgelaufen.
- Optional. Adobe-IO-Screenshot-/PDF-Generierungsdienst ist asynchron. AEM-Dienst ruft AIO-Statusendpunkt auf, um Screenshot/PDF zu erhalten. Diese Eigenschaft entscheidet in Millisekunden, zwischen welchen Pausen bei jedem Statusaufruf gewechselt wird. Der Standardwert ist
10000
. - Optional. Maximale Wiederholungsanzahl für Statusaufrufe an Adobe-IO zum Abrufen von Screenshot/PDF. Der Standardwert ist
10
.
Registerkarte Erweitert
Füllen Sie auf der Registerkarte Erweitert Folgendes aus:
- Erforderlich für die PDF-/Bildgenerierung. Das beim Erstellen von PDF/Bildern verwendete Dateinamenmuster.
{name}
können als Vorlage verwendet werden. (z. B.{name}-screenshot
) - Optional. Die Gerätetypen, für die Seiten-Screenshots außer Desktop erforderlich sind. Gültige Typen sind
Tab (iPad)
undMobile (iPhone X)
. - Optional. Der Wert für den Ausgabedarstellungstyp in Veeva, der die obige Ausgabedarstellung darstellt. (z. B.
web_ready__c
) - Erforderlich für die PDF-/Bildgenerierung. Typ des zu erstellenden Screenshots Entweder
PDF
oderImage
- Erforderlich für die PDF-/Bildgenerierung. Der zu erzeugende PDF-Typ. Entweder
Print CSS Based PDF
oderPixel Perfect Screenshot PDF
- Erforderlich für die PDF-/Bildgenerierung. Der zu erzeugende Bildtyp. Entweder
PNG
oderJPEG
- Erforderlich. Workflow, der ausgeführt werden soll, sobald der Veeva-Vault-Genehmigungs-Trigger durchlaufen wurde.
- Erforderlich. Wert der Statuseigenschaft, der „Genehmigt“ darstellt. (z. B.
Approved for Distribution
) - Erforderlich. Workflow, der ausgeführt werden soll, sobald der Veeva-Vault-Ablehnungs-Trigger durchgekommen ist.
- Erforderlich. Wert der Statuseigenschaft, der „Abgelehnt/Nicht genehmigt“ darstellt. (z. B.
Rejected
) - Optional. Eigenschaftsname für Dokument-ID in Veeva Vault. Der Standardwert ist
id
. - Optional. Eigenschaftsname für Status in Veeva Vault. Der Standardwert ist
status__v
. - Optional. Eigenschaftsname für Änderungsdatum des Dokuments Der Standardwert ist
version_modified_date__v
. - Optional. Eigenschaftsname für Dokumentressourcen-URL. Der Standardwert wird
external_id__v
. Wenn dieses Feld bereits verwendet wird, erstellen Sie ein anderes Feld in Veeva und füllen Sie den Feldnamen hier aus. Dieses Feld wird in Veeva verwendet, um den AEM-Ressourcenpfad zu speichern. Dies ist für die automatisierte Metadaten-Synchronisierung erforderlich. - Optional. Eigenschaftsname für die Hauptversionsnummer in Veeva Vault. Der Standardwert ist
major_version_number__v
. - Optional. Eigenschaftsname für die Nebenversionsnummer in Veeva Vault. Der Standardwert ist
minor_version_number__v
. - Optional. Veeva Vault-Beziehungstyp-Wert. Alle zu dieser Seite hinzugefügten Assets werden auf Grundlage dieses Werts als verwandt dargestellt. Der Standardwert ist
supporting_document__c
.
Registerkarte „Seite“
Wenn Sie Seiten synchronisieren, füllen Sie Folgendes auf der Registerkarte Seite aus:
-
Erforderlich. Ordnen Sie eine Eigenschaft von AEM nach Veeva zu.
A. AEM-Eigenschaftsname. Aus AEM-Eigenschaften auswählbar. (z. B.jcr:title
){name}
können als Vorlage verwendet werden.
b. Veeva Eigenschaftsname, der genau unter eingegeben wurde, existiert in Veeva. (z. B.name__v
)
c. Eigenschaftstyp. EntwederText
oderMultiline Text
-
Erforderlich. Zuordnen einer Eigenschaft von Veeva zu AEM.
a. Der unter genau eingegebene Veeva-Eigenschaftsname existiert in Veeva. (z. B.name__v
)
B. AEM-Eigenschaftsname. Aus AEM-Eigenschaften auswählbar. (z. B.jcr:title
)
c. Eigenschaftstyp. EntwederText
oderMultiline Text
Registerkarte „Asset“
Wenn Sie Assets synchronisieren, füllen Sie Folgendes auf der Registerkarte Asset aus:
-
Erforderlich. Ordnen Sie eine Eigenschaft von AEM nach Veeva zu.
A. AEM-Eigenschaftsname. Aus AEM-Eigenschaften auswählbar. (z. B./jcr:content/metadata/jcr:title
){name}
können als Vorlage verwendet werden.
b. Veeva Eigenschaftsname, der genau unter eingegeben wurde, existiert in Veeva. (z. B.name__v
)
c. Eigenschaftstyp. EntwederText
oderMultiline Text
-
Erforderlich. Zuordnen einer Eigenschaft von Veeva zu AEM.
a. Der unter genau eingegebene Veeva-Eigenschaftsname existiert in Veeva. (z. B.name__v
)
B. AEM-Eigenschaftsname. Aus AEM-Eigenschaften auswählbar. (z. B./jcr:content/metadata/jcr:title
)
c. Eigenschaftstyp. EntwederText
oderMultiline Text
Zusätzliche Einrichtung
AEM-Benutzererstellung
Während der PDF-/Bildgenerierung muss ein AEM-Benutzer erstellt werden, um Seiten von AEM zu erhalten. Erstellen Sie schreibgeschützte Berechtigungen für einen Benutzer, indem Sie die folgenden Links aufrufen:
Bei Verwendung von AEM 6.5.5+:
Bei Verwendung von AEM-Cloud Services:
Die folgenden Berechtigungen sind für den AEM-Service-Benutzer für den Inhalt erforderlich, der in PDF/Image konvertiert und an Veeva gesendet wird:
- Lesen
Beim Erstellen von Benutzern und Festlegen von Berechtigungen müssen Sie die Sicherheitsstandards Ihrer Organisation einhalten.
Veeva-Benutzererstellung
Um diese Integration verwenden zu können, muss ein Benutzer in Veeva Vault erstellt werden. Gehen Sie wie folgt vor, um einen Benutzer zu erstellen:
-
Navigieren Sie zu Admin > Benutzer und Gruppen > Vault-Benutzer > Erstellen .
-
Füllen Sie die erforderlichen Eingaben aus. Die einfachste Einrichtung besteht darin, die
License Type
aufFull User
und dieSecurity Profile
aufVault Owner
festzulegen. Nach Abschluss speichern.
Die folgenden Berechtigungen sind für die spezifischen Veeva-Dokumenttypen erforderlich, die verwendet werden:
- Dokumente erstellen/lesen
- Erstellen/Lesen von Versionen
- Erstellen/Aktualisieren von Metadaten
- Erstellen/Aktualisieren von Ausgabedarstellungen
Beim Erstellen von Benutzern und Festlegen von Berechtigungen müssen Sie die Sicherheitsstandards Ihrer Organisation einhalten.