[Também se aplica ao v8]{class="badge positive" title="Também se aplica ao Campaign v8"}

Trabalhar com pacotes de dados working-with-data-packages

Sobre pacotes de dados about-data-packages

O Adobe Campaign permite exportar ou importar a configuração e os dados da plataforma por meio de um sistema de pacotes. Os pacotes podem conter diferentes tipos de configurações, elementos, filtrados ou não.

Os pacotes de dados permitem que entidades do banco de dados do Adobe Campaign sejam exibidas por meio de arquivos no formato XML. Cada entidade contida em um pacote é representada com todos os seus dados.

O princípio de pacotes de dados é exportar uma configuração de dados e integrá-la a outro sistema do Adobe Campaign. Saiba como manter um conjunto consistente de pacotes de dados nesta seção.

Tipos de pacotes types-of-packages

Há três tipos de pacotes exportáveis: pacotes de usuário, pacotes de plataforma e pacotes de administrador.

Estrutura de dados data-structure

A descrição de um pacote de dados é um documento XML estruturado que está de acordo com a gramática do schema de dados xrk:navtree.

Exemplo de pacote de dados:

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

O documento XML deve começar e terminar com o elemento <package>. Quaisquer elementos <entities> seguintes distribuem os dados por tipo de documento.

Um elemento <entities> contém os dados do pacote no formato do schema de dados inserido no atributo schema.

Os dados em um pacote não devem conter chaves internas incompatíveis entre as bases, como chaves geradas automaticamente (opção autopk).

No nosso exemplo, as associações nos links "pasta" e "empresa" foram substituídas por teclas de "alto nível" nas tabelas de destino:

<recipient>
  <folder _operation="none" name="nmsRootFolder"/>
  <company _operation="none" name="Adobe"/>
</recipient>

O atributo operation com o valor "none" define um link de reconciliação.

Um pacote de dados pode ser construído manualmente a partir de qualquer editor de texto. Basta garantir que a estrutura do documento XML esteja em conformidade com o schema de dados "xtk:navtree". O console do Adobe Campaign tem um módulo de importação e exportação de pacotes de dados.

Exportar pacotes exporting-packages

Sobre a exportação de pacotes about-package-export

Os pacotes podem ser exportados de três formas diferentes:

Após a exportação, é possível importar o pacote e todas as entidades adicionadas para outra instância do Campaign.

Exportar um conjunto de dados em um pacote exporting-a-set-of-objects-in-a-package

O assistente de exportação de pacotes pode ser acessado no menu Tools > Advanced > Export package… do console do cliente do Adobe Campaign.

Para os três tipos de pacote, o assistente oferece as seguintes etapas:

Gerenciar dependências managing-dependencies

O mecanismo de exportação permite que o Adobe Campaign rastreie os links entre os vários elementos exportados.

Esse mecanismo é definido por duas regras:

Exportar uma campanha exporting-a-campaign

Veja aqui um exemplo de como exportar uma campanha. A campanha de marketing a ser exportada contém uma tarefa (rótulo: "MyTask") e um workflow (rótulo: "CampaignWorkflow") em uma pasta "MyWorkflow" (nó: Administration / Production / Technical workflows / Campaign processes / MyWorkflow).

A tarefa e o workflow são exportados no mesmo pacote que a campanha desde que os schemas correspondentes sejam conectados por links com uma integridade do tipo "own".

Conteúdo do pacote:

<?xml version='1.0'?>
<package author="Administrator (admin)" buildNumber="7974" buildVersion="7.1" img=""
label="" name="" namespace="" vendor="">
 <desc></desc>
 <version buildDate="AAAA-MM-DD HH:MM:SS.954Z"/>
 <entities schema="nms:operation">
  <operation duration="432000" end="AAAA-MM-DD" internalName="OP1" label="MyCampaign"
  modelName="opEmpty" start="AAAA-MM-DD">
   <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="2023-01-17 10:07:51.000Z" label="MyTask" name="TSK2" start="2023-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>

A afiliação a um tipo de pacote é definida em um schema com o atributo @pkgAdmin e @pkgPlatform. Esses atributos recebem uma expressão XTK que define as condições de afiliação ao pacote.

<element name="offerEnv" img="nms:offerEnv.png"
template="xtk:folder" pkgAdmin="@id != 0">

Finalmente, o atributo @pkgStatus permite definir as regras de exportação para esses elementos ou atributos. Dependendo do valor do atributo, o elemento ou atributo será encontrado no pacote exportado. Os três valores possíveis para este atributo são:

Gerenciar definições de pacote managing-package-definitions

As definições de pacote permitem criar uma estrutura de pacote na qual você adiciona entidades que serão exportadas posteriormente em um único pacote. É possível importar esse pacote e todas as entidades adicionadas para outra instância do Campaign.

Tópicos relacionados:

Criar uma definição de pacote creating-a-package-definition

As definições de pacote podem ser acessadas no menu Administration > Configuration > Package management > Package definitions.

Para criar uma definição de pacote, clique em New e preencha as informações gerais sobre a definição de pacote.

Você pode então adicionar entidades à definição do pacote e exportá-lo para um pacote de arquivos XML.

Tópicos relacionados:

Adicionar entidades a uma definição de pacote adding-entities-to-a-package-definition

Na guia Content, clique no botão Add para selecionar as entidades que serão exportadas com o pacote. As práticas recomendadas ao selecionar entidades são apresentadas nesta seção.

