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

Estrutura do formulário form-structure

A descrição de um formulário é um documento XML estruturado que observa a gramática do esquema de formulário xtk:form.

O documento XML do formulário de entrada deve conter o elemento raiz <form> com os atributos name e namespace para preencher o nome e o namespace do formulário.

<form name="form_name" namespace="name_space">
…
</form>

Por padrão, um formulário é associado ao schema de dados com o mesmo nome e namespace. Para associar um formulário a um nome diferente, defina o atributo entity-schema do elemento <form> como o nome da chave do esquema. Para ilustrar a estrutura de um formulário de entrada, descrevamos uma interface usando o schema de exemplo "cus:recipient":

<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 address of recipient"/>
    <attribute name="birthDate" type="datetime" label="Date"/>
    <attribute name="gender" type="byte" label="Gender" enum="gender"/>
  </element>
</srcSchema>

O formulário de entrada com base no schema de exemplo:

<form name="recipient" namespace="cus">
  <input xpath="@gender"/>
  <input xpath="@birthDate"/>
  <input xpath="@email"/>
</form>

A descrição dos controles de edição começa no elemento raiz <form>. Um controle de edição é inserido em um elemento <input> com o atributo xpath contendo o caminho do campo do schema.

O controle de edição se adapta automaticamente ao tipo de dados correspondente e usa o rótulo definido no schema.

Por padrão, cada campo é exibido em uma única linha e ocupa todo o espaço disponível, dependendo do tipo de dados.

Formatação formatting

O layout dos controles se parece com o layout usado em tabelas de HTML, com a possibilidade de dividir um controle em várias colunas, entrelaçar elementos ou especificar a ocupação do espaço disponível. No entanto, lembre-se de que a formatação só permite dividir a área por proporções; não é possível especificar dimensões fixas para um objeto.

Para exibir os controles do exemplo acima em duas colunas:

<form name="recipient" namespace="cus">
  <container colcount="2">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email"/>
  </container>
</form>

O elemento <container> com o atributo colcount permite forçar a exibição de controles filho em duas colunas.

O atributo colspan em um controle estende o controle pelo número de colunas inseridas em seu valor:

<form name="recipient" namespace="cus">
  <container colcount="2">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
</form>

Ao preencher o atributo type="frame", o contêiner adiciona um quadro ao redor dos controles filho com o rótulo contido no atributo label:

<form name="recipient" namespace="cus">
  <container colcount="2" type="frame" label="General">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
</form>

Um elemento <static> pode ser usado para formatar o formulário de entrada:

<form name="recipient" namespace="cus">
  <static type="separator" colspan="2" label="General"/>
  <input xpath="@gender"/>
  <input xpath="@birthDate"/>
  <input xpath="@email" colspan="2"/>
  <static type="help" label="General information about recipient with date of birth, gender, and email address." colspan="2"/>
</form>

A marca <static> com o tipo separator permite adicionar uma barra separadora com um rótulo contido no atributo label.

Um texto de ajuda foi adicionado usando a marca <static> com o tipo de ajuda. O conteúdo do texto é inserido no atributo rótulo.

Containers containers

Os containeres permitem agrupar um conjunto de controles. Eles são representados pelo elemento <container>. Eles foram usados acima para formatar controles em várias colunas.

O atributo xpath em um <container> permite simplificar a referência a controles filho. A referência de controles é então relativa ao elemento pai <container>.

Exemplo de um contêiner sem "xpath":

<container colcount="2">
  <input xpath="location/@zipCode"/>
  <input xpath="location/@city"/>
</container>

Exemplo com a adição de "xpath" ao elemento chamado "location":

<container colcount="2" xpath="location">
  <input xpath="@zipCode"/>
  <input xpath="@city"/>
</container>

Tipos de contêiner types-of-container

Os containers são usados para construir controles complexos usando um conjunto de campos formatados em páginas.

Contêiner da guia tab-container

Um container de guias formata dados em páginas que podem ser acessadas a partir de guias.

<container type="notebook">
  <container colcount="2" label="General">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
  <container colcount="2" label="Location">
    …
  </container>
</container>

O container principal é definido pelo atributo type="notebook". As guias são declaradas nos contêineres filho, e o rótulo das guias é preenchido a partir do atributo rótulo.

Lista de ícones icon-list

Esse container exibe uma barra de ícones vertical que permite selecionar as páginas a serem exibidas.

<container type="iconbox">
  <container colcount="2" label="General" img="xtk:properties.png">
    <input xpath="@gender"/>
    <input xpath="@birthDate"/>
    <input xpath="@email" colspan="2"/>
  </container>
  <container colcount="2" label="Location" img="nms:msgfolder.png">
    …
  </container>
