analytics/templates/ps/portal/emailOptions/email_interface.xml

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

    IBM Cognos Products: ps

    (C) Copyright IBM Corp. 2005, 2011

    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 email_options.xts

The paremeters passed to the email_options.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
                                 addEntries - call the add entries morphlet
                                 finished - generate the resulting XML and return it
                                 canceled - user hit the cancel button, return </canceled>
                                 markup - produce the HTML markup for the email page
                                 genDefault - return a default options blob 
													
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

titlePrefix                      for display purposes                                                 yes

titlePostfix                     for display purposes                                                 no, will get appened to titlePrefix

formName                         the form name to use in the javascript                               no, defaults to pform

options                          used to default the fields                                           no

defaultSubject              user to generate the email options dialog with defailts             no

defaultRecipient                 used to generate the email options dialog with defaults	            no, default is false

burst                            has bursting been selected                                           no, defaults to false

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

displayButtons                   should the footer get generated                                      no, default is true

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

reportViewer                     is email options getting called from the report viewer               no, default is false

subscription                     is email options getting called for a subscription               no, default is false

hideInsertButton                 hide the insert buttons when set to true				              no, default is false

headerStyle                      what style should be used to render the header				no, default is the standard dialog header. Possible
                                                                                                      values are 'dialog' or 'page'

taskName                         default taskName                                                     no

                                                                                                      
eventList                        text that will show up under the 'Send this email for                no
                                 the events:' section

objectClass                      Used to help render some of the strings                              no, currently only needed for Jobs

linkToReport                     If specified, this value will be appended to the body, and the       no
                                 emailAsAttachment runOption will not be used.

addEntriesPopUp                  Should the added entries be displayed in an iframe                   no, default is false

defaultEmailAsAttachment         When generating defaults, should the report be emailed               no, default is false (i.e. will email the link)
                                 as an attachment

attach                           An XML structure describing the possible items to attach to          no, only needed for Event Studio
                                 the email

hideEmailAsAttachment            Should the hideEmailAsAttachment be hidden                           no, default is false

hideLinkToReport                 Should the 'Include a link to the report' option be hidden                           no, default is false
hideAddLinks						Should the 'Add Links...' action be hidden											no, default is true
hideAttachMenu					Should the 'Attach...' action be hidden													no, default is true


usePowerPlay8Options		Generate powerPlay compatible options rather than run options					no, default is false

**** All the target and URL params can 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.

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

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

finishTarget                     target morphlet to be called when hitting the Finish button          no, defaultTarget will be used. Set value to disable
                                                                                                      if you want the Finish 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 
                                                                                                      defaultTarget will be used. Set value to disable
                                                                                                      if you want the Finish button to be disabled.

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

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

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


Email Options will return the following markup
<markup>....</markup>
or
<options>...</options>
or
<canceled/>
====================================================================================================================================
-->
<API_params>
	<request_state/>
	<formName default="pform"/>
	<options/>
	<defaultSubject/>
	<defaultRecipient/>
	<titlePrefix/>
	<titlePostfix/>
	<burst default="false"/>
	<inWizard default="false"/>
	<displayButtons default="true"/>
	<agentStudio default="false"/>
	<headerStyle default="dialog"/>
	<reportViewer default="false"/>
	<subscription default="false"/>
	<hideInsertButton default="false"/>
	<addEntriesPopUpTarget/>
	<addEntriesPopUp default="false"/>
	<defaultEmailAsAttachment default="false"/>
	<hideEmailAsAttachment default="false"/>
	<hideLinkToReport default="false"/>
	<hideAddLinks default="true"/>
	<hideAttachMenu default="true"/>
	<usePowerPlay8Options default="false"/>
	<useJobOptions default="false"/>
	<linkToReport/>
	<eventList/>
	<taskName/>
	<defaultTarget/>
	<okTarget/>
	<cancelTarget/>
	<backTarget/>
	<nextTarget/>
	<finishTarget/>
	<okURL/>
	<cancelURL/>
	<backURL/>
	<nextURL/>
	<finishURL/>
</API_params>