Draft: [WTF-2288]: Documentation update for page parameters #10472

stdagkalakis · 2025-12-09T16:06:50Z

The documentation for optional and primitive page parameters which is introduced at 11.6

CLAassistant · 2025-12-09T16:07:03Z

All committers have signed the CLA.

content/en/docs/refguide/modeling/pages/page/page-parameter.md

weirdwater · 2025-12-10T09:09:03Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+## Introduction
+
+Parameters are the means by which you pass data to your logic. When a page is loaded, the parameters are filled with the current values.


Here it still says "logic", should be page I think.

I am not really happy with the introduction. I will cook a bit longer on an alternative.

content/en/docs/refguide/modeling/pages/page/page-parameter.md

weirdwater · 2025-12-10T09:12:30Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+## Common Section
+
+The **Documentation** property can be used to store developer documentation. This can be used to explain to other developers about the parameter. End-users will never see this documentation.


Do we have documentation for page parameter?

✅ (I can't resolve this thread)

weirdwater · 2025-12-10T09:16:31Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+### Data Type
+
+The data type of a parameter defines the type of the value that it expects. See [Data Types](/refguide/data-types/) for the possible data types.


I believe we do not support all datatypes for page parameters. Readers can still refer to the linked page for more information, but we should enumerate which are supported.

✅ (I can't resolve this thread)

weirdwater · 2025-12-10T09:20:28Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+### Argument {#argument}
+
+Determines whether the argument is optional or required. When the argument is set to be **Optional**, it can be omitted when opening the page. When the argument is set to be **Required**, an argument must be passed.


I think it is important to stay consistent with terminology here. The page has a parameter, which can be made required or optional. If it is required it is mandatory to supply an argument for that parameter when opening a page.

Perhaps:

Determines whether it is required or optional to pass an argument to the parameter when opening the page.

weirdwater · 2025-12-10T09:23:21Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+#### Default Value
+
+When an argument is set to **optional**, a default value can be set:


I am missing an explanation on what the default value does and when it is used.

The text now states: "if the parameter is omitted by the user..." but the user has no choice in this. I would rewrite the sentence to:

Given the example below, if no argument is passed for CustomerName, the page will open with the parameter set to ''.

…pings screenshot

weirdwater · 2025-12-10T15:11:47Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

@@ -0,0 +1,58 @@
+---
+title: "Parameter"


Considering the sibling page "Page Properties" and the other "Parameters" page, I would rename this to "Page Parameters"

weirdwater · 2025-12-10T15:12:35Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+The page has a parameter, which can be made required or optional. If it is required it is mandatory to supply an argument for that parameter when opening a page.
+
+#### Default Value


This section is indented one level too deep.

weirdwater · 2025-12-10T15:13:36Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+{{< figure src="/attachments/refguide/modeling/pages/page/page-parameter.png" class="no-border" >}}
+
+## Output Section


This section title does not make sense. Maybe "Properties" or "Options" makes more sense?

Would "Mappings" make more sense? I see we use the term, in other sections like "Import Mappings".

weirdwater · 2025-12-10T15:15:50Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+{{< figure src="/attachments/refguide/modeling/pages/page/page-parameter-default-value.png" max-width=70% >}}
+
+{{% alert color="info" %}}
+ The default value is used when the argument is omitted, not when the argument value is `empty`.


I think it might make sense to make it clear what app-lifetimes we are talking about. But I am not sure if it is clear.

The default value is used when the argument is omitted during modeling. Not when the argument value is empty during runtime.

weirdwater · 2025-12-10T15:18:09Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+ The default value is used when the argument is omitted, not when the argument value is `empty`.
+{{% /alert %}}
+
+## Passing Arguments from a caller


Maybe just "Passing Arguments" is sufficient

weirdwater · 2025-12-10T15:27:06Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+## Passing Arguments from a caller
+
+When using an **Show page** action form a microflow, nanoflow or button, you can pass arguments in two primary ways, depending on the data type of the argument.


Arguments are passed to page parameters when a page is opened. For example, using a Show page action on a widget event or in a microflow. For each parameter the page has an argument can be configured. It is only necessary to pass arguments to required parameters.

weirdwater · 2025-12-10T15:30:18Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+## Introduction
+
+Parameters are the means by which you pass data to your logic. When a page is loaded, the parameters are filled with the current values.


I am not really happy with the introduction. I will cook a bit longer on an alternative.

weirdwater · 2025-12-10T15:33:27Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+### Variable Arguments
+
+Variable arguments are used to pass parameters from the context to the page. This is done by selecting the desired `arguments` from the dropdown. **Optional** can be omitted by selecting `(None)` .


Suggested change

Variable arguments are used to pass parameters from the context to the page. This is done by selecting the desired `arguments` from the dropdown. **Optional** can be omitted by selecting `(None)` .

Variable arguments are used to pass parameters from the context to the page. This is done by selecting from the available variables on the page presented in the dropdown. **Optional** parameters don't require an argument and can be omitted by selecting `(None)` .

weirdwater · 2025-12-10T15:33:53Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+{{< figure src="/attachments/refguide/modeling/pages/page/page-parameter-argument-variable.png" max-width=70% >}}
+
+### Expression-Based Arguments (All Data Types)


Suggested change

### Expression-Based Arguments (All Data Types)

### Expression-Based Arguments

weirdwater · 2025-12-10T15:35:09Z

content/en/docs/refguide/modeling/pages/page/page-parameter.md

+
+### Expression-Based Arguments (All Data Types)
+
+Primitive values, such as strings, booleans, and enumerations, can be passed as expressions. This method allows users to use functions and follow associations within the expression to set the argument values. Using expressions for arguments provides flexibility in setting values and improves the functionality of pages. In the example below, the page has an parameter **AnimalName** which is populated by the **Name** member of the provided **Animal** object. 


I think it would also be possible to pass an object using an expression. But I would need to try to be sure.

Need to decide if I should bold any other terms

WIP: Add page parameter page and screenshots

d95dee9

weirdwater suggested changes Dec 10, 2025

View reviewed changes

Review: Address review comments, update parameter page text, adds map…

a27ecb4

…pings screenshot

weirdwater suggested changes Dec 10, 2025

View reviewed changes

weirdwater reviewed Dec 10, 2025

View reviewed changes

Review: fix more comments

0930f54

stdagkalakis force-pushed the wtf-2288-doc-update-for-primitive-and-optional-page-parameters branch from 8fff48e to 0930f54 Compare December 11, 2025 10:57

MarkvanMents requested a review from ConnorLand December 11, 2025 13:02

MarkvanMents assigned ConnorLand Dec 11, 2025

MarkvanMents added the Needs language review label Dec 11, 2025

ConnorLand added the 11.6 label Dec 11, 2025

Edit

b8c37e9

Need to decide if I should bold any other terms


		## Introduction

		Parameters are the means by which you pass data to your logic. When a page is loaded, the parameters are filled with the current values.


		## Common Section

		The Documentation property can be used to store developer documentation. This can be used to explain to other developers about the parameter. End-users will never see this documentation.


		### Data Type

		The data type of a parameter defines the type of the value that it expects. See [Data Types](/refguide/data-types/) for the possible data types.


		### Argument {#argument}

		Determines whether the argument is optional or required. When the argument is set to be Optional, it can be omitted when opening the page. When the argument is set to be Required, an argument must be passed.


		#### Default Value

		When an argument is set to optional, a default value can be set:


		The page has a parameter, which can be made required or optional. If it is required it is mandatory to supply an argument for that parameter when opening a page.

		#### Default Value


		{{< figure src="/attachments/refguide/modeling/pages/page/page-parameter.png" class="no-border" >}}

		## Output Section


		## Passing Arguments from a caller

		When using an Show page action form a microflow, nanoflow or button, you can pass arguments in two primary ways, depending on the data type of the argument.


		### Variable Arguments

		Variable arguments are used to pass parameters from the context to the page. This is done by selecting the desired `arguments` from the dropdown. Optional can be omitted by selecting `(None)` .


		{{< figure src="/attachments/refguide/modeling/pages/page/page-parameter-argument-variable.png" max-width=70% >}}

		### Expression-Based Arguments (All Data Types)

	### Expression-Based Arguments (All Data Types)
	### Expression-Based Arguments


		### Expression-Based Arguments (All Data Types)

		Primitive values, such as strings, booleans, and enumerations, can be passed as expressions. This method allows users to use functions and follow associations within the expression to set the argument values. Using expressions for arguments provides flexibility in setting values and improves the functionality of pages. In the example below, the page has an parameter AnimalName which is populated by the Name member of the provided Animal object.

Draft: [WTF-2288]: Documentation update for page parameters #10472

Are you sure you want to change the base?

Draft: [WTF-2288]: Documentation update for page parameters #10472

Conversation

stdagkalakis commented Dec 9, 2025

Uh oh!

CLAassistant commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weirdwater Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

CLAassistant commented Dec 9, 2025 •

edited

Loading

weirdwater Dec 10, 2025 •

edited

Loading