Documentation Center

Field Tags XML Structure

Contains the XML structure with the tags per field

XML structure


<?xml version="1.0" encoding="utf-8" ?>
<xs:schema id="ISHFieldTags" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="ishfieldtags">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="ishfieldtag"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="ishfieldtag">
    <xs:complexType>
      <xs:choice minOccurs="1" maxOccurs="3">
        <xs:element ref="tags" minOccurs="0" maxOccurs="1"/>
        <xs:element ref="relationships" minOccurs="0" maxOccurs="1"/>
        <xs:element ref="logger" minOccurs="0" maxOccurs="1"/>
      </xs:choice>
      <xs:attribute name="ishfieldname" use="required" type="ElementName"/>
      <xs:attribute name="ishfieldlevel" use="optional" >
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="none"/>
            <xs:enumeration value="logical"/>
            <xs:enumeration value="version"/>
            <xs:enumeration value="lng"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
    </xs:complexType>
  </xs:element>
  <xs:element name="tags">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="tag"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="tag">
    <xs:complexType>
      <xs:all>
        <xs:element name="label" minOccurs="1" maxOccurs="1" type="MandatoryText"/>
        <xs:element name="annotatedlabel" minOccurs="0" maxOccurs="1" type="AnnotatedLabel"/>
        <xs:element name="description" minOccurs="1" maxOccurs="1" type="xs:string"/>
        <xs:element name="selectable" minOccurs="0" maxOccurs="1" type="xs:boolean" />
      </xs:all>
      <xs:attribute name="id" use="required" type="MandatoryText"/>
    </xs:complexType>
  </xs:element>
  <xs:element name="relationships">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="relationship"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="relationship">
    <xs:complexType>
      <xs:attribute name="fromid" use="required" type="xs:string"/>
      <xs:attribute name="toid" use="required" type="MandatoryText"/>
    </xs:complexType>
  </xs:element>
  <xs:complexType name="AnnotatedLabel" mixed="true">
    <xs:sequence minOccurs="0" maxOccurs="unbounded">
      <xs:element name="em" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <!-- Logger elements -->
  <xs:element name="logger">
    <xs:complexType>
      <xs:choice maxOccurs="unbounded">
        <xs:element ref="logs" minOccurs="1" maxOccurs="1" />
      </xs:choice>
      <xs:attribute name="applicationname" use="required" type="xs:string"/>
      <xs:attribute name="userid" use="required" type="xs:string" />
      <xs:attribute name="serverrequestid" use="optional" type="xs:string" />
      <xs:attribute name="serverhostname" use="optional" type="xs:string" />
    </xs:complexType>
  </xs:element>
  <xs:element name="logs">
    <xs:complexType>
      <xs:choice maxOccurs="unbounded">
        <xs:element name="error" minOccurs="0" maxOccurs="unbounded" type ="LogEntryComplexType" />
        <xs:element name="warning" minOccurs="0" maxOccurs="unbounded" type ="LogEntryComplexType" />
        <xs:element name="message" minOccurs="0" maxOccurs="unbounded" type ="LogEntryComplexType" />
      </xs:choice>
    </xs:complexType>
  </xs:element>
  <xs:complexType name="LogEntryComplexType">
    <xs:choice maxOccurs="unbounded">
      <xs:element ref="basedescription" minOccurs="1" maxOccurs="1" />
      <xs:element ref="desc" minOccurs="1" maxOccurs="1" />
      <xs:element ref="param" minOccurs="0" maxOccurs="unbounded" />
    </xs:choice>
    <xs:attribute name="logid" use="required" type="PositiveNumber"/>
    <xs:attribute name="resourceid" use="required" type="MandatoryText"/>
    <xs:attribute name="resourcelib" use="required" type="MandatoryText"/>
    <xs:attribute name="number" use="required" type="NegativeNumber" />
  </xs:complexType>
  <xs:element name ="basedescription" type="StringContent"/>
  <xs:element name ="desc" type="StringContent"/>
  <xs:element name ="param">
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base="xs:string">
          <xs:attribute name ="paramname" use="required" type ="MandatoryText"/>
          <xs:attribute name ="paramtype" use="required">
            <xs:simpleType>
              <xs:restriction base ="xs:string">
                <xs:enumeration value ="String"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>
  <!-- Simple types -->
  <xs:complexType name="StringContent">
    <xs:simpleContent>
      <xs:extension base="xs:string" />
    </xs:simpleContent>
  </xs:complexType>
  <xs:simpleType name="MandatoryText">
    <xs:restriction base="xs:string">
      <xs:minLength value="1"/>
    </xs:restriction>
  </xs:simpleType>
  <xs:simpleType name="ElementName">
    <xs:restriction base="MandatoryText">
      <xs:maxLength value="255" />
    </xs:restriction>
  </xs:simpleType>
  <xs:simpleType name="NegativeNumber">
    <xs:restriction base="xs:long">
      <xs:maxExclusive value="0"/>
    </xs:restriction>
  </xs:simpleType>
  <xs:simpleType name="PositiveNumber">
    <xs:restriction base="xs:long">
      <xs:minInclusive value="0"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>
      

