feat: adding communication content about UIB #2722
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,43 @@ | ||
| = Applications with Bonita UI Builder | ||
| :page-aliases: ROOT:bonita-ui-builder.adoc | ||
| :description: In this section, you will learn more about: Bonita UI Builder, its purpose, how to subscribe and start using it, as well as Applications. | ||
| They are not anymore standalone elements (such as pages and forms) in a process (paradigm change with legacy Bonita UI Designer). | ||
|
|
||
| {description} | ||
|
|
||
| [.card-section] | ||
|
There was a problem hiding this comment. The goal of these sections was to have cards like on https://bonitasoft-bonita-doc-build_preview-pr-2722.surge.sh/bonita/latest/applications/uid-applications-index Cards are nice, as they provide a quick display without a lot of text to read. There was a problem hiding this comment. We could have both presentation text and cards, as done in the Getting Started Tutorial. |
||
| == Bonita UI Builder | ||
|
|
||
|
|
||
| Bonita UI Builder is a development environment made for designing all kind of interfaces, pages, forms, for your applications. It brings a host of advanced features and improved usability, designed to help you create even more compelling and user-friendly interfaces: a set of more than 45 widgets, a wide gallery template, code completion, custom JS code, native debugging option, a restriction-free drag & drop interface, import and export JSON options, React interfaces, and many more. | ||
|
|
||
|
There was a problem hiding this comment. Too long sentence, hard to read. There was a problem hiding this comment. Should we use a list instead? |
||
| Bonita UI Builder is an application-centric development environment that allows for designing forms and application pages, without distinction. You can now design fully-fledged applications, embedding dashboards and complex interfaces. Or, you can just design single-page applications. The choice is up to you. | ||
|
|
||
| With Bonita UI Builder, you can still manage your workflows, continuous integration, etc., the way you’re managing them now. | ||
|
|
||
| We offer xref:applications:initiation-manual.adoc[extensive documentation], xref:applications:how-tos-builder.adoc[tutorials], and a xref:applications:faq.adoc[FAQ] to help you make the most of Bonita UI Builder. | ||
|
There was a problem hiding this comment. Can be replaced by cards. There was a problem hiding this comment. Maybe the text was written with the help of GPT ? |
||
|
|
||
|
|
||
|
|
||
| [.card-section] | ||
| == Applications | ||
|
|
||
| Applications are created and operated within Bonita Platform, created with Bonita Studio and Bonita UI Builder, deployed with Bonita Continuous Delivery, run by Bonita Runtime. | ||
|
|
||
| They are a navigation of pages that can be accessed by a xref:identity:profiles-overview.adoc[Profile]. They aim to display and structure the right information and provide the right controls at the right time to the profiles, so they can efficiently perform their tasks. Once pushed to production, Applications cannot be live edited. | ||
|
|
||
| Bonita also comes with four Bonita Applications. | ||
|
There was a problem hiding this comment. We should list them, to be more precise. There was a problem hiding this comment. List the 4 bonita applications you mean? There was a problem hiding this comment. Le lien a sauté lors des copier-coller. Il faudrait que [Bonita applications] redirige vers https://documentation.bonitasoft.com/bonita/latest/runtime/bonita-applications-interface-overview |
||
|
|
||
| “Applications” are very similar to “Living Applications”, which are created with Bonita UI Designer and will be phased out. | ||
|
There was a problem hiding this comment. We should say the difference, at least move the "Once pushed to production, Applications cannot be live edited" sentence here. |
||
|
|
||
|
|
||
| [.card-section] | ||
| == How to start using Bonita UI Builder | ||
|
|
||
| Bonita UI Builder is available by default and for no additional cost in all https://www.bonitasoft.com/pricing[Scale subscriptions]. It is also available as a payable add-on in https://www.bonitasoft.com/pricing[Access subscriptions]. | ||
|
|
||
| If you haven’t subscribed to a Scale of Access plan yet, please https://www.bonitasoft.com/contact-us[get in touch] with our sales team to start your journey today! | ||
|
|
||
| If you have already subscribed to a Scale plan or purchased the UI Builder add-on, then start your journey by following our xref:applications:initiation-manual.adoc[initiation manual]. | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,7 +1,136 @@ | ||||||
| = FAQ | ||||||
| :description: | ||||||
|
|
||||||
|
|
||||||
| == Bonita UI Builder | ||||||
|
|
||||||
| === What is Bonita UI Builder? | ||||||
| Bonita UI Designer (sometimes abbreviated UIB) is a development environment used for creating all kind on interfaces, whether they are pages or forms or else, that make up an Application. It is a web-based tool that is launched from a Bonitasoft custom docker image. It is the new and only standard used in the Bonita ecosystem for designing interfaces. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
|
|
||||||
| === What does it mean for my workflows? | ||||||
| There should be no changed in your logic, continuous integration, and workflows. You can still manage them the way you’re managing them today. Just download the docker image and follow the xref:applications:initiation-manual.adoc[initiation manual]. | ||||||
|
|
||||||
|
|
||||||
| === How to subscribe? | ||||||
| Bonita UI Builder is available by default and for no additional cost in all https://www.bonitasoft.com/pricing[Scale subscriptions]. It is also available as a payable add-on in https://www.bonitasoft.com/pricing[Access subscriptions]. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| === How to use? | ||||||
| Please refer to the xref:applications:initiation-manual.adoc[initiation manual]. If you have any other additional questions, reach out to our https://csc.bonitacloud.bonitasoft.com[Support team]. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| === Can I expect any support from Bonitasoft? | ||||||
| Yes you can! | ||||||
|
|
||||||
| * Support and resources: We offer extensive documentation, tutorials, and support to help you make the most of xref:applications:bonita-ui-builder.adoc[Bonita UI Builder]. | ||||||
| * Facilitated transition: We are dedicated to facilitate the transition, with detailed guides on how to use Bonita UI Builder, as well as https://www.bonitasoft.com/professional-services/on-demand-services[professional services support]. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| === I am using the Open source edition of Bonita, can I use Bonita UI Builder? | ||||||
| Unfortunately no. You’ll need to either use Bonita UI Designer or design your interfaces with the language or tool of your choice and integrate them to Bonita. Upgrade to an Access or Scale edition if you want to use Bonita UI Builder. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| === Is Bonita UI Builder compatible with all supported versions of Bonita? | ||||||
| Bonita UI Builder is compatible with all Bonita versions starting from 2024.3. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| === What is an advancedApplication? | ||||||
| It is a tag used to describe an Application made with Bonita UI Builder in the Studio’s Application descriptor. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| === Can I use other datasources than Bonita’s? | ||||||
| Theoretically you can, yes. However, we’re not supporting them yet. | ||||||
|
|
||||||
|
|
||||||
| === How do Bonita UI Builder and Bonita UI Designer compare? | ||||||
| [cols="1,1,1"] | ||||||
| |=== | ||||||
| |Feature |Bonita UI Designer |Bonita UI Builder | ||||||
|
|
||||||
| |Widgets | ||||||
| |~25 | ||||||
| |~45 | ||||||
|
|
||||||
| |Custom widgets | ||||||
| |Yes | ||||||
| |Yes | ||||||
|
|
||||||
| |Downloadable array data | ||||||
| |Yes (custom code) | ||||||
| |Yes (native) | ||||||
|
|
||||||
| |Form's auto-generation from a contract | ||||||
| |Yes | ||||||
| |Yes in a future release | ||||||
|
|
||||||
| |Templates | ||||||
| |No | ||||||
| |Yes | ||||||
|
|
||||||
| |Themes | ||||||
| |Yes (using CSS bootstrap 3) | ||||||
| |Yes (native feature) | ||||||
|
|
||||||
| |Custom code | ||||||
| |Yes (HTML, CSS, JS) | ||||||
| |Yes (HTML, JS, custom JS libraries) | ||||||
|
|
||||||
| |Code completion | ||||||
| |No | ||||||
| |Yes | ||||||
|
|
||||||
| |Native debugging options | ||||||
| |No | ||||||
| |Yes | ||||||
|
|
||||||
| |Application import/export | ||||||
| |Yes | ||||||
| |Yes (JSON) | ||||||
|
|
||||||
| |Page components' hierarchy | ||||||
| |No | ||||||
| |Yes | ||||||
|
|
||||||
| |Page preview | ||||||
| |Yes | ||||||
| |Yes | ||||||
|
|
||||||
| |Undo/redo | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| |No | ||||||
| |Yes | ||||||
|
|
||||||
| |Stack | ||||||
| |AngularJS | ||||||
| |React | ||||||
|
|
||||||
| |Works best for... | ||||||
| |Quick development tests, simple use cases | ||||||
| |Fully-fledged applications, complex use cases | ||||||
|
|
||||||
|
|
||||||
| |=== | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| === What does it mean for my existing forms and pages? | ||||||
| You existing forms and pages will always be compatible with Bonita. Eventually, Bonita UI Designer will be phased out as we fully transition to Bonita UI Builder. We cannot guarantee you will be able to edit your existing interfaces made with Bonita UI Designer in the future versions of Bonita. | ||||||
|
|
||||||
| Our goal is to make this transition as smooth as possible, minimizing any disruption to your workflow: | ||||||
| * Continued access: Bonita UI Designer will remain fully operational for an extended period, allowing ample time for adaptation. | ||||||
|
There was a problem hiding this comment. Insert blank line before. |
||||||
| * Support and resources: We offer extensive documentation, tutorials, and support to help you make the most of xref:applications:bonita-ui-builder.adoc[Bonita UI Builder] | ||||||
| * Facilitated transition: We are dedicated to facilitate the transition, with detailed guides on how to use Bonita UI Builder, as well as https://www.bonitasoft.com/professional-services/on-demand-services[professional services support] | ||||||
|
|
||||||
|
|
||||||
| === Are the interfaces made with Bonita UI Builder compatible with platform mode and self-contained applications ? | ||||||
| Yes they are. | ||||||
|
|
||||||
|
|
||||||
| === Is Bonita UI Builder Bonita Cloud compatible? | ||||||
| Yes it is. Reach out to your customer service representative to explore how you can migrate to Bonita Cloud. | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| = Living Applications with Bonita UID | ||
| :description: This page explains what a Living Application is, what it is made of, and how you can create your own applications. | ||
|
|
||
| {description} | ||
|
|
||
| [NOTE] | ||
| ==== | ||
| Starting from 2024.3 version, Bonita UI Builder is the only standard for designing all your applications. It brings a host of advanced features and improved usability, designed to help you create even more compelling and user-friendly interfaces. Bonita UI Builder is an application-centric development environment that allows for designing interfaces, forms and application pages, without distinction. | ||
|
|
||
| During the transition, you can continue using Bonita UI Designer while exploring Bonita UI Builder. Eventually, Bonita UI Designer will be phased out, but we will provide support and resources to ensure a smooth transition. Check our xref:applications:bonita-ui-builder.adoc[documentation] to learn more and start creating applications with Bonita UI Builder. | ||
| ==== | ||
|
|
||
|
|
||
| A Living Application is a navigation of pages that can be accessed by a xref:identity:profiles-overview.adoc[Profile]. + | ||
| It is created and operated within Bonita Platform: created with Bonita Studio and UI Designer, deployed with Bonita Continuous Delivery, run by Bonita Runtime. | ||
|
|
||
| Its purpose is to display and structure the right information and provide the right controls at the right time to the profiles, so they can efficiently perform their tasks. + | ||
|
|
||
| _Graphically_, an application is made of a navigation menu and a set of pages. In some of the pages, some controls, like -"Validate" or "Reject" buttons- are directly linked to processes and execute tasks in the background. Others -like "New request" or "Add additional information"- open forms that, once submitted start a new process instance, or execute a task. + | ||
| Bonita allows you to create xref:ROOT:bonita-purpose.adoc#_what_can_i_do_with_bonita[different types of applications]. + | ||
|
|
||
| _Structurally_, an application is made of various xref:ROOT:project-structure.adoc[elements]. Some are directly linked to the application (name, token, navigation), others are referenced (layout, pages, profiles, theme). They are all assembled in the application descriptor. + | ||
|
|
||
| Bonita comes with four xref:ROOT:bonita-applications-interface-overview.adoc[Bonita Applications]. + | ||
|
|
||
| We encourage our users to create their own *custom applications* so as to create the best user experience for their specific use-cases. + | ||
| The application can be put together by the citizen developer or a professional developer. + | ||
| You just need to make sure that all the elements have been developed before you can use them in the application descriptor. + | ||
| For testing purposes, Bonita provides a layout and several themes, before you create your own. | ||
|
|
||
| [.card-section] | ||
| == Application elements | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| xref:ROOT:application-creation.adoc[[.card-title]#Application descriptor# [.card-body.card-content-overflow]#pass:q[Both its ID card and the place where all elements come together]#] | ||
| -- | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| xref:ROOT:pages.adoc[[.card-title]#Pages# [.card-body.card-content-overflow]#pass:q[The foundation for a great end-user experience]#] | ||
| -- | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| xref:identity:profiles-overview.adoc[[.card-title]#Profiles# [.card-body.card-content-overflow]#pass:q[Entities of the organization who can access the application]#] | ||
| -- | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| xref:layout-development.adoc[[.card-title]#Layout# [.card-body.card-content-overflow]#pass:q[The visual structure of the application]#] | ||
| -- | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| xref:customize-living-application-theme.adoc[[.card-title]#Theme# [.card-body.card-content-overflow]#pass:q[The graphical details that create a visual identity]#] | ||
| -- | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| xref:ROOT:navigation.adoc[[.card-title]#Navigation between applications# [.card-body.card-content-overflow]#pass:q[How to switch from one application to another]#] | ||
| -- | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| xref:ROOT:multi-language-applications.adoc[[.card-title]#Multi-language applications# [.card-body.card-content-overflow]#pass:q[How to translate applications in several languages]#] | ||
| -- | ||
|
|
||
|
|
||
| [.card-section] | ||
| == The resources | ||
|
|
||
| Starting the development of an application from scratch may not be the most efficient way to go. If your project implies: | ||
|
|
||
| * That a user picks tasks in a tasklist made of all processes, you may want to try and use or customize our *Bonita User Application* | ||
| * That an administrator-like user monitors the health of process execution and fixes the potential errors, you may want to try and use or customize our *Bonita Administrator Application* | ||
| * Specific pages showing specific business data, you may want to *borrow a project created by a Community member and customize it* | ||
| * Adaptive Case Management, with non-sequential parts in the processes to let the knowledge workers' expertise decide which tasks to do and which ones to skip for a dedicated case, you may check our *ACM example* | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| xref:runtime:user-application-overview.adoc[[.card-title]#Bonita User Application# [.card-body.card-content-overflow]#pass:q[Start process instances and execute tasks using a generic tasklist]#] | ||
| -- | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| xref:ROOT:admin-application-overview.adoc[[.card-title]#Bonita Administrator Application# [.card-body.card-content-overflow]#pass:q[Monitor and troubleshoot process execution]#] | ||
| -- | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| https://community.bonitasoft.com/project?title=&field_type_tid=All&field_project_category_tid=1341&field_certification_tid=All&sort_by=created&sort_order=DESC[[.card-title]#Community projects# [.card-body.card-content-overflow]#pass:q[Browse the Community members' applications to get inspired]#] | ||
| -- | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| xref:ROOT:use-bonita-acm.adoc[[.card-title]#Adaptive Case Management example# [.card-body.card-content-overflow]#pass:q[An all configured process and its dedicated application]#] | ||
| -- | ||
|
|
||
|
|
||
| [.card-section] | ||
| == Related topics | ||
|
|
||
| [.card.card-index] | ||
| -- | ||
| xref:runtime:bonita-applications-deep-dive.adoc[[.card-title]#Applications deep dive# [.card-body.card-content-overflow]#pass:q[Applications under the hood, and the four Bonita applications]#] | ||
| -- | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
custom-applications-index.adoc should be removed.
I guess uid-applications-index.adoc is just a copy of it ?
custom-applications-index.adoc should also be added to aliases in uid-applications-index.adoc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why should it be removed?
custom-applications-index.adoc and uid-applications-index.adoc are 2 distinct pages and will have different content
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
custom-applications-index.adoc is the one about Legacy UID, so I don't understand what the difference would be with uid-applications-index
custom-applications-index.adoc is no longer accessible from the navigation.
I do understand the need for renaming as "custom-" is ambiguous. But if that's not a page renaming, then I don't understand the change.
Aliases are here to ensure the correct redirection in case of page renaming.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As it is now, "Living applications" and "Living applications with Bonita UID (legacy)" are both on custom-applications-index.adoc with the same content, and I want to avoid that and split them into 2 different pages (since they will have different content). Hence this change