Xpert.ivy 5.0

Designer Guide

30.07.2015


Table of Contents

1. Introduction
Conventions used in this book
Typographic Conventions
Icons
Screen
Sidebar
Xpert.ivy Documentation
Xpert.ivy Workbench
Xpert.ivy Editors and Views
Xpert.ivy Perspectives
Process Perspective
Process Engine / Simulation Perspective
Html Dialog Perspective
Rich Dialog Perspective
Other
Most important menu entries
File menu
Search menu
Project menu
Xpert.ivy menu
Window menu
Help menu
Most important toolbar items
Xpert.ivy Preferences (Workspace Preferences)
Drag and Drop Settings
Process Editor Settings
Email Settings
Engine/Simulation Settings
ivyScript
Licence
SSL Client Settings
Common UI Components
IvyScript Editor
Macro Text Editor
Smart Buttons
Refactoring Wizards
2. Projects
Overview
Xpert.ivy Archives
Ivy Project View
New Project Wizard
Overview
Accessibility
Features
Importing a Project
Overview
Accessibility
Features
Exporting a Project
Overview
Accessibility
Features
Converting old 3.x Projects
Import a Xpert.ivy 3.9 Project
Manual Conversion Tasks
Not supported 3.x functionality
Converting old 4.x Projects
Project Properties (Project Preferences)
Xpert.ivy - Project Information
Content Management System Settings
Data Class Settings
Project Deployment Descriptor
Deployment Descriptor Editor
Validating Xpert.ivy projects and resources
Overview
Validating projects and resources
Validation preferences
3. Process Modelling
Process Kinds
Business Process
Embedded Subprocess (Composite)
Independent Subprocess (Callable)
Web Service Process
User Dialog Logic
New Process Wizard
Overview
Accessibility
Features
New Process Group Wizard
Overview
Accessibility
Features
Process Properties
Name and Description
Values
Web Service Process
Process Editor
Accessibility
Palette
Editor Area
Swimlanes
Process Model Reporting Wizard
Overview
Accessibility
Features
Process Outline View
Overview
Accessibility
Features
Process Template View
Overview
Accessibility
Features
Export / Import
Problems View
Overview
Accessibility
Features
Tasks View
Overview
Accessibility
Features
Reference View
Overview
Accessibility
Features
4. Simulating process models
Simulation
Engine Actions
Content and Formatting Language Settings
Breakpoints
Debugger
Debug View
History View
Breakpoints View
Variables View
Expressions View
Runtime Log View
Process Performance View
5. Process Elements Reference
Common Tabs
Name Tab
Output Tab
Code Tab
Panel Tab
Data Cache Tab
Request Start
Element Details
Inscription
Event Start
Element Details
Inscription
Exception Start
Element Details
Inscription
Alternative
Element Details
Inscription
Split
Element Details
Inscription
Join
Element Details
Inscription
Task Switch Gateway
Element Details
Inscription
Task Switch Event
Element Details
Intermediate Event
Element Details
Inscription
Call & Wait
Element Details
Inscription
Process End Page
Element Details
Inscription
Process End
Element Details
Inscription
Web Page
Element Details
Inscription
User Dialog
Element Details
Inscription
Script Step
Element Details
Inscription
DB Step
Element Details
Inscription
Web Service Call Step
Element Details
Inscription
E-Mail Step
Element Details
Inscription
Composite
Element Details
Inscription
Call Sub
Element Details
Inscription
Trigger Step
Element Details
Inscription
PI (Programming Interface) Step
Element Details
Inscription
Complete Code sample
PUI (Programming User Interface) Step
Element Details
Inscription
Note
Element Details
Inscription
Web Service Process Start
Element Details
Inscription
User Dialog Start
Element Details
Inscription
User Dialog Method Start
Element Details
Inscription
User Dialog Event Start
Element Details
Inscription
User Dialog Broadcast Start
Element Details
Inscription
User Dialog Script Step
Element Details
Inscription
User Dialog Fire Event Step
Element Details
Inscription
User Dialog UI Synchronization
Element Details
Inscription
User Dialog Process End
Element Details
Inscription
User Dialog Exit End
Element Details
Inscription
6. Data Classes
Types of Data Classes
New Data Class Wizard
Overview
Accessibility
Features
Data Class Editor
Overview
Accessibility
Features
7. IvyScript
IvyScript Language
Language Elements
Null handling / Automatic object creation
IvyScript Editor
Overview
Features
Browsers
Attribute and Method Browser
Function Browser
Data Type Browser
Public API
IvyScript Reference
Operators
Ivy Script Data Types
The Environment Variable ivy
IvyScript-Java Integration
Call Java methods and fields
Working with different Date, Time and DateTime implementations
Auto casting rules
8. Content Management
Content Management System (CMS)
Access CMS Content with a Browser
Common Content Object Types
Content Editor
Accessibility
CMS Tree
Content Object Details
CMS Search
CMS Selection
Content Object Value Editors
String Editor
Text Editor
Image Editor
Document Editor
Source Editor
CSS Editor
HTML Table Editor
HTML Link Editor
Result Table Editor
HTML Page Editor
HTML Panel Editor
Smart Table Content Editor
JSP Editor
Layout Editor
CMS Tree View
Accessibility
Features
Content Object View
Accessibility
Features
9. User Dialogs
User Dialog Concept
Interface
Logic
Data
User Dialog Interface Editor
Html Dialogs
PrimeFaces JSF Component Library
Themes
Html Dialog Data Binding and Event Mapping
Ajax Method Call API
Html Dialog Editor
Html Dialog Templates
Html Dialog Components
Html Dialog with Multiple Views
Converters
Validators
Managed Beans
Rich Dialogs
Process based Rich Dialogs
Rich Dialog Interface Editor
Rich Dialog Editor
Java Beans View
(Rich Dialog Editor) Properties View
New User Dialog Wizard
Widget Configuration View
Ivy Outline View
Data Binding View
New Event Mapping Wizard
Event Mapping View
Drag and Drop in Xpert.ivy Designer
Rich Dialog User Context
Rich Dialog User Context Examples
Rich Dialog UI State
Rich Dialog Widget Reference
ButtonGroup
Chart widgets
RBooleanCellWidget
RBorderLayoutPane
RBoxPane
RBrowser
RButton
RButtonCellWidget
RCardDisplay
RCardPane
RCheckBox
RCheckBoxMenuItem
RCloseableTabbedDisplay
RCollapsiblePane
RComboBox
RComboBoxCellWidget
RDatePicker
RFiller
RFlowLayoutPane
RGridBagLayout
RGridLayoutPane
RHtmlPane
RHyperlink
RHyperlinkCellWidget
RLabel
RList
RListDisplay
RLookupTextField
RMenu
RMenuBar
RMenuItem
RMenuSeparator
RPasswordField
RPopupMenu
RProgressBar
RRadioButton
RRadioButtonMenuItem
RScrollBar
RScrollPane
RSlider
RSplitPane
RTabbedDisplay
RTabbedPane
RTable
RTableTree
RTaskPane
RTaskPaneContainer
RTaskPaneDisplay
RTextArea
RTextField
RTextFieldCellWidget
RToggleButton
RToolBar
RTree
PDF Viewer Widget
Portal Display
10. Web Page
Using Web Pages (web content) in a Business Process
Creating and Editing Web Pages from within the Process
Where Web Pages are stored
HTML content in the CMS
Web Page Editor
HTML Panel Editor
HTML Table Editor
Result Table Editor
HTML Link Editor
Smart Table Content Editor
JSP Editor
Layout Editor
Link Browser
Other content editors
HTML content in the Web Content Folder
HTML Best Practice
How to provide own HTML Validation Scripts
11. Configuration Management
Configuration Management
Configuration Editor
Accessibility
Configuration Tree
Configuration Editor Area
Multi language Configuration Selector
Renderers Configuration
Smart Table Configuration Editor
Configuration Types
Format Configurations
Style Configurations
Input Validation Configurations
Validation Framework
Supplied Features by the Validation Framework
Widgets of the Validation Framework
Configurations
Programming Interface (API)
Environments
Editor
Environment settings
Change environment for Simulation
Change environment at runtime
Global Variables
Editor
Access global variables in IvyScript
12. Database Configuration
Database Configuration Editor
Overview
Accessibility
Environments
Features
13. Web Service Configuration
Structure
Web Service Configuration Editor
Overview
Web service configuration tree editor
Web service folder/entry editor
Environments
14. Roles and Users
Role Editor
Test User Editor
15. Persistence
Entity Classes
New Entity Class Wizard
Overview
Accessibility
Features
Entity Class Editor
Overview
Accessibility
Features
Persistence Configuration Editor
Overview
Accessibility
Features
Generate database schema from persistence unit
Generation options (Step 1)
Generation preview (Step 2)
Accessibility
Persistence API
Overview
Persist an entity object
Find an entity object by id
Merge an entity object
Remove an entity object
Refresh an entity object
Persistence Queries (JPA QL)
Accessibility
16. Overrides
The Concept of Overrides
Case Scope
Process Facade
Overrides Editor
Overview
Accessibility
Features
New Override Wizard
Overview
Accessibility
Features
17. Deployment
Application
Process Model
Process Model Version
Configuration Example
Xpert.ivy Project Deployment
Export all Project Files to a ZIP-File
18. Troubleshooting
Error Dialogs
Error Id
Error Report
Startup Problems
Start of Designer fails
Memory Problems
OutOfMemoryException: Java heap space
OutOfMemoryException: PermGen space
Graphics Problems
Superimposition of UI elements when scrolling
Logging
Configure ULC logging on server and client
19. Miscellaneous
Xpert.ivy Search
The search page
The search result view
Data Caching
Caches
Access and Life Cycle
Invalidation
Eclipse Plugin Mechanism
System Events
Concept and general usage
How to send and receive System Events in Rich Dialogs
20. Extensions
Process Elements
New Bean Class Wizard
Overview
Accessibility
Features
Xpert.ivy Extension Mechanism
Extensions File
Installation
Build an Xpert.ivy extension bundle (Eclipse plugin)
Extension Points
Provide your own process elements
Rich Dialog Client Side Libraries
Providing a Custom Certificate
Providing custom ULC Widgets
Troubleshooting Java Web Start Cache Problems
21. Configuration files
Introduction
log4jconfig.xml
jnlpconfig.any
ulclogconfig.any
22. Reference
Editors
Views
Wizards
Perspectives
Process Elements
Widgets
IvyScript
Miscellaneous
23. Glossary

