URL addressability in Process Portal

Each page in Process Portal has its own unique URL. Process Portal users can bookmark or share a URL with other users to easily navigate back to the page. In custom client applications, use the URL to navigate between coaches.

The URLs for the Process Portal pages have the following format:
Dashboards
/ProcessPortal/dashboards/application_acronym/service_name/snapshot_name?systemID=system_ID
Where:
application_acronym
Required. The acronym for the Process Portal name.
service_name
Required. The client-side human service that is exposed as the dashboard.
/snapshot_name
Optional. If a snapshot is not specified, the default snapshot is used.
?systemID=system_ID
Required for federated environments only. The value of the parameter is used to retrieve the dashboard from a specific IBM® BPM system. If a system ID is not specified for a federated environment, the first dashboard that matches the application acronym and service name on any system is used for the URL.
Examples:
Non-federated environments
  • /ProcessPortal/dashboards/application_acronym/service_name
  • /ProcessPortal/dashboards/application_acronym/service_name/snapshot_name
Federated environments
  • /ProcessPortal/dashboards/application_acronym/service_name
  • /ProcessPortal/dashboards/application_acronym/service_name/snapshot_name
  • /ProcessPortal/dashboards/application_acronym/service_name?systemID=system_ID
  • /ProcessPortal/dashboards/application_acronym/service_name/snapshot_name?systemID=system_ID
Instance Details
/ProcessPortal/launchInstanceUI?instanceId=instance_ID&systemID=system_ID
Where:
instanceId=instance_ID
Required. The ID of the process instance.
&systemID=system_ID
Required for federated environments only. The value of the parameter is used to retrieve the instance details from a specific IBM BPM system.
Examples:
Non-federated environments
  • /ProcessPortal/launchInstanceUI?instanceId=instance_ID
Federated environments
  • /ProcessPortal/launchInstanceUI?instanceId=instance_ID&systemID=system_ID
Task Completion
/ProcessPortal/launchTaskCompletion?taskId=task_ID&systemID=system_ID
Where:
taskId=task_ID
Required. The ID of the task.
&systemID=system_ID
Required for federated environments only. The value of the parameter is used to retrieve the task details from a specific IBM BPM system.
Examples:
Non-federated environments
  • /ProcessPortal/launchTaskCompletion?taskId=task_ID
Federated environments
  • /ProcessPortal/launchTaskCompletion?taskId=task_ID&systemID=system_ID
Process Diagram
/ProcessPortal/launchProcessDiagram?instanceId=instance_ID&systemID=system_ID
Where:
instanceId=instance_ID
Required. The ID of the process instance.
&systemID=system_ID
Required for federated environments only. The value of the parameter is used to retrieve the instance details from a specific IBM BPM system.
Examples:
Non-federated environments
  • /ProcessPortal/launchProcessDiagram?instanceId=instance_ID
Federated environments
  • /ProcessPortal/launchProcessDiagram?instanceId=instance_ID&systemID=system_ID
Audit History
/ProcessPortal/launchAuditHistory?instanceId=instance_ID&systemID=system_ID
Where:
instanceId=instance_ID
Required. The ID of the process instance.
&systemID=system_ID
Required for federated environments only. The value of the parameter is used to retrieve the instance details from a specific IBM BPM system.
Examples:
Non-federated environments
  • /ProcessPortal/launchAuditHistory?instanceId=instance_ID
Federated environments
  • /ProcessPortal/launchAuditHistory?instanceId=instance_ID&systemID=system_ID
Parent topic: Customizing Process Portal