SearchList (BaseQuery)

Build 1501 on 14/Nov/2017  This topic last edited on: 6/Sep/2016, at 13:33

The structure of search panes is defined in the xxx_Config.xml file where xxx can be Ted4, Fred4, Shell4, Admin4 or EdAdmin4.

Search panes are defined within SearchList section of the parent BaseQuery section. The defining is limited to the list of object attributes, with optional name, optional operator button, formatting, templates, predefined values, that decide the appearance of every field. The fields appear on the search pane in the same order they're defined in the configuration file.

hmtoggle_plus1Named SearchObjectUI section

The SearchList section contains one or more named SearchObjectUI sections, that in turn contain as many attributes as the number of search fields. The name of the section is referred in the xxx_TabItems.xml file.
hmtoggle_plus1Attributes

Each attribute is defined with the following syntax:

        <attribute path="[objectname.attribute]">

          <ui mode="Normal"

              labelPosition="position"/>

            orientation="orientation"

        </attribute>

where objectname.attribute corresponds to fields defined in the DirectoryStyle section, and position can be Above or Side, while orientation can be Horizontal or Vertical.

hmtoggle_plus0Positioning label and option button

See Positioning label and option button,
hmtoggle_plus1Example of simple attribute

        <attribute path="[linkObject.modifierRef]">

          <ui mode="Normal"

              labelPosition="Above"/>

        </attribute>
hmtoggle_plus1Example of check-box list attribute

Below code shows a check-box list with "article" and "img" positions.

        <attribute path="ObjectType.Id">

          <ui mode="Normal"

              labelPosition="Above"

              label="Object Type">

            <template kind="CheckBoxList"

                      objectTypes="article img"/>

          </ui>

        </attribute>
hmtoggle_plus1Example of tree list attribute

Below code shows a check-box list with "article" and "img" positions.

        <attribute path="[calendar.calendarParent]">

          <ui mode="Normal" labelPosition="Above" refAttributes="calendarParent" orientation="Vertical">

            <template kind="Tree" opMode="Hidden" />

          </ui>

        </attribute>
hmtoggle_plus1Example of folderRef tree attribute

Below code shows a folder tree.

        <attribute path="[archiveObject.folderRef]">

          <ui mode="Normal" labelPosition="Side" refAttributes="folderParent"/>

        </attribute>
hmtoggle_plus1Full code example with one searchObjectUI section

Below code is copied from the ArtImgMainTab BaseQuery:

    <SearchList>

      <searchObjectUI name="Search">

        <attribute path="[linkObject.name]">

          <ui mode="Normal"

              labelPosition="Above"/>

        </attribute>

        <attribute path="[linkObject.modifiedDate]">

          <ui mode="Normal"

              labelPosition="Above"/>

        </attribute>

        <attribute path="[linkObject.modifierRef]">

          <ui mode="Normal"

              labelPosition="Above"/>

        </attribute>

        <attribute path="[linkObject.folderRef]">

          <ui mode="Normal"

              labelPosition="Above"

              refAttributes="folderParent"/>

        </attribute>

        <attribute path="ObjectType.Id">

          <ui mode="Normal"

              labelPosition="Above"

              label="Object Type">

            <template kind="CheckBoxList"

                      objectTypes="article img"/>

          </ui>

        </attribute>

      </searchObjectUI>

    </SearchList>
hmtoggle_plus1Full code example with two searchObjectUI sections