As entidades podem ser adicionadas a uma definição de pacote diretamente da sua localização na instância. Para fazer isso, siga as etapas abaixo:

Configurar a geração de definições de pacote configuring-package-definitions-generation

A criação de pacote pode ser configurada na guia Content de definição de pacote. Para fazer isso, clique em Generation parameters.

Exportar pacotes de uma definição de pacote exporting-packages-from-a-package-definition

Siga as etapas abaixo para exportar um pacote de uma definição de pacote:

Importar pacotes importing-packages

O assistente de importação de pacotes pode ser acessado pelo menu principal Tools > Advanced > Import package do console do cliente do Adobe Campaign.

É possível importar um pacote de uma exportação executada anteriormente, por exemplo, de outra instância do Adobe Campaign ou um pacote integrado, dependendo dos termos da sua licença.

Instalar um pacote de um arquivo installing-a-package-from-a-file

Para importar um pacote de dados existente, selecione o arquivo XML e clique em Open.

O conteúdo do pacote a ser importado é exibido na seção intermediária do editor.

Clique em Next e em Start para iniciar a importação.

Instalar um pacote integrado installing-a-standard-package

Os pacotes padrão são pacotes incorporados quando o Adobe Campaign é configurado. Dependendo das suas permissões e do modelo de implantação, é possível importar novos pacotes padrão se adquirir novas opções ou add-ons ou se atualizar para uma nova oferta.

Consulte o contrato de licença para verificar quais pacotes você pode instalar.

Para obter mais informações sobre pacotes incorporados, consulte esta página.

Práticas recomendadas para o pacote de dados data-package-best-practices

Esta seção descreve como organizar pacotes de dados de forma consistente durante a vida útil do projeto.

Os pacotes podem conter diferentes tipos de configurações e elementos, filtrados ou não. Se você perder alguns elementos ou não importar elementos/pacotes na ordem correta, a configuração da plataforma poderá ser interrompida.

Além disso, com várias pessoas trabalhando na mesma plataforma com vários recursos diferentes, a pasta de especificações do pacote pode se tornar complexa rapidamente.

Embora isso não seja obrigatório, esta seção oferece uma solução para ajudar a organizar e usar pacotes no Adobe Campaign para projetos de grande escala.

As principais restrições são as seguintes:

Recomendações data-package-recommendations

Sempre importe dentro da mesma versão da plataforma. Você deve verificar se implantou seus pacotes entre duas instâncias que têm a mesma build. Nunca force a importação e sempre atualize a plataforma primeiro (se a build for diferente).

Preste atenção ao schema e à estrutura do banco de dados. A importação do pacote com o schema deve ser seguida pela geração do schema.

Solução data-package-solution

Tipos de pacotes package-types

Comece definindo diferentes tipos de pacotes. Serão usados apenas quatro tipos:

Entidades

Se precisar implantar sua configuração em uma nova instância, você poderá importar todos os pacotes de entidade.

Recursos

Este tipo de pacote:

Campanhas

Este pacote não é obrigatório. Às vezes, é útil criar um tipo específico para todas as campanhas, mesmo se uma campanha puder ser vista como um recurso.

Atualizações

Depois de configurado, um recurso pode ser exportado para outro ambiente. Por exemplo, o pacote pode ser exportado de um ambiente dev para um ambiente de teste. Neste teste, um defeito é revelado. Primeiro, ele precisa ser corrigido no ambiente dev. Em seguida, o patch deve ser aplicado na plataforma de teste.

A primeira solução seria exportar todo o recurso novamente. Mas, para evitar qualquer risco (atualizar elementos indesejados), é mais seguro dispor de um pacote que contenha apenas a correção.

É por isso que recomendamos criar um pacote de “update”, contendo apenas um tipo de entidade do recurso.

Uma atualização não pode ser apenas uma correção, mas também um novo elemento do seu pacote de entidade/recurso/campanha. Para evitar a implantação de todo o pacote, é possível exportar um pacote de atualização.

Nomeação de convenções data-package-naming

Agora que os tipos estão definidos, devemos especificar uma convenção de nomenclatura. O Adobe Campaign não permite criar subpastas para especificações de pacotes, o que significa que os números são a melhor solução para se manter organizado. Nomes de pacote de prefixos de números. Você pode usar a seguinte convenção:

Pacotes data-packages

Ordem dos pacotes de entidade entity-packages-order

Para ajudar na importação, os pacotes de entidade devem ser ordenados, pois serão importados. Por exemplo:

Pacote 200 package-200

O número do pacote “200” não deve ser utilizado para uma campanha específica: esse número será usado para atualizar algo que diz respeito a todas as campanhas.

Atualizar pacote update-package

O último ponto diz respeito à numeração do pacote de atualização. É o número do seu pacote (entidade, recurso ou campanha) com o prefixo “5”. Por exemplo:

O pacote de atualização deve conter apenas uma entidade específica para ser facilmente reutilizável. Para dividi-los, adicione um novo número (comece por 1). Não há regras de pedido específicas para esses pacotes. Para entender melhor, imagine que temos um recurso 101, um aplicativo social:

Documentação do pacote package-documentation

Ao atualizar um pacote, você deve sempre colocar um comentário no campo de descrição para detalhar quaisquer modificações e motivos (por exemplo, "adicionar um novo schema" ou "corrigir um defeito").

Você também deve datar o comentário. Sempre relate o seu comentário em um pacote de atualização ao “principal” (o pacote sem o prefixo 5).