Trabajo con paquetes de datos data-packages

Introducción a los paquetes gs-data-packages

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 types-of-packages

Puede trabajar con tres tipos de paquetes en Adobe Campaign: paquetes de usuario, paquetes de plataforma y paquetes de administrador.

Estructura de datos data-structure

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 export-packages

Los paquetes se pueden exportar de tres formas diferentes:

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 export-a-set-of-objects-in-a-package

Para exportar un conjunto de objetos en un paquete de datos, siga estos pasos:

Administración de dependencias manage-dependencies

El proceso de exportación realiza un seguimiento de los vínculos entre los distintos elementos exportados. Este mecanismo se define por dos reglas:

Exportación de una campaña export-a-campaign

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:

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:

Administración de definiciones de paquetes manage-package-definitions

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 create-a-package-definition

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 add-entities-to-a-package-definition

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:

Configuración de la generación de definiciones de paquetes configure-package-definitions-generation

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.

Exportación de paquetes desde una definición de paquete export-packages-from-a-package-definition

Para exportar un paquete desde una definición de paquete, siga los pasos siguientes:

Importación de paquetes import-packages

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 install-a-package-from-a-file

Para importar un paquete de datos existente, siga estos pasos:

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 install-a-standard-package

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.

Prácticas recomendadas de paquete de datos data-package-best-practices

En esta sección se describe cómo organizar los paquetes de datos de forma coherente durante toda la duración del proyecto.

Versiones

Siempre debe importar en la misma versión de la plataforma. Debe comprobar que implementa los paquetes entre dos instancias que tienen la misma compilación. Evite forzar la importación y siempre actualice primero la plataforma (si la compilación es diferente).

Preste atención a la estructura del esquema y de la base de datos. La importación de un paquete con esquema debe ir seguida de la generación de esquemas.

Tipos de paquetes package-types

Empiece por definir diferentes tipos de paquetes. Solo se utilizan cuatro tipos:

Entidades

Si necesita implementar la configuración en una instancia nueva, puede importar todos los paquetes de entidades.

Funciones

Este tipo de paquete:

Campañas

Este paquete no es obligatorio. A veces resulta útil crear un tipo específico para todas las campañas, incluso si una campaña se puede ver como una función.

Actualizaciones

Una vez configurada, una función se puede exportar a otro entorno. Por ejemplo, el paquete se puede exportar de un entorno de desarrollo a un entorno de prueba. En esta prueba, se muestra un defecto. Primero, debe corregirse en el entorno de desarrollo. A continuación, el parche debe aplicarse a la plataforma de prueba.

La primera solución sería volver a exportar toda la función. Sin embargo, para evitar cualquier riesgo (actualizar elementos no deseados), es más seguro tener un paquete que contenga solamente la corrección.

Por este motivo, recomendamos crear un paquete "actualización" que contenga solo un tipo de entidad de la función.

Una actualización no solo podría ser una corrección, sino también un nuevo elemento del paquete de campaña, función o entidad. Para evitar implementar todo el paquete, puede exportar un paquete de actualización.

Convenciones de nomenclatura data-package-naming

Ahora que los tipos están definidos, debemos especificar una convención de nombres. Adobe Campaign no permite crear subcarpetas para las especificaciones del paquete, lo que significa que los números son la mejor solución para mantenerse organizados. Números de nombres de paquetes de prefijos.

Por ejemplo, puede utilizar la siguiente convención:

Orden de paquetes de entidades entity-packages-order

Para ayudar a la importación, los paquetes de entidades deben ordenarse a medida que se importan.

Por ejemplo:

Documentación del paquete package-documentation

Al actualizar un paquete, siempre debe colocar un comentario en el campo de descripción para detallar las modificaciones y motivos (por ejemplo, "añadir un nuevo esquema" o "corregir un defecto").

Una práctica recomendada también es introducir la fecha de la actualización.