Below code contains two searchObjectUI sections: Search and Browse

    <SearchList>

      <!--'Simple' pane without operator buttons-->

      <searchObjectUI name="Basic">

        <attribute path="[article.name]" op="Containing">

          <ui mode="Normal" labelPosition="Side" >

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[article.folderRef]" mode="Normal" op="InSubtree" >

          <ui labelPosition="Side" refAttributes="folderParent" orientation="Horizontal">

            <template kind="Tree" opMode="Hidden"/>

          </ui>

        </attribute>

        <attribute path="[article.modifiedDate]">

          <ui mode="Normal" orientation="Vertical">

            <template kind="Calendar" opCodes="Today Yesterday ThisYear ThisMonth ThisWeek EqualDate" />

          </ui>

        </attribute>

        <attribute path="[article.folderRef.workstateRef]" mode="Normal" op="In">

          <ui labelPosition="Side" orientation="Horizontal" opMode="Hidden">

            <template kind="CheckBoxList" opMode="Hidden" />

            <searchConditions xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd">

              <SearchNode xmlns="http://www.teradp.com/schemas/GN4/1/SearchConditions.xsd" xsi:type="SearchConditionList" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

                <List Op="In" Path="[workstate.levels]">

                  <IdList>

                    <IdName Name="Element" />

                  </IdList>

                </List>

              </SearchNode>

            </searchConditions>

          </ui>

        </attribute>

        <attribute path="[article.authorRef]" mode="Normal" op="In">

          <ui label="Authors" labelPosition="Side" orientation="Horizontal">

            <template kind="CheckBoxList" opMode="Hidden" />

          </ui> 

        </attribute>

      </searchObjectUI>

      <!--'Advanced' pane with operator buttons-->

      <searchObjectUI name="Options">

        <attribute path="[article.name]" mode="Normal">

          <ui labelPosition="Side" orientation="Horizontal"/>

        </attribute>

        <attribute path="[article.folderRef]" mode="Normal">

          <ui labelPosition="Side" refAttributes="folderParent" orientation="Horizontal">

            <template kind="Tree"/>

          </ui>

        </attribute>

        <attribute path="[article.modifiedDate]" mode="Normal">

          <ui labelPosition="Side" orientation="Horizontal"/>

        </attribute>

        <attribute path="[article.folderRef.workstateRef]" mode="Normal">

          <ui labelPosition="Side" orientation="Horizontal">

            <searchConditions xmlns="http://www.teradp.com/schemas/GN4/1/XmlSchemaExt.xsd">

              <SearchNode xmlns="http://www.teradp.com/schemas/GN4/1/SearchConditions.xsd" xsi:type="SearchConditionList" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

                <List Op="In" Path="[workstate.levels]">

                  <IdList>

                    <IdName Name="Element" />

                  </IdList>

                </List>

              </SearchNode>

            </searchConditions>

          </ui>

        </attribute>

        <attribute path="[article.authorRef]" mode="Normal">

          <ui label="Authors" labelPosition="Side" orientation="Horizontal"/>

        </attribute>

      </searchObjectUI>

    </SearchList>

