Build a heritage human service when you want an activity in your process or business
process definition (BPD) to create an interactive task that process participants can perform in a
web-based user interface.
Before you begin
You can create and edit heritage human services from:
- The Process Designer
- The desktop Process Designer
If you are working in the Process Designer, the heritage human service always opens
in the web editor. If you are working in the desktop Process Designer, the heritage human service opens in the
desktop editor by default. You can change a preference setting so that heritage human services
always open in the web editor. See Setting preferences in the desktop Process Designer.
About this task
A heritage human service consists of a server-based flow
that can include scripts, events, decisions, and coaches. When the
flow reaches a coach, users see the web-based form that is defined
in the coach layout. The form displays process-related data to users
and collects input from those users.
Procedure
-
Open a process application in Process Designer.
-
Click the plus sign next to User Interface, select Heritage
Human Service, and complete the wizard.
-
In the heritage human service diagram, add elements and wire them together to create a
flow.
Restriction: In the desktop
Process Designer, you cannot wire out from a coach unless the
coach (or one of its child views) contains at least one element that fires a boundary event. You can
use the Button view to fire a boundary event, or you can create a custom view that fires a boundary
event. For more information, see
Button control.
-
In the Variables view, add business process variables to support your
service.
Tip: If you provide HTML code as a default value for a variable, wrap the code using the
other type of quotation mark. For example, if the HTML values use double quotation marks, wrap the
entire code in single quotation marks as shown in the following
example:
'<font color="#f08080"><b>Some text!</b></font>'
-
Create the user interfaces used in the service.
Note: Heritage coaches are deprecated and are not
supported in the Process Designer. Only basic
support is provided to open and edit the XML model of heritage coaches in Process Designer.
- Optional:
If necessary, validate the data in the coach.
- Click Save or Finish
Editing.
-
To test the service and user interfaces, click Run Service.
Note: The following limitations apply when you run a heritage human service in playback
or debug mode in the
Process Designer:
- The human service starts as a task instead of a stand-alone service. If the playback session
does not complete, you must manually close the task in Process Portal.
- The first coach step in the human service flow runs twice before the coach user interface
displays. However, the session can complete as expected without any negative impact.
-
Iterate through steps 3 - 7 until the service runs correctly and the user interface is
correct.
-
If you want to expose the heritage human service outside of the business process (for example,
in the Process Portal), set the exposure in the
Overview properties of the service. See Exposing heritage human services.
-
If you do not want to automatically synchronize shared business objects that are inputs to this
service when the business object is changed in other instances, switch to
Overview and clear Automatically sync shared business
objects.
Important: Nested services inherit the synchronization behavior of the starting service.
In addition, if you have a service that runs custom logic and then explicitly saves your shared
business objects, always clear the automatic synchronization option. Otherwise, the shared business
object is automatically saved and the code in your service will not run.
You can also create a heritage human service from a BPD in the desktop Process Designer:
-
Open an existing BPD or create one.
-
In the diagram, drop an activity into a non-system lane and then rename the activity.
Activities dropped into any lane but System have the default client-side human service
implementation. In the remaining steps, you replace the default human service with your own.
- Right-click the activity and select Activity
Wizard from the list of options.
- In the Set up an activity page of
the wizard, select Create a heritage human service.
- If the BPD has variables that are defined, click Next.
In the Parameters page of the wizard, set whether
each business process variable is an input or output of the heritage
human service.
For example, if you have business process
variable that is named request
and the heritage human
service is to collect data to create that request for the server,
set its Input to false and Output to true.
The heritage human service then provides the data for the subsequent
process activities to act upon.
- Click Finish.
The activity now has an associated heritage human service that includes a simple
diagram.
The content of the default coach can vary, as follows:
- If you added one or more business process variables that are primitive types, the coach has an
appropriate view in the layout for each of these variables.
- If you added one or more business process variables that are complex types and they have an
associated view, the coach has that view for each of these variables.
- If you added one or more business process variables that are complex types and they do
not have an associated view, the coach has a placeholder message for each of these variables.
When you are building the coach, you replace each placeholder with a view that is appropriate for
the variable and how the coach is using it. For example, if you have a
Customer business object, you could replace the placeholder with a
Customer View that displays customer data in a set of text fields.
- A button that provides the boundary event that you can use to wire the coach to the end node.
The default content is provided for your convenience, and you can use it or replace it.