Documentation Center

Requested Background Task Metadata XML structure

The XML structure for the Requested Metadata of a background task

XML structure

<?xml version="1.0" encoding="utf-8" ?>
<xs:schema id="ISHBackgroundTaskFields" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="ishfields">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="ishfield"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="ishfield">
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base="xs:string">
          <xs:attribute name="name" use="required" type="ElementName"/>
          <xs:attribute name="level" use="required">
            <xs:simpleType>
              <!-- The level of the ishfield -->
              <xs:restriction base="xs:string">
                <xs:enumeration value="task"/>
                <xs:enumeration value="history"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
          <xs:attribute name="ishvaluetype" use="optional" type="IshValueType"/>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>
  <xs:simpleType name="ElementName">
    <xs:restriction base="xs:string">
      <xs:minLength value="1"/>
      <xs:maxLength value="255" />
    </xs:restriction>
  </xs:simpleType>
  <xs:simpleType name="IshValueType">
    <xs:restriction base="xs:string">
      <xs:enumeration value=""/>
      <xs:enumeration value="value"/>
      <xs:enumeration value="element"/>
      <xs:enumeration value="id"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Example

<ishfields>
    <ishfield name="USERID" level="task"/>
    <ishfield name="USERID" level="task" ishvaluetype="element"/>
    <ishfield name="HASHID" level="task"/>
    <ishfield name="STATUS" level="task"/>
    <ishfield name="STATUS" level="task" ishvaluetype="element"/>
    <ishfield name="EVENTTYPE" level="task"/>
    <ishfield name="EVENTTYPE" level="task" ishvaluetype="element"/>
    <ishfield name="PROGRESSID" level="task"/>
    <ishfield name="TRACKINGID" level="task"/>
    <ishfield name="CREATIONDATE" level="task"/>
    <ishfield name="MODIFICATIONDATE" level="task"/>
    <ishfield name="EXECUTEAFTERDATE" level="task"/>
    <ishfield name="LEASEDON" level="task"/>
    <ishfield name="LEASEDBY" level="task"/>
    <ishfield name="CURRENTATTEMPT" level="task"/>
    <ishfield name="INPUTDATAID" level="task"/>
    <ishfield name="OUTPUTDATAID" level="task"/>
    <ishfield name="EXITCODE" level="history"/>
    <ishfield name="ERRORNUMBER" level="history"/>
    <ishfield name="OUTPUT" level="history"/>
    <ishfield name="ERROR" level="history"/>
    <ishfield name="STARTDATE" level="history"/>
    <ishfield name="ENDDATE" level="history"/>
    <ishfield name="HOSTNAME" level="history"/>
</ishfields>