Annotation Metadata XML Structure
The XML for metadata structure will be used for setting metadata of an annotation. Because the same metadata field can occur on multiple levels, the level needs to be specified.
XML structure
<xs:schema id="ISHAnnotationFields" 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" type="IshLevel"/>
<xs:attribute name="ishvaluetype" use="optional" type="IshValueType"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:simpleType name ="IshLevel">
<!-- The level of the ishfield -->
<xs:restriction base="xs:string">
<xs:enumeration value="annotation"/>
<xs:enumeration value="reply"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="IshValueType">
<!-- The requested type of the fieldvalue -->
<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:simpleType name="ElementName">
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
<xs:maxLength value="255" />
</xs:restriction>
</xs:simpleType>
</xs:schema>
Example to create an annotation
<ishfields>
<ishfield name='FISHANNOTATIONTYPE' level='annotation'>General</ishfield>
<ishfield name='FISHANNOTATIONTEXT' level='annotation'>Oracle 12.2 is supported and Oracle 12.1 is deprecated</ishfield>
<ishfield name='FISHANNOTPROPOSEDCHNGTXT' level='annotation'>Replace 'Oracle 12.1' with 'Oracle 12.2'</ishfield>
<ishfield name='FISHREVISIONID' level='annotation'>GUID-667E6C27-BC54-4B38-A7BB-AE841ADOPTRS</ishfield>
<ishfield name='FISHPUBLOGICALID' level='annotation'>GUID-8BDFFB06-C520-464D-8BBF-D855D9D6A003</ishfield>
<ishfield name='FISHPUBVERSION' level='annotation'>1.1.2</ishfield>
<ishfield name='FISHANNOTATIONSTATUS' level='annotation' ishvaluetype='element'>VANNOTATIONSTATUSUNSHARED</ishfield>
<ishfield name='FISHANNOTATIONCATEGORY' level='annotation'>Comment</ishfield>
<ishfield name='FISHSELECTEDORIGINALTEXT' level='annotation'>Oracle 12.1</ishfield>
<ishfield name='FISHANNOTATIONADDRESS' level='annotation'>....</ishfield>
</ishfields>
Example to create an annotation reply
<ishfields>
<ishfield name='FISHANNOTATIONTEXT' level='reply'>This should only be changed for the latest release.</ishfield>
</ishfields>
Example to update an annotation
<ishfields>
<ishfield name='FISHANNOTATIONSTATUS' level='annotation' ishvaluetype='element'>VANNOTATIONSTATUSSHARED</ishfield>
</ishfields>
<ishfields>
<ishfield name='FISHANNOTATIONSTATUS' level='annotation' ishvaluetype='element'>VANNOTATIONSTATUSRESOLVED</ishfield>
<ishfield name='FISHANNOTRESOLUTIONTEXT' level='annotation'>'Oracle 12.1' is replaced by 'Oracle 12.2'</ishfield>
<ishfield name='FISHANNOTRESOLUTIONTYPE' level='annotation'>Accepted</ishfield>
</ishfields>