Contents
Building process applications 1
Business process management and case management 4
Getting started with IBM Process Designer 8
Process Designer interface 9
Where to edit Process Designer artifacts 11
Process Designer tips and shortcuts 14
Concurrent editing 16
Setting preferences 17
Creating new process applications 26
Creating a process application from a WebSphere Business Modeler process 28
Creating processes in IBM Process Designer 30
Modeling processes 32
Creating a business process definition (BPD) 34
Adding lanes to a BPD 37
Adding activities to a BPD 38
Adding events to a BPD 39
Modeling process execution paths by using sequence flows 41
Converging and diverging flows 42
Example gateways 45
Implementing activities in a BPD 49
Implementing a BPD activity as a human service 54
Creating loops for a BPD activity 55
Configuring a BPD activity for simple loops 57 Configuring a BPD activity for multi-instance loops 58
Assigning teams to BPDs and lanes 61
Assigning teams to BPD activities 63
Assigning a dynamically retrieved team 66
Setting up a routing policy (deprecated) 67
Defining rules with a routing policy (deprecated) 69 Assigning an activity to an ad hoc list of users (deprecated) 72
Configuring conditional activities 73
Implementing a conditional activity 74
Managing conditional activities by using the JavaScript API 76
Creating an unstructured (ad hoc) activity 77
Example: Starting an unstructured (ad hoc) activity (JavaScript API) 79
Subprocess types 81
Modeling non-reusable subprocesses 85
Working with linked processes 87
Calling a linked process dynamically 89
Modeling event subprocesses 91
Creating a user attribute definition 94
Validating processes 96
Task types 97
Creating user interfaces for a BPD 100
Building services 102
Service components 108
Building a Decision service 112
Scenario: Creating a Decision service in a Personalized Notification
process 115
Adding a Decision service to a process 122
Implementing an activity using a Decision service 124 Attaching a Decision service to a decision gateway 125
Adding a BAL Rule component to a service 128
Creating rules using the rule editor 131
Business rule parts and structure 133
Defining variables in the rule editor 136
Copying and pasting content in the rule editor 138
Setting the rule language 139
Troubleshooting BAL rule editor errors 140
Adding and modifying Decision service variables 142
Default rule variables and parameters 146
Adding variable types and business objects to a Decision service 148
Variable types 150
Testing a Decision service 153
Debugging a Decision service 155
Exception messages in Decision service testing 157 Scenario: Exporting rules to a Rule Execution Server 160
Exporting rules for use in Rule Studio 163
Configuring a remote Decision service 165
Adding a JRules Decision Service component to a service 167 Adding a Decision Table component to a service 170 Authoring rules using JavaScript in a Decision Table component 172
Decision Table controls 174
Specifying variable values using JavaScript 175
BAL reference 176
Decision service limitations 177
Building a client-side human service 178
Building a heritage human service 180
Building an Ajax service 183
Building an integration service 184
Building an advanced integration service 186
Building a General System service 189
Modeling events 190
Event types 191
Modeling delays, escalations, and timeouts by using timer events 195
Modeling message events 198
Using start message events 201
Using intermediate and boundary message events to receive messages 205 Using intermediate message events and message end events to send
messages 209
Enabling users to perform ad hoc actions (deprecated) 213 Building a sample ad hoc action (deprecated) 214 Testing a sample ad hoc action (deprecated) 216
Modeling event gateways 218
Handling errors using error events 220
Handling errors in BPDs 223
Handling errors in services 225
Error events in models from V7.5.x and earlier 227 Using Service Component Architecture to interact with processes 228
Undercover agents 232
Creating and configuring an undercover agent for a message event 234 Creating and configuring an undercover agent for a scheduled message
event 237
Creating and configuring an undercover agent for a content event 240
Documenting development artifacts 242
Linking to external information 243
Process documentation location links 246
Using external implementations 247
Building a custom application to implement an activity 248
Creating an external implementation 249
Using an external implementation to implement an activity 251 Integrating with web services, Java and databases 253
Creating outbound integrations 254
Integrating with web services 256
SOAP headers 258
Creating implicit SOAP headers for outbound web service integrations 260
Adding SOAP headers to a SOAP request message 261 Retrieving SOAP headers from the SOAP response message 263
Adding a web services server 264
Configuring a Web Service Integration component 268 Security for Web Service Integration steps 271
Web service faults 273
Serialization of objects 275
Setting up message-level encryption 276
Troubleshooting web services outbound web service integrations 279 Considerations when using WSDL with multiple XSD or WSDL imports 281
Troubleshooting XML schema messages for web service integrations 282
Calling a Java method in an integration service 287
Sending attachments using an SMTP server 290
Using Business Process Manager SQL Integration services 291
Creating inbound integrations 293
Building a sample inbound integration 294
Adding a message event to a BPD 295
Creating an undercover agent 297 Attaching the undercover agent to the message event 298
Creating a caller service 300
Creating an inbound web service 301
Testing the integration 304
Creating implicit SOAP headers for inbound web service integrations 306 Retrieving SOAP headers from an inbound request message 307 Adding SOAP headers to an outgoing response message 309 Posting a message to IBM Business Process Manager Event Manager 311 Publishing IBM Business Process Manager web services 315
Web services compatibility 317
Verifying that the web service is working 318
Calling a web service using a SOAP connector 319
Integrating BPDs with IBM Case Manager cases 322
Adding an IBM Case Manager server 323
Building the IBM Case Manager Integration service 325
Building a query for a search case operation 327
Processing a search case operation result 328
Data mapping in case operations 330
Accessing an IBM Case Manager server using the Secure Sockets Layer (SSL) 332
Designing process interactions for business users 333
Configuring a role-based business user interface 334
Exposing business process definitions 335
Exposing the Ad Hoc Reports dashboard 337
Exposing heritage human services 338
Enabling resumable services 343
Globalizing dashboard names 346
Generating portlets for heritage human services exposed as dashboards 347
Exposing client-side human services 352
Making business data available in searches and views 356 Developing flexible and efficient process applications 358
Configuring activities for inline completion 360
Optimizing BPD execution for latency 363
Automatically starting the user's next task 365
Defining ad hoc actions (deprecated) 367
Setting up collaboration features for business users 369
Enabling Sametime Connect integration 370
Specifying experts for an activity 371
Enabling IBM Connections integration 372
Enabling process instance management 374
Setting the work schedule for a BPD 377
Examples 379
Managing time and holiday schedules 380
Enabling processes for tracking and reporting 384 Tracking IBM Business Process Manager performance data 385
Data tracking considerations 387
Autotracking performance data 389
KPIs and SLAs 391
Creating custom KPIs 393
Associating KPIs with activities 394
Creating SLAs 396
Setting up autotracking 398
Tracking groups of process variables 399
Creating a tracking group 400
Associating process variables to a tracking group 401
Creating a timing interval 402
Sending tracking definitions to Performance Data Warehouse 404
Exposing performance scoreboards 406
Defining reports (deprecated) 407
Defining a custom layout (deprecated) 409
Building cases 410
Case management overview 413
Case management concepts 415
Scenario: Financial services credit card dispute resolution 418
Scenario: Automobile insurance claims 420
Designing a case 422
Opening Case Designer from Process Center 423
Creating a case type 425
Configuring how a case is started 427
Adding a case type variable or property 429
Adding case type folders 431
Assigning teams to a case type 433
Adding a case activity 434
Setting preconditions 437
Implementing an activity 440
Creating a document type 442
Example document types 444
Creating case user interfaces 445
Testing and debugging a case type 448
Services to support case management applications 450
The IBM BPM content store 453
Case artifacts and the IBM BPM content store 454
Update restrictions for modifying case artifacts 456
Creating a team 461
Using services to define dynamic teams 463
Setting up a team retrieval service 465
Setting up a team filter service 467
Defining team managers 469
Defining Team rules (deprecated) 470
Variable types 475
Variable scope 477
Creating business objects 478
Shared business objects 480
Business objects, attributes, and variables that are renamed 482
Business object advanced properties 485
Declaring and passing variables 491
How variables are passed 493
Declaring variables 496
Mapping input and output data for an activity or step 498
Declaring variables for a subprocess 500
Testing declared variables and data mapping 502
XSD generation pattern for business objects 504
Using JavaScript in BPDs 506
Initializing complex variables 507
Creating exposed process values 508
Adding an EPV to a BPD or service 510
Adding an EPV to a report 511
Setting variables in pre and post assignments 512
Making business data available in searches and views 513
Creating user interfaces for business processes 513
Which artifacts should I use? 515
User interface concepts 517
Human services 519 Dashboards 520 Coaches 521 Coach views 523 Templates 525 Properties 526 General properties 527
Configuration properties and configuration options 529 Positioning options for coach view instances 533
Visibility properties 536
HTML attributes 538
Data binding for coach views 539
Binding data and configuration options 541
Boundary events 547
Event handlers overview 548
Framework managed versus view managed content for coaches 551
Controls 553
Advanced items for coach views 554
Content box 555
Custom HTML 557
Heritage artifacts 559
Difference between heritage human services and client-side human services 561
Modeling client-side human services 565 Tools available from the palette for client-side human services 568
Building a client-side human service 572
Implementing a BPD task using a client-side human service 574
Declaring variables 575
JavaScript API for client-side human service authoring 577 Calling another service from a client-side human service 582 Implementing exclusive gateways in client-side human services 584 Saving the state of a client-side human service during execution 586 Validating client-side coaches using client-side validation 588 Validating client-side coaches using server-side validation 591
Handling errors in client-side human services 594
Exposing client-side human services 596
Adding HTML meta tags to client-side human services 596 Enabling work to be postponed and resumed at run time 597
Navigation options for after service completion 599
Running and debugging client-side human services 600
Running client-side human services 601
Debugging client-side human services 602
Troubleshooting errors from running client-side human services 604 Keyboard accessibility for client-side human services 607 Adding nodes to client-side human services by using the keyboard 610 Heritage human service to client-side human service conversion 612
Building coaches 614
Validating coaches in heritage human services 617
Developing reusable coach views 619
Providing information about coach views 622
Defining coach view behavior 624
Improving coach view performance 627
Adding custom AMD modules 629
Accessing a child coach view 631
Configuring the design-time appearance of coach views 633
Adding variables to coach views 636
Defining the contents of coach views 637
Adding bidirectional language support 639
Setting the visibility of coach views 641
Calling Ajax services from coach views 646
Generating URLs of managed assets 649
Generating a unique ID for a coach view 651
Tips for debugging coach view lifecycle method inside client-side human services 652
Tips for debugging coach views in Process Portal 654
Enabling JavaScript debugging for coaches 656
Coach and coach view troubleshooting 657
Responsive settings for coach views 658
Coach and coach view examples 660
Example: creating a template 661
Example: creating a tabbed coach 667 Example: creating a Select control using custom HTML 673
Example: creating a Dojo button control 676
Example: creating a jQuery button control 678
Example: validating a coach in a client-side human service 680 Example: validating a coach in a heritage human service 683 Example: creating a coach that calls an Ajax service 687 Example: creating a coach for tablets and smartphones 690 Example: showing the label of a complex coach view 697
Building Heritage Coaches 701
Adding sections to a Heritage Coach and controlling the layout 702
Setting column widths in a Heritage Coach 704
Setting the number of columns in a Heritage Coach 705 Examples of building services with heritage coaches 706 Example: building an integration service with a Heritage Coach 707 Nesting the Integration service and mapping its variables 708 Building Heritage Coaches to collect input and display output 709 Building a heritage human service with heritage coaches 710 Example: Building a heritage human service with coaches 713 Building an Ajax service with Heritage Coaches 715
Configuring Heritage Coach controls 717
Populating a list with static data 718
Populating a list with dynamic data 719
Binding a complex data structure to a Table control 721 Populating a table control using an SQL query 723 Binding a variable to a custom HTML component 725
Making an input control a required field 726
Displaying a control based on the input value of another control 727
Displaying a control to a specific group 729
Changing the visibility of a Heritage coach control 730
Validating user input 732
Controlling field and other formatting in Heritage Coaches 733 Using pre-defined formats in Heritage Coach Controls 734 Using characters to apply custom numeric formatting 736
Adding custom format types 740
Using formatting with variables 741
Using formatting with language localization resources 742
Configuring a Hebrew or Islamic calendar 743
Aligning buttons in a Heritage Coach 744
Aligning check boxes and radio buttons in a Heritage Coach 745 Adding documents and reports to Heritage Coaches 746 Choosing the type of documents to attach to a Heritage Coach 747 Attaching IBM Business Process Manager documents to a Heritage Coach 750
Attaching ECM documents to a Heritage Coach 753
Embedding documents in a Heritage Coach 755
How Heritage Coaches work 761
Adding custom images to a Heritage Coach 763
Overriding CSS styles for selected controls and fields 764
Specifying a custom CSS for a Heritage Coach 766
Specifying an XSL transform override for a Heritage Coach 767
Setting the length of input text fields 768
Enhancing interface layout using custom attributes 769 System services to implement conditional activities 771
Troubleshooting Heritage Coaches 772
Localizing process applications 773
Creating localization resources 774
Localizing user interfaces 776
Localizing coach view configuration options 777
Versioning process applications 778
Naming conventions 780
Naming conventions for Process Center server deployments 782 Naming conventions for Process Server deployments 786
Enabling document support 788
Working with IBM BPM documents 789
The IBM BPM document store 791
Inbound events for the IBM BPM document store 792
Inbound events for the IBM BPM content store 794
The IBM_BPM_Document document type 796
Creating IBM BPM documents 798
Updating IBM BPM documents 799
Working with the IBM_BPM_Document_Properties property 800 Writing to the IBM_BPM_Document_Properties property 801 Reading from the IBM_BPM_Document_Properties property 802 Updating the IBM_BPM_Document_Properties property 804 Specifying search criteria for the IBM_BPM_Document_Properties property 806 Working with IBM BPM documents in the Document List coach view 807
Limitations in working with IBM BPM documents 808
Integrating with Enterprise Content Management (ECM) systems 809
Adding an Enterprise Content Management server 810
Outbound interactions with Enterprise Content Management systems 812
Authentication scenarios 813
How to use Coach views to store or view documents 815 Configuring coach views for storing and viewing Enterprise Content
Management documents 817
Building a service that integrates with an ECM system or the IBM BPM
document store 820
Building a query for an Enterprise Content Management search operation 824 Working with a search result programmatically 827
Working with document content 829
Data mapping in Enterprise Content Management operations 831 Inbound events from Enterprise Content Management systems 840
Performing modeling tasks for inbound events 842 Subscribing to document and folder events: the end-to-end approach 844 Creating and configuring event subscriptions 848
Content event types 851
Creating attached services 855
Creating and configuring an undercover agent for a content event 856
Adding a content event to a BPD 856
The ECMContentEvent business object 858
Performing administrative tasks for inbound events 859 Creating an event handler for an Enterprise Content Management system 860
Using the event handler for FileNet Content Manager 862 Troubleshooting interactions with Enterprise Content Management systems 867
Integration considerations for ECM products 868
IBM FileNet Content Manager 869
IBM Content Manager 871
Alfresco Community 873
Microsoft SharePoint 875
Accessing the SharePoint CMIS provider from IBM BPM 877
Testing and debugging process applications 880
Visualizing process data 881
Visualize variables 883
Visualize tag groups 884
Keyboard shortcuts for data visualization 885
Running and debugging processes with the Inspector 887
Managing process instances 889
Restricting access to debugging for services 890
Stepping through a process 893
Debugging a process 895
Resolving errors 897
Inspector reference 898
Authentication during playback to handle changes in user identity 903
Globalization 904
Bidirectional support in IBM Business Process Manager 905 Applying bidirectional text layout transformation 906
Contextual support 908
Troubleshooting Process Designer and Process Center connectivity 909
Enabling error logging 911
Troubleshooting Process Designer and Process Center connectivity 913
Enabling error logging 913
-Building process applications
In IBM® Business Process Manager (BPM), process applications are the containers for business processes and cases that are created in IBM Process Designer.
You can either create process applications in Process Center or export and import process applications into Process Center. After a process application is created or imported, it is stored and listed in the Process Center repository. You open process applications in Process Designer where you can create and edit the business
process definitions (BPDs) or cases within those process applications.
For information about designing high-performing IBM Business Process Manager solutions, see the following publications:
For designing processes, see Chapter 5: Design considerations and patterns in
Business Process Management Design Guide: Using IBM Business Process Manager.
For best practices, see Chapter 2: Architecture best practices and Chapter 3:
Development best practices in IBM Business Process Manager V8.5 Performance
Tuning and Best Practices.
For an overview of critical performance-related information, see IBM Business
Process Manager V8.5 Performance Tuning.
The following high-level diagram illustrates the basic tasks and activities that are typically associated with building a process application.
Business process management and case management
Business process management and case management are two approaches to build a process. The type of business situation you are addressing determines which approach you use.Case management functions are only available if you have IBM BPM Advanced with the Basic Case Management feature installed.
-Getting started with IBM Process Designer
Process Designer is an easy-to-use graphics-oriented tool that enables you to model and implement your business processes and easily demonstrate process design and functionality during development efforts. This overview describes how to begin using all of the tools that are available with Process Designer.
Creating new process applications
When you create a new process application, you provide a name, acronym, and optional description of the process application.
Creating a process application from a WebSphere Business Modeler process
You can import business processes from WebSphere Business Modeler to Process Designer.
Creating processes in IBM Process Designer
Create processes in Process Designer that represent the processes in your
company. When you run your processes inside Process Designer, you can analyze and simulate them in order to optimize your business activity.
Building cases
A case is a project that starts and finishes over time to resolve a problem. The problem can involve a claim or a request or a proposal and be supplemented by many documents and records relevant to the case. A case usually involves multiple people from inside and outside of an organization. These people often have a relationship to each other. For example, a customer with a problem and a corporate support representative who solves the problem for the customer.
Creating a team
A team is a group of users that perform similar tasks, and consists of a set of members and a team of managers. Teams are used to manage the tasks that users can perform in Process Portal. Because any team can be added as the manager of another team, you can flexibly define your organization's management structure.
Business objects and variables
In Process Designer, variables capture the business data that is used by activities in a business process definition or by steps in services such as integration services or human services.
Creating user interfaces for business processes
In IBM Business Process Manager, human services provide the logic and user interface through which users can view and interact with business processes, cases, data or process instances.
Versioning process applications
Versioning provides the ability for the runtime environment to identify snapshots in the lifecycle of a process application, and to be able to concurrently run multiple snapshots on a process server.
Enabling document support
Testing and debugging process applications Globalization
To ensure that applications can be used in multiple geographical locations and cultures, globalization support is built in through appropriate design and
-layout transformation, and calendar support for Hebrew and Hijri.
Troubleshooting Process Designer and Process Center connectivity
Resolve problems starting Process Designer, for example during login, by using various techniques such as correcting invalid connection information or logging errors that are captured with log4J or java.util.logging.
-1. 2. 3. 4. 5. 6.
-Business process management and
case management
Business process management and case management are two approaches to build a process. The type of business situation you are addressing determines which approach you use.Case management functions are only available if you have IBM BPM Advanced with the Basic Case Management feature installed.
IBM® Business Process Manager provides tools for the approaches to define and then improve a process: business process management and case management. Learn the differences so that you can select the best approach for your situation. Consider two types of situations that a corporation faces. In the first situation, the corporation wants more customers to use its credit card. In the second situation, the corporation wants a process to handle calls about credit card billing problems. The following sections describe the design and implementation you would likely use for each situation.
Designs for two types of business situations Building and running a business process Building and running a case
Key differences between business process management and case management
Designs for two types of business situations
If you needed to get more customers to use your credit card, you might come up with the following activities:
Define the type of customer you think might benefit from your credit card. Use an application to search a database for potential candidates.
Use an application to email the candidates.
Review the candidates who responded to assess the effectiveness of the email and determine patterns in the list of interested customers.
Use an application to check the credit rating of the respondents.
Use an application to mail the credit cards to candidates with good credit ratings. The activities are in order and their order follows a predictable and repeatable
process. The process determines the sequence of events. It is a stable process that likely remains unchanged over many years. A number of the actions can be
automated. In this scenario, a business process would most likely be your implementation choice.
If you wanted to handle customers with credit card billing problems, you might come up with the following unordered activities:
Capture the complaint when someone called or sent an email. Get information about the customer.
Get information about the vendor.
Collect receipts and invoices to verify the complaint.
Notify Customer Records if unusual information was found.
Notify system administrators if the billing system caused problems. Notify Vendor Records if unusual information was found.
The activities are unordered because the sequence of activities is unpredictable. The events determine the order in which the activities in the process are followed. People rather than programs interact to resolve the dispute. External documents are needed for verification. In this scenario, a case would most likely be your
implementation choice.
Example of building and running a business process
The following business process might get more customers to use the corporation's credit card. It is a wired process. You can see which activity follows the other. At run time, the activities drive the events. For example, a worker defines the type of
customer that the worker is looking for and then starts the application to get the candidates and email the candidates. Then, the worker waits until there is a list of candidates to review based on the people who responded to the email. Finally, the worker starts the credit check application. The credit check application is followed by the application that mails out the credit cards. A worker at run time does not select the next activity from a set of choices to choose what comes next; the next activity is predetermined at development time.
The activities are in swimlanes that define the type of activity. The team lane is for activities that people do and the system lane is for activities that programs do. Programs automate and complete many activities. To implement these activities with human services, subprocesses, services, and teams, you use the same set of tools as you do to implement a case.
Example of building and running a case
The following case might handle credit card billing complaints. The activities are not wired. No predetermined sequence is set at development time. A worker would likely start by describing the complaint and finish by resolving the dispute. However,
whether the worker receives the customer information before the vendor information would likely be determined by what the worker read in the complaint. The
information that is retrieved about the customer would determine whether the worker would check with the people who handle the customer records. The information that is retrieved about the vendor would determine whether the worker would check with the people who handle vendor records. The information that is retrieved about either the customer or the vendor might lead to investigating the computer billing system for problems.
controls the process at run time, the process is dynamic and influenced by current events. As in a business process, the required activities must be completed.
However, optional activities do not need to be completed.
People who interact with other people, rather than automated programs, determine the activities. To verify the complaint, receipts and invoices, which are external documents independent of the case, must be captured. To implement these activities with human services, subprocesses, services, and teams, you use the same set of tools as you do to implement a business process.
Key differences between business process management
and case management
Considering the previous scenarios, the following table summarizes the
characteristics of business process management and case management. Examining these characteristics, you can select which type of process might best suit your situation.
Table 1. Characteristics of business process management and case management
Business process management Case management
You can define an ordered sequence of activities that can be completed to solve a business challenge.
You can define an unordered set of activities that can be completed to solve a business challenge.
The sequence of activities is stable and seldom changes; that is, the process is predicable and repeatable.
The activities occur in an unpredictable order.
The process determines the events. The first activity determines the first set of events, which then leads to the next activity and the next set of events. The activities are wired to one another, which determines the sequence.
The events determine the process. As events occur, a worker selects the appropriate activity. The resulting process can vary depending on the current event and the subsequent
selection by the worker. Activities are not wired to one another.
Parent topic:Building process applications
The activities are often programmatic. A repeatable sequence, such as selecting a set of potential credit card owners from a database, can be automated.
People primarily determine the activities. Handling a customer with a billing error is done by a person who uses judgment to determine the best resolution of this particular case.
External documents are not part of the process.
External documents play a key role. For example, receipts provide a record for how the problem that must be resolved began.
-Getting started with
IBM Process Designer
Process Designer is an easy-to-use graphics-oriented tool that enables you to model and implement your business processes and easily demonstrate process design and functionality during development efforts. This overview describes how to begin using all of the tools that are available with Process Designer.
For a high-level overview of the components of the Process Designer interface,
watch Getting Started with Process Designer version 8.5.5, available on YouTube
or in the IBM Education Assistant information center. A transcript of the video is available.
Process Designer interface
Before you start to build processes with IBM Process Designer, you must understand the tools that are available in the Process Designer interface.
Where to edit Process Designer artifacts
Learn where you can edit artifacts in IBM Process Designer.
Process Designer tips and shortcuts
You can use several features in Process Designer to improve your efficiency.
Concurrent editing
Multiple users can simultaneously access and change process applications and library items in IBM Process Designer. When you edit concurrently, you collaborate with other team members to create the library items that you need for your project. For example, you can communicate about your ideas and edits with instant
messaging and see the results in the Designer view as they happen.
Setting preferences
IBM Process Designer provides several settings to control the appearance and functionality of the editors and interfaces that it includes.
Process Designer interface
Before you start to build processes with IBM® Process Designer, you must understand the tools that are available in the Process Designer interface.
The Process Designer interface provides the tools to model your processes in IBM BPM. The following image and corresponding table describe the parts of the
Designer view that you interact with when modeling processes and implementing the steps in those processes.
Table 1. Description of numbered areas on the Designer interface image
Number Area Description
1 Main toolbar Provides access to the
Designer view and
Inspector. Also provides access to Process Center and Optimizer if you open the Process Designer desktop editor. The main toolbar is also where you go to save all open editors, take a snapshot, and view web-based help.
2 Library Provides access to the
library items for the current process application. You can create and edit library items, as described in
Managing library items in the Designer view. Note: Users who have
administrative access to the application control access to process applications. For more
information, see Managing
access to the Process Center repository.
Parent topic:Getting started with IBM Process Designer
Related information:
Known issues for translated IBM BPM components
3 Main canvas Where you can graphically
model and configure your process and design the layout of coaches, human services, and heritage human services.
4 Palette Provides BPMN elements
and variables that you can use to model and configure your process.
5 Property manager Where you can set
properties and
configuration options for selected components in your process.
-Where to edit Process Designer artifacts
Learn where you can edit artifacts in IBM® Process Designer.
In previous releases, you worked with artifacts in Process Designer on your desktop. Now, you can work with artifacts that are in the Process Designer web editor and in the Process Designer desktop editor. For example, to create process applications that contain business process definitions (BPDs) and client-side human services, you must use both the desktop editor and the web editor because there are some Process Designer capabilities that you can access only on the web and some that you can access only on your desktop.
Multiple users can work simultaneously on the same process applications and artifacts in the two editors and changes happen automatically and seamlessly. If you have Process Designer open on your desktop and you are working in the web editor, you can edit certain artifacts in the desktop editor. When you click the
artifacts in the web editor, they open in the desktop editor so that you can edit them. You can access the Process Designer web editor in the following ways:
Open Process Designer desktop editor and then select an artifact that is editable only on the web, such as a client-side human service, case type, or document type. Case management functions are only available if you have IBM BPM Advanced with the Basic Case Management feature installed.
Open Process Designer desktop editor, select a coach view, and then right-click and select Open in > Web Editor.
The following table lists which artifacts you can edit where (indicated with asterisks). You can edit some artifacts in the desktop editor. You can edit other artifacts in the web editor. The web editor opens in a web browser from Process Designer.
Table 1. Where you can edit Process Designer artifacts
Artifacts Editable in the Process
Designer desktop editor
Editable in the Process Designer web editor Advanced Integration service * Ajax service * business object * * BPD * case typeNote:Case
management functions are only available if you have IBM BPM Advanced with the Basic Case
Management feature installed.
coach viewNote: To use responsive features in coach views, for example to have the runtime
behavior respond to different screen size environments, you must edit coach views in the web editor.
* *
client-side human service *
decision service *
design file *
document typeNote:Case management functions are only available if you have IBM BPM Advanced with the Basic Case
Management feature installed.
*
event subscription *
external implementation *
exposed process value *
General System service *
heritage human service *
historical analysis scenario * IBM Case Manager
Integration service
*
Integration service *
key performance indicator (KPI)
*
localization resource * *
process application setting *
server file * * service-level agreement * simulation analysis scenario * teamNote: To define a
team using a filter or
retrieval service, you need to edit this artifact in the Process Designer desktop editor.
* *
timing interval *
tracking group *
undercover agent *
Parent topic:Getting started with IBM Process Designer
-Process Designer
tips and shortcuts
You can use several features in Process Designer to improve your efficiency. When you start using the Designer interface in Process Designer, there are some tips and shortcuts to keep in mind.
The following are tips and shortcuts for the Process Designer desktop editor:
To maximize the space available for the main canvas, you can hide the library by clicking the toggle at the bottom of the Revision History. You can also hide the palette by clicking the left margin of the palette. Click the toggle icon and the palette margin to restore the library and the palette.
To move from one open library item to another, click the arrow keys or the menu at the top of the window.
Unsaved changes have an asterisk next to the item name at the top of the window. To create a new library item while you are working in the Designer view, press Ctrl+Shift+N.
To open an existing library item while you are working in the Designer view, press Ctrl+Shift+O.
To choose multiple items in a category, press and hold the Ctrl key and then click each item.
You can capture your development progress in snapshots as described in
Creating snapshots in the Designer view.
You can revert to a previous snapshot (version) of a library item as described in
Reverting to a previous version of a library item.
You can copy the previous snapshot (version) of a library item to your current
project as described in Copying an asset from a snapshot.
You can add a dependency to a toolkit to use the library items from that toolkit as
described in Creating, changing, and deleting a toolkit dependency in the Designer
view.
You can see updates that are made by other users as described in Concurrent
editing.
For quick and easy access of particular library items, you can create favorites as described in Creating favorites.
To group library items for easy access, follow the instructions in Tagging library items.
To create smart folders of library items, follow the instructions in Organizing library items in smart folders.
To move or copy library items from one process application to another, follow the instructions in Copying or moving library items.
To add and manage external files as part of your IBM® BPM project, see
Managing external files.
The following are tips and shortcuts for the Process Designer web editor:
Click the "Hide the Library" icon at the top left corner of Process Designer to hide the library.
To maximize the space available for in the main canvas, you can resize the palette and the main canvas and you can also hide the property manager by clicking the
-To move from one open library item to another, click the arrow keys or the menu at the top of the window.
To choose multiple items in a category, press and hold the Ctrl key and then click each item.
You can capture your development progress in snapshots as described in
Creating snapshots in the Designer view.
Unsaved changes have an asterisk next to the item name at the top of the window. You can add a dependency to a toolkit to use the library items from that toolkit as
described in Creating, changing, and deleting a toolkit dependency in the Designer
view.
You can see updates that are made by other users as described in Concurrent
editing.
To tag library items for easy access, follow the instructions in Tagging library items. To move or copy library items from one process application to another, follow the instructions in Copying or moving library items.
To add and manage external files as part of your IBM BPM project, see Managing
external files.
-Concurrent editing
Multiple users can simultaneously access and change process applications and library items in IBM® Process Designer. When you edit concurrently, you
collaborate with other team members to create the library items that you need for your project. For example, you can communicate about your ideas and edits with instant messaging and see the results in the Designer view as they happen.
Note: Each user must be connected to the same Process Center and each user
must have write access to the process application or toolkit where the library items are located. When you edit concurrently with other users, ensure that your
connection status is good.
When you are working in the Designer view, you can see when other users are working in the same process application, as shown in the following screen capture:
You can also see when others are viewing or editing the same library item, as shown in the following screen capture:
When multiple users work on the same library item, such as a human service, each user can see the changes when edits are saved. To ensure that all users are aware which library items are open and what changes are being made, Process Designer provides the following notifications:
When another user opens a library item by showing a user icon. You can hover over the icon to see who that user is.
When another user is editing a library item by displaying the words Read Only next to the library item. When a user saves their work, the library item will be available to edit.
When another user has saved changes while you are editing a library item by displaying the words Read Only next to the library item. When you click Save, a Save conflict message displays to ask you either to save your changes and override the other user's changes or discard the changes and accept the other user's changes.
When multiple users start to edit a library item at the same time, before the Read
Only text appears, by displaying a warning icon and message to suggest to each
user that they either immediately save their changes or discard them.
1. 2. 3.
Setting preferences
IBM® Process Designer provides several settings to control the appearance and functionality of the editors and interfaces that it includes.
Process Designer preferences
The following steps describe how to access the preference settings and the following table describes the options that are available:
Select File > Preferences from the main menu.
Click the IBM BPM entry to display the available options.
Click the option that you want. For example, to set the user name for Blueworks Live™ process subscriptions, click the Blueworks Live option.
Table 1. Options for IBM Process Designer preferences
Option Description
Blueworks Live Set the Blueworks Live server
URL and email address for Blueworks Live process
subscriptions.Tip: Changing the email address or the URL logs you out of Blueworks Live.
Capabilities Control the capabilities of the
current user. For example, to create external activities in IBM Process Designer, you must enable IBM BPM Developer Capability and IBM BPM Advanced Features.
Decisions Control the locale setting for BAL
Rules.
JavaScript Set preferences for the
JavaScript editor included in IBM Process Designer. For example, you can choose whether to display JavaScript warnings.
Optimizer Settings Set options for the Optimizer.
For example, the KPI thresholds that are used by the
Visualization Modes are the thresholds from the current working version of your process application or toolkit. If you want to use the KPI thresholds from the snapshot (version) of your process application or toolkit that was most recently run and
tracked, change the Optimizer to the following preference setting:
Use the KPI threshold values from the actual version of the Process App/Toolkit.
Process Center Console preferences
To set the locale for IBM Process Center Console and Process Designer, access the Process Center Console by opening your web browser to the following location:
http://[host_name]:[port]/ProcessCenter. Click Preferences in the upper
right corner and choose the language that you want from the list. When you change the locale, you must exit and then restart IBM Process Designer for the change to take effect. (When you are accessing Process Center Console from a browser, you can log out and then log back in for the change to take effect.)
The locale preference that you selected applies to the user who logs in. Each IBM Business Process Manager interface that is started by the same user in the same environment uses this preference setting.
Process Designer XML configuration settings
The IBM BPM settings related to Process Designer are transferred through the network from Process Center to Process Designer as properties of the
AuthoringEnvironmentConfig configuration object every time Process Designer is
launched. These properties affect the connections created between Process Designer and Process Center. Based on your business requirements, you might want to change the properties of Process Designer.
For IBM BPM XML configuration settings that are related to Process Designer, see the following table that contains properties and explains how to set the properties. The AuthoringEnvironmentConfig object contains the following properties:
Passwords Manage the passwords that are
stored when running tasks from the Inspector.
Web Browser Select the web browser to use
when web pages are opened from IBM Process Designer. If you do not see a particular external web browser as an option, click New to add it.
Name Description Additional Information
Images Prefix The Images Prefix
endpoint maps to the AE_IMAGES_PREFIX scenario key, which configures the URLs that are used in the Process Designer authoring
environment to get images.
Information about using the scenario keys to configure the IBM BPM endpoints is described in the topic
Configuring endpoints to match your topology.
Portal Prefix The Portal Prefix endpoint maps to the
AE_PORTAL_PREFIX scenario key, which configures the URLs that are used in the Process Designer authoring environment to reach Process Portal.
Repository Prefix The Repository Prefix
endpoint maps to the
AE_REPOSITORY_PREFI X scenario key, which configures the URLs that are used in the Process Designer authoring
environment to reach the repository.
Servlet Prefix The Servlet Prefix endpoint
maps to the
AE_SERVLET_PREFIX scenario key, which configures the URLs that are used in the Process Designer. This scenario must specify an absolute
URL by setting the url
property.
Social Bus WebApp Prefix The Social Bus WebApp Prefix endpoint maps to the
AE_SOCIALBUS_WEBAP P_PREFIX scenario key, which configures the URLs that are used in the
Process Designer
authoring environment to reach the social bus web application.
Web API Prefix The Web API Prefix
endpoint maps to the AE_WEBAPI_PREFIX scenario key, which configures the URLs that are used in the Process Designer authoring
environment to reach the web API.
REST Gateway Prefix The REST Gateway Prefix endpoint maps to the
AE_REST_GATEWAY_CR _PREFIX scenario key, which configures the URL that is used in the Process Designer authoring
environment to reach the Process Center REST Gateway.
Web PD Prefix The Web PD Prefix
endpoint maps to the AE_WEB_PD_PREFIX scenario key, which
configures the URL that is used in the Process
Designer authoring
environment to launch the web editor.
Webviewer WebApp Prefix The Webviewer WebApp Prefix specifies the
endpoint of the web
application contained in the webviewer.war file.The host and port number of the URL can be
customized by setting the IBM BPM virtual host. The context root of the URL can be customized by adding a prefix before the context root.
Information on setting the IBM BPM virtual host is found in the topic
Configuring endpoints to match your topology. For information about setting the context root prefix, see the topic
BPMConfig command-line utility.
BPM Asset Prefix The BPM Asset Prefix
specifies the endpoint of the web application contained in the
bpmasset.war file. The host and port number of the URL can be
customized by setting the IBM BPM virtual host. The context root of the URL can be customized by adding a prefix before the context root.
Process Portal Prefix The Process Portal Prefix specifies the endpoint of the web application
contained in the
process-portal.war file. The host and port number of the URL can be customized by setting the IBM BPM virtual host.
The context root of the URL can be customized by adding a prefix before the context root. For example,
/prefix/ProcessPortal.
HTTP Protocol Only If this attribute is set (which
is the default),
communication between Process Designer and Process Center is limited to using HTTP or HTTPS protocols instead of RMI with JMS.
Note that if the attribute is not set, HTTP or HTTPS communication still occurs between some Process Designer components and Process Center, but not exclusively.
Information on setting the
httpProtocolOnly
attribute is found in the topic Configuring the httpProtocolOnly property for Process Designer.
Suppress Redirect URL Password
Specifies whether to suppress the inclusion of the user password in the URLs that Process
Designer opens. For example, each time you run a playback in Process Designer, a new Process Portal browser session is opened. Process Designer then submits the user credentials, which consist of the user ID and
password, and the browser session uses these
credentials to log in. The
suppressRedirectUrlPas swd option stops the
password from being included in the URL to improve security. Note: When you use the
suppressRedirectUrlPas
swd option, you only need
to log into the browser the first time that you open a web editable artifact or run a playback in Process Designer. This option only applies to Process
Designer and can be turned on and off as needed.
Information on setting the
suppressRedirectUrlPas swd attribute is found in the
topic Installing IBM Process Designer.
Formatting Templates Specifies the predefined
character formats for text controls or specifies the creation of additional formats. The data type is FormattingTemplatesConfi g.<authoring-environment merge="mergeChildren"> <formatting-templates merge="replace"> <formatting-template comment="Currency" template="$ ###,###,###.##"/> <formatting-template comment="Currency" template="###,###,###.## €"/> <formatting-template comment="Currency" template="€ ###,###,###.##"/> <formatting-template comment="Integer" template="###,###,###"/> <formatting-template comment="Decimal" template="###,###,###.##"/> <formatting-template comment="US phone" template="(###) 000-0000"/> <formatting-template comment="US SSN" template="000-00-0000"/> </formatting-templates> </authoring-environment>
These properties are all configured using IBM BPM configuration XML files. For information about setting the properties, see
the topic Changing IBM
Process Server properties in 100Custom.xml.
Inspector This property specifies inspector configuration. The data type is
InspectorConfig. <authoring-environment merge="mergeChildren"> <inspector> <target-servers> <type></type> <name></name> <default-action-policy> <action> <type></type> <role>role1</role> <role>role2</role> </action> </default-action-policy> </target-servers> </inspector> </authoring-environment>
Library Event Stream Manager
The data type is
SequencedStateDeltaMan agerConfig.<authoring-environment merge="mergeChildren"> <sequenced-state-delta-manager> <fallback-timeout>15 </fallback-timeout> <slow-timeout>15 </slow-timeout> <scheduled-timeout-padding>15 </scheduled-timeout-padding> <time-in-fallback-before-link-reset>15 </time-in-fallback-before-link-reset> <time-in-fallback-after-link-reset-before-full-reset>15 </time-in-fallback-after-link-reset-before-full-reset> </sequenced-state-delta-manager> </authoring-environment>
Mime Types The data type is
MimeTypesConfig. <authoring-environment merge="mergeChildren"> <mime-types merge="replace"> <mime-type type="application/javascript"/> <mime-type type="application/octet-stream"/> <mime-type type="application/pdf"/> <mime-type type="application/xml"/> <mime-type type="application/xml-dtd"/> <mime-type type="application/zip"/> <mime-type type="image/gif"/> <mime-type type="image/jpeg"/> <mime-type type="image/png"/> <mime-type type="text/calendar"/> <mime-type type="text/css"/> <mime-type type="text/csv"/> <mime-type type="text/html"/> <mime-type type="text/rtf"/> </mime-types> </authoring-environment>
Repository Broken Ping Time
Specify an integer value.
The default value is 15000
if the value is set to 0 or a value is not specified.<authoring-environment merge="mergeChildren"> <repository-broken-ping-time merge="replace"> </repository-broken-ping-time> </authoring-environment>
Repository Max Wait During Shutdown
Specify an integer value. The default value is 3000 if the value is set to 0 or a value is not specified.<authoring-environment merge="mergeChildren"> <repository-max-wait-during-shutdown merge="replace"> </repository-max-wait-during-shutdown> </authoring-environment>
Repository Ping Delay Specify an integer value.
The default value is 15000
if the value is set to 0 or a value is not specified.<authoring-environment merge="mergeChildren"> <repository-ping-delay merge="replace"> </repository-ping-delay> </authoring-environment>
Repository Slow Ping Time Specify an integer value. The default value is 7500 if the value is set to 0 or a value is not specified.<authoring-environment merge="mergeChildren"> <repository-slow-ping-time merge="replace"> </repository-slow-ping-time> </authoring-environment>
Add Redirect URL Credentials
Specifies whether the
credentials are permitted to be passed in IBM Business Process Manager URLs. For example, a service can be started directly from IBM Process Designer without presenting a login screen. The default value is true.<authoring-environment merge="mergeChildren"> <add-redirect-url-credentials merge="replace">true </add-redirect-url-credentials> </authoring-environment>
Deploy Snapshot Using HTTPS
Specifies whether the Process Center Server uses HTTPS to deploy process applications and toolkits to process servers. If the property is set to the default value of true and all process servers are secure, then
communication from
Process Center to Process Server will work with HTTP Secure (HTTPS) or HTTP over SSL. However, if you have a mix of secure and non-secure servers, Process Center can only communicate with Process Servers that are configured to work with this mixed configuration. <authoring-environment merge="mergeChildren"> <deploy-snapshot-using-https merge="replace">true </deploy-snapshot-using-https> </authoring-environment>
Parent topic:Getting started with IBM Process Designer
Encode Redirect URL Credentials
Specifies whether the
credentials that are passed in an IBM Business
Process Manager URL that
implements
redirect-login.jsp are encoded. For example, you can encode credentials in a URL that is used to start a service directly from IBM Process Designer. By default, this property is set to true, which specifies that the credentials passed in an IBM BPM URL are encoded. If you change the setting to false, the URL is composed with credentials in plain text.<authoring-environment merge="mergeChildren"> <encode-redirect-url-credentials merge="replace">true </encode-redirect-url-credentials> </authoring-environment>
-1. 2. 3. 4. 5.
-Creating new process applications
When you create a new process application, you provide a name, acronym, and optional description of the process application.
About this task
You create new process applications in Process Center. You can access the Process Center console in the following ways:
From entering the remote Process Center URL (for example
https://servername:9080/ProcessCenter/login) into a web browser.
By starting the Process Designer desktop editor.
Tip: If you are creating processes in your process application, use the Process
Designer desktop editor. If you are building cases in your process application, use the remote Process Center URL.
Procedure
To create a new process application, complete the following steps: Start the Process Designer desktop editor or enter the remote Process Center URL into a web browser.
In the Process Apps tab, click the Create New Process App option.
In the Create New Process App window, enter a name, acronym, and description of the process application. Ensure that the acronym for the process application is unique and limited to seven characters. IBM® Business Process Manager (BPM) uses the acronym as an identifier for this process application and the library items that it contains. For example, when you manipulate the items in the process
application with the IBM BPM JavaScript API, you can use the acronym to specify the namespace of the items. For example, when you manipulate the items in the process application with the IBM BPM JavaScript API, you can use the acronym to specify the namespace of the items. The acronym for the process application must be unique and limited to 7 characters. IBM BPM uses the acronym as an identifier for this process application and the library items that it contains. For example, when you manipulate the items within the process application with the IBM BPM JavaScript API, you can use the acronym to specify the namespace of the items.
Providing a description is optional. When you enter a description, you can view it in the Process Center console by clicking the question mark next to the process application name.
If you are building cases in the process application, you can select Allow users to open the process application in the web-based Case
Designer. For more information, see Opening Case Designer from Process
Center.Note:Case management functions are only available if you have IBM BPM Advanced with the Basic Case Management feature installed.
To create library items in the process application, click the appropriate option:
Open in Designer
-Management feature installed. You see the Open in Case Designer option only if you selected the option described in step 4.
What to do next
To use tracks in this process application, enable the tracks in the Process Center console.
You can create toolkits to enable Process Designer users to share library items across process applications.
1.
2. 3. 4.
Creating a process application from a WebSphere
Business Modeler process
You can import business processes from WebSphere Business Modeler to Process Designer.
About this task
You can do this by importing the BPMN models that you exported earlier from WebSphere Business Modeler BPMN 2.0 file archive (.zip) files. You can import your models into the IBM Process Center. You can then use the IBM Process
Designer to open the resulting Process App or Toolkit, if you want to see the details of what was imported or to make changes to the imported models.
Procedure
To import BPMN models into the IBM® Process Center complete the following steps:
Start the IBM Process Designer from your Windows desktop or using the URL for the Process Center in a browser. The first time you start the IBM Process
Designer it opens to the Process Center console.You can trigger the import of the models in two ways. You can either click Import Process App (on the Process App tab), or Import Toolkit (on the Toolkit tab). Either of these actions will result in an import window.
Click Import Process App. The Import Process App window displays.
Click Browse to select the BPMN 2.0 archive (.zip) file that you exported from IBM WebSphere® Business Modeler and click Next.
In the Import Process App window, a name and acronym have been specified based on information in the file you selected. You can edit the name and acronym and add a description. If you are using IBM BPM Advanced, you will see radio buttons that you can use to choose what will be generated for unimplemented services. Select either Advanced Integration Services or Integration Services and then click Next. Note: Advanced integration services are only available for unimplemented services. Integration services are always generated for
implemented services. Both radio buttons display only in IBM BPM Advanced. For
more information, see Building an Integration service and Building an Advanced
Integration service.
A Summary of the import results pane opens containing any generated error, warning and information messages. A new process application or a toolkit is created, containing the content from the BPMN 2.0 archive. It will include
integration services if the model contained web service bindings and advanced integration services if the model contained unimplemented advanced integration services. All Blueworks Live artifacts will also be integrated with a BPMN import if Blueworks Live phases and other BPMN 2 extensions were in the model.
A snapshot of the process application is automatically created in the Process Center, for your use as a baseline, in the future, if necessary.
5. 1. 2. 3. 4. A. B. A. B. C. D. 5.
You can filter the messages by clicking Errors or Warnings. Click Save and specify a location if you want to save the messages. All the messages will be saved as a text file even if a filter has been applied. Click Close.
What to do next
You have now imported your BPMN models successfully into the Process Center. The following procedure helps you identify the step-by-step actions you will take after a successful import. However these steps will vary depending on the contents of your model and how you intend to make use of these models in the future. If you had seen warning messages at the end of your import it is likely that you may need to take some remedial action. Warnings usually indicate an unsupported construct or invalid input model. For each warning, examine the contents of what was
generated and take additional action as required.
Parent topic:Building process applications
Next Steps after importing BPMN Models
Procedure
Open the Process App or Toolkit that you created
Open every single generated artifact and ensure that its contents appear as expected.
Replace any of the default generated logic with the intended logic wherever necessary.
Complete the following steps for each of the following artifact:Services: Enter the service flow details
Human services: Customize the default generated coach Rule services: Enter the rule details
Teams: Specify the team members Processes:
Private Variables: Provide default values for any variables that are not
initialized.
XOR and IOR Gateways: Enter the conditional logic Javascript Activities: Enter the javascript logic
Adjust the process layout to minimize connection crossing. Check for validation messages and fix them as necessary.
-Creating processes in IBM
Process Designer
Create processes in Process Designer that represent the processes in your
company. When you run your processes inside Process Designer, you can analyze and simulate them in order to optimize your business activity.
The following diagram illustrates the main tasks and activities that are associated with creating processes.
Modeling processes
A process is the major unit of logic in IBM Business Process Manager (BPM). It is the container for all components of a business process definition (BPD). Modeling a good process that matches your requirements is at the core of Process Designer.
Designing process interactions for business users
After you deploy a business process definition that you have built in Process Designer to the Process Portal, a business user might interact with it in a number of ways. The user might be the one to launch the process, or the user might be assigned individual activities in the process.
Enabling processes for tracking and reporting
IBM Business Process Manager provides ways to collect and consume process performance information. To take advantage of this information, you enable to design your processes to make them trackable.