Payload structure: ControlDesk

You must provide the field item references for the ControlDesk payload. A specific payload structure cannot be defined for ControlDesk, because the filter forms are user defined and, as a consequence, contain an unknown number of fields. Therefore, the payload contains multiple occurrences of <Field> to define the filter item reference and value. For example:

<ControlDesk>
<FilterName>TESTFILTER</FilterName>
<FilterFields>
		<Field>
				<Reference>1</Reference>
				<Value>SO/999999</Value>
		</Field>
		<Field>
				<Reference>2</Reference>
				<Value>1</Value>
		</Field>
</FilterFields>
</ControlDesk>

When a filter is created, the fields should have sequential item references, but we recommend that you check this has occurred. The check boxes on a filter form are normally set as unchecked=1.

To verify the field values:

  1. Run Sales Inquiry SOQ (or Purchase Inquiry POQ, if applicable).
  2. Select a filter name.
  3. Click Run. The filter is displayed.
  4. Use Query Form Properties to find the item reference for each field, and whether the check boxes are selected or cleared.
  5. Exit without completing the process.
Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified before the payload can be processed successfully.