Skip to main content
Pentaho Documentation

Parameter

Below are the attributes associated with the parameter property:
Attribute Name Data Type Definition/Values
auto-submit Boolean

Determines whether the report uses the parameter interface in the Pentaho User Console (PUC) when it runs. The values are:

  • True: When set to True, the report runs when any control is updated in the parameter interface.
  • False: When set to False, the report does not run when a control is updated in the parameter interface. The report runs when you select the Update button.  
  • <undefined> (Default). When set to undefined, the auto-submit checkbox displays in the parameter interface so you can control when you want to use the option. The initial state of the checkbox is determined by the auto-submit-default attribute.
auto-submit-default Boolean

Sets the state of the auto submit checkbox on the parameter interface. The values are:

  • True: When set to True or undefined, the auto submit checkbox is enabled.
  • False (Default): When set to False, the auto submit check box is disabled.
  • <undefined> When set to True or <undefined>, the auto submit checkbox is enabled. 
parameter-layout Selection

Sets the parameter display in PUC. The values are:

  • The vertical value adds each selection control into separate rows (Default).
  • The horizontal value adds each selection control into the same row.
  • The flow value adds each selection control into the same row and wraps them when space is limited.
show-parameter-ui Boolean

Determines whether the parameter interface will display in PUC. The values are:

  • True: When set to True, the parameter interface displays.
  • False (Default). When set to False, the parameter interface does not display.