Publish your additional operator mapping fields to Pega Process Fabric Hub
by configuring the pyPF_SetRequest data transform in your remote
application. For example, you can publish additional fields that pass information about a
region where users work, or skills that users need to have to resolve an
assignment.
Before you begin:
Create or use existing properties that you want to pass as fields to Pega Process Fabric Hub. Create the properties in the
PPF-Data-Ext-Operator class. For more information, see
Properties.Note: As a best practice, create additional
properties and configure the pyPF_SetRequest data
transform before you register your application to Pega Process Fabric Hub. If your business scenario requires adding
custom fields to a registered application, stop the sync between the
application and Pega Process Fabric Hub, configure additional
fields, and then start the sync with Pega Process Fabric Hub. For
more information, see Managing applications in Pega Process Fabric Hub.
After you install the Pega Process Fabric Hub Connector component, your remote
application includes multiple instances of the pyPF_SetRequest
data transform that apply to different classes. The instance that you select depends
on the class that stores your custom data model fields.
In the navigation pane of Dev Studio,
click Records.
Expand the Data Model category, and then click
Data Transform.
In the list of data transform instances, open the data transform that you want
to edit:
To edit a data transform for fields that you store in the
Data-Admin-Operator-ID- class, open the
pyPF_SetRequest data transform that applies to the
Data-Admin-Operator-ID- class, as shown in the
following figure:Opening pyPF_SetRequest data transform
To edit a data transform for fields that you store in the class
different from Data-Admin-Operator-ID-, open the
pyPF_SetRequest data transform that applies to the
System-Queue-PPF-Connect-Operator-.
Copy the data transform into your application ruleset:
On the rule form header, click Save as.
On the Save as Data Transform form, in the
Context section, in the Add to
ruleset list, select your application ruleset.
Click Create and open.
On the Pages & Classes tab,click Add
item, and then, in the Page name field,
enter RequestPage.custom and in the
Class field, enter $NONE.
RequestPage.custom is a page that stores additional
properties to pass to Pega Process Fabric Hub.
On the Definition tab, click Add a
row.
In the Action column of the new row, select
Update Page.
In the Target column, enter
RequestPage.custom.
In the new row that appears, in the Action column,
select Set.
In the Target column, select the field that you want to
publish to Pega Process Fabric Hub.For example: To add a field that represents a skill, enter
.skill.
In the Source column, enter a value that you want to
assign to the field.For example: To display a skill related to speaking French, enter
"French".
You can use constants and autopopulated properties.
Optional: To add more fields, repeat steps 6 through 11.
Click Save.
Result: The following figure shows the
pyPF_SetRequest data transform in an application ruleset. The
data transform includes a new row that passes information about a skill.pyPF_SetRequest data transform
Mapping additional operator fields
Map your additional operator fields between your remote application and
Pega Process Fabric Hub, so that the remote application can correctly
publish additional operator data. You map operator fields by configuring the
PopulateAdditionalFields data transform in Pega Process Fabric Hub.
For example, in your remote application you can
create the .skill property that corresponds with the field that stores
the skill of an operator. Then, in Pega Process Fabric Hub, you create a property
that can accept data from your remote application, and that you can use to display the skill
at run time, for example, in Interwoven Worklist. Finally, you map the
property from your remote application to the property in Pega Process Fabric Hub
by configuring the PopulateAdditionalFields data transform.
Before you begin: In Pega Process Fabric Hub, create properties that
match properties in your remote application. Matching properties can have different
names in both applications. Ensure that the type of properties is scalar, Page List, or
Page Group, and that you store the properties in the
PPF-Data-Ext-Operator class. For more information, see Properties and Configuring page, page group, and page list properties.
You configure the
PopulateAdditionalFields data transform in Pega Process Fabric Hub.Note: Configuration of the
PopulateAdditionalFields data transform applies to scalar,
Page List, and Page Group properties. If your properties use advanced logic, you
copy and then modify the PopulateAdditionalFields activity that
applies to the PPF-Data-Ext-Operator class. Modifications to
the PopulateAdditionalFields activity depend on your unique
business scenario. For more information, see Configuring steps in an activity.
In the navigation pane of Dev Studio,
click Records.
Expand the Data Model category, and then click
Data Transform.
In the list of data transform instances, click the
PopulateAdditionalFields data transform that applies
to the PPF-Data-Ext-Operator class, as shown in the
following figure:
Opening PopulateAdditionalFields data transform
Copy the data transform to your ruleset:
On the rule form header, click Save as.
On the Save as Data Transform rule form, in the
Context section, in the Add to
ruleset list, select a ruleset to store the data
transform.
Click Create and open.
On the Definition tab, click Add a
row.
In the Action column, select
Set.
In the Target column, enter the property that you store
in Pega Process Fabric Hub.For example: Enter .Skill.
In the Source column, enter the property that you store
on the RequestPage.custom data page in your remote
application.For example: Enter .skill.
Optional: To add more properties, repeat steps 5 through 8.
Click Save.
For example: The following figure shows the PopulateAdditionalFields data
transform that maps the .skill property from the remote application
to the .Skill property from Pega Process Fabric Hub:PopulateAdditionalFields data transform
Optional: Validating additional operator fields
If your use case requires restricting input values in additional operator
fields, validate properties that correspond with the fields. For example, you can create
a property that stores a skill rating that a user is required to have, to resolve the
assignment. You can then create validation to ensure that users can provide only values
that are greater than 0.
As a result, you ensure that assignment management
and routing in Pega Process Fabric Hub is error-free and meets your business
requirements.
To
provide validation for operator fields, you configure the
ValidateAdditionalFields validate rule, or, if your properties
use advanced validation logic, the ValidateAdditionalFields
activity, and then the MapToAPIFields decision table that applies
to the PPF-Data-Ext-Operator class. The validate rule and the
activity store conditions for validation, and the MapToAPIFields
decision table map the properties from your remote application to the properties from
Pega Process Fabric Hub.
As a result, Pega Process Fabric Hub
can display error messages that include property names from the remote application,
so that you can quickly identify and investigate a property that fails validation.
You configure validation in the instance of your system that stores Pega Process Fabric Hub.
Provide validation for operator fields:
Choices
Actions
If you use standard validation logic for your properties,
configure the ValidateAdditionalFields validate
rule.
In the navigation pane of Dev Studio,
click Records.
Expand the Process category, and then click
Validate.
In the list of validate rules instances, click the
ValidateAdditionalFields validate
rule that applies to the
PPF-Data-Ext-Operator class.
On the validate rule form, click Save
as.
On the Save as Validate form, in the
Context section, in the
Add to ruleset list, select a
ruleset to store the validate rule, and then click
Create and open.
On the Validate tab, create
validation for your properties with required
conditions.
On the Validate form, click
Save.For example: The following figure shows a validation for the
.Skill property. The validation
states that the only allowed values are greater than 0. If
users provide an incorrect value, Pega Process Fabric Hub displays an error message. Property validation
If you use advanced validation logic for your properties,
configure the ValidateAdditionalFields
activity.
In the navigation pane of Dev Studio,
click Records.
Expand the Technical category, and then
click Activity.
In the list of activity instances, click the
ValidateAdditionalFields activity
that applies to the
PPF-Data-Ext-Operator class.
On the activity rule form, click Save
as.
On the Save as Activity form, in the
Context section, in the
Add to ruleset list, select a
ruleset to store the activity, and then click
Create and open.
Modify the validation method for your property.
Modifications to the
ValidateAdditionalFields activity
depend on your unique business scenario. For more
information, see Configuring steps in an activity.
On the ValidateAdditionalFields
activity rule form, click Save.
Configure the MapToAPIFields decision table:
In the navigation pane of Dev Studio,
click Records.
Expand the Decision category, and then click
Decision Table.
In the list of decision table instances, click the
MapToAPIFields decision table that applies to
the PPF-Data-Ext-Operator class.
On the decision table rule form, click Save
as.
On the Save as Decision Table form, in the
Context section, in the Add to
ruleset list, select the ruleset to store the decision
table, and then click Create and open.
On the Table tab, in the field
name column, enter the property from Pega Process Fabric Hub that you want to validate.
In the Return column, enter the matching
property from your remote application.
Optional: To map more properties, on the toolbar click Insert Row
After, and then repeat steps 2.f and 2.g.
Click Save.
Result: For more intuitive debugging, Pega Process Fabric Hub displays
the property name from your remote application, for example, in the error logs,
as shown in the following figure:Error logs in Pega Process Fabric Hub
Optional: Adding custom operator fields to Next Best Work
For more precise routing of assignments, you can incorporate your additional operator
fields into the Next Best Work algorithm. For example, you can create additional fields that
correspond with different skills, such as speaking French or programming in Java, and then
add the fields to Next Best Work. As a result, Pega Process Fabric Hub routes
assignments to users with the most appropriate skills.
You add custom operator fields to the Next Best Work algorithm by configuring the
GetNextUnifiedWorkList and
GetNextUnifiedWork report definitions that apply to the
PPF-Work-Task class. You perform the configuration in the
system that hosts Pega Process Fabric Hub.
Configure the GetNextUnifiedWorkList report
definition:
In the navigation pane of Dev Studio,
click Records.
Expand the Reports category, and then
click Report Definition.
In the list of report definition instances, click the
GetNextUnifiedWorkList that applies to the
PPF-Work-Task class.
In the rule form header, click Save as.
On the Save as report definition form, in the
Context section, in the Add to
ruleset list, select a ruleset to store the report
definition.
On the Query tab, click Add
column.
In the Column source column, enter the property
from Pega Process Fabric Hub that you want to display.For example: Ensure that you start the property name with
.Custom. For example, to add a field that
stores a skill rating for speaking French, enter
.Custom.FrenchRating.
In the Column name column, enter a label for the
field that you want to use in reports.For example: Enter French rating.
Optional: To add more properties, repeat steps 1.f through 1.h.
Click Save.
Configure the GetNextUnifiedWork report definition:
In the navigation pane of Dev Studio,
click Records.
Expand the Reports category, and then
click Report Definition.
In the list of report definition instances, click the
GetNextUnifiedWork that applies to the
PPF-Work-Task class.