views_conf.dtd

OPIAM stands for Open Identity and Access Management. This Suite will provide modules for user & rig

<?xml version="1.0" encoding="ISO-8859-1" ?>
<!-- OPIAM Admin Views service DTD -->

<!-- 
        Definition of the set of views.
	label: Label displayed on the top level node of the tree.
	icon:  URL of the image displayed on the top level node of the tree.
        viewdef : Views definitions
        orgchartparams : OrgChart global parameters
 -->
<!ELEMENT viewdefs (viewdef+,orgchartparams?)>
<!ATTLIST viewdefs
	label CDATA #IMPLIED
	icon CDATA #IMPLIED
>

<!-- 
	Definition of a view.
	name:     name of the view, must be unique
	dynamic:  if true, each view node is loaded from the directory each time the node is expanded.
                  if false, each view node is loaded from the directory the first time the node is expanded, and next
                  expansions redisplay data from memory.
                  Beware that dynamic views may impact performance a lot.
	plugin:   name of the views plugin. OPIAM Admin delivers two plugins: 
				 - Logical views plugin: opiam.admin.faare.service.services.views.plugins.LogicalTreeView
				 - Physical views plugin: opiam.admin.faare.service.services.views.plugins.PhysicalTreeView
	expandUrl: URL associated with the expansion of the nodes in this view
	label:     Label displayed on the base node of this view
	icon:      URL of the image associated with the base node of this view
	labelUrl:  URL associated with the label of the base node of this view
        viewdef_profiles : profiles which are allowed to see the view
        param : view specific parameters
        objectview : objects displayed in this view
        level : definition of view levels, for a logical view
 -->
<!ELEMENT viewdef (viewdef_profiles?, param*, objectview+, level*)>
<!ATTLIST viewdef
	name CDATA #REQUIRED
	dynamic (false | true) #REQUIRED
	plugin CDATA #REQUIRED
	expandUrl CDATA #REQUIRED
	label CDATA #REQUIRED
	labelURL CDATA #IMPLIED
	icon CDATA #REQUIRED
>

<!-- 
	List of profiles which are allowed to see a view.
 -->
<!ELEMENT viewdef_profiles (viewdef_profile+)>

<!-- 
	Profile which is allowed to see a view.
	name: name of the profile (as defined in profiles_config.xml)
 -->
<!ELEMENT viewdef_profile EMPTY>
<!ATTLIST viewdef_profile
	name CDATA #REQUIRED
>

<!-- 
	View specific parameter. Currently : used to refine the LDAP base of the view
	param-name:     ldap-base
	param-value:    LDAP base for the view.
