Configurar a árvore de navegação do explorador do Campaign configuration

Como usuário especialista, você pode adicionar pastas à árvore do explorador e personalizá-la.

Saiba mais sobre o explorador do Campaign e a hierarquia de navegação nesta seção.

Os tipos de pastas usados pela lista de navegação são descritos em um documento XML que obedece à gramática do esquema xtk:navtree.

O documento XML está estruturado da seguinte maneira:

<navtree name="name" namespace="name_space">
  <!-- Global commands -->
  <commands>
      ...
  </commands>

  <!-- Structured space for adding a folder -->
  <model name="<name>" label="<Label>">
    <!-- Folder type -->
    <nodeModel>
      ...
    </nodeModel>
<model name="<name>" label="<Sub model>">
      ...
    </model>
  </model>
</navtree>

O documento XML contém o elemento raiz <navtree> com os atributos name e namespace para especificar o nome e o namespace do documento. O nome e o namespace compõem a chave de identificação do documento.

Os comandos globais do aplicativo são declarados no documento do elemento <commands>.

A declaração de tipos de arquivo está estruturada no documento com os seguintes elementos: <model> e <nodemodel>.

Comandos globais global-commands

Um comando global permite iniciar uma ação. Essa ação pode ser um formulário de entrada ou uma chamada SOAP.

Os comandos globais podem ser acessados no menu principal Tools.

A estrutura de configuração do comando é a seguinte:

<commands>
  <!-- Description of a command -->
  <command name="<name>" label="<label>" desc="<Description>" form="<form>" rights="<rights>">
    <soapCall name="<name>" service="<schema>">
      <param type="<type>" exprIn="<xpath>"/>
        ...
    </soapCall>
    <enter>
      ...
    </enter>
  </command>
  <!-- Separator -->
  <command label="-" name="<name>"/>
  <!-- Command structure -->
  <command name="<name>" label="<Label>">
    <command...
  </command>
</commands>

A descrição de um comando global é inserida no elemento <command> com as seguintes propriedades:

Um elemento <command> pode conter subelementos <command>. Nesse caso, o elemento pai permite exibir um submenu composto desses elementos filhos.

Os comandos são exibidos na mesma ordem declarada no documento XML.

Um separador de comandos permite exibir uma barra de separação entre comandos. Ela é identificada pelo valor '-' contido no rótulo do comando.

A presença opcional da marca <soapcall> com seus parâmetros de entrada define a chamada de um método SOAP a ser executado. Para obter mais informações sobre a API do SOAP, consulte a documentação do Campaign JSAPI.

O contexto do formulário pode ser atualizado na inicialização a partir da marca <enter>. Para obter mais informações sobre essa tag, consulte a documentação nos formulários de entrada.

Exemplo:

Tipo de pasta folder-type

Um tipo de pasta permite que você dê acesso aos dados de um esquema. A visualização associada à pasta consiste em uma lista e um formulário de entrada.

A estrutura de configuração do tipo de pasta é a seguinte:

<!-- Structured location to add the folder -->
<model name="name" label="Labelled">
  <!-- Type of folder -->
  <nodeModel name="<name>" label="<Labelled>" img="<image>">
    <view name="<name>" schema="<schema>" type="<listdet|list|form|editForm>">
      <columns>
        <node xpath="<field1>"/>
        ...
    </columns>
    </view>
  </nodeModel>
  <model name="<name>" label="<Sous modèle>">
    ...
  </model>
</model>

A declaração de tipo de pasta deve ser inserida em um elemento <model>. Esse elemento permite definir uma organização hierárquica visível no menu Add new folder. Um elemento <model> deve conter elementos <nodemodel> e outros elementos <model>.

Os atributos name e label preenchem o nome interno do elemento e o rótulo exibido no menu Add new folder.

O elemento <nodemodel> contém a descrição do tipo de pasta com as seguintes propriedades:

O elemento <view> sob o elemento <nodemodel> contém a configuração da lista associada ao modo de exibição. O esquema da lista é inserido no atributo schema do elemento <view>.

Para editar os registros da lista, o formulário de entrada com o mesmo nome do schema de lista é usado implicitamente. O atributo type no elemento <view> afeta a exibição do formulário. Os valores possíveis são:

