Trabajo con paquetes de datos
Introducción a los paquetes
Puede utilizar paquetes de datos para exportar e importar la configuración y los datos personalizados de la plataforma. Los paquetes pueden contener diferentes tipos de configuraciones y componentes, filtrados o no.
En los paquetes de datos de Campaign, las entidades de la base de datos de Adobe Campaign se muestran en archivos XML. En un paquete, cada entidad se representa con todos sus datos.
El principio de paquetes de datos es exportar una configuración de datos e integrarla en otro entorno de Adobe Campaign. Aprenda a mantener un conjunto coherente de paquetes de datos en esta sección.
Tipos de paquetes
Puede trabajar con tres tipos de paquetes en Adobe Campaign: paquetes de usuario, paquetes de plataforma y paquetes de administrador.
- Un paquete de usuario le permite seleccionar la lista de entidades a exportar. Este tipo de paquete administra dependencias y comprueba errores.
- Un paquete de plataforma incluye todos los recursos técnicos agregados (no estándar): esquemas, código JavaScript, etc.
- Un paquete de administración incluye todas las plantillas y objetos empresariales agregados (no estándar): plantillas, bibliotecas, etc.
CAUTIONEstructura de datos
La descripción de un paquete de datos es un documento XML estructurado que se ajusta a la gramática del esquema de datos xrk:navtree, como en el ejemplo siguiente:
<package>
<entities schema="nms:recipient">
<recipient email="john.smith@adobe.com" lastName="Smith" firstName="John">
<folder _operation="none" name="nmsRootFolder"/>
<company _operation="none" name="Adobe"/>
</recipient>
</entities>
<entities schema="sfa:company">
<company name="Adobe">
<location city="London" zipCode="W11 2BQ"/>
</company>
</entities>
</package>
El documento XML debe comenzar y terminar con el elemento <package>. Cualquier elemento <entities> que siga distribuye los datos por tipo de documento. Un elemento <entities> contiene los datos del paquete en el formato del esquema de datos especificado en el atributo schema. Los datos de un paquete no deben contener claves internas que no sean compatibles con las bases, como las claves generadas automáticamente (opción autopk).
En nuestro ejemplo, las uniones en los vínculos folder y company se han reemplazado con teclas de "alto nivel" en las tablas de destino:
<recipient>
<folder _operation="none" name="nmsRootFolder"/>
<company _operation="none" name="Adobe"/>
</recipient>
El atributo operation con el valor none define un vínculo de reconciliación.
Un paquete de datos se puede crear manualmente desde cualquier editor de texto. Debe asegurarse de que la estructura del documento XML cumple con el esquema de datos xtk:navtree. La consola del cliente tiene un módulo de exportación e importación de paquete de datos.
Exportación de paquetes
Los paquetes se pueden exportar de tres formas diferentes:
- Utilice el asistente Package Export para exportar un conjunto de objetos en un solo paquete. Más información
- Para exportar un objeto único, haga clic con el botón derecho en él y seleccione Actions > Export in a package.
- Use Definiciones de paquetes para crear una estructura de paquetes en la que agregue objetos para exportarlos posteriormente en un paquete. Más información
Una vez exportado el paquete, puede importarlo, junto a todas las entidades añadidas, en otra instancia de Campaign.
Exportación de un conjunto de objetos en un paquete
Para exportar un conjunto de objetos en un paquete de datos, siga estos pasos:
-
Vaya al asistente de exportación de paquetes a través del menú Tools > Advanced > Export package… del explorador.
-
Seleccione los tipos de paquetes.
-
Haga clic en el botón Agregar para seleccionar las entidades que desea exportar como paquete.
CAUTIONSi exporta una carpeta de tipo Offer category, Offer environment, Program o Plan, evite seleccionar la carpeta xtk:folder, ya que puede perder algunos datos. Seleccione la entidad que corresponde a la carpeta: nms:offerCategory para categorías de ofertas, nms:offerEnv para entornos de ofertas, nms:program para programas y nms:plan para planes.El mecanismo de dependencia controla la secuencia de exportación de entidades. Para obtener más información, consulte Administración de dependencias.
-
Haga clic en Next y defina la consulta de filtro en el tipo de documento que desea extraer. Debe configurar la cláusula de filtrado para la extracción de datos.
NOTEEl editor de consultas se muestra en esta sección. -
Haga clic en Next y seleccione el criterio de ordenación de los datos exportados.
-
Previsualice los datos que desea extraer para comprobar la configuración.
-
La última página del asistente de exportación de paquetes permite iniciar la exportación. Los datos se almacenan en el archivo indicado en el campo File.
Administración de dependencias
El proceso de exportación realiza un seguimiento de los vínculos entre los distintos elementos exportados. Este mecanismo se define por dos reglas:
- los objetos vinculados a un vínculo con una integridad de tipo
ownoowncopyse exportan en el mismo paquete que el objeto exportado. - los objetos vinculados a un vínculo con una integridad de tipo
neutralodefine(vínculo definido) deben exportarse por separado.
NOTEExportación de una campaña
A continuación se muestra un ejemplo de cómo exportar una campaña. La campaña de marketing que se va a exportar contiene:
- una
MyTasktarea - un flujo de trabajo
campaignWorkflowen la siguiente carpeta: Administration > Production > Technical workflows > Campaign processes > MyWorkflow.
La tarea y el flujo de trabajo se exportan en el mismo paquete que la campaña, ya que los esquemas coincidentes están conectados por vínculos con una integridad de tipo own.
El contenido del paquete es:
<?xml version='1.0'?>
<package author="Administrator (admin)" buildNumber="7974" buildVersion="7.1" img=""
label="" name="" namespace="" vendor="">
<desc></desc>
<version buildDate="2013-01-09 10:30:18.954Z"/>
<entities schema="nms:operation">
<operation duration="432000" end="2013-01-14" internalName="OP1" label="MyCampaign"
modelName="opEmpty" start="2013-01-09">
<controlGroup>
<where filteringSchema=""/>
</controlGroup>
<seedList>
<where filteringSchema="nms:seedMember"></where>
<seedMember internalName="SDM1"></seedMember>
</seedList>
<parameter useAsset="1" useBudget="1" useControlGroup="1" useDeliveryOutline="1"
useDocument="1" useFCPValidation="0" useSeedMember="1" useTask="1"
useValidation="1" useWorkflow="1"></parameter>
<fcpSeed>
<where filteringSchema="nms:seedMember"></where>
</fcpSeed>
<owner _operation="none" name="admin" type="0"/>
<program _operation="none" name="nmsOperations"/>
<task end="2013-01-17 10:07:51.000Z" label="MyTask" name="TSK2" start="2013-01-16 10:07:51.000Z"
status="1">
<owner _operation="none" name="admin" type="0"/>
<operation _operation="none" internalName="OP1"/>
<folder _operation="none" name="nmsTask"/>
</task>
<workflow internalName="WKF12" label="CampaignWorkflow" modelName="newOpEmpty"
order="8982" scenario-cs="Notification of the workflow supervisor (notifySupervisor)"
schema="nms:recipient">
<scenario internalName="notifySupervisor"/>
<desc></desc>
<folder _operation="none" name="Folder4"/>
<operation _operation="none" internalName="OP1"/>
</workflow>
</operation>
</entities>
</package>
La afiliación a un tipo de paquete se define en un esquema con el atributo @pkgAdmin and @pkgPlatform. Ambos atributos reciben una expresión XTK que define las condiciones de afiliación del paquete.
<element name="offerEnv" img="nms:offerEnv.png"
template="xtk:folder" pkgAdmin="@id != 0">
Finalmente, el atributo @pkgStatus le permite definir las reglas de exportación para estos elementos o atributos. En función del valor del atributo, el elemento o atributo se encuentra en el paquete exportado. Los tres valores posibles de este atributo son:
never: no exporta el campo/vínculoalways: fuerza la exportación de este campopreCreate: autoriza la creación de la entidad vinculada
NOTEpreCreate solo se admite para eventos de tipo vínculo. Permite crear o señalar una entidad que aún no se ha cargado en el paquete exportado.Administración de definiciones de paquetes
Las definiciones de paquete permiten crear una estructura de paquetes en la que se añaden entidades que se exportan posteriormente en un solo paquete. Después puede importar este paquete y todas las entidades añadidas en otra instancia de Campaign.
Creación de una definición de paquete
Se puede acceder a las definiciones de paquetes desde el menú Administration > Configuration > Package management > Package definitions.
Para crear una definición de paquete, haga clic en el botón New y complete la información general de la definición del paquete.
A continuación, se pueden añadir entidades a la definición del paquete y exportarla a un paquete de archivos XML.
Temas relacionados:
Adición de entidades a una definición de paquete
En la pestaña Content, haga clic en el botón Add para seleccionar las entidades que desea exportar con el paquete. Las prácticas recomendadas al seleccionar entidades se presentan en esta sección.
Las entidades se pueden añadir a una definición de paquete directamente desde su ubicación en la instancia. Para realizar esto, siga los pasos a continuación:
-
Haga clic con el botón derecho en la entidad deseada y luego seleccione Actions > Export in a package.
-
Seleccione Add to a package definition y luego seleccione la definición del paquete a la que desea añadir la entidad.
-
La entidad se añade a la definición del paquete y se exporta con el paquete (consulte esta sección).
Configuración de la generación de definiciones de paquetes
La generación de paquetes se puede configurar desde la pestaña de Content de definición del paquete. Para ello, haga clic en el vínculo Generation parameters.
-
Utilice la opción Include the definition para incluir la definición utilizada actualmente en la definición del paquete.
-
Utilice la opción Include an installation script para agregar un script javascript para ejecutarlo en la importación del paquete. Al seleccionarlo, se añade una pestaña Script en la pantalla de definición del paquete.
-
Utilice la opción Include default values para agregar al paquete los valores de todos los atributos de las entidades.
Esta opción no está seleccionada de forma predeterminada para evitar exportaciones largas. Esto significa que, de forma predeterminada, los atributos de las entidades con valores predeterminados ("cadena vacía", "0" y "falso" si no se definen en el esquema) no se añaden al paquete y, por lo tanto, no se exportan.
CAUTIONSi la instancia en la que se importa el paquete contiene entidades idénticas a las del paquete (por ejemplo, con la misma ID externa), sus atributos no se actualizan. Esto puede ocurrir si los atributos de la instancia anterior tienen valores predeterminados, ya que no se incluyen en el paquete. En ese caso, la selección de la opción Include default values impide que las versiones se fusionen, ya que todos los atributos de la instancia anterior se exportan con el paquete.
Exportación de paquetes desde una definición de paquete
Para exportar un paquete desde una definición de paquete, siga los pasos siguientes:
- Seleccione la definición del paquete que desea exportar, haga clic en el botón Actions y seleccione Export the package.
- Compruebe el nombre y la ubicación del archivo exportado.
- Haga clic en el botón Start para iniciar la exportación.
Importación de paquetes
Se puede acceder al asistente de importación de paquetes a través del menú principal Tools > Advanced > Import package de la consola del cliente.
Instalación de un paquete desde un archivo
Para importar un paquete de datos existente, siga estos pasos:
- Acceda al asistente de importación a través del menú principal Tools > Advanced > Import package de la consola del cliente.
- Seleccione el archivo XML y haga clic en Open.
El contenido del paquete que se va a importar se muestra en la sección central del editor.
Haga clic en Next y después en Start para iniciar la importación.
Instalación de un paquete integrado
Paquetes integrados (también conocidos como paquetes estándar) se instalan cuando se configura Adobe Campaign. Según los permisos, el modelo de implementación y la oferta de productos, puede importar nuevos paquetes estándar.
Consulte el acuerdo de licencia para comprobar qué paquetes puede instalar.
