Documentation Center

Preferences XML structure

Preferences XML structure will be used for creating/updating/retrieving preferences of a Content Manager object.

XML structure


<?xml version="1.0" encoding="utf-8" ?>
<xs:schema id="ISHPreferences" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="ishpreferencesets">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="ishpreferenceset"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="ishpreferenceset">
    <xs:complexType>
      <xs:sequence minOccurs="1" maxOccurs="1">
        <xs:element ref="items"/>
      </xs:sequence>
      <xs:attribute name="name" use="required" type="ElementName" />
    </xs:complexType>
  </xs:element>
  <xs:element name="items">
    <xs:complexType>
      <xs:sequence minOccurs="1" maxOccurs="unbounded">
        <xs:element ref="item"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="item">
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base="xs:string">
          <xs:attribute name="name" use="required" type="ElementName" />
        </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:schema>
	 

Example

An example when creating or updating preferences. The same example will be returned when retrieving the preferences.

<ishpreferencesets>
	<ishpreferenceset name="trisoft.publicationmanager.forms.baselineviewcontrol">
		<items>
			<item name="defaultSort">Title</item>
			<item name="defaultSortOrder">Ascending</item>
			<item name="title.width">32</item>
			<item name="title.displayindex">3</item>
			<item name="title.ishidden">false</item>
		</items>
	</ishpreferenceset>
</ishpreferencesets>