Add Input

Adding an Input involves defining the parameters that will be used to filter or refine the data returned by a query. Inputs are essential for building dynamic and customizable queries.

Steps to Add an Input

1. Navigate to the Inputs Tab

   • Go to the Query Page where you want to configure inputs.

   • Click on the Inputs tab. This tab displays the list of already defined inputs for the selected query.

     
2. Initiate Input Creation

   • In the Tabs and Actions Bar section, click the New Input button.

   • This action opens the New Input Drawer.

     
3. Enter Input Details

   • The New Input drawer will appear with the following fields:

     • Name

       • Enter a unique name for the input.

       • Validation Rules:

         • The name must be unique within the query.

         • The name length should be between 2 and 100 characters.

         • The name cannot be empty, include special characters, or start with a numeric character.

     • Description (optional)

       • Provide a brief description of the input's purpose within the query.

       • Validation Rules:

         • The description length should be between 0 and 400 characters.

     • Type

       • Select the type of input from the following options:

         • Text

         • Whole Number

         • Decimal

         • Date/Time

         • Boolean

         • Enum

       • Note: Some additional fields may appear for further configuration based on the selected type. Refer to the Data > Properties > Property Types section for more details on these fields.

     • Nullable

       • Indicate if the input can accept null values.

4. Submit the Input

   • Click the Submit button to add the new input to the query.

   • The newly created input will now appear in the list under the Inputs tab.

     

Inputs are used to build dynamic conditions for the query, allowing you to filter and refine the data returned by the query API.