Parameters
There are two types of parameters: Standard parameters and input variables. Read more about those below.
You can add parameters thorughout the numerous platform. Here are the places where you can add parameters and input variables:
| Place | Type |
|---|---|
| Tools | Parameter |
| Jobs | Parameter |
| Components | Parameter and input variables |
| Projects under Project Templates | Parameter |
| Groups under Project Templates | Parameter |
Parameters
Parameters are general parameters you can specify for the systems, jobs and components. The parameter values can be set when added under the system or they can be set and changed under the scenario depending on the access setting as explained below.
ID
The reference value for the parameter. This is used when the parameter is referenced in code and by other components and scenarios.
Display name and tooltip
The names users of scenarios sees.
Type
The value type of the parameter:
| Type | Description |
|---|---|
| number | Floatingpoint number, eg. 1.2345678E5. |
| string | UTF-8 string max 1MB of characters. |
| boolean | True/false. |
| selecter | Configure values for a dropdown. Unlimited. |
| month | Select a month. |
| config | Configuration. Plain text. UTF-8 string max 1MB of characters. |
| file | Allows the users of scenarios to upload a file. Max 1MB. |
| table | Configure a table. Under parameters you can set the columns and the users of scenarios can add the rows. |
| time_value | Set a time duration value. Seconds, minutes, hours, days, months, years. |
| json | JSON input. UTF-8 string max 1MB of characters. |
| reference |
Tag/Setup
This is uses for some input types.
Default value
This is the default value of the parameter. I can be changed on the scenario page depending on the access setting.
Access
Access defines how the parameter is accessed on the scenario page:
| Type | Description |
|---|---|
| normal | The parameter can be accessed and changed on the scenario page |
| fixed | The parameter can be access but not changed on the scenario page |
| advanced | |
| hidden | The parameter is hidden like a password on the scenario page |
Input variables
Input variables are used as inputs for scientific and engineering calculations. When used thay always have a value and an attached unit of measurement.
ID
The reference value for the parameter. This is used when the parameter is referenced in code and by other components and scenarios.
Display name and tooltip
The name and tooltip users of scenarios sees.
Unit
The scientific unit of measurement for the input variable.
Standard value
The value of the input variable. Input variables always have a value. You can use scientific notation like 1.3E5.