Skip to main content
Pentaho Documentation

Parameter

Below are the attributes associated with the parameter property:
Attribute Name Purpose Possible Values
auto-submit Determines if the report when it runs uses parameter interface in the Pentaho User Console. Boolean, undefined, or prompt; default is undefined. If set to true, the report runs when any control is updated in the parameter interface. If set to false, the report does not run when any control is updated in the parameter interface. It runs when the Update button is selected. If set to undefined displays the auto-submit checkbox in the parameter interface so the user can control when they want to use the option. The initial state of the checkbox is determined by the auto-submit-default attribute. If set to prompt, displays the Auto Submit checkbox in the parameter interface so the user can control when to use the option. The initial state of checkbox is determined by the auto-submit-default attribute.
parameter-layout Set parameter display in the Pentaho User Console. Selection; default is vertical — vertical adds each selection control into separate rows; horizontal adds each selection control into the same row; flow adds each selection control into the same row and wraps them when space is limited.
show-parameter-ui Determines whether the parameter interface will display in the Pentaho User Console Boolean; default is false.
auto-submit-default Sets the state of the auto submit checkbox on the parameter interface. Boolean, undefined; default is false. If true or undefined, the auto submit checkbox will be enabled. If false, the auto submit check box will be disabled.