Uso de integración
Tutorial
En el siguiente vídeo explicativo se describe el uso del conector:
Configuración
Esta guía le guiará para poner en marcha el conector.
Instalación del paquete de integración
Recibirá acceso al paquete de integración de AEM. Existen dos opciones para instalar la integración:
- Instalación de paquetes - Directa y menos involucrada.
- Instalación de POM: más avanzada, pero puede resultar útil al usar AEM Cloud Manager y actualizar la integración.
Instalación de paquetes
Para instalar el paquete, descárguelo con el vínculo que aparece en el correo electrónico de incorporación. Encontrará instrucciones detalladas para instalar un paquete de AEM haciendo clic aquí.
Instalación de POM
Para incluir el conector en el POM, siga estos pasos. Reemplace su nombre de usuario y contraseña por los que recibió en el correo electrónico de incorporación.
-
Agregue lo siguiente al archivo
.cloudmanager/maven/settings.xmlde su proyecto o a~/.m2/settings.xmlde su equipo. ReemplaceYOUR_USERNAMEcon el nombre de usuario yYOUR_PASSWORDcon la contraseña proporcionada en el correo electrónico de incorporación.note important IMPORTANT Si usa Cloud Manager, el enfoque seguro es seguir los pasos que se encuentran aquí para repositorios Maven protegidos por contraseña. 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> -
Agregue lo siguiente al archivo
pom.xmldel proyecto: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> -
Agregue lo siguiente al archivo
all/pom.xmldel proyecto. Reemplaceproject.dependencies.dependency.versionpor la versión apropiada yproject.build.plugins.plugin.configuration.embeddeds.embedded.targetpor la ruta de acceso correcta.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>
Configuración de nube
Esta integración se configura creando una configuración de nube en la carpeta en la que funcionará el conector. Siga estos pasos para crear una configuración de nube:
-
Vaya a la configuración de nube de Veeva.
-
Cree una nueva configuración de nube de Veeva en la carpeta adecuada y rellene el como se describe en las secciones siguientes.
Pestaña Configuración
Complete lo siguiente en la pestaña de configuración:
- Obligatorio. Título para la configuración del conector de Veeva Vault. Puede ser un valor arbitrario. (p. ej.
Veeva Vault Configuration) - Obligatorio. La URL de dominio de la instancia de Veeva (p. ej.
https://my-instance.veevavault.com/) - Obligatorio. Se requiere ClientID para llamar a la API de Veeva Vault. Puede ser un valor arbitrario y se utiliza principalmente para la depuración. (p. ej.
adobe-aem-vvtechpartner) - Obligatorio. Nombre de usuario de Veeva Vault. Ver Creación de usuarios de Veeva.
- Obligatorio. Contraseña de Veeva Vault. Ver Creación de usuarios de Veeva.
Pestaña Adobe IO
Si el proyecto necesita generar PDF o imágenes para las páginas, esta pestaña es obligatoria. Complete lo siguiente en la pestaña Adobe IO:
- Obligatorio. Extremo de Adobe IO para crear imágenes de PDF proporcionado en el correo electrónico de incorporación. (p. ej.
https://my-namespace.adobeioruntime.net/api/v1/web/aem-veeva-serverless-0.0.2/trigger-action.json) - Obligatorio. Nombre de la acción para la generación de imágenes de página. Este valor debe ser
aem-veeva-integration/get-image-async. - Obligatorio. Nombre de la acción para la generación de imágenes HTML. Este valor debe ser
aem-veeva-integration/get-pdf-async-new. - Obligatorio. El extremo de Adobe IO para obtener el estado de la generación que se proporcionó en el correo electrónico de incorporación.(p. ej.
https://my-namespace.adobeioruntime.net/api/v1/web/aem-veeva-serverless-0.0.2/get-state-value) - Obligatorio. Nombre de usuario de AEM que utilizará Adobe IO. Consulte Creación de usuarios de AEM.
- Obligatorio. Contraseña de AEM que utilizará Adobe IO. Consulte Creación de usuarios de AEM.
- Opcional. El tiempo de espera predeterminado es permitir que la página responda hasta un momento especificado después del cual el servicio AIO deje de intentar obtener una respuesta. El valor predeterminado es
30000. - Opcional. El retraso es después de que la página haya respondido con 200 para retrasar todas las imágenes que se procesarán antes de tomar una captura de pantalla. El valor predeterminado es
2000. - Opcional. La URL generada por la captura de pantalla/PDF caducará después de configurar el valor en segundos.
- Opcional. La captura de pantalla de Adobe IO/servicio de generación de PDF es asincrónica. El servicio AEM llama al extremo de estado de AIO para obtener la captura de pantalla/PDF. Esta propiedad decidirá en milisegundos la pausa entre cada llamada de estado. El valor predeterminado es
10000. - Opcional. Recuento máximo de reintentos para la llamada de estado a Adobe IO para obtener la captura de pantalla/PDF. El valor predeterminado es
10.
Pestaña Avanzadas
Complete lo siguiente en la pestaña avanzada:
- Necesario para la generación de imágenes/PDF. Patrón de nombre de archivo utilizado al crear PDF/imágenes.
{name}se puede crear una plantilla. (p. ej.{name}-screenshot) - Opcional. Los tipos de dispositivo para los que se requieren capturas de pantalla de página que no sean de escritorio. Los tipos válidos incluyen
Tab (iPad)yMobile (iPhone X). - Opcional. El valor del tipo de representación en Veeva que representa la representación anterior. (p. ej.
web_ready__c) - Necesario para la generación de imágenes/PDF. Tipo de captura de pantalla que crear.
PDFoImage. - Necesario para la generación de imágenes/PDF. Tipo de PDF que se va a generar.
Print CSS Based PDFoPixel Perfect Screenshot PDF. - Necesario para la generación de imágenes/PDF. Tipo de imagen que se va a generar.
PNGoJPEG. - Obligatorio. El flujo de trabajo se ejecutará una vez que haya finalizado el déclencheur de aprobación de Veeva Vault.
- Obligatorio. Valor de propiedad Status que representa Approved. (p. ej.
Approved for Distribution) - Obligatorio. El flujo de trabajo se ejecutará una vez que se haya completado el déclencheur de rechazo de Veeva Vault.
- Obligatorio. Valor de propiedad Status que representa Rechazado/No aprobado. (p. ej.
Rejected) - Opcional. Nombre de propiedad para ID de documento en Veeva Vault. El valor predeterminado es
id. - Opcional. Nombre de propiedad de Status en Veeva Vault. El valor predeterminado es
status__v. - Opcional. Nombre de propiedad de la fecha de modificación del documento. El valor predeterminado es
version_modified_date__v. - Opcional. Nombre de propiedad de la URL del recurso de documento. El valor predeterminado será
external_id__v. Si este campo ya está en uso, cree un campo diferente en Veeva y rellene el nombre del campo aquí. Este campo se utilizará en Veeva para mantener la ruta del recurso de AEM. Esto es necesario para la sincronización automatizada de metadatos. - Opcional. Nombre de propiedad para el número de versión principal en Veeva Vault. El valor predeterminado es
major_version_number__v. - Opcional. Nombre de la propiedad para el número de versión menor en Veeva Vault. El valor predeterminado es
minor_version_number__v. - Opcional. Valor de tipo de relación de Veeva Vault. Todos los recursos agregados a la página se representarán como relacionados en función de este valor. El valor predeterminado es
supporting_document__c.
Pestaña Página
Si sincroniza páginas, complete lo siguiente en la pestaña de página:
-
Obligatorio. Mapa de una propiedad de AEM a Veeva.
a. Nombre de propiedad de AEM. Se puede seleccionar en Propiedades de AEM. (p. ej.jcr:title){name}se puede crear una plantilla.
b. El nombre de propiedad de Veeva introducido exactamente en existe en Veeva. (p. ej.name__v)
c. Tipo de propiedad.TextoMultiline Text. -
Obligatorio. Mapa de una propiedad de Veeva a AEM.
a. El nombre de propiedad de Veeva introducido exactamente en existe en Veeva. (p. ej.name__v)
b. Nombre de propiedad de AEM. Se puede seleccionar en Propiedades de AEM. (p. ej.jcr:title)
c. Tipo de propiedad.TextoMultiline Text.
Pestaña Recurso
Si sincroniza recursos, complete lo siguiente en la pestaña de recursos:
-
Obligatorio. Mapa de una propiedad de AEM a Veeva.
a. Nombre de propiedad de AEM. Se puede seleccionar en Propiedades de AEM. (p. ej./jcr:content/metadata/jcr:title){name}se puede crear una plantilla.
b. El nombre de propiedad de Veeva introducido exactamente en existe en Veeva. (p. ej.name__v)
c. Tipo de propiedad.TextoMultiline Text. -
Obligatorio. Mapa de una propiedad de Veeva a AEM.
a. El nombre de propiedad de Veeva introducido exactamente en existe en Veeva. (p. ej.name__v)
b. Nombre de propiedad de AEM. Se puede seleccionar en Propiedades de AEM. (p. ej./jcr:content/metadata/jcr:title)
c. Tipo de propiedad.TextoMultiline Text.
Ajustes adicionales
Creación de usuarios de AEM
Durante la generación de PDF/imágenes, es necesario crear un usuario de AEM para obtener páginas de AEM. Cree y conceda permisos de solo lectura a un usuario siguiendo estos vínculos:
Si utiliza AEM 6.5.5 o posterior:
Si utiliza AEM Cloud Services:
Se requieren los siguientes permisos para el usuario del servicio AEM en el contenido que se convertirá a PDF/Image y se insertará en Veeva:
- Lectura
Debe cumplir con los estándares de seguridad de su organización al crear usuarios y configurar permisos.
Creación de usuarios de Veeva
Para utilizar esta integración, es necesario crear un usuario en Veeva Vault. Para crear un usuario, siga estos pasos:
-
Vaya a Administración -> Usuarios y grupos -> Usuarios de Vault -> Crear
-
Rellene las entradas necesarias. La configuración más sencilla es establecer
License TypeenFull UserySecurity ProfileenVault Owner. Guardar cuando se complete.
Se requieren los siguientes permisos para los tipos de documento Veeva específicos que se están utilizando:
- Crear/leer documentos
- Crear/Leer versiones
- Crear/actualizar metadatos
- Crear/actualizar representaciones
Debe cumplir con los estándares de seguridad de su organización al crear usuarios y configurar permisos.