Estrutura de esquema schema-structure

A estrutura básica de um <srcschema> é a seguinte:

<srcSchema>
    <enumeration>
        ...          //definition of enumerations
    </enumeration>

    <element>         //definition of the root <element>    (mandatory)

        <compute-string/>  //definition of a compute-string
        <key>
            ...        //definition of keys
        </key>
        <sysFilter>
            ...           //definition of filters
        </sysFilter>
        <attribute>
            ...             //definition of fields
        </attribute>

            <element>           //definition of sub-<element>
                  <attribute>           //(collection, links or XML)
                  ...                         //and additional fields
                  </attribute>
                ...
            </element>

    </element>

        <methods>                 //definition of SOAP methods
            <method>
                ...
            </method>
            ...
    </methods>

</srcSchema>

O documento XML de um schema de dados deve conter o <srcschema> elemento raiz com os atributos name e namespace para preencher o nome e o namespace do schema.

<srcSchema name="schema_name" namespace="namespace">
...
</srcSchema>

Vamos usar o seguinte conteúdo XML para ilustrar a estrutura de um schema de dados:

<recipient email="John.doe@aol.com" created="AAAA/DD/MM" gender="1">
  <location city="London"/>
</recipient>

Com seu schema de dados correspondente:

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

Descrição description

O ponto de entrada do schema é seu elemento principal. É fácil identificar porque ele tem o mesmo nome do schema e deve se originar do elemento raiz. A descrição do conteúdo começa com esse elemento.

No nosso exemplo, o elemento principal é representado pela seguinte linha:

<element name="recipient">

Os elementos <attribute> e <element> que seguem o elemento principal permitem definir os locais e nomes dos itens de dados na estrutura XML.

No nosso esquema de amostra, são eles:

<attribute name="email"/>
<attribute name="created"/>
<attribute name="gender"/>
<element name="location">
  <attribute name="city"/>
</element>

As seguintes regras devem ser seguidas:

Tipos de dados data-types

O tipo de dados é inserido pelo atributo type nos elementos <attribute> e <element>.

Uma lista detalhada está disponível na documentação do Campaign Classic v7.

Quando este atributo não é populado, string é o tipo de dados padrão, a menos que o elemento contenha elementos filhos. Em caso afirmativo, ele é usado apenas para estruturar os elementos hierarquicamente (<location> elemento em nosso exemplo).

Os seguintes tipos de dados são aceitos em esquemas:

Aqui está nosso schema de exemplo com os tipos inseridos:

<srcSchema name="recipient" namespace="cus">
  <element name="recipient">
    <attribute name="email" type="string" length="80"/>
    <attribute name="created" type="datetime"/>
    <attribute name="gender" type="byte"/>
    <element name="location">
      <attribute name="city" type="string" length="50"/>
   </element>
  </element>
</srcSchema>

Propriedades properties

Os elementos <elements> e <attributes> do esquema de dados podem ser enriquecidos com várias propriedades. É possível preencher um rótulo para descrever o elemento atual.

Rótulos e descrições labels-and-descriptions

Valores padrão default-values

A propriedade default permite definir uma expressão que retorna um valor padrão na criação de conteúdo.

O valor deve ser uma expressão compatível com a linguagem XPath. Para obter mais informações, consulte esta seção.

Exemplo:

Para vincular um valor padrão a um campo, é possível usar o <default> or <sqldefault> field. </sqldefault> </default>

<default>: permite preencher previamente o campo com um valor padrão ao criar entidades. O valor não será um valor SQL padrão.

<sqldefault>: permite que você tenha um valor agregado ao criar um campo. Esse valor aparece como um resultado SQL. Durante uma atualização de schema, somente os novos registros serão afetados por esse valor.

Enumerações enumerations

Lista discriminada livre free-enumeration

A propriedade userEnum permite definir uma enumeração livre para memorizar e exibir os valores inseridos por meio desse campo. A sintaxe é a seguinte:

userEnum="nome da enumeração"

O nome dado à enumeração pode ser escolhido livremente e compartilhado com outros campos.

Esses valores são mostrados em uma lista suspensa no formulário de entrada:

Definir enumeração set-enumeration

A propriedade enum permite definir uma enumeração fixa usada quando a lista de valores possíveis é conhecida antecipadamente.

O atributo enum refere-se à definição de uma classe de enumeração preenchida no esquema fora do elemento principal.

As enumerações permitem que o usuário selecione um valor em uma lista suspensa em vez de inserir o valor em um campo de entrada regular:

Exemplo de uma declaração de enumeração no schema de dados:

<enumeration name="gender" basetype="byte" default="0">
  <value name="unknown" label="Not specified" value="0"/>
  <value name="male" label="male" value="1"/>
  <value name="female" label="female" value="2"/>
</enumeration>

Uma enumeração é declarada fora do elemento principal por meio do elemento <enumeration>.

As propriedades de enumeração são as seguintes:

Os valores de enumeração são declarados no elemento <value> com os seguintes atributos:

enumeração dbenum dbenum-enumeration

Exemplo example

Este é o nosso exemplo de schema com as propriedades preenchidas:

<srcSchema name="recipient" namespace="cus">
  <enumeration name="gender" basetype="byte">
    <value name="unknown" label="Not specified" value="0"/>
    <value name="male" label="male" value="1"/>
    <value name="female" label="female" value="2"/>
  </enumeration>

  <element name="recipient">
    <attribute name="email" type="string" length="80" label="Email" desc="Email of recipient"/>
    <attribute name="created" type="datetime" label="Date of creation" default="GetDate()"/>
    <attribute name="gender" type="byte" label="gender" enum="gender"/>
    <element name="location" label="Location">
      <attribute name="city" type="string" length="50" label="City" userEnum="city"/>
   </element>
  </element>
</srcSchema>

Coleções collections

Uma coleção é uma lista de elementos com o mesmo nome e o mesmo nível hierárquico.

O atributo unbound com o valor "true" permite preencher um elemento de coleção.

Exemplo: definição do elemento de coleção <group> no esquema.

<element name="group" unbound="true" label="List of groups">
  <attribute name="label" type="string" label="Label"/>
</element>

Com projeção do conteúdo XML:

<group label="Group1"/>
<group label="Group2"/>

Referência com XPath reference-with-xpath

A linguagem XPath é usada no Adobe Campaign para referenciar um elemento ou atributo que pertence a um schema de dados.

XPath é uma sintaxe que permite localizar um nó na árvore de um documento XML.

Os elementos são designados pelo nome e os atributos são designados pelo nome precedido pelo caractere "@".

Exemplo:

Também é possível definir expressões complexas, como as seguintes operações aritméticas:

Foram adicionadas funções de alto nível às expressões, a fim de enriquecer o potencial dessa linguagem.

Você pode acessar a lista de funções disponíveis por meio de qualquer editor de expressão no console do cliente do Adobe Campaign:

Exemplo:

Criação de uma string através do comando compute string building-a-string-via-the-compute-string

Uma cadeia de caracteres de computação é uma expressão XPath usada para construir uma cadeia de caracteres que representa um registro em uma tabela associada ao esquema. A Cálculo de cadeia de caracteres é usada principalmente na interface gráfica para exibir o rótulo de um registro selecionado.

A Cálculo de cadeia de caracteres é definida por meio do elemento <compute-string> sob o elemento principal do esquema de dados. Um atributo expr contém uma expressão XPath para calcular a exibição.

Exemplo: cadeia de caracteres de cálculo da tabela de destinatários.

<srcSchema name="recipient" namespace="nms">
  <element name="recipient">
    <compute-string expr="@lastName + ' ' + @firstName +' (' + @email + ')' "/>
    ...
  </element>
</srcSchema>

Resultado da cadeia de caracteres computada para um destinatário: Doe John (john.doe@aol.com)