Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

Properties Defined dlm:property tag explained.
Fragments Defined dlm:fragment tag explained.
Roles Defined dlm:role tag explained.
Audiences Defined dlm:audience tag explained.

dlm.xml
<managedLayoutFragments xmlns:dlm="http://www.campuspipeline.com/uportal/dlm">

  <dlm:property name='defaultLayoutOwner' value='fragmentTemplate'/>
  <dlm:property name='layoutDecorator' value='com.pipeline.uportal.dlm.provider.CpLayoutDecorator'/>
  <dlm:property name='campuspipeline.uportal.dlm.debug' value="false"/>
  
  <!-- Controls clearing of dlm fragment cache.  This allows changes  made to layout
  owners to be reflected once the cache has been updated.  Specified in minutes. -->
  
  <dlm:property name='campuspipeline.uportal.dlm.fragment_cache_refresh' value="60"/>

  <dlm:fragment name='Faculty' ownerID='faculty-lo' precedence='50'>
   <dlm:role>faculty</dlm:role>
   <dlm:audience evaluatorFactory='com.pipeline.uportal.dlm.provider.CPPersonEvaluatorFactory'>
     <attribute name='role' mode='equals' value='faculty'/>
   </dlm:audience>
  </dlm:fragment>

  <dlm:fragment name='All Users' ownerID='allusers-lo' precedence='100'>
   <dlm:audience evaluatorFactory='campuspipeline.uportal.dlm.provider.AllUsersEvaluatorFactory'/>
  </dlm:fragment>

  <dlm:fragment name='Students' ownerID='student-lo' precedence='100'>
   <dlm:role>student</dlm:role>
   <dlm:audience evaluatorFactory='com.pipeline.uportal.dlm.provider.CPPersonEvaluatorFactory'>
     <paren mode="AND">     
       <attribute name='role' mode='equals' value='student'/>
       <paren mode="NOT">
         <attribute name='role' mode='equals' value='faculty'/>
       </paren>
     </paren>
   </dlm:audience>
 </dlm:fragment>
  
  <dlm:fragment name='Employee' ownerID='employee-lo' precedence='30'>
   <dlm:role>employee</dlm:role>
   <dlm:audience evaluatorFactory='com.pipeline.uportal.dlm.provider.CPPersonEvaluatorFactory'>
     <attribute name='role' mode='equals' value='employee'/>
   </dlm:audience>
  </dlm:fragment>

</managedLayoutFragments>

Properties Defined

There are currently four properties understood by the DLM infrastructure.

Property

Description

defaultLayoutOwner

The user account whose layout will be used to perform a cookie cutter copy for newly created fragment owner accounts when they first log in. This concept is similar to the usertemplate account for new uPortal users.

layoutDecorator

The fully qualified name of a class that is delegated to by the DLM infrastructure immediately after all layout merging has taken place at log-in time. This class can then add layout information and is used to implement the cp:info functionality. PersonDirs.xml can replace nearly all cp:info functionality.

campuspipeline.uportal.dlm.debug

You can guess what this property was for. It was a way to turn on debugging in the DLM infrastructure without incurring scrolling blindness by turning on debugging system wide in uPortal. With the switch to commons logging and log4j this is no longer needed.

'campuspipeline.uportal.dlm.fragment_cache_refresh

As noted in the comment this value indicates how often changes are reloaded that are made to the layouts of fragment owner accounts.

Fragments Defined

The <dlm:fragment> element has four attributes.

Attribute

Description

name

A required unique name by which this fragment is known

ownerID

The required login id of the user who owns the distributed layout and hence can edit the layout.

precedence

A required positive, decimal number or zero. Negative numbers are not allowed. This number is used to indicate the ordering of layouts for a user during their layout construction sequence. When a user logs in the system asks each distributed layout if it is applicable to that user. (See Audiences Defined below.) Those that answer yes are placed in a layout construction sequence in order of precedence, the higher the number the higher the precedence and the earlier the layout will be merged into the user's viewed or constructed layout. Layouts merged in prior to other layouts have higher precedence and hence can restrict actions taken by layouts merged in later enforcing such things as position for their elements. A user's personal layout fragment, that portion representing changes made to incorporated layouts, has a precedence of zero. If two or more layouts have the same value then their precedence is determined by their order in this file. Those at the top have higer precedence than those appearing later.

defaultLayoutOwner

This is an optional attribute. If included then it identifies the default user whose layout is copied for this fragments layout when the fragment owner first logs in. If not included it defaults to the value of the only defined property element of the same name declared in this file. If neither is defined then the default is the user indicated by the org.jasig.portal.services.Authentication.defaultTemplateUserName property in portal.properties.

The <dlm:fragment> element contains zero to many <dlm:audience> elements or comments.

Roles Defined

Coming soon....

Audiences Defined

Coming soon....

  • No labels