Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: new page for SPO and small changes to the application page #20

Draft
wants to merge 26 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 23 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ nav:
- modules/cli/taxonomy.adoc
- modules/application/taxonomy.adoc
- modules/dashboards/taxonomy.adoc
- modules/spo/taxonomy.adoc

Binary file modified modules/application/images/import-data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion modules/application/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ When you delete an application, all related imported data will be removed. This

Once the export tool generates the zip file containing your dataset, you can import it.

Go to the _Applications_ page in your BPI instance, click the "Import Data" button on the target application's card, and access the upload form. Upload the zip file and wait for it to be processed and analyzed. Once completed, you can explore the data in your dashboards.
Go to the _Applications_ page in your BPI instance, click the "Import Data" button on the target application's card, and access the upload form. Upload the zip file and wait for it to be processed and analyzed. You can also choose to generate a xref:spo:index.adoc[Smart Process Overview], which sends an email with details about the process execution of your data. Once completed, you can explore the data in your dashboards.

image::import-data.png[Import Data]

Expand Down
Binary file added modules/spo/images/card-spo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/spo/images/configure-email.gif
marcobonita marked this conversation as resolved.
Show resolved Hide resolved
marcobonita marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/spo/images/import-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
79 changes: 79 additions & 0 deletions modules/spo/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
= Smart Process Overview
:description: Explain how to use and receive a Smart Process Overview for your application

== Overview
Smart Process Overview (SPO) harnesses the power of AI to provide a concise yet insightful summary of your process execution and performance.
It delivers clear, actionable insights into your business processes, empowering you to make informed decisions with ease.

With the Smart Process Overview, you gain a comprehensive perspective on your operations.
Monitor performance at a glance, evaluate team effectiveness, and quickly identify areas requiring attention through user-friendly reports—designed for both beginners and experienced users.

Every time you import data on Bonita Process Insights, you can choose whether to generate a Smart Process Overview for your data.
If enabled, the SPO is automatically sent to the email distribution list specified in your application's settings.
Additionally, you can generate the SPO on demand via your application card.


== How to use
[#requirements]
=== Requirements

* A xref:application:index.adoc[BPI application]

* At least one email configured in your application’s email distribution list:

image:configure-email.gif[configure-email]

Ensure emails in the distribution list are separated by commas. There is no limit to the number of recipients.


=== Generating the Smart Process Overview

==== 1. After importing data

When you import data into your application, the SPO will be available for generation:

image:import-page.png[import-page]

Ensure at least one email is configured in your xref:spo:index.adoc#requirements[application details].
tbouffard marked this conversation as resolved.
Show resolved Hide resolved
marcobonita marked this conversation as resolved.
Show resolved Hide resolved

[#on-demand]
==== 2. On-demand from the application’s card

Navigate to the application's card on the home page and click the “Generate Smart Process Overview” button to generate it:

image:card-spo.png[card-spo]


Ensure you’ve xref:application:index.adoc[imported at least one dataset] and configured at least one email in the xref:spo:index.adoc#requirements[application details].
marcobonita marked this conversation as resolved.
Show resolved Hide resolved

Once generated, the SPO will be sent to your email distribution list within a few moments.


== FAQ

=== What AI model is used to generate the Smart Process Overview?

The SPO is powered by https://openai.com/[OpenAI].


=== How is the Smart Process Overview computed?

The SPO analyzes data from the last three months based on the most recent date in your dataset. For example, if your imported data ends on November 15, the SPO will cover November, October, and September.


=== What can I expect in terms of data privacy?

Smart Process Overview leverages OpenAI's APIs to deliver its functionalities. Any data sent to OpenAI is governed by their privacy policy, which you can review https://openai.com/policies/row-privacy-policy/[here].
For organizations with stringent privacy requirements, we suggest to xref:cli:configuration-for-anonymization.adoc[anonymize your imported data] first for maximum privacy.

Rest assured, the SPO relies on computed KPIs such as wait times and failed processes—not raw data. Nothing is sent to OpenAI without your explicit consent.


=== I have imported datasets and I have an email configured in my application, yet I haven’t received anything

Smart Process Overview delivery may take a few hours. Check your spam folder or try again later. If the issue persists, contact our https://csc.bonitacloud.bonitasoft.com/apps/CustomerServices/supportGuide/[Support team].


=== I have imported data while not having any email configured in my application, can I still generate a Smart Process Overview afterwards?

Yes. Simply configure an email in your application, return to the home page and click the "Generate Smart Process Overview" button on the xref:spo:index.adoc#on-demand[application card].
marcobonita marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions modules/spo/taxonomy.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* xref:index.adoc[Smart Process Overview]