About adding text, integer, checkbox, and variable input fields

You can choose from several different types of text and numerical input fields:

Info Text

Inserts a text box into which the integrator can enter informative or descriptive text about a section or field. For example, you can add an info text field to explain how to use the following field.

1. Unable to render {include} The included page could not be found.
2. Click to open the section into which you want to add the info text field.
3. In the Text/Numerical Input section on the left, click and drag the Info Text item to the location in the selected section.
4. Click in the Info Text Label field to display its Details on the right.
5. In the Details section, enter the text to display in the information line.
6. Click Preview and then click Preview UI. When done, close the Preview window.
7. Click Save.

Single-line text input fields

Inserts a text field into which the user can enter a single line of text, with validation either for a maximum number of characters or a regular expression.

1. In the Create Apps window for the app, click to open the section into which you want to add the single-line text input field.
2. In the Text/Numerical Input section on the left, click and drag the Single-line Text item to the location in the selected section.
3. Click in the Single-line Text Label field to display its Details on the right.
4. Edit the Details section:
   • Text box label: Edit the label as you want it to be displayed in the DE.
   • Argument option: Enter the command line option according to the tool's requirements.
   • Default text: Enter the default text string that will be displayed.
   • Do not display this item in the app: Hides the field in the GUI.
   • Make this field required: Requires the user to enter at least one text string.
   • Exclude this item if nothing is entered: Skips the item if no selection was made.
   • Tool tip text: Edit as needed.
5. To add a validation rule for the text string:
   1. Click .
   2. In the Rule Type list, select either:
      • Value must contain, at most, a maximum number of characters: Enter the maximum number of characters that may be entered in the text string and then click OK.
      • Matches a regular expression: Enter the text string that is required and then click OK.
   3. Repeat for each validation rule to define.
6. To edit a validation rule, click the validation rule in the Validation rules table, click Edit, and change the Rule Type or Value, and then click OK.
7. To delete a validation rule, click the validation rule in the Validation rules table and then click Delete.
8. Click Preview and then click Preview UI. When done, close the Preview window.
9. Click Save.

Multi-line text fields

Inserts a text input field into which the user can enter multiple lines of text.

1. In the Create Apps window for the app, click to open the section into which you want to add the multi-line text input field.
2. In the Text/Numerical Input section on the left, click and drag the Multi-line Text object to the location in the selected section.
3. Click in the Multi-line Text Label field to display its Details on the right.
4. Edit the Details section:
   • Multi-line Text label: Edit the label as you want it to be displayed in the DE.
   • Argument option: Enter the command line option according to the tool's requirements.
   • Default text: Enter the default text strings that will be displayed.
   • Do not display this item in the app: Hides the field in the GUI.
   • Make this field required: Requires the user to select at least one input file.
   • Exclude this item if nothing is entered: Skips the item if no selection was made.
   • Tool tip text: Edit as needed.
5. Click Preview and then click Preview UI. When done, close the Preview window.
6. Click Save.

Checkbox fields

Inserts a checkbox and checkbox label.

1. In the Create Apps window for the app, click to open the section into which you want to add the checkbox.
2. In the Text/Numerical Input section on the left, click and drag the Checkbox object to the location in the selected section.
3. Click in the Checkbox Label field to display its Details on the right.
4. Edit the Details:
   • Checkbox label:
     1. Edit the label as you want it to be displayed in the DE.
     2. Enter the argument option and value for the Checked and Not Checked options.
   • Check item by default: Defines whether the default state is checked or cleared.
   • Do not display this item in the app: Hides the field in the GUI.
   • Exclude this item if nothing is entered: Skips the item if no selection was made.
   • Tool tip text: Edit as needed.
5. Click Preview and then click Preview UI. When done, close the Preview window.
6. Click Save.

Environment variable fields

Allows the user to enter variables that affect the user's local machine. For more information, see Environment variable on the Wikipedia website.

1. In the Create Apps window for the app, click to open the section into which you want to add the argument.
2. In the Text/Numerical Input section on the left, click and drag the Environment Variable object to the location in the selected section.
3. Click in the Environment Variable Label field to display its Details on the right.
4. In the Details panel:
   • Environment Variable label: Edit the label as you want it to be displayed in the DE.
   • Environment Variable name: Displays the name of the environment variable name set by the app before the command line tool is run.
   • Default value: Enter the default value for the variable you entered.
   • Do not display this item in the app: Hides the field in the GUI.
   • Make this field required: Requires the user to enter a variable.
   • Tool tip text: Edit as needed.
5. Click Preview and then click Preview UI. When done, close the Preview window.
6. Click Save.

Integer input fields

Adds a text field into which the user can enter an integer, with validation for upper limit, lower limit, or range of values.

1. In the Create Apps window for the app, click to open the section into which you want to add the argument.
2. In the Text/Numerical Input section on the left, click and drag the Integer object to the location in the selected section.
3. Click in the Integer Label field to display its Details on the right.
4. In the Details section:
   • Integer Input label: Edit the label as you want it to be displayed in the DE.
   • Argument option: Enter the argument to use for the item, according to the tool's requirements.
   • Default value: Enter the default value that will be displayed.
   • Do not display this item in the app: Hides the field in the GUI.
   • Make this field required: Requires the user to enter an integer.
   • Exclude this item if nothing is entered: Skips the item if no selection was made.
   • Tool tip text: Edit as needed.
5. To add a validation rule for the integer field:
   1. Click .
   2. In the Rule Type field, select either:
      • Has a range of allowed values: Enter the upper and lower values for the entered integer to define the range the user can enter in the field.
      • Has a lower limit: Enter the value that must be above the entered integer.
      • Has an upper limit: Enter the integer that must be below the entered integer.
   3. Click OK.
   4. Repeat for each validation rule to define.
6. To edit a validation rule, click the rule in the table, click Edit, change the settings, and click OK.
7. To delete a validation rule, click the rule in the table and then click Delete.
8. Click Preview and then click Preview UI. When done, close the Preview window.
9. Click Save.

Decimal input fields

Adds a field into which the user can enter an integer — decimal or large integer — with validation for lower limit, upper limit, or range of values.

1. In the Create Apps window for the app, click and drag the Double object in the Text/Numerical Input section on the left, to the location in the selected section.
2. Click in the Decimal Label field to display its Details on the right.
3. In the Details section:
   • Decimal Input label: Edit the label as you want it to be displayed in the DE.
   • Argument option: Enter the command line option according to the tool's requirements.
   • Default value: Enter the default value that will be displayed.
   • Do not display this item in the app: Hides the field in the GUI.
   • Make this field required: Requires the user to enter an integer.
   • Exclude this item if nothing is entered: Skips the item if no selection was made.
   • Tool tip text: Edit as needed.
4. To add a validation rule for the decimal:
   1. Click .
   2. In the Rule Type list, select either:
      • Has a range of allowed values: Enter the upper and lower values for the entered integer to define the range the user can enter in the field.
      • Has a lower limit: Enter the decimal that the entered value must be above.
      • Has an upper limit: Enter the decimal that the entered value must be below.
   3. Repeat for each validation rule to define.
5. To edit a validation rule, click the rule in the table, click Edit, change the settings, and click OK.
6. To delete a validation rule, click the rule in the table and then click Delete.
7. Click Preview and then click Preview UI. When done, close the Preview window.
8. Click Save.

Deleting a text, integer, checkbox, or variable input field

1. In the middle secton, hover over the argument to delete until you see a blue border around it:
   
2. Hover over the the gray icon at the top right until it turns red:
   
3. Click the icon to complete the deletion.
4. Click Save.