9.178 PUT_WEB_COMPONENT

Note: Built-In Function Rules     Usage Options

Programmatically (re)build an HTML Web Component. Refer to the Components in the Web Functions Guide for information about Web Components.

Use this Built-In Function when you want to generate handcrafted web components at execution time. Note that there is no validation of the component page text; it is your responsibility to verify that your web components work as expected.

This Built-In Function only supports page, script, text, and visual components.

Any existing component will be replaced unless the existing component is of an unsupported type, in which case an error will occur.

If a component already exists the function will fail if the existing component is not of the same type as the one used in this function.

Arguments

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Req

Web Component

1

20

 

 

2

A

Req

Mode. Possible values are:
I: Input
O: Output
N: Not applicable.

1

1

 

 

3

A

Req

Type. Possible values are:
P: Page
S: Script
T: Text
V: Visual.

1

1

 

 

4

A

Req

Description

1

40

 

 

5

L

Req

Working list containing component page text. For a Text component, the working list should only have one entry.

255

255

 

 

6

A

Opt

Page
Defaults to same as component.
Generally, you should leave as default.

1

20

 

 

7

A

Opt

Language
Default is current language
For non-multilingual partitions this should be 'NAT'
*DFT - partition default language.

4

4

 

 

8

A

Opt

Roll sets? (Y/N)
Default is N.

1

1

 

 

 

Return Values

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Opt

Possible values are:
OK: Build completed normally.
ER: Build encountered an error.

1

2