Portal

Portal

Declares the application's structure, including its set of workspaces. Model Server serves the application at *serverRoot*/ui/portal/*portalName*.

Properties

augment : uiIdentifier

Name of a portal to augment.

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.

caption : string

Name of the application in the browser title bar.

This should be a stringId for internationalization.

image : string

Navigation Drawer background image. The image typically comes from the images metadata folder.

Example

“image:buildingsky.jpg”

Content

• Sequence of:

  • Portal_Search [0..1]

  • Portal_Tool [0..*] - Tools appear in the Global Actions section of the Application Toolbar.

  • Portal_WorkspaceRef [0..*] - A Portal Application contains a list of Workspaces each of which declare the UX content, layout, and behaviour for an application feature.

  • Portal_Drawer [0..*] - References to Portlets to display in the Application Drawer area.

  • Portal_Broker [0..1] - A reference to a portal that is not visible, but provides orchestration and state capabilities to the portal application.

Example

xml
<Portal caption="idsa.Contact.caption" image="image:buildingsky.jpg">
   <Tool name="toolPreview" caption="ids.preview" icon="icon:remove_red_eye" event="sysPreview"/>
   <Tool name="toolNotifications" caption="ids.notifications" icon="icon:notifications" event="setSidebar" parameter="NOTIFICATIONS"/>
   <WorkspaceRef name="Home" workspace="mda:Home"/>
   <WorkspaceRef name="Contacts" workspace="mda:Contacts"/>
   <WorkspaceRef name="Schedule" workspace="mda:Schedule"/>
   <WorkspaceRef name="Task" workspace="mda:Task"/>
   <WorkspaceRef name="Opportunity" workspace="mda:Opportunity"/>
   <Drawer name="refNotifications" portlet="mda:Sidebar" event="setSidebar"/>
   <Drawer name="refEntityPreview" portlet="mda:EntityPreview" event="sysPreview" case="Entity"/>
   <Drawer name="refOpportunityPreview" portlet="mda:OpportunityPreview" event="sysPreview" case="BaseOpportunity"/>
   <Drawer name="refActPreview" portlet="mda:ActPreview" event="sysPreview" case="Act"/>
</Portal>

• Portal_Search
  

• Portal_Tool
  Tools appear in the Global Actions section of the Application Toolbar.

• Portal_WorkspaceRef
  A Portal Application contains a list of Workspaces each of which declare the UX content, layout, and behaviour for an application feature.

• Portal_Drawer
  References to Portlets to display in the Application Drawer area.

• Portal_Broker
  A reference to a portal that is not visible, but provides orchestration and state capabilities to the portal application.

Parent topic: references