List of Figures

1.1. Xpert.ivy Workbench Overview
1.2. Switch between Perspectives
1.3. The Process Perspective
1.4. The Engine Perspective
1.5. The Html Dialog Perspective
1.6. Rich Dialog Perspective
1.7. The Drag and Drop preferences
1.8. The Process Editor preferences
1.9. The Email preferences
1.10. The Process Engine preferences
1.11. The IvyScript preferences
1.12. The Licence preferences
1.13. The SSL Client preferences
1.14. IvyScript Editor
1.15. IvyScript Editor with a validation problem
1.16. IvyScript Editor with completer Popup Window
1.17. Macro Text Editor
2.1. Pack Xpert.ivy Archive (*.iar)
2.2. Unpack Xpert.ivy Archive (*.iar)
2.3. The Xpert.ivy Project View with some content
2.4. New Project Wizard: First Page
2.5. New Project Wizard: Second Page
2.6. New Project Wizard: Third Page
2.7. Import Wizard for Existing Projects
2.8. Import Wizard for Xpert.ivy Archives (*.iar)
2.9. Export Wizard: Export Xpert.ivy Archive (*.iar)
2.10. Xpert.ivy 3.9 Import Wizard
2.11. Xpert.ivy 3.9 Import Protocol and Progress Dialog
2.12. Wrong project version marker
2.13. Project version before conversion
2.14. Project version after conversion
2.15. Invoking the project conversion
2.16. Project Properties Xpert.ivy information
2.17. A project dependency, defined by the Project Deployment Descriptor
2.18. Project Dependency Graph
2.19. Deployment Descriptor Editor: Deployment Tab
2.20. Deployment Descriptor Editor: Required Libraries Tab
3.1. The New Process Wizard
3.2. The New Process Group Wizard
3.3. The Process Model Reporting Wizard
3.4. Problems View
3.5. Process Element with Problem Markers
3.6. Tasks View
3.7. Process Elements with Task Markers
3.8. The Reference View
3.9. The Reference Menus
4.1. The Process Start Overview Page
4.2. The Engine Sub-Menu
4.3. Content and Formatting Language Settings Dialog
4.4. The Debug view in action
4.5. The History view in action
4.6. The Breakpoints view in action
4.7. The Variables View in action
4.8. The Expressions View in action
4.9. Runtime Log View: List of logged Events
4.10. Runtime Log View Event Details
4.11. IvyScript to log into Runtime Log
4.12. The Process Performance View
5.1. An exemplary inscription mask
5.2. The Name tab
5.3. The Output tab
5.4. The Code Tab
5.5. The Panel tab
5.6. The Data Cache tab
5.7. The Start tab
5.8. The Condition tab
5.9. The Call tab
5.10. The Wait tab
5.11. The Dialog tab
5.12. The Call tab
5.13. The DB Tab
5.14. The Web Service tab
5.15. The Web Service Config tab
5.16. The Web Service Test tab
5.17. The Header Tab
5.18. The Content Tab
5.19. The Attachment Tab
5.20. The PI tab
5.21. The PUI tab
5.22. The Name Tab
5.23. The Start Tab
5.24. The Result Tab
5.25. The WS Tab
5.26. The Start Tab
5.27. The Output Tab
5.28. The Embedded Rich Dialogs Tab
5.29. The Result Tab
5.30. The Method Tab
5.31. The Output Tab
5.32. The Result Tab
5.33. The Broadcast Tab
5.34. The Event Tab
5.35. Example usage of the UI Synchronization element
5.36. Example usage of ivy.rd.clickDeferred(hiddenButton)
6.1. The New Data Class Wizard
6.2. The Data Class Editor
7.1. Standard IvyScript Editor
7.2. IvyScript Editor for macros
7.3. Content assist in action
7.4. Constructor proposals
7.5. Package proposals
7.6. Parameter hopping: After insertion of proposal first parameter is selected
7.7. Smart Buttons
7.8. Macro Editor after insertion of a CMS object with help of the Content Smart Button
7.9. The Attribute and Method Browser
7.10. The Function Browser
7.11. Ivy Base Types
7.12. All Other Types
9.1. The New User Dialog Wizard Page 1
9.2. The New User Dialog Wizard Page 2
9.3. The New User Dialog Wizard Page 3
9.4. The Widget Configuration View
9.5. The General tab
9.6. The Style tab
9.7. The Text/Icon tab
9.8. The ComboBox Data tab
9.9. The Lookup Data tab
9.10. The List Data tab
9.11. The Table Data tab
9.12. The Cell Widget tab
9.13. The Tree Data tab
9.14. The Table Data tab
9.15. The Validation tab
9.16. The IvyScript Editor Widget
9.17. The IvyScript Editor Widget as cell editor in a table
9.18. The Ivy Outline View
9.19. Create Rich Dialog Widgets dialog
9.20. The Data Binding View
9.21. The New Event Mapping Wizard
9.22. The Event Mapping View
9.23. The DnD Xpert.ivy Designer support
10.1. The Smart Table Content Editor
10.2. Link Browser
11.1. The Smart Table Content Editor
12.1. The Database Configuration Editor
13.1. Web service tree editor part
13.2. Web service configuration details part
14.1. The Role Editor
14.2. The User editor
15.1. The New Entity Class Wizard
15.2. The Persistence Configuration Editor (single persistence unit)
15.3. The Persistence Configuration Editor (multiple persistence units)
15.4. Database schema generation option
15.5. Database schema generation preview
16.1. Adapting a generic application with overrides
16.2. Implementing a process facade with process stubs
16.3. The Override Editor
16.4. The New Override Wizard
17.1. Export Wizard
17.2. Export Wizard
18.1. Error dialog when XpertIvyDesigner.ini broken
20.1. New Bean Class Wizard
20.2. Extension File XML Schema