</container>

O container principal é definido pelo atributo type="iconbox". As páginas associadas aos ícones são declaradas nos contêineres filho. O rótulo dos ícones é preenchido a partir do atributo label.

O ícone de uma página é preenchido a partir do atributo img="<image>", onde <image> é o nome da imagem correspondente à sua chave composta do nome e do namespace (por exemplo, "xtk:properties.png").

As imagens estão disponíveis no nó Administration > Configuration > Images.

Contêiner de visibilidade visibility-container

É possível mascarar um conjunto de controles por meio de uma condição dinâmica.

Este exemplo ilustra a visibilidade dos controles no valor do campo "Gênero":

<container type="visibleGroup" visibleIf="@gender=1">
  …
</container>
<container type="visibleGroup" visibleIf="@gender=2">
  …
</container>

Um contêiner de visibilidade é definido pelo atributo type="visibleGroup". O atributo visibleIf contém a condição de visibilidade.

Exemplos de sintaxe de condição:

Ativar container enabling-container

Esse container permite ativar ou desativar um conjunto de dados de uma condição dinâmica. Desabilitar um controle impede que ele seja editado. O exemplo a seguir ilustra a ativação de controles a partir do valor do campo "Gênero":

<container type="enabledGroup" enabledIf="@gender=1">
  …
</container>
<container type="enabledGroup" enabledIf="@gender=2">
  …
</container>

Um contêiner de habilitação é definido pelo atributo type="enabledGroup". O atributo enabledIf contém a condição de ativação.

Edição de um link editing-a-link

Lembre-se de que um link é declarado no schema de dados da seguinte maneira:

<element label="Company" name="company" target="cus:company" type="link"/>

O controle de edição do link em seu formulário de entrada é o seguinte:

<input xpath="company"/>

A seleção de público-alvo pode ser acessada por meio do campo de edição. A entrada é assistida pelo tipo antecipado, para que um elemento de destino possa ser facilmente encontrado a partir dos primeiros caracteres inseridos. A pesquisa é baseada na cadeia de caracteres de cálculo definida no esquema de destino. Se o schema não existir após a validação no controle, uma mensagem de confirmação da criação do target em tempo real será exibida. A confirmação cria um novo registro na tabela de target e o associa ao link.

Uma lista suspensa é usada para selecionar um elemento target na lista de registros já criados.

O ícone Modify the link (pasta) inicia um formulário de seleção com a lista de elementos direcionados e uma zona de filtro:

O ícone Edit link (lente de aumento) inicia o formulário de edição do elemento vinculado. O formulário usado é deduzido por padrão na chave do schema direcionado. O atributo form permite forçar o nome do formulário de edição (por exemplo, "cus:company2").

Você pode restringir a opção de elementos target adicionando o elemento <sysfilter> da definição de link no formulário de entrada:

<input xpath="company">
  <sysFilter>
    <condition expr="[location/@city] =  'Newton"/>
  </sysFilter>
</input>

Você também pode classificar a lista com o elemento <orderby>:

<input xpath="company">
  <orderBy>
    <node expr="[location/@zipCode]"/>
  </orderBy>
</input>

Propriedades de controle control-properties

Lista de links list-of-links

Um link inserido no schema de dados como um elemento de coleção (unbound="true") deve passar por uma lista para exibir todos os elementos associados a ele.

O princípio consiste em exibir a lista de elementos vinculados com carregamento de dados otimizado (download por lote de dados, execução da lista somente se estiver visível).

Exemplo de um link de coleção em um esquema:

<element label="Events" name="rcpEvent" target="cus:event" type="link" unbound="true">
…
</element>

A lista em seu formulário de entrada:

 <input xpath="rcpEvent" type="linklist">
  <input xpath="@label"/>
  <input xpath="@date"/>
</input>

O controle de lista é definido pelo atributo type="linklist". O caminho da lista deve fazer referência ao link da coleção.

As colunas são declaradas por meio dos elementos <input> da lista. O atributo xpath refere-se ao caminho do campo no esquema de destino.

Uma barra de ferramentas com um rótulo (definido no link no schema) é colocada automaticamente acima da lista.

A lista pode ser filtrada por meio do botão Filters e configurada para adicionar e classificar as colunas.

Os botões Add e Delete permitem adicionar e excluir elementos de coleção no link. Por padrão, adicionar um elemento inicia o formulário de edição do schema de destino.

O botão Detail é adicionado automaticamente quando o atributo zoom="true" é concluído na marca <input> da lista: ele permite iniciar o formulário de edição da linha selecionada.

