com.sapportals.portal.sapapplication.urlgenerator
Interface IIViewUrlGenerator

public interface IIViewUrlGenerator

This class provides applications the functionality to compute iView URLs for SAP applications such as APPTYPE_TRANSACTION or APPTYPE_WEBDYNPRO.

The iView URL is computed using the method createIViewURL(IPortalComponentRequest, String, Hashtable). Beside the Portal Component Request the method gets the application type and a hashtable which contains the parameterization regarding the given application type.

The following example shows how to create an iView URL that starts transaction su01 using SAPGUI for HTML in system My_Sap_System and prefills the dynpro field USR02-BNAME with the user id p80000001:

  Hashtable params = new Hashtable();
  params.put(IIViewUrlGenerator.SYSTEM_KEY, "My_SAP_System");
  params.put(IIViewUrlGenerator.TRANSACTION_TCODE, "su01");
  params.put(IIViewUrlGenerator.TRANSACTION_GUITYPE, IIViewUrlGenerator.SAPGUI_HTML);
  params.put(IIViewUrlGenerator.DYNAMICPARAMETER, "USR02-BNAME=p80000001");
 
  IIViewUrlGenerator urlGenerator = (IIViewUrlGenerator) PortalRuntime.getRuntimeResources().getService(IIViewUrlGenerator.KEY);
  String txiViewURL = urlGenerator.createIViewURL(request, IIViewUrlGenerator.APPTYPE_TRANSACTION, params);
 

This URL will point to the Transaction starter component com.sap.portal.appintegrator.sap.Transaction. If the parameter IVIEW_KEY contains a valid PCD iView URL createIViewURL(IPortalComponentRequest, String, Hashtable) will return a URL that points to this iView:

  Hashtable params = new Hashtable();
  params.put(IIViewUrlGenerator.IVIEW_KEY, "portal_content/templates/iviews/sap_transaction_iview");
  params.put(IIViewUrlGenerator.DYNAMICPARAMETER, "USR02-BNAME=p80000001");
 
  IIViewUrlGenerator urlGenerator = (IIViewUrlGenerator) PortalRuntime.getRuntimeResources().getService(IIViewUrlGenerator.KEY);
  String txiViewURL = urlGenerator.createIViewURL(request, IIViewUrlGenerator.APPTYPE_TRANSACTION, params);
 

In this case the provided iView should define at least the system, transaction code and the SAP Gui Type. Of course it doesn't matter what parameters are defined inside the iView and what parameter are provided by the parameter hashtable. Only if IVIEW_KEY is not defined all parameters that are mandatory for the given application type must be defined.

Version:

$Revision:$.

Field Summary

