# Module setting parameters

> [HTML Version](extention-settings.html)

On the **Settings** tab of a custom module, you can add global parameters required for the module to function correctly and perform its intended tasks. These parameters can be used in server-side scripts of module widgets and business processes, as well as when creating API methods. For example, you can add parameters to store an API token or API key.

After a parameter is created, it is displayed on the module management page by default. You can customize the appearance of this page and create a custom module settings form.

**Important**: Starting with system version 2025.11, use the asynchronous `Namespace.getParams()` method to access parameters in scripts. For a use case of getting module parameters using this method, see the [Custom module for two-factor authentication](two-factor-integration.md#script-example) article.

Accessing module parameters through the `Namespace.params` property is considered deprecated, although scripts that use this approach can still be published.

## Add module settings 

1. Go to **Administration > Modules**.

2. Hover over the module and click on the gear icon that appears.  
**(widget_module_settings.PNG)**

3. Go to the **Settings** tab.

4. Click **+Add** and fill in the fields:

**(custom-extension-settings-3.png)**

- **Display Name**. The name of the property that will be displayed on different forms of the module and in its settings.

- **Property Name**. The name of the property used when working with APIs and scripts.

- **Tip**. Additional information about the property.

- **Type**. The [type](360009707032.md) of the property, for example, **String**.

- **Search and sort by field**. If you select this option, the value of this field will be used in [search by parameters and conditions](360009669952.md).

- **Quick search**. If you select this option, the value of the **String**-type field will be used in [quick search](360009669952.md#full-text-search).

- **Set a formula for the field**.** **This option is available only for fields of the **String**, **Number**, and **Money** types. You can specify a formula by which the system will automatically calculate the value for this property. Read more in the [Calculated fields](360013448740.md) article.

- **Show only when a condition is met**. This option allows you to hide/show the property based on the conditions you set. Read more in the [Calculated fields](360013448740.md) article.

5. When you finish, click **Save**.

By default, all settings that you create are added to the module connection page. The user will see them when they click on the module’s name in the **Administration** workspace.

**(extension-settings-4.png)**

## Set a custom form for module settings

You can rearrange how a module’s settings are displayed. For example, hide some of the settings, add fields for checking tokens, or customize the page to immediately display the necessary data from an external service. To do this:

1. Click **Change Form** on the **Settings** tab of the module.

**(extention-settings-3.png)**

2. The [Interface designer](interface_designer.md) will open. On the **Template** tab, the design canvas is displayed in the center. By default, it contains the **Standard App Item Form** widget. Remove this widget to configure a custom layout for the settings form.

3.  To the right of the design canvas, you will find the available widgets, while the **Properties** tab contains the module parameters that were previously added on the **Settings** tab. To create a custom form, drag widgets and properties from this area onto the design canvas.

**(extention-settings-5.png)**

4. On the **Context** tab you can add properties that can be used in the widget’s scripts. Read more about this in [Context types](context_types.md) and [System data types](360009707032.md).

5. On the **Scripts** tab, you can write scripts that determine the widget’s behavior.

6.  After making your changes, click **Save** in the upper-left corner, and then click **Publish**.

## Remove parameters from module settings

If parameters added on the **Settings** tab are no longer used, you can remove them from the list. To do this:

1. Select the required entries. To select all parameters, check the box to the left of the **Display Name** column.

2. In the upper-right corner, click **Delete** and confirm the action.

Note: If you have manually added a parameter to a [custom settings form](#settings) as a separate field or inside a widget (for example, **Columns**), an error message will appear when you try to delete it.