A filtragem e a classificação podem ser aplicadas quando a lista está sendo carregada:

 <input xpath="rcpEvent" type="linklist">
  <input xpath="@label"/>
  <input xpath="@date"/>
  <sysFilter>
    <condition expr="@type = 1"/>
  </sysFilter>
  <orderBy>
    <node expr="@date" sortDesc="true"/>
  </orderBy>
</input>

Tabela de relações relationship-table

Uma tabela de relação permite vincular duas tabelas com cardinalidade N-N. A tabela de relacionamento contém apenas os links para as duas tabelas.

A adição de um elemento à lista deve, portanto, permitir que você complete uma lista de um dos dois links na tabela de relacionamento.

Exemplo de uma tabela de relação em um esquema:

<srcSchema name="subscription" namespace="cus">
  <element name="recipient" type="link" target="cus:recipient" label="Recipient"/>
  <element name="service" type="link" target="cus:service" label="Subscription service"/>
</srcSchema>

Para nosso exemplo, começamos com o formulário de entrada do schema "cus:recipient". A lista deve exibir as associações com assinaturas para serviços e permitir que você adicione uma assinatura selecionando um serviço existente.

<input type="linklist" xpath="subscription" xpathChoiceTarget="service" xpathEditTarget="service" zoom="true">
  <input xpath="recipient"/>
  <input xpath="service"/>
</input>

O atributo xpathChoiceTarget permite iniciar um formulário de seleção no link inserido. A criação do registro da tabela de relacionamento atualizará automaticamente o link para o recipient atual e o serviço selecionado.

Propriedades da lista list-properties

Controles de lista de memória memory-list-controls

As listas de memória permitem editar os elementos de coleção usando o pré-carregamento de dados de lista. Esta lista não pode ser filtrada nem configurada.

Essas listas são usadas em elementos de coleção mapeados XML ou em links de baixo volume.

Lista de colunas column-list

Este controle exibe uma lista de colunas editável com uma barra de ferramentas contendo os botões Adicionar e Excluir.

<input xpath="rcpEvent" type="list">
  <input xpath="@label"/>
  <input xpath="@date"/>
</input>

O controle de lista deve ser preenchido com o atributo type="list" e o caminho da lista deve se referir ao elemento de coleção.

As colunas são declaradas nas marcas filho <input> da lista. O rótulo e o tamanho da coluna podem ser forçados com os atributos label e colSize.

Os botões da barra de ferramentas podem ser alinhados horizontalmente:

<input nolabel="true" toolbarCaption="List of events" type="list" xpath="rcpEvent" zoom="true">
  <input xpath="@label"/>
  <input xpath="@date"/>
</input>

O atributo toolbarCaption força o alinhamento horizontal da barra de ferramentas e insere o título acima da lista.

Ampliação de uma lista zoom-in-a-list

A inserção e a edição de dados em uma lista podem ser inseridas em um formulário de edição separado.

<input nolabel="true" toolbarCaption="List of events" type="list" xpath="rcpEvent" zoom="true" zoomOnAdd="true">
  <input xpath="@label"/>
  <input xpath="@date"/>

  <form colcount="2" label="Event">
    <input xpath="@label"/>
    <input xpath="@date"/>
  </form>
</input>

O formulário de edição é preenchido no elemento <form> na definição da lista. Sua estrutura é idêntica à de um formulário de entrada. O botão Detail é adicionado automaticamente quando o atributo zoom="true" é concluído na marca <input> da lista. Este atributo permite iniciar o formulário de edição da linha selecionada.

Propriedades da lista list-properties-1

Campos não editáveis non-editable-fields

Para exibir um campo e evitar que ele seja editado, use a marca <value> ou preencha o atributo readOnly="true" na marca <input>.

Exemplo no campo "Sexo":

<value value="@gender"/>
<input xpath="@gender" readOnly="true"/>

Botão de opção radio-button

Um botão de opção permite escolher entre várias opções. As marcas <input> são usadas para listar as opções possíveis, e o atributo checkedValue especifica o valor associado à escolha.

Exemplo no campo "Sexo":

<input type="RadioButton" xpath="@gender" checkedValue="0" label="Choice 1"/>
<input type="RadioButton" xpath="@gender" checkedValue="1" label="Choice 2"/>
<input type="RadioButton" xpath="@gender" checkedValue="2" label="Choice 3"/>

Caixa de seleção checkbox

Uma caixa de seleção reflete um estado booleano (selecionado ou não). Por padrão, esse controle é usado por campos "Booleano" (true/false). Uma variável que assume um valor padrão de 0 ou 1 pode ser associada a esse botão. Este valor pode ser sobrecarregado por meio dos atributos checkValue.

<input xpath="@boolean1"/>
<input xpath="@field1" type="checkbox" checkedValue="Y"/>