static java.lang.String	APPTYPE_BSP Application Type BSP (Business Server Pages) Value for: applicationType Uses: SYSTEM_KEY Uses: BSP_CUSTOMER_NAMESPACE Uses: BSP_APPLICATION_NAMESPACE Uses: BSP_APPLICATION_ID Uses: BSP_ALIAS Uses: BSP_PAGE_ID Uses: DYNAMICPARAMETER
static java.lang.String	APPTYPE_BWREPORT Application Type BW Report Value for: applicationType Uses: SYSTEM_KEY Uses: BWREPORT_REPORTID Uses: DYNAMICPARAMETER
static java.lang.String	APPTYPE_CONTENTINTEGRATOR Application Type Content Integrator Value for: applicationType Uses: SYSTEM_KEY Uses: CONTENT_INTEGRATOR_ID Uses: DYNAMICPARAMETER
static java.lang.String	APPTYPE_CRYSTALREPORT Application Type Crystal Report Value for: applicationType Uses: SYSTEM_KEY Uses: CRYSTAL_REPORT_TYPE Uses: CRYSTAL_REPORT_ID Uses: CRYSTAL_VIEWER_APPLICATION Uses: CRYSTAL_VIEWER_TECHNIQUE Uses: CRYSTAL_VIEW_TYPE Uses: DYNAMICPARAMETER
static java.lang.String	APPTYPE_DNROBJECT Application Type DNRObject (Drag and Relate object starter) Value for: applicationType Uses: SYSTEM_KEY Uses: DNROBJECT_TYPE Uses: DNROBJECT_KEY Uses: DNROBJECT_NAME
static java.lang.String	APPTYPE_GENERIC Application Type Generic (Generic URL launcher) Value for: applicationType Uses: SYSTEM_KEY Uses: GENERIC_ID Uses: GENERIC_URL_TEMPLATE Uses: GENERIC_USERMAPPING_TEMPLATE Uses: GENERIC_SAPLOGONTICKET_TEMPLATE
static java.lang.String	APPTYPE_IAC Application Type IAC (Internet Application Component) Value for: applicationType Uses: SYSTEM_KEY Uses: IAC_SERVICE_ID Uses: DYNAMICPARAMETER
static java.lang.String	APPTYPE_MINIAPP Application Type MiniApp (ITS based application type) Value for: applicationType Uses: SYSTEM_KEY Uses: MINIAPP_SERVICE_ID Uses: DYNAMICPARAMETER
static java.lang.String	APPTYPE_TRANSACTION Application Type Transaction Value for: applicationType Uses: SYSTEM_KEY Uses: TRANSACTION_TCODE Uses: TRANSACTION_GUITYPE Uses: DYNAMICPARAMETER Uses: TRANSACTION_AUTOSTART Uses: TRANSACTION_OKCODE Uses: TRANSACTION_SPO1 Uses: TRANSACTION_FROGDESIGN Uses: TRANSACTION_WINGUITECHNIQUE
static java.lang.String	APPTYPE_WEBDYNPRO Application Type Web Dynpro Value for: applicationType Uses: SYSTEM_KEY Uses: WEBDYNPRO_DEFINITIONTYPE Uses: WEBDYNPRO_NAMESPACE Uses: WEBDYNPRO_APPLICATION Uses: DYNAMICPARAMETER
static java.lang.String	BSP_ALIAS BSP Alias The Business Server Page (BSP) Alias is used as a shortcut for 'Customer Namespace', 'Application Namespace' and 'Application'.
static java.lang.String	BSP_APPLICATION_ID BSP Application ID The name of the Business Server Page (BSP) Application (without its namespace).
static java.lang.String	BSP_APPLICATION_NAMESPACE BSP Application Namespace The Application Namespace is used as a prefix for the application name in order to separate the applications from each other.
static java.lang.String	BSP_CUSTOMER_NAMESPACE BSP Customer Namespace The Customer Namespace is used to separate SAP applications from customer applications.
static java.lang.String	BSP_PAGE_ID BSP Page-ID The Business Server Page (BSP) start page Type: String Mandatory: yes Default: empty Example: "index.html"
static java.lang.String	BWREPORT_REPORTID BW Report ID The query string of the BW Report Type: String Mandatory: yes, if not defined by the iView Default: no default Example: "cmd=ldoc&TEMPLATEID=4711"
static java.lang.String	CONTENT_INTEGRATOR_ID Content Integrator ID ID of the Content Integrator application Type: String Mandatory: yes, if not defined by the iView Default: no default Example: "CI.APP.DISPLAY_SCHEMA"
static java.lang.String	CRYSTAL_BW_REPORT Crystal Report Type BW Report Value for: CRYSTAL_REPORT_TYPE
static java.lang.String	CRYSTAL_REPORT_ID Crytsl Report ID Unique ID of the Crystal Report.
static java.lang.String	CRYSTAL_REPORT_TYPE Crystal Report Type Crystal Enterprise Reports can be defined as a standard report or as a report that is assigned to a BW Report (use the Java constants).
static java.lang.String	CRYSTAL_STANDARD_REPORT Crystal Report Type Standard Value for: CRYSTAL_REPORT_TYPE
static java.lang.String	CRYSTAL_VIEW_TYPE Crystal Report View Type Crystal Enterprise viewing type decides if the report will be displayed 'on demand' or if the last instance will be displayed (use the Java constants).
static java.lang.String	CRYSTAL_VIEW_TYPE_LASTINSTANCE Crystal Viewer Type Last Instance Value for: CRYSTAL_VIEW_TYPE
static java.lang.String	CRYSTAL_VIEW_TYPE_ONDEMAND Crystal Viewer Type On Demand Value for: CRYSTAL_VIEW_TYPE
static java.lang.String	CRYSTAL_VIEWER_APPLICATION Crystal Report Viewer Application Actual viewer application file which gets execute to display the results for this iView.
static java.lang.String	CRYSTAL_VIEWER_TECHNIQUE Crystal Report Viewer Technique Crystal Enterprise Viewer that will be used to display the Crystal Report (use the Java constants).
static java.lang.String	CRYSTAL_VIEWER_TECHNIQUE_ACTIVEX Crystal Viewer Technique ActiveX Value for: CRYSTAL_VIEWER_TECHNIQUE
static java.lang.String	CRYSTAL_VIEWER_TECHNIQUE_HTML Crystal Viewer Technique pure HTML Value for: CRYSTAL_VIEWER_TECHNIQUE
static java.lang.String	CRYSTAL_VIEWER_TECHNIQUE_JAVA Crystal Viewer Technique pure Java Applet Value for: CRYSTAL_VIEWER_TECHNIQUE
static java.lang.String	CRYSTAL_VIEWER_TECHNIQUE_JAVA_PLUGIN Crystal Viewer Technique Java Plugin Value for: CRYSTAL_VIEWER_TECHNIQUE
static java.lang.String	CRYSTAL_VIEWER_TECHNIQUE_NETSCAPE_PLUGIN Crystal Viewer Technique Netscape Plugin Value for: CRYSTAL_VIEWER_TECHNIQUE
static java.lang.String	DNROBJECT_KEY Object Key The Object Key as defined in the Business Object Repository (BOR) of the SAP system.
static java.lang.String	DNROBJECT_NAME Object Name Descriptive, English ID of a business object in the Business Object Repository (BOR).
static java.lang.String	DNROBJECT_TYPE Object Type Internal technical key of a business object in the Business Object Repository (BOR).
static java.lang.String	DYNAMICPARAMETER Additinal application parameters URL-querystring like list of parameters that are passed to the iView.
static java.lang.String	GENERIC_APPLICATION_PARAMETER Generic Application Parameter URL-querystring like list of parameters that are passed to the remote application.
static java.lang.String	GENERIC_ID Generic Application ID The ID of the remote application.
static java.lang.String	GENERIC_SAPLOGONTICKET_TEMPLATE Generic SAP Logon Ticket Template The Single Sign-On template fraction is resolved during runtime and its result is stored in the variable 'Authentication'.
static java.lang.String	GENERIC_URL_TEMPLATE Generic URL Template The URL template includs expressions placed in <...> that are evaluated during runtime, e.g: The URL template 'http://myserver?
static java.lang.String	GENERIC_USERMAPPING_TEMPLATE Generic User Mapping Template The user mapping template fraction is resolved during runtime and its result is stored in the variable 'Authentication'.
static java.lang.String	IAC_SERVICE_ID IAC service ID The ITS service name of the Internet Application Component (IAC).
static java.lang.String	IVIEW_KEY iView ID The iView to create the URL for (path in the PCD) Type: String Mandatory: no Default: the portal component concerning the application type Example: "portal_content/templates/iviews/sap_transaction_iview"
static java.lang.String	KEY Service KEY
static java.lang.String	MINIAPP_SERVICE_ID MiniApp service ID The ITS service name of the MiniApp.
static java.lang.String	SAPGUI_HTML SAPGui type SAPGUI for HTML Value for: TRANSACTION_GUITYPE
static java.lang.String	SAPGUI_JAVA SAPGui type SAPGUI for Java Value for: TRANSACTION_GUITYPE
static java.lang.String	SAPGUI_WINDOWS SAPGui type SAPGUI for Windows Value for: TRANSACTION_GUITYPE
static java.lang.String	SYSTEM_KEY System ID ID of the SAP system as defined in the system landscape Type: String Mandatory: yes, if not defined by the iView or you use the Genericapplication type Default: no default Example: "MySystem"
static java.lang.String	TRANSACTION_AUTOSTART Process first dynpro automatically If set to 'true' than <Enter> is automatically executed when the transaction is started and the first screen is executed if all mandatory screen fields are defined.
static java.lang.String	TRANSACTION_FROGDESIGN Flag for new Visual design If set to true the SAPGUI for Java is started using the new Visual Design Type: {true, false} Mandatory: no Default: true Example: "false"
static java.lang.String	TRANSACTION_GUITYPE SAP Gui type One of 'SAPGUI for Windows' (WinGui), 'SAPGUI for Java' (javaGui) or 'SAPGUI for HTML' (WebGui) - use the Java constants Type: {SAPGUI_HTML, SAPGUI_WINDOWS, SAPGUI_JAVA} Mandatory: yes, if not defined by the iView Default: no default Example: SAPGUI_HTML
static java.lang.String	TRANSACTION_OKCODE Okcode to trigger PAI on first screen Sets the Ok code field for the transaction start.
static java.lang.String	TRANSACTION_SPO1 Flag for SPO1 If set to true than the transaction is started via the parameter transaction SPO1.
static java.lang.String	TRANSACTION_TCODE The Transaction code A transaction code can contain up to 20 characters and should always begin with a letter.
static java.lang.String	TRANSACTION_WINGUITECHNIQUE SAPGUI for Windows starting technique Defines the technique to start Wingui.
static java.lang.String	WEBDYNPRO_APPLICATION Web Dynpro Application The Web Dynpro application name Type: string Mandatory: yes, if not defined by the iView Default: no default Example: "HelloWorld"
static java.lang.String	WEBDYNPRO_DEFINITIONTYPE Web Dynpro Definition Type The definition type defines whether this is an ABAP- or Java-Web Dynpro iView.
static java.lang.String	WEBDYNPRO_NAMESPACE Web Dynpro Namespace The namespace of the Webdynpro application (ie. the development component in Java).
static java.lang.String	WINGUI_STARTTECH_AUTO WinGui Starting technique automatic detection Value for: TRANSACTION_WINGUITECHNIQUE
static java.lang.String	WINGUI_STARTTECH_SSD WinGui Starting technique Structured Document Value for: TRANSACTION_WINGUITECHNIQUE
static java.lang.String	WINGUI_STARTTECH_SSF WinGui Starting technique Shortcut File Value for: TRANSACTION_WINGUITECHNIQUE

