Skip to main content

Veritran Docs

Parameters

Parameters are configuration sets for the different components of your apps in Studio. They can be designated as Global parameters or Site parameters, depending on whether their value should apply to all the apps within the Studio environment (Global scope) or be customized for each specific app (Site scope).

The Parameters page shows a list of all the parameters in your Studio environment, and allows you to create, edit, import and export parameters. To access it, click Global > Parameters. Refer to the annotated image below to learn more.

parameters_update.png
  1. Search bar. Find a parameter by typing its ID, description, type or value.

  2. Parameters list. See a list of all parameters divided into the following sections:

    ID

    ID given to the parameter.

    Description

    Basic information about the parameter.

    Type

    Type of parameter chosen depending on the value it represents. It can be numeric, string, boolean or array.

    Value

    Value assigned to the parameter.

    Scope

    Shows if the parameter is a Global or Site parameter.

  3. Actions. Each icon is explained in order of appearance in the table below.

    Select All/None

    Click to select or deselect all the parameters.

    Export

    Click to export the parameter or parameters selected as an .xml file.

    Delete

    Click to delete a selected parameter. Note that this option will be unavailable if you have more than one parameter selected.

    Edit

    Click to edit the attributes of the selected parameter. Note that this option will be unavailable if you have more than one parameter selected.

    Import

    Click to import a parameter in .xml format. In the file explorer that opens, find the configuration file of your parameter in .xml format. Select your file and click Import.

    New

    Click to create a new parameter.

    Note

    Parameters are not sorted alphabetically by their Id. Click the up or down arrows in any of the columns to organize the list in ascending (A to Z) or descending (Z to A) order.

Double-click any parameter in the list to edit it. To learn more about how to edit parameters, read Create or Edit Parameters.