Specify module setting parameters

In a custom module, you can add global parameters on the Settings tab to store service data, API keys, and access tokens. The created parameters are displayed on the module management page and are used in server-side scripts for processes and widgets, as well as in API methods.

This article describes how to add and configure parameters, modify the module management page form in the interface designer, automatically update parameter values using a script, and delete unused properties.

Important: Starting from system version 2025.11, use the Namespace.getParams() method to work with parameters in scripts. An example of calling this method to retrieve module parameters is provided in Custom module for two-factor authentication. Accessing module parameters using the Namespace.params property is deprecated, but publishing scripts that use it remains possible.

Add module parameters

1. Go to Administration > Modules and hover over the module and click on the gear icon that appears.
2. Go to the Settings tab.
3. Click +Add and fill in the fields:

• 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 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.
• Quick search. If you select this option, the value of the String-type field will be used in quick 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 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 article.

5. When you finish, click Create.

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.

Customize module settings page

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.

2. The Interface designer 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.

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 and System data types.
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.

Change parameter values via script

Module parameter values can be updated automatically while the module is running. For example, when connection data for an external service changes.

To avoid updating values manually, define a server-side script that calls the Namespace.setParams() method. You can add a special button to the custom module settings form to trigger this script.

An example of calling the method to update parameter values in module settings:

await Namespace.setParams({
field1: value1,
field2: value2,
});

Where:

• field1, field2. Module parameters on the Settings tab.
• value1, value2. New values to be written to the corresponding module parameters.

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 as a separate field or inside a widget (for example, Columns), an error message will appear when you try to delete it.