Method Summary

java.lang.String

createIViewURL(com.sapportals.portal.prt.component.IPortalComponentRequest request, java.lang.String applicationType, java.util.Hashtable parameterization) Computes an iView URL for the given parameterization.

Field Detail

KEY

public static final java.lang.String KEY

Service KEY

APPTYPE_TRANSACTION

public static final java.lang.String APPTYPE_TRANSACTION

Application Type Transaction

Value for: applicationType

Uses: SYSTEM_KEY

Uses: TRANSACTION_TCODE

Uses: TRANSACTION_GUITYPE

Uses: DYNAMICPARAMETER

Uses: TRANSACTION_AUTOSTART

Uses: TRANSACTION_OKCODE

Uses: TRANSACTION_SPO1

Uses: TRANSACTION_FROGDESIGN

Uses: TRANSACTION_WINGUITECHNIQUE

See Also:

createIViewURL(IPortalComponentRequest, String, Hashtable)

APPTYPE_BSP

public static final java.lang.String APPTYPE_BSP

Application Type BSP (Business Server Pages)

Value for: applicationType

Uses: SYSTEM_KEY

Uses: BSP_CUSTOMER_NAMESPACE

Uses: BSP_APPLICATION_NAMESPACE

Uses: BSP_APPLICATION_ID

Uses: BSP_ALIAS

Uses: BSP_PAGE_ID

Uses: DYNAMICPARAMETER

See Also:

createIViewURL(IPortalComponentRequest, String, Hashtable)

APPTYPE_WEBDYNPRO

public static final java.lang.String APPTYPE_WEBDYNPRO

Application Type Web Dynpro

Value for: applicationType

Uses: SYSTEM_KEY

Uses: WEBDYNPRO_DEFINITIONTYPE

Uses: WEBDYNPRO_NAMESPACE

Uses: WEBDYNPRO_APPLICATION

Uses: DYNAMICPARAMETER

See Also:

createIViewURL(IPortalComponentRequest, String, Hashtable)

APPTYPE_BWREPORT

public static final java.lang.String APPTYPE_BWREPORT

Application Type BW Report

Value for: applicationType

Uses: SYSTEM_KEY

Uses: BWREPORT_REPORTID

Uses: DYNAMICPARAMETER

See Also:

createIViewURL(IPortalComponentRequest, String, Hashtable)

APPTYPE_IAC

public static final java.lang.String APPTYPE_IAC

Application Type IAC (Internet Application Component)

Value for: applicationType

Uses: SYSTEM_KEY

Uses: IAC_SERVICE_ID

Uses: DYNAMICPARAMETER

See Also:

createIViewURL(IPortalComponentRequest, String, Hashtable)

APPTYPE_MINIAPP

public static final java.lang.String APPTYPE_MINIAPP

Application Type MiniApp (ITS based application type)

Value for: applicationType

Uses: SYSTEM_KEY

Uses: MINIAPP_SERVICE_ID

Uses: DYNAMICPARAMETER

See Also:

createIViewURL(IPortalComponentRequest, String, Hashtable)

APPTYPE_DNROBJECT

public static final java.lang.String APPTYPE_DNROBJECT

Application Type DNRObject (Drag and Relate object starter)

Value for: applicationType

Uses: SYSTEM_KEY

Uses: DNROBJECT_TYPE

Uses: DNROBJECT_KEY

Uses: DNROBJECT_NAME

See Also:

createIViewURL(IPortalComponentRequest, String, Hashtable)

APPTYPE_CRYSTALREPORT

public static final java.lang.String APPTYPE_CRYSTALREPORT

Application Type Crystal Report

Value for: applicationType

Uses: SYSTEM_KEY

Uses: CRYSTAL_REPORT_TYPE

Uses: CRYSTAL_REPORT_ID

Uses: CRYSTAL_VIEWER_APPLICATION

Uses: CRYSTAL_VIEWER_TECHNIQUE

Uses: CRYSTAL_VIEW_TYPE

Uses: DYNAMICPARAMETER

See Also:

createIViewURL(IPortalComponentRequest, String, Hashtable)

APPTYPE_CONTENTINTEGRATOR

public static final java.lang.String APPTYPE_CONTENTINTEGRATOR

Application Type Content Integrator

Value for: applicationType

Uses: SYSTEM_KEY

Uses: CONTENT_INTEGRATOR_ID

Uses: DYNAMICPARAMETER

See Also:

createIViewURL(IPortalComponentRequest, String, Hashtable)

APPTYPE_GENERIC

public static final java.lang.String APPTYPE_GENERIC

Application Type Generic (Generic URL launcher)

Value for: applicationType

Uses: SYSTEM_KEY

Uses: GENERIC_ID

Uses: GENERIC_URL_TEMPLATE

Uses: GENERIC_USERMAPPING_TEMPLATE

Uses: GENERIC_SAPLOGONTICKET_TEMPLATE

See Also:

createIViewURL(IPortalComponentRequest, String, Hashtable)

IVIEW_KEY

public static final java.lang.String IVIEW_KEY

iView ID
The iView to create the URL for (path in the PCD)

Type: String

Mandatory: no

Default: the portal component concerning the application type

Example: "portal_content/templates/iviews/sap_transaction_iview"

See Also:

createIViewURL(IPortalComponentRequest, String, Hashtable)

SYSTEM_KEY

public static final java.lang.String SYSTEM_KEY

System ID
ID of the SAP system as defined in the system landscape

