Optional scenario keys

You can use the optional IBM® BPM endpoint scenario keys to configure endpoints for complex topologies.

Table 1. Optional scenario keys for generated URLs
Optional IBM BPM endpoint scenario keys	Which default scenario objects is used if the optional scenario object is not set (`EXTERNAL_CLIENT`, `INTERNAL_CLIENT`, or `RELATIVE`)	Notes
`AE_BPM_REST_SERVICE_CR_PREFIX`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer authoring environment to contact the IBM BPM REST API service.
`AE_IMAGES_PREFIX`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer authoring environment to get images.
`AE_PORTAL_PREFIX`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer authoring environment to reach Process Portal.
`AE_REPOSITORY_PREFIX`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer authoring environment to reach the repository.
`AE_REST_GATEWAY_CR_PREFIX`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer authoring environment to reach the REST Services Gateway.
`AE_SERVLET_PREFIX`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer. This scenario must specify an absolute URL by setting the `url` property. The purpose of this scenario key is so that you can add your own target to the whitelist of targets to which Process Portal can redirect browsers to access dashboards. For security reasons, redirection to arbitrary targets is not allowed. IBM BPM enforces the following whitelist for allowable redirect targets. `localhost` `127.0.0.1` The host that is identified by the `AE_SERVLET_PREFIX` scenario's `url` attribute, which must be specified as an absolute URL. The host that is identified by the `PROCESS_PORTAL_DASHBOARD_REDIRECT_ADDITIONAL_WHITELISTED` scenario.
`AE_TO_PS`	`EXTERNAL_CLIENT`	Configures the base URL that will be used by the Process Designer authoring environment to communicate with a connected Process Server. This scenario key is configured on the Process Server.
`AE_WEBAPI_PREFIX`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer authoring environment to reach the web API.
`AE_WEB_PD_PREFIX`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer authoring environment to reach Web based Process Designer.
`AE_SOCIALBUS_WEBAPP_PREFIX`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer authoring environment to reach the social bus web application.
`BPM_HELP`	`RELATIVE` and `EXTERNAL_CLIENT`	Configures the URLs generated to access the product help information in the BPMHelp.war file. If there is an active user, for example using a browser, the `RELATIVE` default is used, otherwise, if there is no active user, such as for a link in an email, the `EXTERNAL_CLIENT` default is used.
`BPM_REST`	`RELATIVE`	Configures the URLs generated to access the REST APIs.
`COACHGENERATION_TEAMWORKS_JS`	`RELATIVE`	Configures the URLs that are used in JavaScript variables in coaches to reach the `IBM_BPM_Teamworks` application.
`COACHGENERATION_BPMREST_JS`	`RELATIVE`	Configures the URLs that are used in JavaScript variables in coaches to reach the REST API.
`COACHGENERATION_PROCESSPORTALSUPPORT_JS`	`RELATIVE`	Configures the URLs that are used in JavaScript variables in coaches to reach the Process Portal supporting application.
`COACHGENERATION_SOCIALBUSWEB_JS`	`RELATIVE`	Configures the URLs that are used in JavaScript variables in coaches to reach the Process Portal notification application.
`COACHGENERATION_PROCESSPORTAL_JS`	`RELATIVE`	Configures the URLs that are used in JavaScript variables in coaches to reach the Process Portal application.
`COACHGENERATION_WEBVIEWER_JS`	`RELATIVE`	Configures the URLs that are used in JavaScript variables in coaches to reach the webviewer application.
`COACHGENERATION_AJAX_SERVLET`	`RELATIVE`	Configures the URLs that are used in JavaScript variables in coaches to reach Ajax services.
`COMMON_COACH_DESIGNER_XSL_URL`	`EXTERNAL_CLIENT`
`COMMON_PORTAL_PREFIX`	`EXTERNAL_CLIENT`
`COMMON_PROCESS_ADMIN_PREFIX`	`EXTERNAL_CLIENT`
`COMMON_TEAMWORKS_WEBAPP_PREFIX`	`EXTERNAL_CLIENT`	Is used to point to the IBM BPM virtual host that is used by the `TeamworksWebappPrefixLegacyStrategy` strategy. For more information about this strategy, see Strategies for identifying endpoint information.
`COMMON_WEBSERVICES_BASE_URL`	`EXTERNAL_CLIENT`
`EXPOSED_ITEMS`	`EXTERNAL_CLIENT`	Configures generated URLS for items that are exposed, such as favorites. By default it uses the `XForwardedHeaderStrategy` strategy.
`HEARTBEAT_DESIGNATED_DEPLOYMENT_ENDPOINT`	`INTERNAL_CLIENT`	Configures the URL that is used by Process Center to deploy applications to Process Server. The endpoint must resolve to the teamworks.war web module in the `IBM_BPM_Teamworks` application.
`IBM_BPM_DOCUMENTSTORE_CMIS_WEBSERVICE`	`INTERNAL_CLIENT`	Configures how the `EmbeddedECM` finds the CMIS web service.
`LSW_SERVLET`	`EXTERNAL_CLIENT`	Used by the LSW servlet. By default, it uses the following strategies: `WCCMConfigStrategy`, `XForwardedHeaderStrategy`, and `HttpProtocolHostStrategy`.
`NAVIGATION_UTILITY_TO_TEAMWORKS_HTML`	`RELATIVE`	Configures the navigation URLs that are generated in the utility module. These URLs are used by Process Portal.
`NAVIGATION_UTILITY_TO_TEAMWORKS_JSON`	`RELATIVE`	Configures the URLs in the navigation tree of the Server Admin tab of the Process Admin Console.
`PROCESSADMIN_TO_TEAMWORKS`	`RELATIVE`	Configures the URLs that are used from Process Admin Console to reach the `IBM_BPM_Teamworks` application.
`PROCESS_CENTER`	`EXTERNAL_CLIENT`	Configures URLs to Process Center.
`PROCESS_CENTER_RELATIVE`	`RELATIVE`	Configures URLs that are relative to the Process Center.
`PROCESSCENTER_TO_PROCESSADMIN`	`EXTERNAL_CLIENT`	Configures the URL that is used by the Process Center console to open the Process Admin Console of the online Process Server.
`PROCESS_PORTAL`	`RELATIVE` and `EXTERNAL_CLIENT`	Configures URLs to Process Portal. If there is an active user, for example using a browser, the `RELATIVE` default is used, otherwise, if there is no active user, such as for a link in an email, the `EXTERNAL_CLIENT` default is used.
`PROCESS_PORTAL_DASHBOARD_REDIRECT_ADDITIONAL_WHITELISTED`	`EXTERNAL_CLIENT`	The purpose of this scenario key is so that you can add your own target to the whitelist of targets to which Process Portal can redirect browsers to access dashboards. For security reasons, redirection to arbitrary targets is not allowed. IBM BPM enforces the following whitelist for allowable redirect targets. `localhost` `127.0.0.1` The host that is identified by the `AE_SERVLET_PREFIX` scenario's `url` attribute, which must be specified as an absolute URL. The host that is identified by the `PROCESS_PORTAL_DASHBOARD_REDIRECT_ADDITIONAL_WHITELISTED` scenario.
`PROCESS_PORTAL_JS`	`RELATIVE`	Configures URLs to Process Portal. You must set this scenario key in the following cases: IBM Security Access Manager WebSEAL is configured in the IBM BPM topology. If the `PROCESS_PORTAL` scenario key is configured for some other environment that is not related to WebSEAL or Sametime, then the `PROCESS_PORTAL_JS` scenario key must match the setting for the `PROCESS_PORTAL` scenario key.
`PROCESS_PORTAL_SUPPORT`	`RELATIVE` and `EXTERNAL_CLIENT`	Configures URLs to Process Portal support. If there is an active user, for example using a browser, the `RELATIVE` default is used, otherwise, if there is no active user, such as for a link in an email, the `EXTERNAL_CLIENT` default is used. If Lotus Sametime is configured in the IBM BPM topology, set this scenario to use the `WCCMConfigStrategy` strategy and set the `virtualHost` property to point to the virtual host information object for the Process Portal server.
`PROCESS_PORTAL_SUPPORT_TO_BPM_HELP`		Configures URLs that are from Process Portal support to BPM help.
`PROCESS_PORTAL_SUPPORT_TO_PROCESS_PORTAL`		Configures URLs that are from Process Portal support to Process Portal.
`PROCESS_PORTAL_SUPPORT_TO_TEAMWORKS` and `PROCESS_PORTAL_SUPPORT_TO_TEAMWORKS_JS`		Configures URLs that are from Process Portal support to the Teamworks web archive WAR file. Important: If you useIBM Security Access Manager WebSEAL, the scenario key ending with `_JS` must be configured to include the WebSEAL junction name so that URLs that are generated in JavaScript are handled correctly. If you do not use IBM Security Access Manager WebSEAL, both scenario keys must be set identically.
`PROCESS_PORTAL_TO_BPM_HELP` and `PROCESS_PORTAL_TO_BPM_HELP_JS`	`RELATIVE`	Configures the links in Process Portal that point to the product help information in the BPM_HELP.war file. Important: If you useIBM Security Access Manager WebSEAL, the scenario key ending with `_JS` must be configured to include the WebSEAL junction name so that URLs that are generated in JavaScript are handled correctly. If you do not use IBM Security Access Manager WebSEAL, both scenario keys must be set identically.
`PROCESS_PORTAL_TO_BPM_REST` and `PROCESS_PORTAL_TO_BPM_REST_JS`	`RELATIVE`	Configures URLs that are from Process Portal to the IBM BPM REST API. Important: If you useIBM Security Access Manager WebSEAL, the scenario key ending with `_JS` must be configured to include the WebSEAL junction name so that URLs that are generated in JavaScript are handled correctly. If you do not use IBM Security Access Manager WebSEAL, both scenario keys must be set identically.
`PROCESS_PORTAL_TO_BUSINESS_SPACE` and `PROCESS_PORTAL_TO_BUSINESS_SPACE_JS`	`RELATIVE`	Configures URLs that are from Process Portal to Business Space. Important: If you useIBM Security Access Manager WebSEAL, the scenario key ending with `_JS` must be configured to include the WebSEAL junction name so that URLs that are generated in JavaScript are handled correctly. If you do not use IBM Security Access Manager WebSEAL, both scenario keys must be set identically.
`PROCESS_PORTAL_TO_BUSINESS_SPACE_HELP` and `PROCESS_PORTAL_TO_BUSINESS_SPACE_HELP_JS`	`RELATIVE`	Configures URLs that are from Process Portal to Business Space help. Important: If you useIBM Security Access Manager WebSEAL, the scenario key ending with `_JS` must be configured to include the WebSEAL junction name so that URLs that are generated in JavaScript are handled correctly. If you do not use IBM Security Access Manager WebSEAL, both scenario keys must be set identically.
`PROCESS_PORTAL_TO_MASHUPS_RUNTIME` and `PROCESS_PORTAL_TO_MASHUPS_RUNTIME_JS`	`RELATIVE`	Configures URLs that are from Process Portal to mashups run time. Important: If you useIBM Security Access Manager WebSEAL, the scenario key ending with `_JS` must be configured to include the WebSEAL junction name so that URLs that are generated in JavaScript are handled correctly. If you do not use IBM Security Access Manager WebSEAL, both scenario keys must be set identically.
`PROCESS_PORTAL_TO_PROCESS_PORTAL_SUPPORT` and `PROCESS_PORTAL_TO_PROCESS_PORTAL_SUPPORT_JS`	`RELATIVE`	Configures URLs that are from Process Portal to Process Portal support. Important: If you useIBM Security Access Manager WebSEAL, the scenario key ending with `_JS` must be configured to include the WebSEAL junction name so that URLs that are generated in JavaScript are handled correctly. If you do not use IBM Security Access Manager WebSEAL, both scenario keys must be set identically.
`PROCESS_PORTAL_TO_SOCIAL_BUS_WEB` and `PROCESS_PORTAL_TO_SOCIAL_BUS_WEB_JS`	`RELATIVE`	Configures URLs that are from Process Portal to social bus web. Important: If you useIBM Security Access Manager WebSEAL, the scenario key ending with `_JS` must be configured to include the WebSEAL junction name so that URLs that are generated in JavaScript are handled correctly. If you do not use IBM Security Access Manager WebSEAL, both scenario keys must be set identically.
`PROCESS_PORTAL_TO_TEAMWORKS` and `PROCESS_PORTAL_TO_TEAMWORKS_JS`	`RELATIVE`	Configures URLs that are from Process Portal targeting the Teamworks web archive WAR file. Important: If you useIBM Security Access Manager WebSEAL, the scenario key ending with `_JS` must be configured to include the WebSEAL junction name so that URLs that are generated in JavaScript are handled correctly. If you do not use IBM Security Access Manager WebSEAL, both scenario keys must be set identically.
`PROCESS_PORTAL_TO_WEBAPI` and `PROCESS_PORTAL_TO_WEBAPI_JS`	`RELATIVE`	Configures URLs that are from Process Portal to the web API. Important: If you useIBM Security Access Manager WebSEAL, the scenario key ending with `_JS` must be configured to include the WebSEAL junction name so that URLs that are generated in JavaScript are handled correctly. If you do not use IBM Security Access Manager WebSEAL, both scenario keys must be set identically.
`PROCESS_PORTAL_TO_WEBVIEWER` and `PROCESS_PORTAL_TO_WEBVIEWER_JS`	`RELATIVE`	Configures URLs that are from Process Portal to the web viewer. Important: If you useIBM Security Access Manager WebSEAL, the scenario key ending with `_JS` must be configured to include the WebSEAL junction name so that URLs that are generated in JavaScript are handled correctly. If you do not use IBM Security Access Manager WebSEAL, both scenario keys must be set identically.
`REMOTE_AL`		Configures URLs to the remote artifact loader's Remote_AL_WEB.war file. There is one remote artifact loader per deployment environment, so if you have multiple deployment environments, you must define the `REMOTE_AL` scenario for each deployment environment to direct appropriately to `https://hostname:port/RemoteAL/`, where `RemoteAL` is specified as a required `uriPrefix`.
`SERVER_ACTIVITY_STREAM_IMAGE_LINK`	`EXTERNAL_CLIENT`	Configures the URL for the activity stream image, for example, `https://sureshb13:9443/ProcessPortal`. The path `/com/ibm/bpm/social/img/Bpm_connections_48x48.png` is appended to the value that you specify.
`SERVER_EMAIL_GADGET_LINK`	`EXTERNAL_CLIENT`	Configures the URL for the gadget XML file, for example `https://sureshb13:9443/ProcessPortal`. The path `/gadgets/OpenSocial/BPMOpenSocialGadget.xml` is appended to the value that you specify.
`SERVER_EMAIL_PORTAL_LINK`	`EXTERNAL_CLIENT`	Configures the URLs for links to Process Portal that are included in emails.
`SERVER_EMAIL_PORTAL_PROCESS_INFO_LINK`	`EXTERNAL_CLIENT`	Configures the URL for links to process information that are included in emails, for example `https://sureshb13:9443/ProcessPortal`. The path `/dashboards/TWP/Process+Performance?tw.local.selectedInstanceId={6}` is appended to the value that you specify.
`SERVER_EMAIL_PORTAL_RUN_TASK_LINK`	`EXTERNAL_CLIENT`	Configures the URLs for links (to run tasks) that are included in emails, for example `https://sureshb13:9443/ProcessPortal`. The path `/dashboards/TWP/BPM_WORK?tw.local.view=taskcompletion&tw.local.taskid={2}` is appended to the value that you specify.
`SERVER_EMAIL_TEMPLATE_CLIENT_LINK`	`EXTERNAL_CLIENT`	Configures the URLs for links (to the client template) that are included in emails.
`SERVER_TASK_NOTIFICATION_GADGET_LINK`	`EXTERNAL_CLIENT`
`SERVER_WEBIMAGES_PREFIX`	`EXTERNAL_CLIENT`
`SOCIAL_BUS_WEB`		Configures URLs to social bus web.
`TASK_REST_API`	`EXTERNAL_CLIENT`	Configures URLs used by the task REST API. By default it invokes the following strategies: `WCCMConfigStrategy`, `WebsphereProxyHeaderStrategy`, `XForwardedHeaderStrategy`, and `HttpProtocolHostStrategy`.
`TASK_TEMPLATE_REST_API`	`EXTERNAL_CLIENT`	Configures URLs used by the task template REST API. By default it invokes the following strategies: `WCCMConfigStrategy`, `WebsphereProxyHeaderStrategy`, `XForwardedHeaderStrategy`, and `HttpProtocolHostStrategy`.
`TEAMWORKS`	`RELATIVE`	Configures URLs to Teamworks.
`TEAMWORKS_TO_BUSINESSSPACE`	`RELATIVE`	Configures URLs in Teamworks to Business Space.
`TEAMWORKS_TO_MASHUPS_RUNTIME`	`RELATIVE`	Configures URLs in Teamworks to get data from mashups run time.
`TEAMWORKS_TO_PROCESS_PORTAL_SUPPORT`	`RELATIVE`	Configures URLs in Teamworks to Process Portal support.
`TEAMWORKS_TO_PROCESSADMIN`	`RELATIVE`	Configures URLs in Teamworks to get back to the Process Admin Console. For example, on the Process Admin welcome page this scenario key is used to generate the URL to the Process Status Summary widget.
`WEBVIEWER`	`RELATIVE` and `EXTERNAL_CLIENT`	Configures URLs to the web viewer. If there is an active user, for example using a browser, the `RELATIVE` default is used, otherwise, if there is no active user, such as for a link in an email, the `EXTERNAL_CLIENT` default is used.
`WEBPD`	`EXTERNAL_CLIENT`	Configures the URLs generated to access the Process Designer web editor in the web-pd.war file.
`WEBPD_TO_BPMREST`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer web editor to contact the IBM BPM REST API service.
`WEBPD_TO_BPMHELP`	`EXTERNAL_CLIENT`	Configures the URLs generated to access the product help information from the Process Designer web editor.
`WEBPD_TO_SOCIALBUS`	`EXTERNAL_CLIENT`	Configures the URLs that are used in Web based Process Designer to reach the Process Portal notification application.
`WEBPD_TO_TEAMWORKS`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer web editor targeting the Teamworks web archive WAR file.
`WEBPD_TO_COACHFLOW_RT`	`EXTERNAL_CLIENT`	Configures the URLs that are used in the Process Designer web editor targeting the coach flow web archive WAR file (bpm.coachflow.war).