User Tools

Site Tools


parameters

This is an old revision of the document!


Project parameters

(available from version 1.6)

Parameters can be used to parametrize project calculation (e.g. file names, dates, multipliers and ratios in expressions, etc.).

Parameter editor

Parameters can be created, edited and removed using parameter editor available from menu Project or invoked by pressing F6.

Parameter types

Parameters can be of several types:

  • Text or number
  • File name - this parameter type is just like a text parameter but for convenience the input box has buttons for opening file browser and triggering absolute/relative paths
  • Date - it's a number parameter that supposed to indicate a date that can be chosen using a date picker (calendar)
  • Calculated parameter can be calculated using expressions. Although some restrictions apply – expressions used for calculated parameters can't have field names and other calculated parameters.

Required parameters

Any parameter except calculated parameters can be marked as required using respective checkbox in parameter editor. All required parameters are prompted on full project runs – i.e. when running a project with all transformations not calculated (e.g. right after opening a project) or when performing Reload and Run.

Command line execution

Parameter values can be defined from command line. If a project has required parameters they must be defined if running in command line mode. Defining non-required parameters are optional, if such parameter wasn't defined it's default value will be used instead. Calculated parameters can't be defined from command line. New parameters can't be created from command line. See command line syntax for more details.

parameters.1431894701.txt.gz · Last modified: 2015/05/17 16:31 by dmitry

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki