purposeofrequest

This configuration is optional when using the plugin Purpose_Of_Request.

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<purposeOfRequestConfiguration
<firstField
Choice: Choose only ONE of the following
<textfield
mandatory
optional
=
boolean

false to make the user input optional.

Default: true

<printName
>
required
string

The label of the field.

</printName>
<description
>
required
string

A short description of the field to be displayed as a hint for the user to fill in the form.

</description>
>
required

Use this element when you want the user to enter the purpose of the request in a text field.

</textfield>
<select
mandatory
optional
=
boolean

false to make the user input optional.

Default: true

<printName
>
required
string

The label of the field.

</printName>
<description
>
required
string

A short description of the field to be displayed as a hint for the user to fill in the form.

</description>
<options
>
required

For each list item, add an option element with your text.

<option
>
required
string
</option>
</options>
>
required

Use this element when you want the user to select the purpose of the request from a drop-down list of "options" that you have configured.

</select>
Choice End
>
required

Dialog field that prompts the user for the purpose of the request. Possible field types are an input field ("textfield") or a drop-down list ("select").

</firstField>
<secondField
Choice: Choose only ONE of the following
<textfield
mandatory
optional
=
boolean

false to make the user input optional.

Default: true

<printName
>
required
string

The label of the field.

</printName>
<description
>
required
string

A short description of the field to be displayed as a hint for the user to fill in the form.

</description>
>
required

Use this element when you want the user to enter the purpose of the request in a text field.

</textfield>
<select
mandatory
optional
=
boolean

false to make the user input optional.

Default: true

<printName
>
required
string

The label of the field.

</printName>
<description
>
required
string

A short description of the field to be displayed as a hint for the user to fill in the form.

</description>
<options
>
required

For each list item, add an option element with your text.

<option
>
required
string
</option>
</options>
>
required

Use this element when you want the user to select the purpose of the request from a drop-down list of "options" that you have configured.

</select>
Choice End
>
optional

Optionally, in addition to the first purpose of request ("firstField"), the user can be asked to provide additional information about the purpose of request. Possible field types are an input field ("textfield") or a drop-down list ("select").

</secondField>
>
required

Configuration of the form that the user has to fill in to specify the purpose of request

</purposeOfRequestConfiguration>
This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
cadenzaconfig:
  settings:
    purposeofrequest:
      firstField:
        textfield:
          mandatory: true
          printName: "text"
          description: "text"
        select:
          mandatory: true
          printName: "text"
          description: "text"
          options:
          - "text"
          - "text"
      secondField:
        textfield:
          mandatory: true
          printName: "text"
          description: "text"
        select:
          mandatory: true
          printName: "text"
          description: "text"
          options:
          - "text"
          - "text"

Filename: purposeofrequest-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<purposeOfRequestConfiguration>
  <firstField>
    <textfield mandatory="true">
      <printName>text</printName>
      <description>text</description>
    </textfield>
    <select mandatory="true">
      <printName>text</printName>
      <description>text</description>
      <options>
        <option>text</option>
        <option>text</option>
      </options>
    </select>
  </firstField>
  <secondField>
    <textfield mandatory="true">
      <printName>text</printName>
      <description>text</description>
    </textfield>
    <select mandatory="true">
      <printName>text</printName>
      <description>text</description>
      <options>
        <option>text</option>
        <option>text</option>
      </options>
    </select>
  </secondField>
</purposeOfRequestConfiguration>