Example for ResolveIds

The XML structure which is used as an input for resolving ids:

<ishfieldtags>
  <ishfieldtag ishfieldname="FCONTINENTS">
    <tags>
      <tag id="EUR"/>
    </tags>
  </ishfieldtag>
  <ishfieldtag ishfieldname="FCOUNTRIES">
    <tags>
      <tag id="ES"/>
      <tag id="IT"/>
    </tags>
  </ishfieldtag>
</ishfieldtags>
        
The XML structure which is returned after resolving the ids:

<ishfieldtags>
  <ishfieldtag ishfieldname="FCONTINENTS">
    <tags>
      <tag id="EUR">
        <label>Europe</label>
        <description/>
      </tag>
    </tags>
  </ishfieldtag>
  <ishfieldtag ishfieldname="FCOUNTRIES">
    <tags>
      <tag id="ES">
        <label>Spain</label>
        <description>Spain, officially the Kingdom of Spain, is a sovereign state located on the Iberian Peninsula in southwestern Europe.</description>
      </tag>
      <tag id="IT">
        <label>Italy</label>
        <description>Italy, officially the Italian Republic, is a unitary parliamentary republic in Southern Europe.</description>
      </tag>
    </tags>
  </ishfieldtag>
</ishfieldtags>
        

The following XML structure will be returned when something goes wrong when resolving the ids:


<ishfieldtags>
  <ishfieldtag ishfieldname="FPRODUCT">
    <logger applicationname="ISHCM" userid="Admin" serverrequestid="10" serverhostname="APPSERVERNAME">
      <logs>
        <error logid="0" resourceid="MetadataBindingHandlerExecutionFailure" resourcelib="isAuthor" number="-106015">
          <basedescription>The metadata binding handler "MyProductConnector" returned the following error: HTTP request timed out. [106015;MetadataBindingHandlerExecutionFailure]</basedescription>
          <desc>The metadata binding handler "MyProductConnector" returned the following error: HTTP request timed out. [106015;MetadataBindingHandlerExecutionFailure]</desc>
          <param paramname="handlername" paramtype="String">MyProductConnector</param>
          <param paramname="reason" paramtype="String">HTTP request timed out</param>
        </error>
      </logs>
    </logger>
  </ishfieldtag>
</ishfieldtags>
      

Example for RetrieveTags

Retrieving tags returns the following XML structure:

<ishfieldtags>
  <ishfieldtag ishfieldname="FCOUNTRIES" ishfieldlevel="lng">
    <tags>
      <tag id="EUR">
        <label>Europe</label>
        <annotatedlabel>Europe</annotatedlabel>
        <description/>
      </tag>
      <tag id="ES">
        <label>Spain</label>
        <annotatedlabel>Spain</annotatedlabel>
        <description>Spain, officially the Kingdom of Spain, is a sovereign state located on the Iberian Peninsula in southwestern Europe.</description>
      </tag>
      <tag id="IT">
        <label>Italy</label>
        <annotatedlabel>Italy</annotatedlabel>
        <description>Italy, officially the Italian Republic, is a unitary parliamentary republic in Southern Europe.</description>
      </tag>
    </tags>
    <logger applicationname="ISHCM" userid="Admin" serverrequestid="10" serverhostname="APPSERVERNAME">
      <logs>
        <warning logid="0" resourceid="HugeNumberOfTermsList" resourcelib="sesConnector" number="-500004">
          <basedescription>Setup for the field FCOUNTRIES is requesting a huge number of terms to be loaded. LiveContent keeps your system stable by showing you a partial result. Please contact you System Administrator to improve performance for this field.</basedescription>
          <desc>Setup for the field FCOUNTRIES is requesting a huge number of terms to be loaded. LiveContent keeps your system stable by showing you a partial result. Please contact you System Administrator to improve performance for this field.</desc>
        </warning>
      </logs>
    </logger>
  </ishfieldtag>