Below code contains ten searchObjectUI sections:

    <SearchList>

      <!--Used on Content navTab: All content-->

      <searchObjectUI name="Basic">

        <attribute path="FullText">

          <ui label="Search full text" labelPosition="Side" />

        </attribute>

        <attribute path="[folderObject.summary]" op="Containing">

          <ui mode="Normal" labelPosition="Side">

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[folderObject.title]" op="Containing">

          <ui mode="Normal" labelPosition="Side">

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[folderObject.name]" op="Containing">

          <ui mode="Normal" labelPosition="Side">

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[folderObject.folderRef]" mode="Normal" op="InSubtree" >

          <ui labelPosition="Side" refAttributes="folderParent" orientation="Horizontal">

            <template kind="Tree" opMode="Hidden"/>

          </ui>

        </attribute>     

        <attribute path="ObjectType.Id" op="In">

          <ui mode="Normal" labelPosition="Side" label="Type">

            <template kind="CheckBoxList" objectTypes="article audio document image img story video" opMode="Hidden"/>

          </ui>

        </attribute>

        <attribute path="[folderObject.modifiedDate]">

          <ui mode="Normal" labelPosition="Side"/>

        </attribute>

      </searchObjectUI>

 

      <searchObjectUI name="Advanced">

        <attribute path="FullText">

          <ui label="Search full text" labelPosition="Side"/>

        </attribute>

        <attribute path="[folderObject.summary]" op="Containing">

          <ui mode="Normal" labelPosition="Side">

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[folderObject.title]" op="Containing">

          <ui mode="Normal" labelPosition="Side">

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[folderObject.name]" op="Containing">

          <ui mode="Normal" labelPosition="Side">

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[folderObject.folderRef]" mode="Normal">

          <ui labelPosition="Side" refAttributes="folderParent"/>

        </attribute>

        <attribute path="ObjectType.Id" mode="Normal">

          <ui labelPosition="Side" label="Type">

            <template kind="CheckBoxList" objectTypes="article img audio document image story video"/>

          </ui>

        </attribute>

        <attribute path="[archiveObject.authors]" mode="Normal">

          <ui labelPosition="Side"/>

        </attribute>

        <attribute path="[folderObject.cats]" mode="Normal">

          <ui labelPosition="Side"/>

        </attribute>

        <attribute path="[folderObject.modifiedDate]">

          <ui mode="Normal"/>

        </attribute>

        <attribute path="[folderObject.keywords]">

          <ui labelPosition="Side">

            <template kind="AutoComplete" autoCompleteMinChars="1"/>

          </ui>

        </attribute>

        <attribute path="[archiveObject.credit]" mode="Normal">

          <ui labelPosition="Side"/>

        </attribute>

        <attribute path="[archiveObject.instructions]" mode="Normal">

          <ui labelPosition="Side"/>

        </attribute>

        <attribute path="[archiveObject.city]" mode="Normal">

          <ui labelPosition="Side"/>

        </attribute>

        <attribute path="[archiveObject.state]" mode="Normal">

          <ui labelPosition="Side"/>

        </attribute>

        <attribute path="[archiveObject.country]" mode="Normal">

          <ui labelPosition="Side"/>

        </attribute>

      </searchObjectUI>

      <!--Wire_Simple, Wire_Text, Wire_Images: used on Wires navTab: searches wire content-->

      <searchObjectUI name="Wire_Simple">

        <attribute path="[archiveObject.summary]" op="Containing">

          <ui mode="Normal" labelPosition="Above" >

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[archiveObject.title]" op="Containing">

          <ui mode="Normal" labelPosition="Above" >

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[archiveObject.sourceRef]" op="Containing">

          <ui mode="Normal" labelPosition="Above" label="Source" >

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[archiveObject.cats]" op="In">

          <ui mode="Normal" labelPosition="Above">

            <template opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="ObjectType.Id" op="In">

          <ui mode="Normal" labelPosition="Above" label="Type">

            <template kind="CheckBoxList" objectTypes="audio image story video" opMode="Hidden"/>

          </ui>

        </attribute>

        <attribute path="[archiveObject.modifiedDate]">

          <ui mode="Normal" label="Arrived"/>

        </attribute>

        <attribute path="[archiveObject.folderRef]" mode="Normal">

          <ui labelPosition="Above" refAttributes="folderParent">

            <template kind="Tree" root="/Wires" opMode="Hidden" />

          </ui>

        </attribute>

 

      </searchObjectUI>

 

      <searchObjectUI name="Wire_Stories">

        <attribute path="FullText">

          <ui label="Search" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.title]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.authors]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.sourceRef]" op="Containing">

          <ui mode="Normal" labelPosition="Above" label="Source" >

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[archiveObject.cats]" op="In">

          <ui mode="Normal" labelPosition="Above">

            <template opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[story.nWords]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.modifiedDate]">

          <ui mode="Normal" label="Arrived"/>

        </attribute>

        <attribute path="ObjectType.Id" op="In">

          <ui labelPosition="Above" label="Type">

            <template kind="CheckBoxList" objectTypes="story" opMode="Hidden"/>

          </ui>

        </attribute>

        <attribute path="[archiveObject.folderRef]" mode="Normal">

          <ui labelPosition="Above" refAttributes="folderParent">

            <template kind="Tree" root="/Wires" opMode="Hidden" />

          </ui>

        </attribute>

      </searchObjectUI>

 

      <searchObjectUI name="Wire_Images">

        <attribute path="FullText">

          <ui label="Search" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.title]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.authors]">

          <ui mode="Normal" labelPosition="Above" label="Photographer"/>

        </attribute>

        <attribute path="[archiveObject.sourceRef]">

          <ui mode="Normal" labelPosition="Above" label="Source"/>

        </attribute>

        <attribute path="[archiveObject.cats]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.modifiedDate]">

          <ui mode="Normal" label="Arrived"/>

        </attribute>

        <attribute path="ObjectType.Id">

          <ui mode="Hidden" labelPosition="Above" label="Type">

            <template kind="CheckBoxList" objectTypes="image"/>

          </ui>

        </attribute>

        <attribute path="[archiveObject.folderRef]" mode="Normal">

          <ui labelPosition="Above" refAttributes="folderParent">

            <template kind="Tree" root="/Wires" opMode="Hidden" />

          </ui>

        </attribute>

      </searchObjectUI>

 

      <searchObjectUI name="Wire_IPTC">

        <attribute path="FullText">

          <ui label="Search" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.instructions]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.city]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.state]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.country]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.modifiedDate]">

          <ui mode="Normal" label="Arrived"/>

        </attribute>

        <attribute path="ObjectType.Id">

          <ui mode="Normal" labelPosition="Above" label="Type">

            <template kind="CheckBoxList" objectTypes="audio image story video"/>

          </ui>

        </attribute>

        <attribute path="[archiveObject.folderRef]" mode="Normal">

          <ui labelPosition="Above" refAttributes="folderParent">

            <template kind="Tree" root="/Wires" opMode="Hidden" />

          </ui>

        </attribute>

      </searchObjectUI>

 

      <!--Editorial_Simple, Editorial_Advanced: used on Editorial navTab-->

      <searchObjectUI name="Editorial_Simple">

        <attribute path="[linkObject.name]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[linkObject.modifiedDate]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[linkObject.modifierRef]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[linkObject.folderRef]">

          <ui mode="Normal" labelPosition="Above" refAttributes="folderParent"/>

        </attribute>

        <attribute path="[linkObject.folderRef.name]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="ObjectType.Id">

          <ui mode="Normal" labelPosition="Above" label="Type">

            <template kind="CheckBoxList" objectTypes="article img"/>

          </ui>

        </attribute>

      </searchObjectUI>

      <searchObjectUI name="Editorial_Advanced">

        <attribute path="FullText">

          <ui label="Search" labelPosition="Above"/>

        </attribute>

        <attribute path="[linkObject.name]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[linkObject.modifierRef]">

          <ui mode="Normal" labelPosition="Above"/>

        </attribute>

        <attribute path="[linkObject.modifiedDate]">

          <ui mode="Normal" label="Modified" labelPosition="Above"/>

        </attribute>

        <attribute path="[linkObject.folderRef.workstateRef]">

          <ui mode="Normal" labelPosition="Above" orientation="Horizontal">

            <searchConditions>

              <SearchNode xmlns="http://www.teradp.com/schemas/GN4/1/SearchConditions.xsd" xsi:type="SearchConditionList" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

                <List Op="In" Path="[workstate.levels]">

                  <IdList>

                    <IdName Name="Element" />

                  </IdList>

                </List>

              </SearchNode>

            </searchConditions>

          </ui>

        </attribute>

        <attribute path="[linkObject.folderRef]">

          <ui mode="Normal" labelPosition="Above" refAttributes="folderParent"/>

        </attribute>

 

        <!--

   <attribute path="[linkObject.authors]">

    <ui mode="Normal" labelPosition="Above"/>

   </attribute>

   -->

        <attribute path="ObjectType.Id">

          <ui mode="Normal" labelPosition="Above" label="Type">

            <template kind="CheckBoxList" objectTypes="article img"/>

          </ui>

        </attribute>

      </searchObjectUI>

 

      <!--Used on Content navTab: All content-->

      <searchObjectUI name="Asset_Simple">

        <attribute path="[archiveObject.summary]" op="Containing">

          <ui mode="Normal" labelPosition="Above">

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[archiveObject.title]" op="Containing">

          <ui mode="Normal" labelPosition="Above">

            <template kind="Single" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="[archiveObject.folderRef]" op="In">

          <ui mode="Normal" labelPosition="Above" refAttributes="folderParent">

            <template kind="Tree" opMode="Hidden" />

          </ui>

        </attribute>

        <attribute path="ObjectType.Id" op="In">

          <ui mode="Normal" labelPosition="Above" label="Type">

            <template kind="CheckBoxList" objectTypes="audio document image story video" opMode="Hidden"/>

          </ui>

        </attribute>

        <attribute path="[archiveObject.modifiedDate]">

          <ui mode="Normal"/>

        </attribute>

      </searchObjectUI>

      <searchObjectUI name="Asset_Advanced">

        <attribute path="FullText">

          <ui label="Search" labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.folderRef]" mode="Normal">

          <ui labelPosition="Above" refAttributes="folderParent"/>

        </attribute>

        <attribute path="[archiveObject.authors]" mode="Normal">

          <ui labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.cats]" mode="Normal">

          <ui labelPosition="Above"/>

        </attribute>

        <attribute path="ObjectType.Id" mode="Normal">

          <ui labelPosition="Above" label="Type">

            <template kind="CheckBoxList" objectTypes="audio document image story video" opMode="Hidden"/>

          </ui>

        </attribute>

        <attribute path="[archiveObject.modifiedDate]">

          <ui mode="Normal"/>

        </attribute>

        <attribute path="[archiveObject.keywords]">

          <ui labelPosition="Above">

            <template kind="AutoComplete" autoCompleteMinChars="1"/>

          </ui>

        </attribute>

        <attribute path="[archiveObject.credit]" mode="Normal">

          <ui labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.instructions]" mode="Normal">

          <ui labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.city]" mode="Normal">

          <ui labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.state]" mode="Normal">

          <ui labelPosition="Above"/>

        </attribute>

        <attribute path="[archiveObject.country]" mode="Normal">

          <ui labelPosition="Above"/>

        </attribute>

      </searchObjectUI>

    </SearchList>