Skip to content

Commit a27ecb4

Browse files
committed
Review: Address review comments, update parameter page text, adds mappings screenshot
1 parent d95dee9 commit a27ecb4

File tree

3 files changed

+12
-10
lines changed

3 files changed

+12
-10
lines changed

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

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,41 +7,43 @@ weight: 70
77

88
## Introduction
99

10-
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.
10+
Parameters are the means by which you pass data to your page. When a page is loaded, the parameters are filled with the current values.
1111

12-
If you want to use an object or primitive in your page, use the parameter. In the image below, the parameter name is **CustomerName** is of **Type** `string`, is not **Required** and has a **Default value** shown in string empty.
12+
If you want to use an object or primitive in your page, use a parameter. In the image below, the parameter's name is **CustomerName** is of **Type** `string`, is not **Required** and has a **Default value** shown in string empty.
1313

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

16-
## Common Section
16+
## Output Section
1717

18-
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.
18+
### Name
1919

20-
## Output Section
20+
**Name** refers to the name of the parameter.
2121

2222
### Data Type
2323

24-
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.
24+
The data type of a parameter defines the type of the value that it expects. Possible data types are **objects**, and **primitives** such as `Boolean`, `Date and time`, `Decimal`, `Enumeration`, `Integer/Long`, and `String`.
2525

2626
Default: *Object*
2727

2828
### Argument {#argument}
2929

30-
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.
30+
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.
3131

3232
#### Default Value
3333

34-
When an argument is set to **optional**, a default value can be set:
34+
When an argument is set to **optional**, a default value can be set. When a default value is set if the parameter is omitted, the default value will be used. In the example below, if the parameter is omitted by the user an empty string `''` will be used for the parameter.
3535

3636
{{< figure src="/attachments/refguide/modeling/pages/page/page-parameter-default-value.png" max-width=70% >}}
3737

3838
{{% alert color="info" %}}
3939
The default value is used when the argument is omitted, not when the argument value is `empty`.
4040
{{% /alert %}}
4141

42-
### Name
42+
## Passing Arguments from a caller
4343

44-
**Name** refers to the name of the parameter.
44+
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.
45+
46+
{{< figure src="/attachments/refguide/modeling/pages/page/page-parameter-mappings.png" width="500px" >}}
4547

4648
### Variable Arguments
4749

24 KB
Loading
9.37 KB
Loading

0 commit comments

Comments
 (0)