Calling a dynamically selected client-side human service
version
When you use ID-based parameters to call a client-side human service as a URL, you start the service version that is exposed in a specific snapshot or tip. To call a dynamically selected version, you can use name-based parameters in the URL.
By using name-based parameters instead of the original ID-based parameters, you can keep the URL unchanged regardless of what updates to the service or process application are made and deployed.
In general, the same URL can be used whether the service usage is set to
URL, Startable Service, or
Dashboard. In addition to being exposed to user interfaces as described in
table 1 in Defining usage settings for client-side human services, all the exposed client-side human services are made
available to be called as URLs.
- Name-based parameters
- The URL can contain the following new name-based parameters:
- processApp: The short name or the acronym of the process application.
- serviceName: The name of the client-side human service.
- snapshotName: (Optional) The name of the snapshot to use. When this parameter is not specified, the default snapshot is used on Process Server, and the latest version (or tip of the default branch or track) is used on Process Center.
- ID-based parameters
- The original parameters are more specific and can override the new parameters:
- modelID: The ID of the client-side human service. When modelID is present, the serviceName parameter is ignored.
- branchID: The ID of the branch or track on Process Center. When processApp and serviceName are used, you can use branchID to identify the branch in which to find the client-side human service. When snapshotName is also present, branchID is ignored.
- snapshotID: The ID of the snapshot. When snapshotID is used, processApp, snapshotName, and branchID are ignored.
- The handling of input variables as parameters is unchanged.
Typically, you should include only the processApp and
serviceName parameters in the URL. The URL would then be composed of the name
of the host on which IBM® Process
Center server or
Process Server is installed, the port that is
designated for the server during the IBM Business
Process Manager
installation, the acronym of the process application that contains the client-side human service,
and the name of the service.
For example, you can access the Work dashboard in Process Portal from the following URL:
For example, you can access the Work dashboard in Process Portal from the following URL:
http://host_name:port/contextRootPrefix/executecf?processApp=SYSRP&serviceName=RESPONSIVE_WORKFor more information about how to configure a custom context root, see the section for the -update parameter in the BPMConfig command-line utility topic.