A configuração padrão das colunas da lista é inserida por meio do elemento <columns>. Uma coluna é declarada em um elemento <node> contendo o atributo xpath com o campo a ser referenciado em seu esquema como seu valor.

Exemplo: declaração de um tipo de pasta no esquema "nms:recipient".

<model label="Profiles and targets" name="nmsProfiles">
  <nodeModel deleteRight="folderDelete" editRight="folderEdit" folderLink="folder"
             img="nms:folder.png" insertRight="folderInsert" label="Recipients"
             name="nmsFolder">
    <view name="listdet" schema="nms:recipient" type="listdet">
      <columns>
        <node xpath="@firstName"/>
        <node xpath="@lastName"/>
        <node xpath="@email"/>
        <node xpath="@account"/>
      </columns>
    </view>
  </nodeModel>
  <nodeModel name="nmsGroup" label="Groups"...
</model>

O menu de inserção de pasta correspondente:

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

<view name="listdet" schema="nms:recipient" type="listdet">
  <columns>
    ...
  </columns>

  <orderBy>
    <node expr="@lastName" desc="true"/>
</orderBy>
  <sysFilter>
    <condition expr="@type = 1"/>
  </sysFilter>
</view>

Comandos de atalho shortcut-commands

Um comando de atalho permite iniciar uma ação ao selecionar a lista. A ação pode ser um formulário de entrada ou uma chamada SOAP.

Os comandos podem ser acessados no menu Action da lista ou no botão de menu associado.

A estrutura de configuração do comando é a seguinte:

<nodeModel...
  ...
  <command name="<name>" label="<label>" desc="<Description>" form="<form>" rights="<rights>">
    <soapCall name="<name>" service="<schema>">
      <param type="<type>" exprIn="<xpath>"/>
        ...
    </soapCall>
    <enter>
      ...
    </enter>
  </command>
</nodeModel>

A descrição de um comando é inserida no elemento <command> com as seguintes propriedades:

Um elemento <command> pode conter subelementos <command>. Nesse caso, o elemento pai permite exibir um submenu composto desses elementos filhos.

Os comandos são exibidos na mesma ordem declarada no documento XML.

Um separador de comandos permite exibir uma barra de separação entre comandos. Ela é identificada pelo valor '-' contido no rótulo do comando.

A presença opcional da marca <soapcall> com seus parâmetros de entrada define a chamada de um método SOAP a ser executado. Para obter mais informações sobre APIs SOAP, consulte a documentação do Campaign JSAPI.

O contexto do formulário pode ser atualizado na inicialização por meio da marca <enter>. Para obter mais informações sobre essa tag, consulte a documentação do formulário de entrada.

Exemplo:

<command desc="Cancel execution of the job" enabledIf="EV(@status, 'running')"
         img="nms:difstop.bmp" label="Cancel..." name="cancelJob"
         promptLabel="Do you really want to cancel this job?" refreshView="true">
  <soapCall name="Cancel" service="xtk:jobInterface"/>
</command>
<command label="-" name="sep1"/>
<command desc="Execute selected template" form="cus:form" lmonoSelection="true" name="executeModel"
         rights="import,export,aggregate">
  <enter>
    <set expr="0" xpath="@status"/>
  </enter>
</command>

Pasta vinculada linked-folder

Há dois tipos de operações de gerenciamento de pastas:

Para uma pasta vinculada, o atributo folderLink no elemento <nodemodel> deve ser preenchido. Este atributo contém o nome do link na pasta configurada no schema de dados.

Exemplo de declaração de uma pasta vinculada no schema de dados:

<element default="DefaultFolder('nmsFolder', [@_folder-id])" label="Folder" name="folder" revDesc="Recipients in the folder" revIntegrity="define" revLabel="Recipients" target="xtk:folder" type="link"/>

A configuração de <nodemodel> no link da pasta chamada "folder" é a seguinte:

<nodeModel deleteRight="folderDelete" editRight="folderEdit" folderLink="folder"
  img="nms:folder.png" insertRight="folderInsert" label="Recipients" name="nmsFolder">
...
</nodeModel>