Overview
Bizagi offers several Web Part types in order to let you select the one that meets your requirements of how your Bizagi Work Portal will be displayed.
As mentioned at Using Web Parts for other portals, we strongly suggest using the main "Workportal" Web Part as it requires minimal configuration.
Note that using other, more specific Web Parts may be used as well, but while requiring more effort to tune their styling and interaction.
How to use the Web Parts
Recall that as described in the link above, in order to use these Web Parts you will need to first make sure you implement an authentication method in your portal so that it shares authentication with Bizagi and provides an SSO experience.
This section parts from acknowledging the explanation in that same link, regarding how to use http://[BIZAGI_SERVER]/[BIZAGI_PROJECT]/jquery/webparts/desktop/portal/pages/webpart.htm, which features the Web Parts.
List of these specific Web Parts
For this approach you choose to include separately each piece of information and views that Bizagi presents at its Work Portal. Specific available Web Parts are:
1. My Inbox
Technical name: cases
This Web Part shows the list of pending work of a user (his or her Inbox).
In this Web Part, the user will view a filtered list of his or her to-do list (according to activities' due date or to specific Processes).
Notice that Bizagi Inbox is presented in 2 different views: grid or details, and that you may switch these:
Clicking on a pending task will trigger the Case summary Web Part.
2. Activity form
Technical name: activityform
This Web Part allows users to work in a pending activity (includes whenever a Process instance is started).
This Web Part will be shown whenever the user directly clicks on a pending task or creates a new case (triggered by the Cases summary, Start process button and Start process list Web Parts). Through it, the user can fill out any information to complete his or her work (click on Save or Next).
This Web Part can be configured to be shown as a pop-up window, or in a totally different page (useful when having a lot of information to fill out), or somewhere else right in the same page.
Keep in mind this Web Part has some settings which require configuration (as described in the next section: Web Parts settings).
3. Case summary
Technical name: casesummary
This Web Part shows the summary form of a case, and let the user decide if he or she wishes to work on this case (by clicking on the Work on it button).
It is really useful when a user needs to first take a look at summarized and important information related to processes, in order to start working on it.
It is shown by default in the right hand side of the Inbox when in a details view (or also shown by clicking on the View Summary button when in a grid view).
Clicking to work on it will open the Activity form Web Part.
Keep in mind this Web Part has some settings which require configuration (as described in the next section: Web Parts settings).
4. Start process list
Technical name: newcaselist
This Web Part allows users to start Process instances (create new cases).
It will show the available Process list, with the option to search or filter according to recent Processes.
It is really useful when a user has many possible Processes to start, otherwise it can be best to use the Start Process button Web Part instead.
Selecting and clicking on a Process chosen to start, will trigger the Activity form Web Part to show the first form of that Process.
Keep in mind this Web Part has some settings which require configuration (as described in the next section Parameters detail for each of the specific Web Parts).
5. Start process button
Technical name: newcasebutton
This Web Part allows users to start Process instances (create new cases) one-click away.
It will show a button with an optional label to provide a shortcut which is really useful when a user will most likely only start a few types of Processes (you may have 1 or more of this Web Part).
On the other hand, if the user can choose from many possible Processes to start, it can be best to use the Start Process list Web Part instead.
Clicking on the button will trigger the Activity form Web Part to show the first form of that Process.
6. View graphic query
Technical name: graphicquery
This Web Part allows users to see in a graphical way the path a case has followed, the users involved and its status.
For more information about this Web Part type, refer to Graphic query.
7. Cases area
Technical name: processes
The Case area allows end users to see the distribution of cases in the end user's Inbox grouped by process and sorted by their state: On time, at risk or overdue.
This area is very useful to identify which Processes and Activities require to be prioritized and allows easy access to them.
8. Global form
Technical name: globalform
This Web Part shows the global form of a case. Allows the user to review the main information of a case in which the user has no pending activities and the main information of a case that has been closed.
Global forms are related to specific Process versions. If a Process has several versions, each one should have a Global form.
9. Start process
Technical name: newcase
This Web Part allows users to start Process instances (create new cases) once the page is loaded.
It will show the first activity of the selected process in order to let the user work on this process immediately.
Keep in mind this Web Part has some settings which require configuration (as described in the next section: Web Parts settings).
|
To configure this Web Part, it is recommended to sign in with a user that has the proper rights in Bizagi to access processes. |
Parameters detail for each of the specific Web Parts
The following table displays the Web Part type, its parameters, the possible values for each parameter, and an example of how to send them to the Web Part.
Web Part |
Description |
Parameters |
Possible values |
Example |
|---|---|---|---|---|
casesummary |
Displays the summary form of the selected case. |
renderBehavior: defines whether the links/buttons will be displayed in a Pop up or displayed in a new page (OtherPage value), the default value is PopUp. |
•PopUp •OtherPage |
?type=casesummary&idCase=101&idWorkitem=2 |
graphicQueryBehavior: defines whether the Graphic Query will be displayed in a Pop up or displayed in a new page (OtherPage value), the default value is PopUp. |
•PopUp •OtherPage |
|||
renderPageUrl: defines the URL where the action of the links/buttons will be rendered when renderBehavior is OtherPage. |
Valid URL |
|||
idCase: ID of the case selected to display its summary form. |
Integer value |
|||
idWorkitem: ID of the process' element selected to display its summary form. |
Integer value |
|||
graphicquery |
Shows in a graphical way the path a case has followed, the users involved and its status. |
idCase: ID of the process' element selected to display the graphic query. |
Integer value |
?type=graphicquery&idCase=101&idWorkflow=2&caseNumber=101 |
idWorkflow: ID of the selected process to display the graphic query. |
Integer value |
|||
caseNumber: is the number displayed to the end user in the Work Portal. if you haven't customized your case numbers, then use the same value for idCase. |
String value |
|||
newcasebutton |
Creates a button in order to let the user starts a new case of the selected process |
idWfClass: defines the process ID of the new case to be created. |
Integer value |
?type=newcasebutton&idWfClass=1&buttonName=New%20Case |
buttonName: defines the name to be displayed in the button. The non alphanumeric characters must be ASCII encoded. Refer to http://www.w3schools.com/tags/ref_urlencode.asp for more information |
String value |
|||
renderPageUrl: defines the URL where the action of the links/buttons will be rendered when renderBehavior is OtherPage. |
Valid URL |
|||
renderBehavior: Defines whether the links/buttons will be displayed in a Pop up or displayed in a new page (OtherPage value), the default value is PopUp. |
•PopUp •OtherPage |
|||
newcaselist |
Displays a list of the processes created in your Bizagi project in order to create a new case of the selected process. |
renderBehavior: Defines whether the links/buttons will be displayed in a Pop up or displayed in a new page (OtherPage value), the default value is PopUp. |
•PopUp •OtherPage |
?type=newcaselist |
renderPageUrl: defines the URL where the action of the links/buttons will be rendered when renderBehavior is OtherPage. |
Valid URL |
|||
workportal |
Displays the whole Bizagi Work Portal. |
DefaultView: defines how the Work Portal's inbox will display the cases in the Web Part. Default value is details. |
•details •grid |
?type=workportal&showViewToggler=false&DefaultView=details |
showViewToggler: defines whether the option to display the cases in Grid or details view is displayed (true) or not (false). Default value is true. |
Boolean value |
|||
pageSize: defines the number of records to be displayed in the inbox when the view is grid. Default value is 10 |
Integer value |
|||
processes |
Displays the Case Area that allows end users to see the distribution of cases in the end user's Inbox sorted by their state: On time, at risk or overdue. |
Not required |
?type=processes |
|
cases |
In this view you can see the Inbox, that is to say the list of pending tasks and their status. |
renderBehavior: Defines whether the links/buttons will be displayed in a Pop up or displayed in a new page (OtherPage value), the default value is PopUp. |
•PopUp •OtherPage |
?type=cases&DefaultView=grid&pageSize=8&summaryBehavior=OtherPage&renderBehavior=OtherPage |
renderPageUrl: defines the URL where the action of the links/buttons will be rendered when renderBehavior is OtherPage. |
Valid URL |
|||
graphicQueryBehavior: Defines whether the Graphic Query will be displayed in a Pop up or displayed in a new page (OtherPage value), the default value is PopUp. |
•PopUp •OtherPage |
|||
summaryBehavior: Defines whether the links/buttons will be displayed in a Pop up or displayed in a new page (OtherPage value), the default value is PopUp. |
•PopUp •OtherPage |
|||
summaryPageUrl: defines the URL where the action of the links/buttons will be rendered when summaryBehavior is OtherPage. |
Valid URL |
|||
DefaultView: defines how the inbox will display in the case the Web Part. Default value is details. |
•details •grid |
|||
showViewToggler: defines whether the option to display the cases in Grid or details view is displayed (true) or not (false). Default value is true. |
Boolean value |
|||
pageSize: defines the number of records to be displayed in the inbox when the view is grid. Default value is 10 |
Integer value |
|||
globalform |
Displays the global form of the selected case. |
idCase: ID of the case selected to display its global form. |
Integer value |
?type=globalform&idCase=253 |
newcase |
Creates a new cases of the process sent to the Web Part through its ID |
idWfClass: defines the process ID of the new case to be created. |
Integer value |
?type=newcase&idWfClass=2 |
activityform |
Displays the actual pending task instance for a given case. |
idCase: ID of the case selected to display its pending task instance. |
Integer value |
?type=activityform&idCase=1&adjustButtonsToContent=true |
idWorkitem: the actual pending process' element instance for a given case. This parameter is optional. This attribute is not required when the case has only one pending element and when idTask is set. |
Integer value |
|||
idTask: the actual pending Task instance for a given case. This parameter is optional. This attribute is not required when the case has only one pending task and when idWorkitem is set. |
Integer value |
|||
adjustButtonsToContent: if this value is set to true, the activity buttons will be displayed in the bottom of the Web Part. Otherwise, they will be displayed in the bottom of the form created. Default value is false. |
Boolean value |
|||
Example
In order to create your Web Parts, follow the steps presented in the section Using Web Parts for other portals.
For example, if you want to show the user's Inbox, select cases as Web Part ([WEB_PART] variable). Then, add the parameters in order to modify the rendering of the links/buttons and how the Web Part will display the list of the cases. The following image displays the inbox in grid view with 10 records per page and the actions will be rendered in other page.
Notice we just use these following parameters with their appropriate values, in order to see the inbox as shown above:
&DefaultView=grid&pageSize=10&summaryBehavior=OtherPage&renderBehavior=OtherPage
|
If you wish to view a live demo and explore the results of this inbox example shown above, you may test and review the Web Part types and parameters as explained before. To do so, log at http://demo.bizagi.com/MySamplePortal/ and alter the inbox by modifying the parameters: you only need to add to the given URL the Web Part type preceded by a quotation mark (?) and each parameter preceded by an ampersand mark (&). |