Type: String

Mandatory: yes, if not defined by the iView or you use the Genericapplication type

Default: no default

Example: "MySystem"

See Also:

APPTYPE_BSP, APPTYPE_BWREPORT, APPTYPE_CONTENTINTEGRATOR, APPTYPE_CRYSTALREPORT, APPTYPE_GENERIC, APPTYPE_DNROBJECT, APPTYPE_IAC, APPTYPE_MINIAPP, APPTYPE_TRANSACTION, APPTYPE_WEBDYNPRO, createIViewURL(IPortalComponentRequest, String, Hashtable)

DYNAMICPARAMETER

public static final java.lang.String DYNAMICPARAMETER

Additinal application parameters
URL-querystring like list of parameters that are passed to the iView.

Type: querystring

Mandatory: no

Default: empty

Example: "plvar=01&persid=0815"

See Also:

APPTYPE_BSP, APPTYPE_BWREPORT, APPTYPE_CONTENTINTEGRATOR, APPTYPE_CRYSTALREPORT, APPTYPE_GENERIC, APPTYPE_IAC, APPTYPE_MINIAPP, APPTYPE_WEBDYNPRO

TRANSACTION_TCODE

public static final java.lang.String TRANSACTION_TCODE

The Transaction code
A transaction code can contain up to 20 characters and should always begin with a letter. Permitted characters are letters from A to Z, numbers from 0 to 9, and the underscore.

Type: String

Mandatory: yes, if not defined by the iView

Default: no default

Example: "su01"

See Also:

APPTYPE_TRANSACTION

TRANSACTION_GUITYPE

public static final java.lang.String TRANSACTION_GUITYPE

SAP Gui type
One of 'SAPGUI for Windows' (WinGui), 'SAPGUI for Java' (javaGui) or 'SAPGUI for HTML' (WebGui) - use the Java constants

Type: {SAPGUI_HTML, SAPGUI_WINDOWS, SAPGUI_JAVA}

Mandatory: yes, if not defined by the iView

Default: no default

Example: SAPGUI_HTML

See Also:

APPTYPE_TRANSACTION

SAPGUI_HTML

public static final java.lang.String SAPGUI_HTML

SAPGui type SAPGUI for HTML

Value for: TRANSACTION_GUITYPE

See Also:

APPTYPE_TRANSACTION

SAPGUI_WINDOWS

public static final java.lang.String SAPGUI_WINDOWS

SAPGui type SAPGUI for Windows

Value for: TRANSACTION_GUITYPE

See Also:

APPTYPE_TRANSACTION

SAPGUI_JAVA

public static final java.lang.String SAPGUI_JAVA

SAPGui type SAPGUI for Java

Value for: TRANSACTION_GUITYPE

See Also:

APPTYPE_TRANSACTION

TRANSACTION_AUTOSTART

public static final java.lang.String TRANSACTION_AUTOSTART

Process first dynpro automatically
If set to 'true' than <Enter> is automatically executed when the transaction is started and the first screen is executed if all mandatory screen fields are defined.

Type: {true, false}

Mandatory: no

Default: false

Example: "true"

See Also:

APPTYPE_TRANSACTION

TRANSACTION_OKCODE

public static final java.lang.String TRANSACTION_OKCODE

Okcode to trigger PAI on first screen
Sets the Ok code field for the transaction start. This is only possible for SAPGUI for HTML.

Type: {true, false}

Mandatory: no

Default: false

Example: "true"

See Also:

APPTYPE_TRANSACTION, SAPGUI_HTML

TRANSACTION_SPO1

public static final java.lang.String TRANSACTION_SPO1

Flag for SPO1
If set to true than the transaction is started via the parameter transaction SPO1.

Type: {true, false}

Mandatory: no

Default: false

Example: "true"

See Also:

APPTYPE_TRANSACTION

TRANSACTION_FROGDESIGN

public static final java.lang.String TRANSACTION_FROGDESIGN

Flag for new Visual design
If set to true the SAPGUI for Java is started using the new Visual Design

Type: {true, false}

Mandatory: no

Default: true

Example: "false"

See Also:

APPTYPE_TRANSACTION, SAPGUI_JAVA

TRANSACTION_WINGUITECHNIQUE

public static final java.lang.String TRANSACTION_WINGUITECHNIQUE

SAPGUI for Windows starting technique
Defines the technique to start Wingui. You can choose between

• automatic detection (auto)
• Structured Document (SSD - SAPGui runs inside the browser window - IE only)
• SAP Shortcut File (SSF - SAPGui runs in its own window)

Type: {WINGUI_STARTTECH_AUTO, WINGUI_STARTTECH_SSD, WINGUI_STARTTECH_SSF}

Mandatory: no

Default: auto

Example: WINGUI_STARTTECH_SSF

See Also:

APPTYPE_TRANSACTION

WINGUI_STARTTECH_AUTO

public static final java.lang.String WINGUI_STARTTECH_AUTO

WinGui Starting technique automatic detection

Value for: TRANSACTION_WINGUITECHNIQUE

See Also:

APPTYPE_TRANSACTION

WINGUI_STARTTECH_SSD

public static final java.lang.String WINGUI_STARTTECH_SSD

WinGui Starting technique Structured Document

Value for: TRANSACTION_WINGUITECHNIQUE

See Also:

APPTYPE_TRANSACTION

WINGUI_STARTTECH_SSF

public static final java.lang.String WINGUI_STARTTECH_SSF

WinGui Starting technique Shortcut File

Value for: TRANSACTION_WINGUITECHNIQUE

See Also:

APPTYPE_TRANSACTION

BSP_CUSTOMER_NAMESPACE

public static final java.lang.String BSP_CUSTOMER_NAMESPACE

BSP Customer Namespace
The Customer Namespace is used to separate SAP applications from customer applications. Use the Customer Namespace always in combination with BSP_APPLICATION_NAMESPACE, BSP_APPLICATION_ID and BSP_PAGE_ID.

Type: String

Mandatory: no

Default: sap

Example: "sap"

See Also:

APPTYPE_BSP

BSP_APPLICATION_NAMESPACE

public static final java.lang.String BSP_APPLICATION_NAMESPACE

BSP Application Namespace The Application Namespace is used as a prefix for the application name in order to separate the applications from each other. Use the Application Namespace always in combination with BSP_CUSTOMER_NAMESPACE, BSP_APPLICATION_ID and BSP_PAGE_ID.

Type: String

Mandatory: no

Default: sap

Example: "sap"

See Also:

APPTYPE_BSP

BSP_APPLICATION_ID

public static final java.lang.String BSP_APPLICATION_ID

BSP Application ID
The name of the Business Server Page (BSP) Application (without its namespace). Use the Application ID always in combination with BSP_CUSTOMER_NAMESPACE, BSP_APPLICATION_NAMESPACE and BSP_PAGE_ID.

Type: String

Mandatory: no

Default: empty

Example: "MyApp"

See Also:

APPTYPE_BSP

BSP_ALIAS

public static final java.lang.String BSP_ALIAS

BSP Alias
The Business Server Page (BSP) Alias is used as a shortcut for 'Customer Namespace', 'Application Namespace' and 'Application'. Use the BSP Alias always in combination with BSP_PAGE_ID.

Type: String

Mandatory: no

Default: empty

Example: "MyAlias"

See Also:

APPTYPE_BSP

BSP_PAGE_ID

public static final java.lang.String BSP_PAGE_ID

BSP Page-ID
The Business Server Page (BSP) start page

Type: String

Mandatory: yes

Default: empty

Example: "index.html"

See Also:

APPTYPE_BSP

BWREPORT_REPORTID

public static final java.lang.String BWREPORT_REPORTID

BW Report ID
The query string of the BW Report

Type: String

Mandatory: yes, if not defined by the iView

Default: no default

Example: "cmd=ldoc&TEMPLATEID=4711"

See Also:

APPTYPE_BWREPORT

WEBDYNPRO_DEFINITIONTYPE

public static final java.lang.String WEBDYNPRO_DEFINITIONTYPE

Web Dynpro Definition Type
The definition type defines whether this is an ABAP- or Java-Web Dynpro iView.

Type: {Java, ABAP}

Mandatory: yes, if not defined by the iView

Default: Java

Example: "ABAP"

See Also:

APPTYPE_WEBDYNPRO

WEBDYNPRO_NAMESPACE

public static final java.lang.String WEBDYNPRO_NAMESPACE

Web Dynpro Namespace
The namespace of the Webdynpro application (ie. the development component in Java).

Type: string

Mandatory: yes, if not defined by the iView

Default: no default

Example: "sap"

See Also:

APPTYPE_WEBDYNPRO

WEBDYNPRO_APPLICATION

public static final java.lang.String WEBDYNPRO_APPLICATION

Web Dynpro Application
The Web Dynpro application name

Type: string

Mandatory: yes, if not defined by the iView

Default: no default

Example: "HelloWorld"

See Also:

APPTYPE_WEBDYNPRO

IAC_SERVICE_ID

public static final java.lang.String IAC_SERVICE_ID

IAC service ID
The ITS service name of the Internet Application Component (IAC).

Type: String

Mandatory: yes, if not defined by the iView

Default: no default

Example: "pz26"

See Also:

APPTYPE_IAC

MINIAPP_SERVICE_ID

public static final java.lang.String MINIAPP_SERVICE_ID

MiniApp service ID
The ITS service name of the MiniApp.

Type: String

Mandatory: yes, if not defined by the iView

Default: no default

Example: "WeatherMiniApp"

See Also:

APPTYPE_MINIAPP

DNROBJECT_TYPE

public static final java.lang.String DNROBJECT_TYPE

Object Type
Internal technical key of a business object in the Business Object Repository (BOR).

Type: String (The object type can have a maximum of 10 characters.)

Mandatory: yes, if not defined by the iView

Default: no default

Example: "DRCARR"

See Also:

DNROBJECT_KEY, APPTYPE_DNROBJECT

DNROBJECT_KEY

public static final java.lang.String DNROBJECT_KEY

Object Key
The Object Key as defined in the Business Object Repository (BOR) of the SAP system.

Type: String

Mandatory: yes, if not defined by the iView

Default: no default

Example: "LH"

See Also:

DNROBJECT_TYPE, APPTYPE_DNROBJECT

DNROBJECT_NAME

public static final java.lang.String DNROBJECT_NAME

Object Name
Descriptive, English ID of a business object in the Business Object Repository (BOR).

Type: String

Mandatory: no

Default: no default

Example: "DragRelateCarr"

See Also:

APPTYPE_DNROBJECT

CRYSTAL_REPORT_TYPE

public static final java.lang.String CRYSTAL_REPORT_TYPE

Crystal Report Type
Crystal Enterprise Reports can be defined as a standard report or as a report that is assigned to a BW Report (use the Java constants).

Type: {CRYSTAL_STANDARD_REPORT, CRYSTAL_BW_REPORT}

Mandatory: yes, if not defined by the iView

Default: bw_id

Example: CRYSTAL_STANDARD_REPORT

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_STANDARD_REPORT

public static final java.lang.String CRYSTAL_STANDARD_REPORT

Crystal Report Type Standard

Value for: CRYSTAL_REPORT_TYPE

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_BW_REPORT

public static final java.lang.String CRYSTAL_BW_REPORT

Crystal Report Type BW Report

Value for: CRYSTAL_REPORT_TYPE

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_REPORT_ID

public static final java.lang.String CRYSTAL_REPORT_ID

Crytsl Report ID
Unique ID of the Crystal Report. This ID can be a BW-ID (GUID) or a ID from the Crystal Enterprise system.

Type: {CRYSTAL_STANDARD_REPORT, CRYSTAL_BW_REPORT}

Mandatory: yes, if not defined by the iView

Default: no default

Example: CRYSTAL_BW_REPORT

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_VIEWER_APPLICATION

public static final java.lang.String CRYSTAL_VIEWER_APPLICATION

Crystal Report Viewer Application
Actual viewer application file which gets execute to display the results for this iView.

Type: String

Mandatory: no

Default: viewreport.csp

Example: "myviewer.csp"

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_VIEWER_TECHNIQUE

public static final java.lang.String CRYSTAL_VIEWER_TECHNIQUE

Crystal Report Viewer Technique
Crystal Enterprise Viewer that will be used to display the Crystal Report (use the Java constants).

Type: {CRYSTAL_VIEWER_TECHNIQUE_ACTIVEX, CRYSTAL_VIEWER_TECHNIQUE_NETSCAPE_PLUGIN, CRYSTAL_VIEWER_TECHNIQUE_JAVA, CRYSTAL_VIEWER_TECHNIQUE_JAVA_PLUGIN, CRYSTAL_VIEWER_TECHNIQUE_HTML}

Mandatory: yes, if not defined by the iView

Default: html_frame

Example: CRYSTAL_VIEWER_JAVA

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_VIEWER_TECHNIQUE_ACTIVEX

public static final java.lang.String CRYSTAL_VIEWER_TECHNIQUE_ACTIVEX

Crystal Viewer Technique ActiveX

Value for: CRYSTAL_VIEWER_TECHNIQUE

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_VIEWER_TECHNIQUE_NETSCAPE_PLUGIN

public static final java.lang.String CRYSTAL_VIEWER_TECHNIQUE_NETSCAPE_PLUGIN

Crystal Viewer Technique Netscape Plugin

Value for: CRYSTAL_VIEWER_TECHNIQUE

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_VIEWER_TECHNIQUE_JAVA

public static final java.lang.String CRYSTAL_VIEWER_TECHNIQUE_JAVA

Crystal Viewer Technique pure Java Applet

Value for: CRYSTAL_VIEWER_TECHNIQUE

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_VIEWER_TECHNIQUE_JAVA_PLUGIN

public static final java.lang.String CRYSTAL_VIEWER_TECHNIQUE_JAVA_PLUGIN

Crystal Viewer Technique Java Plugin

Value for: CRYSTAL_VIEWER_TECHNIQUE

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_VIEWER_TECHNIQUE_HTML

public static final java.lang.String CRYSTAL_VIEWER_TECHNIQUE_HTML

Crystal Viewer Technique pure HTML

Value for: CRYSTAL_VIEWER_TECHNIQUE

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_VIEW_TYPE

public static final java.lang.String CRYSTAL_VIEW_TYPE

Crystal Report View Type
Crystal Enterprise viewing type decides if the report will be displayed 'on demand' or if the last instance will be displayed (use the Java constants).

Type: {CRYSTAL_VIEW_TYPE_ONDEMAND, CRYSTAL_VIEW_TYPE_LASTINSTANCE}

Mandatory: no

Default: on_demand

Example: CRYSTAL_VIEW_TYPE_LASTINSTANCE

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_VIEW_TYPE_ONDEMAND

public static final java.lang.String CRYSTAL_VIEW_TYPE_ONDEMAND

Crystal Viewer Type On Demand

Value for: CRYSTAL_VIEW_TYPE

See Also:

APPTYPE_CRYSTALREPORT

CRYSTAL_VIEW_TYPE_LASTINSTANCE

public static final java.lang.String CRYSTAL_VIEW_TYPE_LASTINSTANCE

Crystal Viewer Type Last Instance

Value for: CRYSTAL_VIEW_TYPE

See Also:

APPTYPE_CRYSTALREPORT

CONTENT_INTEGRATOR_ID

public static final java.lang.String CONTENT_INTEGRATOR_ID

Content Integrator ID
ID of the Content Integrator application

Type: String

Mandatory: yes, if not defined by the iView

Default: no default

Example: "CI.APP.DISPLAY_SCHEMA"

See Also:

APPTYPE_CONTENTINTEGRATOR

GENERIC_ID

public static final java.lang.String GENERIC_ID

Generic Application ID
The ID of the remote application. If this field is defined you can use the experssion <Id> inside the GENERIC_URL_TEMPLATE in order to abstract from the concrete application. Therefore one can define an iView that contains a generic URL template and a set of derrived iViews which define the specific application IDs.

Type: String

Mandatory: no

Default: no default

Example: "RemoteApp_01"

See Also:

APPTYPE_GENERIC

GENERIC_URL_TEMPLATE

public static final java.lang.String GENERIC_URL_TEMPLATE

Generic URL Template
The URL template includs expressions placed in <...> that are evaluated during runtime, e.g: The URL template 'http://myserver?language=<Request.Language>' will be resolved to 'http://myserver?language=en' if the user language is english.

Type: String

Mandatory: yes, if not defined by the iView

Default: no default

Example: "http://www.somewhere.com/<Id>?lang=<Request.Language>"

See Also:

APPTYPE_GENERIC, ITemplateProcessor, com.sapportals.portal.appintegrator

GENERIC_USERMAPPING_TEMPLATE

public static final java.lang.String GENERIC_USERMAPPING_TEMPLATE

Generic User Mapping Template
The user mapping template fraction is resolved during runtime and its result is stored in the variable 'Authentication'. The expression <Authentication> can be used inside the URL template to pass user id and password to the web application, e.g: the template fraction '<MappedUser>:<MappedPassword>@' can be used for basic authentication. This field requires that the SYSTEM_KEY is defined and that its Logon Method is set to UIDPW.

Type: String

Mandatory: no

Default: no default

Example: "userid=<MappedUser>&password=<MappedPassword>"

See Also:

APPTYPE_GENERIC

GENERIC_SAPLOGONTICKET_TEMPLATE

public static final java.lang.String GENERIC_SAPLOGONTICKET_TEMPLATE

Generic SAP Logon Ticket Template
The Single Sign-On template fraction is resolved during runtime and its result is stored in the variable 'Authentication'. The expression <Authentication> can be used inside the URL template to pass the SSO2 ticket to the web application, e.g: the template fraction '<Request.SSO2Ticket>' will fill the variable 'Authentication' with the SSO2 ticket. This field requires that the SYSTEM_KEY is defined and that its Logon Method is set to SAPLOGONTICKET.

Type: String

Mandatory: no

Default: no default

Example: "MYSAPSSO2=<Request.SSO2Ticket>"

See Also:

APPTYPE_GENERIC

GENERIC_APPLICATION_PARAMETER

public static final java.lang.String GENERIC_APPLICATION_PARAMETER

Generic Application Parameter
URL-querystring like list of parameters that are passed to the remote application.

Type: String

Mandatory: no

Default: no default

Example: "email=<User.email>&locale=<Request.Locale>"

See Also:

APPTYPE_GENERIC

Method Detail

createIViewURL

public java.lang.String createIViewURL(com.sapportals.portal.prt.component.IPortalComponentRequest request,
                                       java.lang.String applicationType,
                                       java.util.Hashtable parameterization)
                                throws IViewUrlGeneratorException

Computes an iView URL for the given parameterization. The parameterization is a hashtable that contains properties that control the URL creation process. You can specify an iView (see IVIEW_KEY which contains already predefined properties like the SAP system for instance). If you don't specify an iView the portal component related to the application type is choosen and you have to specify all parameters that are mandatory for the this application type. If the application type equals "Transaction" (see APPTYPE_TRANSACTION) and you don't provide a value for IVIEW_KEY than you have to provide at least values for SYSTEM_KEY, TRANSACTION_TCODE and TRANSACTION_GUITYPE.

Parameters:

request - the portal component request

applicationType - the SAP application type (e.g. Transaction, BSP etc.)

parameterization - a hashtable that contains the parameters for the given application type.

Returns:

iView URL that starts the given application type with the given parameterization.

Throws:

IViewUrlGeneratorException - if the iView URL couldn't be computed (unknown system for example)

See Also:

APPTYPE_TRANSACTION, APPTYPE_BSP