> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/pba-report-designer/attributes-reference-cp-prd/parameter.md).

# Parameter

The following attributes belong to the `parameter` property:

| Attribute Name          | Data Type | Definition/Values                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ----------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **auto-submit**         | Boolean   | <p>Determines whether the report uses the parameter interface in the Pentaho User Console (PUC) when it runs. The values are:</p><ul><li><strong>True</strong></li></ul><p>When set to <code>True</code>, the report runs when any control is updated in the parameter interface.</p><ul><li><strong>False</strong></li></ul><p>When set to <code>False</code>, the report does not run when a control is updated in the parameter interface. The report runs when you select the <strong>Update</strong> button.</p><ul><li><strong>undefined</strong></li></ul><p>(Default). When set to <code>undefined</code>, 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 <code>auto-submit-default attribute</code>.</p> |
| **auto-submit-default** | Boolean   | <p>Sets the state of the auto submit checkbox on the parameter interface. The values are:</p><ul><li><strong>True</strong></li></ul><p>When set to <code>True</code> or <code>undefined</code>, the auto submit checkbox is enabled.</p><ul><li><strong>False</strong></li></ul><p>(Default): When set to <code>False</code>, the auto submit check box is disabled.</p><ul><li><strong>undefined</strong></li></ul><p>When set to <code>True</code> or <code>undefined</code>, the auto submit checkbox is enabled.</p>                                                                                                                                                                                                                                                                                                                   |
| **parameter-layout**    | Selection | <p>Sets the parameter display in Pentaho User Console. The values are:</p><ul><li><strong>vertical</strong></li></ul><p>The <code>vertical</code> value adds each selection control into separate rows (Default).</p><ul><li><strong>horizontal</strong></li></ul><p><code>Thehorizontal</code> value adds each selection control into the same row.</p><ul><li><strong>flow</strong></li></ul><p>The flow value adds each selection control into the same row and wraps them when space is limited.</p>                                                                                                                                                                                                                                                                                                                                   |
| **show-parameter-ui**   | Boolean   | <p>Determines whether the parameter interface will display in Pentaho User Console. The values are:</p><ul><li><strong>True</strong></li></ul><p>When set to <code>True</code>, the parameter interface displays.</p><ul><li><strong>False</strong></li></ul><p>(Default). When set to <code>False</code>, the parameter interface does not display.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.pentaho.com/pba-report-designer/attributes-reference-cp-prd/parameter.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.