List of Tables

1.1. Smart Buttons
2.1. Missing 3.x functionality
3.1. Overview over the supported references
4.1. Process elements with usage of external category
4.2. Column Description
7.1. Available Shortcuts inside the IvyScript (and Macro) Editor
7.2. IvyScript Field Access and Type Cast Operators
7.3. IvyScript Logic Operators
7.4. IvyScript Arithmetic Operators
7.5. Automatic conversion of foreign Date / Time values
7.6. Auto casting rules
8.1. Content Object Types
9.1. Process elements only available in User Dialog Logic
9.2. Process elements that are forbidden in User Dialog Logic
9.3. Process elements only available in Rich Dialog Logic
9.4. Default Event Delivery Mode
9.5. Palette Operations
9.6. Containers
9.7. Widgets
9.8. Menus
9.9. Displays
9.10. Non visual Components
9.11. Cell Widgets
9.12. Summary of different Layout Managers
9.13. ButtonGroup Summary
9.14. RButtonCellWidget Summary
9.15. RBorderLayoutPane Summary
9.16. RBoxPane Summary
9.17. RBrowser Summary
9.18. RButton Summary
9.19. RButtonCellWidget Summary
9.20. RCardDisplay Summary
9.21. RCardPane Summary
9.22. RCheckBox Summary
9.23. RCheckBoxMenuItem Summary
9.24. RCloseableTabbedDisplay Summary
9.25. RCollapsiblePane Summary
9.26. RComboBox Summary
9.27. RComboBoxCellWidget Summary
9.28. RDatePicker Summary
9.29. RFiller Summary
9.30. RFlowLayout Summary
9.31. Style Properties for Grid Bag Layout
9.32. GridBagLayoutPane Summary
9.33. RGridLayout Summary
9.34. RHtmlPane Summary
9.35. RHyperlink Summary
9.36. RHyperlinkCellWidget Summary
9.37. RLabel Summary
9.38. RList Summary
9.39. RListDisplay Summary
9.40. RLookupTextField Summary
9.41. RMenu Summary
9.42. RMenuBar Summary
9.43. RMenuItem Summary
9.44. RMenuSeparator Summary
9.45. RPasswordField Summary
9.46. RPopupMenu Summary
9.47. RProgressBar Summary
9.48. RRadioButton Summary
9.49. RRadioButtonMenuItem Summary
9.50. RScrollBar Summary
9.51. RScrollPane Summary
9.52. RSlider Summary
9.53. RSplitPane Summary
9.54. RTabbedDisplay Summary
9.55. RTabbedPane Summary
9.56. RTable Summary
9.57. RTableTree Summary
9.58. RTaskPane Summary
9.59. RTaskPaneContainer Summary
9.60. RTaskPaneDisplay Summary
9.61. RTextArea Summary
9.62. RTextField Summary
9.63. RToggleButton Summary
9.64. RToolBar Summary
9.65. RTree Summary
10.1. All the different input kinds
10.2. Link Types
11.1. Format Symbols
11.2. Date Validation Type
11.3. DateTime Validation Type
11.4. Time Validation Type
11.5. Number Validation Type
11.6. Percent Validation Type
11.7. Regular Expression (String) Validation Type
11.8. Supported Widgets of the Validation Framework
11.9. Supplied Widgets by Validation Framework (not on the palette)
11.10. ch.ivyteam.ivy.richdialog.server.validation.IValidator
11.11. ch.ivyteam.ivy.richdialog.shared.IvyErrorObject
15.1. JPA QL operator precedence
15.2. JPA QL functions
17.1. Release states of process model versions on Xpert.ivy Server
17.2. Configuration Example
20.1. Plug-in Properties
20.2. Xpert.ivy Extension Points