
iViewLauncher can be used to launch any iView or a page in the portal.
Provider Specific Information
iViewLauncher is provider agnostic. Items may belong to any connector.
Supported Actions
Action name can be anything.
Properties
iViewLauncher expects one of the following two properties:
iview (mandatory)
The iView ID to be launched.
page (mandatory)
The page ID of the page to be launched.
All other properties will be passed as name=URL encoded value to the target iView. The dynamic properties can also be passed to an iView via the following property:
iviewDynamicParameter (optional)
Name/value pairs of dynamic parameters to be passed to the iView/page. The expected format is name1=value1&name2=value2 .
Following is the definition of an action that launches an iView with ID ROLES://portal_content/com.sap.pct/every_user/general/iViews/myDemoIView :
<Action name="launchIView" handler="IViewLauncher">
<Properties>
<Property name="iview" value="ROLES://portal_content/com.sap.pct/every_user/general/iViews/myDemoIView"/>
</Properties>
</Action>
Example on how to configure an action to launch a page with ID ROLES://portal_content/com.sap.pct/every_user/general/Pages/com.sap.kmMyInfoDiscussions :
<Action name="launchIView" handler="IViewLauncher">
<Properties>
<Property name="page" value=" ROLES://portal_content/com.sap.pct/every_user/general/Pages/com.sap.km.MyInfoDiscussions"/>
</Properties>
</Action>
Details
The following parameters are optionally passed on to the iView, when no parameters are explicitly defined.
wi_id
Work item ID in the provider system
destination
System alias in the portal system landscape of the provider system
item_id
Internal UWL item ID
task
Provider task item type
uname
Back end user ID for webflow connector, alert connector and generic ABAP connector, otherwise portal user ID
langu
User language in upper case ISO language code
Example
Example of using dynamic properties:
<Action ...>
<Properties>
...
<Property name="workitemId" value="${item.externalId}"/>
<Property name="system" value="${item.systemId}"/>
</Properties>
</Action>
This will result in passing workitemId and system parameters to the target page/iView. This is the same as specifying iviewDynamicParameter property:
<Action ...>
<Properties>
...
<Property name="iviewDynamicParameter" value="workitemId=${item.externalId}&system=${item.systemId}"/>
</Properties>
</Action>
Notes
If the action name is launchIView and the description is empty, a default description is used. If default description does not exist an action name will be used for the label of an action button. To define a description add the <Description> node to <Action> :
<Action …>
…….
<Descriptions default="Launch Demo IView">
<ShortDescriptions>
<Description Language="en" Description="Launch Demo IView"/>
</ShortDescriptions>
</Descriptions>
</Action>
The name for the Action can be different from the default name, and then the above logic will be applied to the label of its action button. This remark is valid for all launch handlers.
The values for iview to launch an iView or for page to launch a portal page should be entered as following. If the iView or the portal page is not part of the role, then find the corresponding iView or the page in the Portal Content catalog tree hierarchy, look at the Quick Info area for its ID, and enter it as a value for the iview or page property. For example:
<Property name="iview" value="pcd: portal_content/com.sap.pct/every_user/general/iViews/myDemoIView">
To ensure backward compatibility the value pcd: can be omitted:
<Property name="iview" value="portal_content/com.sap.pct/every_user/general/iViews/myDemoIView">
If the iView or a portal page is part of the role, then the ID is calculated as follows:
"ROLES://" + role id without "pcd:" + folder IDs in the role + iView ID. For example:
<Property name="iview" value="ROLES://portal_content/every_user/general/eu_role/com.sap.km.home_ws/com.sap.km.MyInfo/ com.sap.km.MyInfoOverview">
where portal_content/every_user/general/eu_role is the role ID, com.sap.km.home_ws is ID of Home folder in the role, com.sap.km.MyInfo is ID of My Info folder and com.sap.km.MyInfoOverview is the ID of Overview iView.
For webflow connector iViewLauncher can be configured on the back end using SWFVISU transaction. The table below summarizes the mapping between the launcher parameters and the visualization parameters.
|
Launcher Parameter |
Visualization Type |
Visualization Parameter |
|---|---|---|
|
page |
Portal Page |
ID |
|
iview |
iView |
ID |
|
iviewDynamicParameter |
iView/portal page/portal component |
DYNPARAM |