Trabalhar com esquemas gs-ac-schemas

A estrutura física e lógica dos dados transportados no aplicativo é descrita em XML. Ela obedece a uma gramática específica do Adobe Campaign, chamada de schema.

Um esquema é um documento XML associado a uma tabela de banco de dados. Ele define a estrutura de dados e descreve a definição SQL da tabela:

Também descreve a estrutura XML usada para armazenar dados:

Os esquemas permitem definir uma entidade no banco de dados. Há um esquema para cada entidade.

A Adobe Campaign emprega esquemas de dados para:

Para entender melhor as tabelas integradas do Campaign e suas interações, consulte esta seção.

Sintaxe de schemas syntax-of-schemas

O elemento raiz do esquema é <srcschema>. Ele contém os subelementos <element> e <attribute>.

O primeiro subelemento <element> coincide com a raiz da entidade.

<srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <attribute name="lastName"/>
    <attribute name="email"/>
    <element name="location">
      <attribute name="city"/>
   </element>
  </element>
</srcSchema>

As marcas <element> definem os nomes dos elementos da entidade. <attribute> marcas do esquema definem os nomes dos atributos nas <element> marcas às quais eles foram vinculados.

Identificação de um esquema identification-of-a-schema

Um schema de dados é identificado por seu nome e seu namespace.

Um namespace permite agrupar um conjunto de esquemas por área de interesse. Por exemplo, o namespace cus é usado para a configuração específica do cliente (clientes).

Namespaces reservados reserved-namespaces

Determinados namespaces são reservados para descrições das entidades do sistema necessárias para a operação do aplicativo do Adobe Campaign. O namespace a seguir não deve ser usado para identificar um novo esquema, em qualquer combinação de maiúsculas/minúsculas:

A chave de identificação de um esquema é uma cadeia de caracteres criada com o uso do namespace e do nome separados por dois pontos, por exemplo: nms:recipient.

Criar ou estender esquemas do Campaign create-or-extend-schemas

Para adicionar um campo ou outro elemento a um dos esquemas de dados principais no Campaign, como a tabela de recipients (nms:recipient), é necessário estender esse esquema.

Para obter mais informações, consulte Estender um esquema.

Para adicionar um tipo de dados totalmente novo que não existe no Adobe Campaign (uma tabela de contratos, por exemplo), você pode criar um esquema personalizado diretamente.

Para obter mais informações, consulte Criar um novo esquema.

Depois de criar ou estender um esquema para trabalhar, a prática recomendada é definir seus elementos de conteúdo XML na mesma ordem em que aparecem abaixo.

Enumerações enumerations

As enumerações são definidas primeiro, antes do elemento principal do esquema. Eles permitem exibir valores em uma lista para restringir as opções que o usuário tem para um determinado campo.

Exemplo:

<enumeration basetype="byte" name="exTransactionTypeEnum" default="store">
<value label="Website" name="web" value="0"/>
<value label="Call Center" name="phone" value="1"/>
<value label="In Store" name="store" value="2"/>
</enumeration>

Ao definir campos, é possível usar essa enumeração da seguinte maneira:

<attribute desc="Type of Transaction" label="Transaction Type" name="transactionType"
type="string" enum="exTransactionTypeEnum"/>

Chaves keys

Todas as tabelas devem ter pelo menos uma chave, e muitas vezes ela é automaticamente estabelecida no elemento principal do esquema usando o atributo autopk definido como true.

Além disso, no contexto de uma implantação corporativa (FFDA), use @autouuid e defina-a como true.

A chave primária também pode ser definida usando o atributo internal.

Exemplo:

<key name="householdId" internal="true">
  <keyfield xpath="@householdId"/>
</key>

Neste exemplo, em vez de permitir que o atributo @autopk ou o @autouuid crie uma chave primária padrão chamada "id", estamos especificando nossa própria chave primária "householdId".

Saiba mais sobre chaves em esta seção.

Atributos (Campos) attributes--fields-

Os atributos permitem definir os campos que compõem seu objeto de dados. Você pode usar o botão Insert na barra de ferramentas da edição do esquema para soltar modelos de atributos vazios no XML onde o cursor está. Saiba mais nesta seção.

A lista completa de atributos está disponível na seção de elemento <attribute> na documentação do Campaign Classic v7. Estes são alguns dos atributos usados com mais frequência: @advanced, @dataPolicy, @default, @desc, @enum, @expr, @label, @length, @name, @notNull @required @ref @xml @type, ​, usar, {24 ​.​

Para obter mais informações sobre cada atributo, consulte a Descrição de atributo na documentação do Campaign Classic v7.

Exemplos examples

Exemplo de definição de um valor padrão:

<attribute name="transactionDate" label="Transaction Date" type="datetime" default="GetDate()"/>

Exemplo de uso de um atributo comum como modelo para um campo também marcado como obrigatório:

<attribute name="mobile" label="Mobile" template="nms:common:phone" required="true" />

Exemplo de um campo calculado que está oculto usando o atributo @advanced:

<attribute name="domain" label="Email domain" desc="Domain of recipient email address" expr="GetEmailDomain([@email])" advanced="true" />

Exemplo de um campo XML também armazenado em um campo SQL e que tem um atributo @dataPolicy.

<attribute name="secondaryEmail" label="Secondary email address" length="100" xml="true" sql="true" dataPolicy="email" />

Links links

Os links são alguns dos últimos elementos no elemento principal do esquema. Elas definem como todos os diferentes esquemas na sua instância se relacionam entre si.

Os links são declarados no esquema que contém a chave estrangeira da tabela à qual está vinculado.

Há três tipos de cardinalidade: 1-1, 1-N e N-N. É o tipo 1-N usado por padrão.

Exemplos examples-1

Um exemplo de um link 1-N entre a tabela do recipient (schema pronto para uso) e uma tabela de transações personalizadas:

<element label="Recipient" name="lnkRecipient" revLink="lnkTransactions" target="nms:recipient" type="link"/>

Um exemplo de um link 1-1 entre um schema personalizado "Car" (no namespace "cus") e a tabela de recipients:

<element label="Car" name="lnkCar" revCardinality="single" revLink="recipient" target="cus:car" type="link"/>

Exemplo de uma associação externa entre a tabela de recipients e uma tabela de endereços com base no endereço de email e não em uma chave primária:

<element name="emailInfo" label="Email Info" revLink="recipient" target="nms:address" type="link" externalJoin="true">
  <join xpath-dst="@address" xpath-src="@email"/>
</element>

Aqui, "xpath-dst" corresponde à chave primária no esquema de destino e "xpath-src" corresponde à chave externa no esquema de origem.

Trilha de auditoria audit-trail

Um elemento útil que você pode querer incluir na parte inferior do esquema é um elemento de rastreamento (Trilha de auditoria).

Use o exemplo abaixo para incluir campos relacionados à data de criação, ao usuário que criou os dados, à data e ao autor da última modificação para todos os dados na tabela:

<element aggregate="xtk:common:auditTrail" name="auditTrail"/>

Atualização da estrutura do banco de dados updating-the-database-structure

Depois que as alterações forem concluídas e salvas, qualquer alteração que possa afetar a estrutura SQL precisará ser aplicada ao banco de dados. Para fazer isso, use o assistente de atualização de banco de dados.

Para obter mais informações, consulte esta seção.