---
title: "User interface description: Input Parameter window"
slug: "user-interface-description-input-parameter-window"
tags: ["AddIn V5.0.4.2", "reference"]
updated: 2026-11-04T10:14:44Z
published: 2026-11-04T10:14:44Z
canonical: "help.dox42.com/user-interface-description-input-parameter-window"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.dox42.com/llms.txt
> Use this file to discover all available pages before exploring further.

# User interface description: Input Parameter window

Since the behaviour and the settings of an input parameter can differ significantly, use this overview to understand the UI elements in the **Input Parameter** window.

## Data Source tab

| UI element name | UI element type | Requirement | Description |
| --- | --- | --- | --- |
| Input Parameter Name | text field | mandatory | Choose a descriptive name for your input parameter. |
| Comment | text field | optional | Enter a call-to-action text that is going to be displayed before generating a document. For example: `Enter the participant's ID:`. > [!NOTE] > Note > > Although this field is optional, we recommend that you fill it in. |
| Input type | dropdown | mandatory | Define the basis of the input parameter. It can be: - Text - Select from Values - Select from Data Source Depending on the selection, different UI elements are displayed. |
| UI elements displayed after selecting Input type *Text* |
| Default Value | text area | optional | Set IDs in plain text, enter an XML/JSON Request Body or a D365 CE Request Body as the basis for document generation. See the following UI elements and for further information, see [Configuring an input parameter for your template](/help/docs/configuring-an-input-parameter-for-your-template). |
| Choose File | checkbox | optional | Select this checkbox to set a **Choose File** button to the query, which appears prior to document generation. The button can be used to select a file containing data relevant to document generation, e.g., mail addresses. |
| Choose Directory | checkbox | optional | Select this checkbox to set a **Choose Directory** button to the query, which appears prior to document generation. The button can be used to dynamically specify a directory from which images or other files can be loaded, e.g., a directory for English icons, one for French icons, and so on. |
| Password (****) | checkbox | optional | Select this checkbox if you want to hide the default values of the input parameter to the user. The user cannot see the IDs to be called. This is useful if you use a password input parameter to authenticate in your data sources. |
| Insert Data Field | button | optional | Select this button to select a default value, e.g. a default content of a data field. In the query that is going to be displayed before generating a document, the user will see exactly that specific content. |
| JSON IDs Sample | button | optional | Select this button to enter an ID as the basis for the document generation. A sample for a valid JSON structure will be displayed in the **Default Value** text area. The JSON sample looks like this: `[{"id":"1"},{"id":"2"},{"id":"3"},{"id":"4"}]` |
| D365 CE Request Body | button | optional | > [!WARNING] > Important > > Only relevant together with a CE data source. Select this button to call an input parameter by RequestBody. The button loads a sample for a valid JSON structure, according to D365 CE. |
| UI elements displayed after selecting Input type *Select from Values* |
| Select from Values | table | mandatory | Create a list of values here that will be available for selection when generating the document. For further information, see [Configuring an input parameter for your template](/help/docs/configuring-an-input-parameter-for-your-template). |
| UI elements displayed after selecting Input type *Select from Data Source* |
| Data Source | dropdown | mandatory | Select a data source as the basis for document generation. |
| Value | dropdown | mandatory | Select a data source’s data field as the basis for document generation. We always recommend selecting a data field that is unique, like `ID`, to ensure that the correct values are retrieved. |
| Display Text | dropdown | mandatory | Select the text that should be displayed when generating the document. |

## LookUp tab

| UI element name | UI element type | Requirement | Description |
| --- | --- | --- | --- |
| Lookup Link | text field | optional | Provide a URL where information can be looked up prior to document generation, e.g. a CRM system. |
| Caption Lookup Link | text field | optional | Link text to be displayed. |