analytics/templates/ps/portal/addEntries/add_entries_interface.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
    Licensed Materials - Property of IBM

    IBM Cognos Products: ps

    (C) Copyright IBM Corp. 2005, 2012

    US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
-->

<!--
   Copyright (C) 2008 Cognos ULC, an IBM Company. All rights reserved.
   Cognos (R) is a trademark of Cognos ULC, (formerly Cognos Incorporated).
-->
<!--
=================================================================================================================================
Interface for add_entries.xts

The paremeters passed to the add_entries.xts morphlet must have the following structure
<root>
	...
	<req-params:requestParams xmlns:req-params="http://developer.cognos.com/schemas/request/params">
		<req-params:param name="requestState">addEntries|markup</req-params:param> 
		<req-params:param name="formName">pform</req-params:param>
		<req-params:param name="">...</req-params:param>
	</req-params:requestParams>
</root>


parameter name                   Description                                                          required
___________________________      ___________________________________________________________          ____________________________
requestState                     the current state of the morphlet                                    yes, will be added automatically by
                                                                                                      the dlgctrl:XTS2Request template
                                 navigate - produce the HTML markup for the add entries (Navigate)
                                 search - produce the HTML markup for the add entries (Search)
                                 type - produce the HTML markup for the add entries (Type)
                                 finished - generate the final addedEntries XML and return it
                                 canceled - user hit the cancel button, return </canceled>
                                 											
titlePostfix                     for display purposes                                                 no, will get appened to titlePrefix

displayButtons                   should the footer get generated                                      no, default is true

defaultSearchPath                searchPath to be used in the initial query to CM                     yes

showUsers                        should the show users checkbox be visible?					no, default is false

returnProperties                 a list of properties that should be returned as part of the          yes
                                 addedEntries response. For for param must be
                                 <req-params:param name="propertiesReturned">
                                      <req-params:property name="searchPath"/>
                                      <req-params:property name="defaultName"/>
                                      ...
                                 </req-params:param>

allowDuplicates                  should the user be able to add the same entry twice                  yes, default is true

addEntriesUI                     what flavor of the add entries dialog should be used                 no, default is runnable
                                 Possible values are:
                                 - runnables
                                 - recipients
                                 - recipients_distribution
                                 - members
                                 - links
                                 - groupMembers
                                 - privileges
                                 - mypages
                                 - portlet
                                 - packagesAndLocations
                                 - indexUpdateLocations
                                 - deploymentObjects
                                 
typeDialog                       should the type dialog be available                                  no, default is false                                 

fromFM                           is the add entries getting called from FM                            no, default is false      

inWizard                         used for display purposes (title)                                    no, default is false        

agentStudio                      is email options getting called from Event Studio                    no, default is false

isPopup                          Is addEntries being displayed in an iframe                           no, default is false                   


**** All the target and URL params have a 'target' attribute to specify what frame should be targeted. Default is _self

defaultTarget                    target morphlet to be called when hitting any button                 yes, used for links on the email dialog
                                 on the page                                                          and any button that hasn't been explicitly specified

okTarget                         target morphlet to be called when hitting the OK button              no, defaultTarget will be used. Set value to disable
                                                                                                      if you want the ok button to be disabled.

cancelTarget                     target morphlet to be called when hitting the Cancel button          no, defaultTarget will be used. Set value to disable
                                                                                                      if you want the Cancel button to be disabled.

okURL                            URL to be used when the user hits the OK button                      no, okTarget will be used if specified or 
                                                                                                      defaultTarget will be used. Set value to disable
                                                                                                      if you want the Finish button to be disabled.

cancelURL                        URL to be used when the user hits the Cancel button                  no, cancelTarget will be used if specified or 

allowRootBrowsing                Can the user browse all the way to the root                          no, default is false

selectableRootObjects            Should the objects shown at the root be selectable                   no, default is false

add_entries.xts will return the following markup
<markup>....</markup>
or
<addedEntries>...</addedEntries>
or
<canceled/>
====================================================================================================================================
-->
<API_params>
	<request_state/>
	<titlePostfix/>
	<displayButtons default="true"/>
	<defaultSearchPath/>
	<classFilter/>
	<showUsers default="false"/>
	<inWizard default="false"/>
	<agentStudio default="false"/>
	<folderClasses/>
	<selectableClasses/>
	<returnProperties/>
	<allowDuplicates default="false"/>
	<addEntriesUI default="runnable"/>
	<withCC default="true"/>
	<withBCC default="true"/>
	<typeDialog default="false"/>
	<fromFM default="false"/>
	<isPopup default="false"/>
	<defaultTarget/>
	<okTarget/>
	<cancelTarget/>
	<okURL/>
	<cancelURL/>
	<allowRootBrowsing default="false"/>
	<selectableRootObjects default="false"/>
</API_params>