The Retrieval section is used to decide how to present the results of the query. Retrievals can be defined in two ways:

RetrievalField. In the cases where retrievals are based on predefined field where the field name in the report matches the field name in the model, a retrieval field is used.

<RetrievalField levelType="ZBKS.Book" category="PDF">

<FieldName>Title</FieldName>

</RetrievalField>
```
		                
```
Custom Retrieval Field. When we want to define retrievals where the field do not exactly map to the field in the model, then CustomRetrievalFields must be used instead of FilterFields.

<CustomRetrievalField>

<FieldRef levelType="ZBKS.Book" category="PDF">

<FieldName>Publisher website</FieldName>

</FieldRef>

<Type>STRING</Type>

<SimpleMapping sqlName="PUBLISHER_WEBSITE"/>

</CustomRetrievalField>

userHidden

Set userHidden to true to indicate that this field should be hidden by default from the UI, but the user should be given the option to show the field from the context menu "Columns" list. This is in contrast to the Hidden element, which hides the existence of the field entirely from the user.

<CustomRetrievalField userHidden="true">
   ...
</CustomRetrievalField> 

Please note that this is for initial setup only. Once the user has set preferences or saved a favorite, the user's visibility setting on the field takes precedence over the userHidden flag.

concurrencyVersion

Set concurrencyVersion to true to indicate that this field should be used for computing the concurrencyVersion value. This attribute should only be set for the DATE type fields.

Please note that setting this attribute value to true will enable the concurrency versioning on this report(if it is actionable). For information on concurrencyVersioning, refer Concurrency Versioning on Models under Programmatic Access to Models

Retrieval Column Width

Width of retrieval columns can be customized by providing <ColumnWidth> element inside <CustomRetrievalField>.

<CustomRetrievalField>
	<FieldRef levelType="ZBKS.Book" category="PDF">
		<FieldName>Title</FieldName>
	</FieldRef>
	<Type>STRING</Type>
	<ColumnWidth>300</ColumnWidth>
	<SimpleMapping sqlName="TITLE"/>
</CustomRetrievalField>	

Ordering by States in State Machine

By Default, State type fields are ordered alphabetically. To retrieve States ordered by their life cycle defined in the state machine, add <CustomModelName> element inside <CustomRetrievalField>.

CustomModelName represents the model name.

<CustomRetrievalField>
	<FieldRef levelType="ZBKS.Book" category="PDF">
		<FieldName>State</FieldName>
	</FieldRef>
	<Type>STATE</Type>
	<SimpleMapping sqlName="STATE"/>
	<CustomModelName>Standard ZBKS.Book</CustomModelName>
</CustomRetrievalField>