Welcome to Bizagi Digital Business Platform V.11.2.3
Overview
Model, build, run
Related Products
Training and support
Register to join the community
Architecture of Bizagi Digital Business Platform
System architecture
Product architecture
Process Xchange
Install web services for Process Xchange
Bizagi Studio Collaboration Services
Service requirements
Studio Collaboration Services subscriptions
Enterprise subscription
Service architecture
Subscription management
Enterprise portal and application summary
Sign in Studio Collaboration Services
Azure AD authentication
ADFS authentication
Subscription Support
Service Level Agreement
Trial subscription
Portal and application summary
Sign in trial subscription
Subscription support
Accessing Studio Collaboration Services
Creating and opening a project
Managing your projects in Studio Collaboration Services
Defining Bizagi Studio security
Running a project
Running a project locally
Management Console Web
Environment
Maintenance window
Sync data
Delete cases
Scheduler
User jobs administration
Wait Jobs
Alert Jobs
Track
Tracing
Event log
BPU Monitoring
From on-premises to Studio Collaboration Services
Studio Collaboration Services considerations
How Studio Collaboration Services handles data and metadata
Bizagi Studio
Bizagi Studio system requirements
Database requisites
SQL Server requisites
Advanced configuration of SQL Server login accounts
Oracle requisites
Bizagi server requisites
IIS configuration
Windows 10
Windows 8.1 or Windows 8
Windows 7
Windows Server 2016
Windows Server 2012 R2
Windows Server 2008 R2
Bizagi Studio installation
Downloading Bizagi Studio
Verifying the installer
Quick start installation
Bizagi Studio Pen Drive edition - Portable/Standalone
Teamwork setup
Teamwork collaboration through Bizagi Studio
Teamwork collaboration through Terminal Services
Bizagi Studio security
Configure Bizagi Studio security
Creating groups in Bizagi Studio security
Bizagi Projects
Creating a new project
Creating a project using Windows Authentication for SQL Server
Creating a project using Oracle
Opening a Project – permissions and ports
Managing your projects
Upgrading your project
My First Process
Bizagi Studio user interface explained
Wizard view
Expert view
Processes in Expert view
Deleting a Process
Clone Processes
Entities in Expert view
Application entities
Master entities
Parameter entities
Stakeholder entities
Advanced settings
Defining your company's processes architecture
Environment configuration
Business configuration
Web server configuration
Tracing configuration
Web services traces
Connector traces
SAP traces
Dynamic Rules Tracer
How do you use the Dynamic Rules Tracer?
Deleting unused objects in your project
Sharing processes between projects
Experience design
Stakeholders
Contexts
Actions
Advanced configuration
Batch actions
Manage entities while viewing their actions
Relevant to me
My Stuff
Data searches
Advanced topics
Classifying end users into stakeholders
Customizing admin forms for stakeholders
Assigning Stakeholders by conditions
Obtaining stakeholder information in rules
Data templates
Classifying relevant processes
Creating indirect collections
Defining starting filters
Enabling new items in my stuff
Inheritance in data modeling
Polymorphism and constructors
Triggers
Process trigger example
Expression trigger example
Process wizard
Model Process
Standards support
Creating a Process within Bizagi Studio
Editing a Process
Importing a Process
Modeling for execution
Shape properties
Process Properties
Task properties
Gateways properties
Start Events properties
Intermediate Events properties
End Events properties
Swimlanes properties
Connectors properties
Sub-Processes
Embedded Sub-Processes
Understanding Transactional Sub-Processes
Creating a Transactional Sub-Processes
Reusable Sub-Processes
Managing Sub-Process entities
Understanding Multiple Sub-Processes
Multiple Sub-Processes concepts
Creating a Multiple Sub-Process
Access the parent Process information from the sub-process context
Synchronize tokens with Each Token option
Advanced configuration for Multiple Sub-Processes
Advanced configuration using Group by
Advanced configuration using sequential creation
Advanced configuration using Integer Constant
Advanced configuration using Integer Attribute
Launch Multiple instances asynchronously
Understanding Ad Hoc Processes
Configuring Ad Hoc Sub-processes
BPMN Collaboration
Duration of Tasks and processes
Dynamic Duration
Documenting a process
Documenting each element
Using Rich Text Format
Spelling review
Extending your documentation
Extended Attributes type
Example: Add a Table Extended Attribute
Managing Extended Attributes
Sharing Extended Attributes between elements
Exporting and Importing Attributes between Models
Using Artifacts
Company logo
Generating Documentation
Publish or Export
Publish in Word
Document Template
Publish in PDF
Publish to Web
Customize styles in Web
Publish to Wiki
Publish to SharePoint
Exporting to XPDL
Exporting diagrams as Image
Exporting to Visio
Exporting to BPMN
Importing diagrams
Import diagram from Visio
Import diagram from XPDL
Import diagram from BPMN
Simulation
What is simulation
Simulation in Bizagi
Simulation levels
Level 1 - Process Validation
Level 2 - Throughput time analysis
Level 3 - Resource analysis
Level 4 - Calendar analysis
Configure Simulation
Scenarios
What If analysis
What if analysis example
Data Modeling
Creating your Data Model
Data Model options
Entity types
Where to manage Parameter entities
Parameter entities options
Populating parameter entities
Parent and child entities configuration
Process entity
Context
Attribute types
File type attributes information
Relationship types
Reversing a related attribute
Connecting to external data sources
Data Replication
Using the Replication Wizard
Using advanced Replication configuration
Customizing Replication
Verifying Replication
Additional options in Replication configuration
Data Virtualization
Using the Virtualization Wizard
Using advanced Virtualization configuration
Customizing Virtualization
Verifying Virtualization
Additional options in Virtualization configuration
Data Type Support
Temporary Attributes
Scopes
Business keys
Hints
Define Forms
Creating my first Form
Creating Forms for a specific device
Example of customizing devices
Offline forms
Where to create Forms
Start Form
Entity forms
Management forms for Parameter entities
Query forms
Process queries
Process controls
Entity queries
Global and summary forms
User preferences form
Form Designer components
Ribbon
Left panel
Containers: Groups, Tabs and Panels
Layouts
Display area
Device tabs
Form Properties
Form Controls
Action Launcher
Association
Button
Changing Button style example
Cascading combo
Combo
Date
Entity Template
File Print Button
File uploads
File uploads ECM
Form link
Geolocation
Grouped table
Totalizers
Hidden
Image
Label
Link
List
Multi Select
Multiselect Combo
Money
Number
Polymorphic Launcher
Radio
Record View
Search
Search form
New records form
Search List
Suggest
Table
Edit columns
Totalizers
Add records
Edit records
Records detail
Export tables to Excel or PDF
Change columns format
Text box
Regular expressions
Yes/No
Controls properties
Default value
Filter property
Table filters
Minimum and maximum values
Enable send as attachment
Table validations
Table validations button
Add, Edit and Delete validation expressions
Changing control type
Extending or customizing Forms
Installing Widgets
Widget Xchange
Example of using a Widget from the Widget XChange
Widget Management
Creating Widgets
Widget Editor user interface explained
Widget structure
Properties' definitions
Functions to implement/override
Advanced types of Widgets
API for Widgets
Coding guidelines and recommendations
Using images
Steps needed to create Widgets
Running simulation for your Widget
Troubleshooting Widgets
Examples and tutorials
My first Widget
Modifying Widgets
My second Widget
Completing tasks via Email
Configuring Email integration using Gmail
Customizing controls behavior
Actions and Validations
Actions components
Basic Actions
Other actions
Performing actions on collections
Form Validations components
Basic Validations
Validations on collections
Compound conditions in actions and validations
Form Buttons
Context in Forms
Saving a Form
Using Copy From
Forms security: check-in / check-out
Force check-in
Business Rules
Bizagi Functions
Data Access through XPath
Filtering XPath
Advanced filters
XPath Functions
Collection Functions
XPath basic functions examples
XPath advanced functions examples
Access entities not related to the data model
Me Functions
Me
Assignees
Case
Case Creator
Case Organization
Case Process Definition
Case Working Credential
Context
Task
CHelper Functions
Math functions
Business rules elements
Expression element
Select Parameter Value
Data Model Viewer
Search Find Replace expressions content
Iterate over XPath element
Assignment element
Boolean, While and If elements
Function element
Web service element
For element
Iterate over fact element
Define Expression (Process routing)
Custom Xpaths in Boolean Expression
Scripting Booleans
Conditional activity and Conditional event
Activity actions (Events)
Assignments, calculations and validations
Policies
Creating a Policy
Creating a Policy version
Vocabulary
Constant Definitions
Xpath Definitions
Advanced properties of Xpath definitions
Policy Rules
Decision Tables
Preconditions or Decision trees
Rule Groups
Reusability
Defining notifications
Automatic Notifications
User configured notifications
Include process and case information
Include Tables or Collections
Send messages according to conditions
Include information returned by a rule
Sending E-mails to Multiple Recipients
Context changes in E-Mails
Send copies and blind copies
Email server configuration
Using an SMTP server
Using the IIS as an SMTP server
Using the IIS SMTP as a relay
Using hMailServer as an SMTP server
Using hMailServer as a relay
SMTP with authentication
Business Rules examples
Cases and activities
Abort a process
Assign a Task
Create a new case
Display validations to end users
Execute Activity
Execute events
Get Assigned WorkItems
Include or replace the work allocation
Managing user interface
Visible, editable and required using expression
Cells visibility and editability using expressions
Default value using expressions
Minimum value using expressions
Maximum value using expressions
Filter using expressions
Obtain Case object
Obtain case organization data
Raise Cancel End Event
Use information from the current case
Raise Error End Event
Raise intermediate event error
Collections and parameter entities
Collection examples
Add items (records) to a collection
Delete items (records) of a collection
Attach items (records) to a collection
Detach (disconnect) elements of a collection
Add records to a table within a table
Access the i-th record of a collection
Store the total value of a column
Iterating using expressions
Obtain and use Entity values
Use EntityArray for batch actions
Using .id with XPath
Using Me.Context
Date operations and timers
Perform date operations
Set tasks and timers duration
Documents and files
File management with expressions
Concatenate Documents
Concatenate Documents From Two Xpaths
Concatenate Documents From Xpath
Concatenate Documents From Files Array
Convert files to base64
Copy the file content from one attribute to a collection
Copy the file content from one attribute to another
Count the number of files uploaded
Delete an uploaded file
Obtain the file name of an uploaded file
Obtain the physical path of Bizagi uploads
Obtain the size of files uploaded
Upload a file using an expression
Validate file names
Update ECM Metadata
Math operations, strings and data validations
Obtain Boolean value
Perform string operations
Validate Data
Perform Math operations
Absolute Value
Average
Ceiling
Exponential
Floor
Is Not a Number
Natural Logarithm
Base 10 Logaritm
Maximum
Minimum
Module
Percentage
Power
Quotient
Random Number
Round
Square Root
Truncate
Project parameters and organization information
Define and use sequences
Force attribute to deploy
Obtain and use Vocabulary values
User information and experience
Add and remove records from My Stuff
Get current time for user
Get user properties
Get users based on Organization components
Get users that have worked on the case
Obtain Stakeholder information
Reassign elements in My Stuff
Use information of the current assignees
Use information of the current logged in user
Use information of the current task
XML Helper object
Querying XML-based information in entities
Querying XML-based information in cases (with scopes)
Updating XML-based information in entities
Updating XML-based information in cases (with scopes)
Applying XSL transformations
Business Rules security: check-in / check-out
Validating business rules
Copy from functionality in Expressions
Reusing business rules
Library Rules
Custom jobs
Performers
Work allocation components
Details on assignment to Everyone
Basic task allocation
Task allocation using expressions
Task allocation using preconditions
When no user meets the allocation conditions
Skip allocation rules
Organization
Creating an Organization
Organization Wizard
User properties
User groups
Working Time and Calendars
Working Time Schema
Holiday Schema
Multiple Organizations
Integrate
Application integration
SAP connector
SAP integration example
SAP connector when synchronizing information
SAP exceptions configuration
Excel connector
Write action
Read action
Read range action
Write range action
Excel Connector example
Collaboration
Signal example
Web services connector
Invoking Web services (SOAP)
Invoking services from IBM WebSphere ESB
Invoking REST services
Configuration options in REST services
Example for data collection methods
Example for data placement methods
Mapping features
Sending and receiving information
Sending and receiving files
Sending files to a Web service
Receiving files from a Web service
Sending and receiving dates
Mapping into collections
Transformation functions
Advanced mapping
Quick mapping by text
Interfaces Error handling
Advanced settings for interfaces
Using Asynchronous Activities
Integrating APIs and extending Bizagi
Bizagi connectors
Connectors Xchange
Installing and configuring connectors
Using connectors
Creating connectors
Connector Editor user interface explained
Connectors concepts and guidelines
Authentication methods and REST connectors
Versioning connectors
Recommended steps to create connectors
Assisted REST connectors
Assisted REST connector example
Custom connectors
Required profile, concepts and tools
API for connectors
Custom connector example
Custom components
Bizagi .NET example
Read and Write from Excel
Execute
Quick prototyping
Bots
UiPath bot integration
Using queues in UiPath
UiPath System parameters
Blue Prism bot integration
Handling bots with long executions
Automation Anywhere bot integration
Automation Anywhere Metabot
Automation Anywhere: Authenticate
Automation Anywhere: StartProcess
Automation Anywhere: AdvanceCase
Automation Anywhere: GetProcess
Automation Anywhere: GetCasesByProcess
Automation Anywhere: GetWorkitemsByCase
Automation Anywhere: AddStartParameter
Automation Anywhere: AppendRowToCollectionParameter
Automation Anywhere: AddColumnToLastRowParameter
Automation Anywhere: AppendFileToParameter
Automation Anywhere: FileToBase64
Advance Bot integrations
FAQ - Using RPA with BIzagi
Sites
Sites Editor
Building a site
Sites Dashboard
Sites Designer
Sites Controls
Header
Collections
Multilingual Site
Pages with context
Downloading and uploading Sites
Publishing a site
Using Sites as a Stakeholder
Document Templates
Create the template
Creating a Word template
Creating an Excel template
Creating plain text templates
Define how to generate the Document Template
Include a Document template to generate manually
Include a Document template control to generate automatically
Configure the Document template
Configuring a Word template
Configuring an Excel template
Configuring a plain text template
Edit and delete a document template
Advanced topics in document templates
Including images in Document Templates
Advanced functions in mapping
Multiple Document Templates
Document templates with tables within tables
Document templates in tables
ECM integration
Preconfiguring the ECM
Configuring SharePoint as the ECM
Configuring Alfresco as the ECM
Configuring Documentum as the ECM
Setting the ECM in Bizagi
Set file metadata through a rule
CMIS compatibility and technical reference
Security definition
Work Portal Security
Authentication
SAML authentication
Authentication with Azure AD
Authentication with ADFS
Authentication with NetIQ
Authentication with Okta
Authentication with PingFederate
Related topics
Issuing self-signed certficates
Troubleshooting SAML messages exchange
Windows Authentication
OAuth authentication
Obtain Client id to delete all users on Development or Test environments
LDAP Authentication
Bizagi Authentication
Mixed Authentication
Forms Authentication
Multi-Factor Authentication
SMS provider configuration
Advanced Authentication
Custom Authentication
Custom authentication example
Multiple authentication
Synchronizing users
Synchronizing users using SCIM
Synchronization procedure
Create a user
Get user information
Update user information
Deactivate a user
Synchronizing users using Azure AD
Synchronizing users via web services
Importing LDAP Users
LDAP attributes
Import users using an Excel
Security for Work Portal menus
How to grant access to Work Portal's menus
Restrict mobile access to Process/Tasks
Case Security
Manage privileges through the Work Portal
Manage privileges through expressions
Manage privileges through web services
Database attributes encryption
Language configuration and localization
Enabling languages and choosing the default one
Translating your Work Portal from the Studio
Internal objects quick start reference
Localizing processes and their objects from the Studio
Customize Case numbers
Customize columns
Customize columns examples
Bizagi from external applications
Bizagi API
SOAP web services
Requisites and concepts for SOAP web services
Enabling Bizagi API
Data model XML schema
Using business keys in XMLs
URL and important notes
Web services security (WS-Security)
Uploading files or images from an external application
Available SOAP web services
EntityManagerSOA Web methods
Create User
Get Case Data Using Schema
Get Case Data Using Schema Lite
Get Case Data Using XPaths
Get Entities
Get Entities Using Schema
Get Entity Schema
Save Entity
QuerySOA Web methods
Query Cases
Query Entities
WorkflowEngineSOA Web methods
Abort Cases
Assign Activity
Create Cases
Get Activities
Get Closed Activities
Get Events
Grant Case Access
Perform Activity
Revoke Case Access
Save Activity
Set Event
OData services
Getting started
Basic concepts
Properties and querying options
Types of data in Bizagi OData responses
Setting which business information is returned
Common lookup services
Related entities values
Navigating into linked information
Columns in collections
URLs for Images and Uploads
Cases search
Sending input parameters
Services index
Data services
My Stuff data
My Stuff's actions data
Executed actions data
Searches data
Searches execution results and data
Searches results' actions data
Relevant to me data
Relevant processes startup data
Queries data
Execute Queries
Entities data
Creation parameters
Stakeholders data
User profile data
Processes data
Processes startup data
Cases from processes data
Activities from processes data
Activities from processes completion data
Cases from Work portal
Activities from Work portal cases
Activities from Work portal completion data
Cases plus activities from Work portal
Metadata services
Processes metadata
Stakeholders metadata
Stakeholder's My Stuff metadata
Stakeholder's Searches metadata
Stakeholder's Relevant processes metadata
Project metadata
Query Services
How to use OData from external systems
Portals integration
Bizagi Web parts for SharePoint
Bizagi Web parts for SharePoint On Premises
Installing or upgrading the Web parts
Configuring SharePoint Server
Using the Web parts
The Work portal Web part
Specific Web parts
My Inbox Web part
Activity form Web part
Case summary Web part
Start process Web part
Appearance and general properties
Styles in Web parts
Customizing the layout
Bizagi Web parts for SharePoint Online
Installing the Web parts
Using the Web parts
The Work portal Web part
Custom options and advanced settings
Using Web parts for other portals
Web part types and parameters
Web parts detail and customization
Web parts hardening
Automatic testing
Configuring Auto testing
Using Auto testing
Recording a scenario
Enabling Auto testing with HTTPS protocol
Additional options and logs of recordings
Recording a scenario while considering performers
Modifying scenarios
Executing scenarios
Executing scenarios from the command prompt
Auto testing example
Best practices and implementation guidelines
Best practices in process modeling
Anti-patterns
Best practices in Data Model
Data model nomenclature and standards
Design and performance guidelines
Guidelines when integrating data
Best practices in Forms design
Best practices in business rules
Best practices in work allocation
Best practices in integration
Component library guidelines
How To´s
Integration how-to's
How to integrate Bizagi with Salesforce
How to create a vendor in SAP from Bizagi via web services
How to integrate Bizagi with Joomla!
How to start Processes in Bizagi from other applications
How to perform a Bizagi Activity from other applications
How to create a custom connector -tutorial
How to configure Virtualization for related Entities
Useful how-to's
How to use a Bizagi virtual machine in Azure
How to create a backup of your Bizagi database
Create backups in SQL Server
Create backups in Oracle
How to restore a backup of your Bizagi database
Restore backups in SQL Server
Restore backups in Oracle
How to migrate from Oracle to SQL Server
How to move or clone a Bizagi project
How to change the path of your Bizagi project
How to set up teamwork collaboration with best security practices
How to obtain Bizagi parameters
How to obtain wfClassName
How to obtain idWorkItem
How to populate data from Excel
How to handle multiple documents to continue a request
Automation Server
Automation Server requirements
System requirements
High availability .NET system requirements
Standard .NET system requirements
Test environment .NET system requirements
Ports and Protocols requirements - Dataflow
Performance and optimization
System architecture recommended practices
Guidelines for Bizagi when considering compute virtualization
Performance and scalability benchmark
Sizing estimation (capacity calculator)
Database growth estimation
Automation Server configuration and administration guide
System prerequisites
Database server prerequisites
SQL Server prerequisites
Oracle prerequisites
Bizagi server prerequisites
Enabling IIS and its features
IIS version 10 (Win 2016)
IIS version 8.5 (Win 2012 R2)
IIS version 7.5 (Win 2008 R2)
Installing the Oracle's connectivity client
Other assets and prerequisites
Installation
Downloading the installer
Verifying the installer
Running the installer
Initial project configuration
Deployment of processes and new versions
Previous considerations and requirements
Deployed Objects
Relate Objects
One-click Deployment
Test environment deployment
Using Release Candidate for a deployment to Test
Production environment deployment
Setting up a Bizagi cluster
Advanced Deployment
Advanced Deployment executables
Package Visualizer
Data Synchronization
Microdeployment
Advanced Deployment example
Command line for Advanced Deployment
Command line deployment example
Other utility commands
Project configuration alternatives
High availability setup procedure
Manual setup procedure without installers
Best practices in the production environment
Setting up a Bizagi ODS
Configuring ODS for Process Analytics
Configuring ODS to run queries
Configuring the SMTP service through IIS
Scaling out the Scheduler service
Setting up a load balancer
Example setting up an f5
Using an external session state repository
Security hardening at the IIS
Basic hardening
Intermediate hardening
Advanced hardening
Infrastructure alternatives
Setting Bizagi in an Azure VM
Setting Bizagi for secure internet access
System maintenance and monitoring
Backups
Database backups
SQL Server Backup and Restore
Oracle Export and Import
Work portal and Scheduler backups
Attachments backups
Monitoring
Infrastructure and platform monitoring
Services monitoring
Bizagi Diagnostics
Setting up Bizagi Diagnostics
Advanced options when recording server events
Using Bizagi Diagnostics
General pointers and tuning tips
Database maintenance
Profiler recommendations
Environment settings and administration
Asynchronous Activities Console
Management Console
Recreate environment (from database)
Bizagi parameters configuration
Security administration
Scheduled jobs administration
How to fine tune the Bizagi Scheduler in Cluster Environments
Scheduler 2.0
Managing external systems
Managing integrated Connectors
Managing integrated SAP systems
Managing integrated Excel connector
Managing integrated Web services
Managing integrated data sources
Diagnosing errors in integrated systems
Diagnosing Web services errors
Diagnosing Connectors errors
Diagnosing SAP errors
Bizagi versions (software upgrades)
Upgrading the minor version
Uninstall
Continuous improvement and incremental deployments
Guidelines for a new version of a process
Bizagi Work Portal
Login to the Work Portal
Me
My Stuff
My Cases
Pending
Following
My Plans
Managing Plans
Working with running Plans
Relevant to me
My searches
Inbox
Main Menu
Case Area
Pending Activities
Case folder
State log
Graphic query
Queries
Graphical Analysis
Live Processes
Designing Live Processes
Palette and Pie menu
Forms controls and Ribbon
Guidelines when using Live Processes
Managing Live Processes
Configuring processes
Live Process Reports
Promoting Processes
Process cloning and new versions
Granting access to Live Processes
Authorizing Users to start cases
Collaborative Live Processes
Managing User Groups
Authorizing users to run Reports
Live Processes from Studio
Entities for Live Processes
Working with Live Processes
Work Portal Administration
Case Administration
Work Reassignment
User Administration
Stakeholders
Enabling the Me menu
Positions, Roles and Skills
Locked accounts
Delegated User
Timezone management
User permissions report
Authentication Log
Admon user
Multi-language support
Choosing the language for each user
Including or modifying translations for the Work Portal
Localizing your processes and their objects
Changing Work Portal look and feel
Configuring a predefined theme
Create a theme based on a specific color
Customizing specific components
Parameter Entities values in the Work Portal
Managing Policies in the Work Portal
Defining Alarms
Holidays
Password Encryption
Reports and Process Analytics
BAM
Analytics
Sensors
My Reports
Dimensions
Third party reporting tools
Tableau Web Data Connector
Power BI Data extension
Mobility
iOS devices
Android devices
Push notifications
Considerations for mobile devices
Change project name
Traditional design
Offline capability
Working offline using iOS devices
Working offline using Android devices
Licensing Explained
Manage licenses
BPU Use Report
License activation
Offline license activation
Customer support
How to use the Support Site
Create and manage support accounts
Previous versions documentation
Version 11.1
Version 11.0
Version 10.7
Version 10.6
Version 10.5
Version 10.4
Version 10.3
Version 10.2
Version 10.1
Version 9.x
Useful resources
Bizagi Glossary
Bizagi Resource Kit
Knowledge Base
Download User guide as PDF
This user guide in other languages
Documentation in spanish
Disclaimer