Parameters
What is a Parameter?
Parameters are variables defined at different levels of the Project configuration that can be used to dynamically set the values of queries in DataView refresh scripts, replace column names in Data Transfer and other bespoke implementations.
How are Parameters defined?
Parameters are defined in a hierarchy of Parameter Stores going from the DataView all the way to the Viewer. They are primarily accessible when configuring DataView, under the button Define Parameters, but third party extensions providers can also provide access to parameters in other relevant places.
When a Parameter is required by BimSens, its value is first looked up in the leaf node of the Store hierarchy for the current context, most often the DataView. If the Parameter definition is not found in the DataView, it is looked up in the parent Store: the DataSource. Then the Project and ultimately the Viewer. This cascading is referred to as Parameter Inheritance.
Examples of Parameter Use
- Select a Parameter instead of column names when running Data Export, for instance to include the {ModelFileName} or {ModelFileDate} as a field in your data set
- Use a custom item property Parameter in Navisworks to filter a SQL Read Query based on the selection, e.g. SELECT * FROM AttributesTable WHERE Id = '{Element.Id}'
- Use a system Parameter from Navisworks to query assets from an AIMS database
Using Configurations
Configurations define values override for parameters in a Parameter Store. Multiple Configurations can be created with different override to create different environments.
With SQL DataSource for instance, Configuration can be used to filter the source data depending on the parameter, or even target different database or server.
To create a Configuration:
- Open the Project Configuration dialogue and click the Configuration button to open the Parameters dialogue.
- In the Parameters dialogue under the Configurations section, click the Create button.
RESTRICTIONS ON CONFIGURATIONS |
|
Configurations are only supported at the Project level at this time |
- Add a row for each Parameter to override and specify the new Expression to use to override the default value.
NO PARAMETER AVAILABLE |
|
Only user defined parameters can be overridden. If no parameter is available in the drop down selection, return to the Parameter dialogue to add at least one. |
- Upon returning to the Parameters dialogue, the Configuration(s) created can be selected from the Configurations drop down, along with the <Default> values. Selecting a configuration will highlight the parameters that are being overridden. in the grid
- Check the option Show Configurations Selector in the App to make the Configurations drop down visible for selection directly into the main BimSens control.