-->
<!ELEMENT param (param-name, param-value)>
<!ELEMENT param-name (#PCDATA)>
<!ELEMENT param-value (#PCDATA)>

<!-- 
	Definition of an objectview. This is an object displayed in the view.
	name: name of the objectview. Must be unique.
	resourceName: name of the corresponding resource (as defined in profiles_config.xml).
	orderBy: sort attribute.
	orderSort: unused, kept for compatibility reason.
	labelAtt: attribute used to carry the label of the nodes corresponding to this objectview.
	icon: URL of the image associated with the nodes corresponding to this objectview.
	size: used with "group" objectviews to set the size of the groups.
    minsize : used with the "group" objectviews to set the minimimum number of entries to generate "groups" nodes.
                  Default value is 1 (always generate "groups").
	labelUrl: URL associated with nodes label.
                  May be built from the current entry, with the following syntax :
                     $this."att"$.
                  Example: labelUrl="genericLoad.do?dn=$this.dn$"
	type: type of the objectview, in case it does not correspond to a resource. 3 kinds :
			- alpha: for alphabetical lists
			- group: for grouped lists
			- virtual: for virtual nodes (the node label is given in the value attribute)
	value: used with "virtual" objectviews to set the label of the node.
    target : indicates where to open the target URL :
               - open in new window                       : _blank ;
               - open in the parent frameset              : _parent ;
               - open in the same frame as it was clicked : _self ;
               - open in the full body of the window      : _top ;
               - open in the specified frame              :  name of the frame.
    orgChartAtt : list of attributes used in orgchart, in case the view is used for orgchart generation.
-->
<!ELEMENT objectview (orgChartAtt*)>
<!ATTLIST objectview
	name CDATA #REQUIRED
	ressourceName CDATA #IMPLIED
	resourceName CDATA #IMPLIED
	orderBy CDATA #IMPLIED
	orderSort CDATA #IMPLIED
	labelAtt CDATA #IMPLIED
	icon CDATA #REQUIRED
	minsize CDATA #IMPLIED
	size CDATA #IMPLIED
	labelUrl CDATA #IMPLIED
	type CDATA #IMPLIED
	value CDATA #IMPLIED
    target CDATA #IMPLIED
>

<!-- 
        Definition of attributes used for orgchart generation.
	name:     name of the attribute
	type:     one of:
           - name: the attribute is used to name the entries
           - photo: the attribute conveys a photo
-->
<!ELEMENT orgChartAtt EMPTY>
<!ATTLIST orgChartAtt
	name CDATA #REQUIRED
	type CDATA #IMPLIED
>

<!-- 
	Definition of a logical view level.
	name:     level name. Must be unique
	type:     "recursive" for a recursive level
        levelResource: objects displayed at this level.
-->
<!ELEMENT level (levelRessource|levelResource)*>
<!ATTLIST level
	name CDATA #REQUIRED
	type CDATA #IMPLIED
>

<!-- 
	Definition of a levelResource. This is an object displayed at a given level in a view.
	name:     name of the levelResource. Must be unique.
	value:    levelResource corresponding to a single entry, either given by its dname, or by a constant.
			  Example:
				- <levelResource name="interne" value="$CURRENT_USER$"/>
	objectview: name of the associated objectview.
	depends:    if set, the view displays this object only if one previous level displays the levelResource 
                    given as "depends" value.
	type:       "leaf" if the corresponding object never has subordinates.
        link: link or set of links with previous levels.
-->
<!ELEMENT levelResource (link*)>
<!ATTLIST levelResource
	name CDATA #REQUIRED
	value CDATA #IMPLIED
	objectview CDATA #IMPLIED
	depends CDATA #IMPLIED
	type CDATA #IMPLIED
>
<!--For compatibility-->
<!ELEMENT levelRessource (link*)>
<!ATTLIST levelRessource
	name CDATA #REQUIRED
	value CDATA #IMPLIED
	objectview CDATA #IMPLIED
	depends CDATA #IMPLIED
	type CDATA #IMPLIED
>

<!-- 
	Definition of a link with previous levels.
	type: link type. Allowed values are :
		- AND: allows to link current level with one of the upper levels.
			Examples: 

                        Constant value:			
				<link type="AND" value="this.ou=opiam.org"/> 

			Basic case where "super" means the previous level :
				<link type="AND" value="this.ou=super.ou"/> 
			
			Basic case with "*" meaning "begins with":
				<link type="AND" value="this.ou=super.ou*"/> 
			
			Link with an attribute from current user, referred to as "CURRENT_USER":
					  <link type="AND" value="this.id=$CURRENT_USER.id$"/> 
			
			Link with an attribute from an entry set by the application, referred to as "CURRENT_ITEM":
					  <link type="AND" value="this.id=$CURRENT_ITEM.id$"/> 
			
			Link with any level, referred to with its levelResource name:
					  <link type="AND" value="this.ou=levelresource1.ou"/>  

		- AND_NOT: the use is the same as the AND type, except that the filter is affected by the NOT operator.

		- member: allows to display the members of a group for example. 
			value: attribute giving membership 
			Example: <link type="member" value="uniquemember"/> 
			This displays all the entries which are in the "uniquemember" of the father node.
		
		- scope_base: allows to display a given entry (search with scope base) :
			Examples: <link type="scope_base" value="o=portal"/>
				  <link type="scope_base" value="super.dn"/>
		
		- scope_one_level: allows to display entries located one level under a given entry in the directory:
			Examples: <link type="scope_one_level" value="o=portal"/>
				  <link type="scope_one_level:" value="super.dn"/>
		
		- scope_subtree: allows to display all entries subordinate to a given entry in the directory.
			Examples: <link type="scope_subtree" value="o=portal"/>
				  <link type="scope_subtree:" value="super.dn"/>
					  
	value: see examples upper.
-->
<!ELEMENT link EMPTY>
<!ATTLIST link
	type CDATA #REQUIRED
	value CDATA #REQUIRED
>

<!-- 
     OrgChart parameters 
        cellColor : color components of the cells background, default : lightGray
        backgroundColor : color components of the orgchart background, default : white
        defaultPhoto : relative file name of the default photo, used when persons do not
                       have photos. If absent, no default photo is used.
                       The file path is given from the webapp directory.
  -->
<!ELEMENT orgchartparams (cellColor?, backgroundColor?)>
<!ATTLIST orgchartparams
        defaultPhoto CDATA #IMPLIED
>

<!-- color definition is given with red, green, blue components -->
<!ELEMENT cellColor EMPTY>
<!ATTLIST cellColor
          red CDATA #REQUIRED
          green CDATA #REQUIRED
          blue CDATA #REQUIRED
>

<!-- color definition is given with red, green, blue components -->
<!ELEMENT backgroundColor EMPTY>
<!ATTLIST backgroundColor
          red CDATA #REQUIRED
          green CDATA #REQUIRED
          blue CDATA #REQUIRED
>