Konfigurera navigeringsträdet i Campaign Explorer configuration

Som expertanvändare kan du lägga till mappar i utforskarträdet och anpassa det.

Läs mer om Campaign Explorer och navigeringshierarkin i det här avsnittet.

De typer av mappar som används av navigeringslistan beskrivs i ett XML-dokument som lyder grammatiken i schemat xtk:navtree.

XML-dokumentet är strukturerat på följande sätt:

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

XML-dokumentet innehåller rotelementet <navtree> med attributen name och namespace som anger dokumentnamnet och namnutrymmet. Namnet och namnutrymmet utgör dokumentets ID-nyckel.

Programmets globala kommandon deklareras i dokumentet från elementet <commands>.

Deklarationen av filtyper är strukturerad i dokumentet med följande element: <model> och <nodemodel>.

Globala kommandon global-commands

Med ett globalt kommando kan du starta ett funktionsmakro. Den här åtgärden kan vara ett indataformulär eller ett SOAP.

Globala kommandon är tillgängliga från huvudmenyn Tools.

Kommandokonfigurationsstrukturen är följande:

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

Beskrivningen av ett globalt kommando anges i elementet <command> med följande egenskaper:

Ett <command>-element kan innehålla <command> underelement. I det här fallet kan du med det överordnade elementet visa en undermeny som består av dessa underordnade element.

Kommandona visas i samma ordning som de deklareras i XML-dokumentet.

Med en kommandoavgränsare kan du visa ett avgränsningstecken mellan kommandona. Den identifieras av värdet - som finns i kommandoetiketten.

Den valfria förekomsten av taggen <soapcall> med dess indataparametrar definierar anropet av en SOAP metod som ska köras. Mer information om SOAP API finns i Kampanjens JSAPI-dokumentation.

Formulärkontexten kan uppdateras vid initiering från taggen <enter>. Mer information om den här taggen finns i dokumentationen om indataformulär.

Exempel:

Mapptyp folder-type

Med en mapptyp kan du ge åtkomst till data i ett schema. Vyn som är associerad med mappen består av en lista och ett inmatningsformulär.

Konfigurationsstrukturen för mapptypen är följande:

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

Mapptypsdeklarationen måste anges under ett <model>-element. Med det här elementet kan du definiera en hierarkisk organisation som visas på menyn Add new folder. Ett <model>-element måste innehålla <nodemodel>-element och andra <model>-element.

Attributen name och label fyller i elementets interna namn och etiketten som visas på menyn Add new folder.

Elementet <nodemodel> innehåller en beskrivning av mapptypen med följande egenskaper:

Elementet <view> under elementet <nodemodel> innehåller konfigurationen för listan som är associerad med vyn. Schemat för listan anges i attributet schema för elementet <view>.

Om du vill redigera posterna i listan används indataformuläret med samma namn som listschemat implicit. Attributet type i elementet <view> påverkar visningen av formuläret. Möjliga värden är:

Listkolumnernas standardkonfiguration anges via elementet <columns>. En kolumn deklareras i ett <node>-element som innehåller attributet Path med fältet som ska refereras i schemat som dess värde.

Exempel: deklaration av en mapptyp i schemat nms:mottagare.

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

Motsvarande inmatningsmeny för mappar:

Filtrering och sortering kan användas när listan läses in:

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

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

Kortkommandon shortcut-commands

Med ett kortkommando kan du starta en åtgärd när du markerar listan. Åtgärden kan vara ett indataformulär eller ett SOAP.

Kommandon är tillgängliga på menyn Action i listan eller på den associerade menyknappen.

Kommandokonfigurationsstrukturen är följande:

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

Beskrivningen av ett kommando anges för elementet <command> med följande egenskaper:

Ett <command>-element kan innehålla <command> underelement. I det här fallet kan du med det överordnade elementet visa en undermeny som består av dessa underordnade element.

Kommandona visas i samma ordning som de deklareras i XML-dokumentet.

Med en kommandoavgränsare kan du visa ett avgränsningstecken mellan kommandona. Den identifieras av värdet - som finns i kommandoetiketten.

Den valfria förekomsten av taggen <soapcall> med dess indataparametrar definierar anropet av en SOAP metod som ska köras. Mer information om SOAP API:er finns i Kampanjens JSAPI-dokumentation.

Formulärkontexten kan uppdateras vid initieringen via taggen <enter>. Mer information om den här taggen finns i dokumentationen till indataformuläret.

Exempel:

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

Länkad mapp linked-folder

Det finns två typer av mapphanteringsåtgärder:

För en länkad mapp måste attributet folderLink för elementet <nodemodel> fyllas i. Det här attributet innehåller namnet på länken i mappen som är konfigurerad i dataschemat.

Exempel på deklaration av en länkad mapp i dataschemat:

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

Konfigurationen för <nodemodel> på länken för mappen med namnet "folder" är följande:

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