Lista discriminada enumeration

Edição da hierarquia de navegação navigation-hierarchy-edit

Este controle cria uma árvore em um conjunto de campos a serem editados.

Os controles a serem editados estão agrupados em um <container> inserido na marca <input> do controle de árvore:

<input nolabel="true" type="treeEdit">
  <container label="Text fields">
    <input xpath="@text1"/>
    <input xpath="@text2"/>
  </container>
  <container label="Boolean fields">
    <input xpath="@boolean1"/>
    <input xpath="@boolean2"/>
  </container>
</input>

Campo de expressão expression-field

Um campo de expressão atualiza um campo dinamicamente de uma expressão; a marca <input> é usada com um atributo xpath para inserir o caminho do campo a ser atualizado e um atributo expo contendo a expressão de atualização.

<!-- Example: updating the boolean1 field from the value contained in the field with path /tmp/@flag -->
<input expr="Iif([/tmp/@flag]=='On', true, false)" type="expr" xpath="@boolean1"/>
<input expr="[/ignored/@action] == 'FCP'" type="expr" xpath="@launchFCP"/>

Contexto de formulários context-of-forms

A execução de um formulário de entrada inicializa um documento XML contendo os dados da entidade que está sendo editada. Este documento representa o contexto do formulário e pode ser usado como um espaço de trabalho.

Atualização do contexto updating-the-context

Para modificar o contexto do formulário, use a marca <set expr="<value>" xpath="<field>"/>, em que <field> é o campo de destino e <value> é a expressão ou o valor de atualização.

Exemplos de uso da tag <set>:

O contexto do formulário pode ser atualizado ao inicializar e fechar o formulário por meio das marcas <enter> e <leave>.

<form name="recipient" namespace="cus">
  <enter>
    <set…
  </enter>
  …
  <leave>
    <set…
  </leave>
</form>

Linguagem de expressão expression-language-

Uma linguagem macro pode ser usada na definição do formulário para executar testes condicionais.

A marca <if expr="<expression>" /> executa as instruções especificadas na marca se a expressão for verificada:

<if expr="([/tmp/@test] == 'Test' or @lastName != 'Doe') and @boolean2 == true">
  <set xpath="@boolean1" expr="true"/>
</if>

A marca <check expr="<condition>" /> combinada com a marca <error> impede a validação do formulário e exibe uma mensagem de erro se a condição não for atendida:

<leave>
  <check expr="/tmp/@test != ''">
    <error>You must populate the 'Test' field!</error>
  </check>
</leave>

Assistentes wizards

Um assistente orienta você sobre um conjunto de etapas de entrada de dados no formato de páginas. Os dados inseridos são salvos quando você valida o formulário.

Um assistente tem a seguinte estrutura:

<form type="wizard" name="example" namespace="cus" img="nms:rcpgroup32.png" label="Assistant example" entity-schema="nms:recipient">
  <container title="Title of page 1" desc="Long description of page 1">
    <input xpath="@lastName"/>
    <input xpath="comment"/>
  </container>
  <container title="Title of page 2" desc="Long description of page 2">
    …
  </container>
  …
</form>

A presença do atributo type="wizard" no elemento <form> permite definir o modo assistente na construção do formulário. As páginas foram concluídas com base nos elementos <container>, que são filhos do elemento <form>. O elemento <container> de uma página é preenchido com os atributos de título do título e desc para exibir a descrição sob o título da página. Os botões Previous e Next são adicionados automaticamente para permitir a navegação entre páginas.

O botão Finish salva os dados inseridos e fecha o formulário.

Métodos SOAP soap-methods

A execução do método SOAP pode ser iniciada a partir de uma tag <leave> preenchida no final de uma página.

A marca <soapcall> contém a chamada para o método com os seguintes parâmetros de entrada:

<soapCall name="<name>" service="<schema>">
  <param  type="<type>" exprIn="<xpath>"/>
  …
</soapCall>

O nome do serviço e seu esquema de implementação são inseridos pelos atributos name e service da marca <soapcall>.

Os parâmetros de entrada são descritos nos elementos <param> sob a marca <soapcall>.

O tipo de parâmetro deve ser especificado por meio do atributo type. Os tipos possíveis são os seguintes:

O atributo exprIn contém o local dos dados a serem passados como parâmetro.

Exemplo:

<leave>
  <soapCall name="RegisterGroup" service="nms:recipient">
    <param  type="DOMElement"    exprIn="/tmp/entityList"/>
    <param  type="DOMElement"    exprIn="/tmp/choiceList"/>
    <param  type="boolean"       exprIn="true"/>
  </soapCall>
</leave>