</ishfieldtags>
        

Example for RetrieveTagStructure

Retrieving the tag structure returns the following XML structure:

<ishfieldtags>
  <ishfieldtag ishfieldname="FCOUNTRIES" ishfieldlevel="lng">
    <tags>
      <tag id="EUR">
        <label>Europe</label>
        <description/>
      </tag>
      <tag id="ES">
        <label>Spain</label>
        <description>Spain, officially the Kingdom of Spain, is a sovereign state located on the Iberian Peninsula in southwestern Europe.</description>
      </tag>
      <tag id="IT">
        <label>Italy</label>
        <description>Italy, officially the Italian Republic, is a unitary parliamentary republic in Southern Europe.</description>
      </tag>
    </tags>
    <relationships>
      <relationship fromid="" toid="EUR" />   <!-- The empty fromId indicates that EUR is a root Tag in the Tree -->
      <relationship fromid="EUR" toid="IT" />
      <relationship fromid="EUR" toid="ES" />
    </relationships>
    <logger applicationname="ISHCM" userid="Admin" serverrequestid="10" serverhostname="APPSERVERNAME">
      <logs>
        <warning logid="0" resourceid="HugeNumberOfTermsStructure" resourcelib="sesConnector" number="-500005">
          <basedescription>Setup for the field FCOUNTRIES is requesting a huge number of terms to be loaded. LiveContent keeps your system stable by showing you the tag structure partially. Please contact you System Administrator to improve performance for this field.</basedescription>
          <desc>Setup for the field FCOUNTRIES is requesting a huge number of terms to be loaded. LiveContent keeps your system stable by showing you the tag structure partially. Please contact you System Administrator to improve performance for this field.</desc>
        </warning>
      </logs>
    </logger>
  </ishfieldtag>
</ishfieldtags>
        

Example for SmartTag

The XML structure which is used as an input for adding smart tags:

<ishfieldtags>
  <ishfieldtag ishfieldname="FCONTINENTS" ishfieldlevel="logical">
    <tags>
      <tag id="EUR"/>
    </tags>
  </ishfieldtag>
  <ishfieldtag ishfieldname="FCOUNTRIES" ishfieldlevel="logical">
    <tags>
      <tag id="ES"/>
      <tag id="IT"/>
    </tags>
  </ishfieldtag>
  <ishfieldtag ishfieldname="FCITIES" ishfieldlevel="logical"/>
</ishfieldtags>
        
The XML structure which is returned after adding smart tags:

<ishfieldtags>
  <ishfieldtag ishfieldname="FCONTINENTS" ishfieldlevel="logical">
    <tags>
      <tag id="EUR">
        <label>Europe</label>
        <label>Europe</label>
        <description/>
      </tag>
    </tags>
  </ishfieldtag>
  <ishfieldtag ishfieldname="FCOUNTRIES" ishfieldlevel="logical">
    <tags>
      <tag id="ES">
        <label>Spain</label>
        <label>Spain</label>
        <description>Spain, officially the Kingdom of Spain, is a sovereign state located on the Iberian Peninsula in southwestern Europe.</description>
      </tag>
      <tag id="IT">
        <label>Italy</label>
        <label>Italy</label>
        <description>Italy, officially the Italian Republic, is a unitary parliamentary republic in Southern Europe.</description>
      </tag>
      <tag id="GB">
	       <label>United Kingdom</label>
	       <annotatedlabel>United Kingdom</annotatedlabel>
        <description>The United Kingdom of Great Britain and Northern Ireland, commonly known as the United Kingdom or Britain, is a sovereign country in north-western Europe, off the north-western coast of the European mainland.</description>
      </tag>
      <tag id="FR">
	       <label>France</label>
	       <annotatedlabel>France</annotatedlabel>
        <description>France, officially the French Republic, is a country primarily located in Western Europe, consisting of metropolitan France and several overseas regions and territories.</description>
      </tag>
    </tags>
  </ishfieldtag>
  <ishfieldtag ishfieldname="FCITIES" ishfieldlevel="logical">
    <tags>
      <tag id="4707414">
	       <label>London</label>
	       <annotatedlabel>London</annotatedlabel>
        <description>London is the capital and largest city of England and the United Kingdom.</description>
      </tag>
      <tag id="2988507">
	       <label>Paris</label>
	       <annotatedlabel>Paris</annotatedlabel>
        <description>Paris is the capital of France.</description>
      </tag>
    </tags>
  </ishfieldtag>
</ishfieldtags>