uPortal framework reserves the use of HTTP request parameters, whose names start with the “uP_” substring. In this space, uPortal defines a parameter syntax that can be used by either channels or theme/structure stylesheets to communicate a limited set of events to the core uPortal classes.
• syntax is given in a standard regular expression form.
• {x} denotes a value of some variable x
• a & b denotes that two parameter-value pairs (‘a’ and ‘b’) are being passed with the request.
• all other words are literal strings
Activate uPortal channel actions (help, about and edit):
• (uP_help_target={channelSubscribeId})*
• (uP_about_target={channelSubscribeId})*
• (uP_edit_target={channelSubscribeId})*
Remove a particular target (folder or a channel):
• (uP_remove_target=({folderId}|{channelSubscribeId}))*
Set a detach target10(folder or channel):
• (uP_detach_target=({folderId}|{channelSubscribeId}))?
Persist current state of the user layout and/or preferences:
• (uP_save=(all|preferences|layout))?
Tell structure/theme transformation to focus on a particular channel:
• (uP_root=(me|{channelSubscribeId})?
Set the value of structure or theme stylesheet parameter:
• (uP_sparam={pName} & {pName}={pValue})*
• (uP_tparam={pName} & {pName}={pValue})*
Set value(s) of structure folder attribute(s):
• (uP_sfattr={attName} & {attName}_folderId={folderId} & {attName}_value={attValue})*
Set value(s) of structure channel attribute(s):
• (uP_scattr={attName} & {attName}_folderId={folderId} & {attName}_value={attValue})*
Set value(s) of theme channel attribute(s):
• (uP_tcattr={attName} & {attName}_channelId={channelSubscribeId} & {attName}_value={attValue})*
10If detach target is set to something other then root, a <layout_fragment> containing the target node will be processed with the structure transformation instead of the entire layout.