t_PageType_Tab_PortletRef

PortletRef

Properties

augment : uiIdentifier

Name of a portlet in the augmented workspace to insert after.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter. Case and length are not restricted. Letters and numbers are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

layout : string

JSON formatted properties that control the Portlet's layout behaviours.

span:<integer> - view width in columns
off:<integer>  - offset in columns from the previous view (or from
                 the first column in a fluid layout)
head:<boolean> - true ensures that the view is placed in the first
                 column. A new row may be started to achieve this.
card:<none/max>- mainly for AFL portlets. 'none' will place card
                 holder html elements (divs of -card and -card-body
                 classes at the time of writing) around the content.
                 'max' will simply insert the content. A common use
                 is for React rendered AFL portlets.  To add
                 appropriate padding back in, one may use -card and
                 -card-body classes in the control's rendering code.

Example: layout="span:2"

name : uiIdentifier

The portlet reference name.

The name should follow development naming standards.

Note: Note that the name properties of the portlet refs should be unique within the page. The reason for this is to allow automated testing tools to find the right location.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter. Case and length are not restricted. Letters and numbers are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

portlet : string

The referenced portlet name.

The portlet reference may be one of:

- MDA portlet name. e.g. portlet="training:EntityDetail"
- AFL module name containing “/” e.g. portlet=“app/radio” (only valid from Workspaces)
- URL to a remote portlet. e.g. portlet="http://www.myserver.com/myApp.html" (only valid
from Workspaces)

Note: For remote portlets, the following syntax is supported.

- root:/ - prefix for URL, provides the current server context
    e.g. root:/myApp.html
- ${<contextVar>} - querystring parameter for context variable values
    e.g. root:/myApp.html?EntityId=${EntityId}
- ${=<contextVar>} - convenient shorthand for the previous syntax.
    e.g. root:/myApp.html?${=EntityId}

- $ - querystring parameter to set background to transparent
e.g. http://www.myserver.com/myApp.html?${=EntityId}&$
- $=max - instructs the AFL-based portlets that they should maximize the IFRAME area.

See: Portlet

required : boolean

True if portlet access is required for workspace access. If the user has no view privileges for a required portlet, the whole workspace will be hidden. Navigator portlets are allways required.

Parents

t_PageType_Tab - A page may contain any number of tabs to present and group portlets.

Parent topic: t_PageType_Tab