Configure Modal/Panel Display For Process Start Forms
Hey guys! Today, we're diving into a cool enhancement for Valtimo that's all about giving you more flexibility and a better user experience. We're talking about making the display type—whether it pops up as a modal or slides in as a panel—configurable for the process links in a start form of a supporting process. Trust me, this is going to make your life a whole lot easier!
Why This Matters
Let's get straight to the heart of the matter. Why should you care about this? Well, in the world of Valtimo, user experience is king, and having the ability to fine-tune how users interact with your processes is a huge win.
The Problem Statement: Custom Code Headaches
In the trenches of a specific Valtimo implementation, a demand arose: the start form of a supporting process needed to open in a panel, just like user tasks. Sounds simple, right? But to make this happen, a significant amount of effort was poured into creating a custom case detail page with all the necessary components. And guess what? It worked like a charm!
But here’s the kicker: every time a new version of Valtimo rolls out, this custom code becomes a major pain point. It needs to be meticulously adapted to comply with the new version, and there’s always the looming fear of breaking something. This is where the need to get rid of custom code and leverage the platform's built-in features becomes critical. We needed to find a way to use what Valtimo offers out of the box, and that's where this new configuration option comes in.
The main keyword here is flexibility. By making the display type configurable, we're empowering you to create a more seamless and intuitive user experience without getting bogged down in custom code. Imagine being able to present start forms in a panel, right alongside the case details, or popping them up as modals when that makes more sense. The choice is yours, and that's incredibly powerful.
We're not just talking about aesthetics here; we're talking about efficiency. When users can easily access and interact with start forms in a way that feels natural and intuitive, they're more likely to complete the process quickly and accurately. This translates to faster turnaround times, reduced errors, and happier users – a win-win-win scenario!
The User Experience Advantage
Think about it: a well-placed panel can keep the user in context, allowing them to see the case details while filling out the start form. This is particularly useful when the form requires referencing information from the case. On the other hand, a modal might be the better choice for more complex forms that need the user's full attention.
By having this configuration option, you can tailor the experience to the specific needs of each process, ensuring that users have the best possible experience every time. This is the kind of attention to detail that sets a great system apart from a merely functional one.
So, in a nutshell, this enhancement is all about giving you the tools you need to create a user-friendly and efficient Valtimo implementation. It's about reducing the burden of custom code and empowering you to leverage the platform's built-in capabilities. And, most importantly, it's about making life easier for you and your users.
How We're Making It Happen
The solution we're proposing is pretty straightforward but packs a punch. When you're configuring a Process-link on the start event of a BPMN process definition, you'll now have the option to select the display type. This is similar to how you already configure the display type for process links in user tasks, so it'll feel familiar and intuitive.
Configuration Options
Think of this as adding another tool to your Valtimo toolbox. Just like you can choose whether a user task opens in a panel or a modal, you'll now have the same control over start forms. This consistency is key to a smooth and predictable user experience.
Imagine you're designing a process where the user needs to quickly initiate a sub-process while staying focused on the main case. A panel is perfect for this scenario. The user can fill out the start form without losing context, and the main case details are always visible. On the other hand, if the start form is more involved and requires the user's undivided attention, a modal might be the better choice. It provides a clear separation and allows the user to focus on the task at hand.
The beauty of this approach is that it gives you the flexibility to choose the best option for each specific process. You're not locked into a one-size-fits-all solution, and you can tailor the experience to the needs of your users. This is the power of configuration, and it's what makes Valtimo such a versatile platform.
Mimicking User Task Configuration
The fact that this configuration mirrors the user task display type settings is no accident. We want to ensure a consistent experience throughout Valtimo. If you're already familiar with configuring user tasks, you'll feel right at home with this new feature. This reduces the learning curve and makes it easier to adopt the enhancement.
By keeping the configuration options consistent, we're also making it easier to maintain and troubleshoot your processes. You don't have to remember different settings for different types of forms; the same principles apply across the board. This is a small detail, but it can make a big difference in the long run.
So, the “how” boils down to adding a simple yet powerful configuration option. By giving you the ability to choose the display type for start forms, we're empowering you to create a more user-friendly and efficient Valtimo implementation. It's about giving you control and flexibility, and that's always a good thing.
What's Actually Changing
Okay, let's get down to the nitty-gritty. What exactly are we changing in Valtimo to make this happen? The main focus is on two key areas: the process link configuration modal and the functionality behind the 'Start supporting process' button.
Updating the Process Link Configuration Modal
The first step is to update the process link configuration modal that you see when you're designing your BPMN process definition. We need to add a new option that allows you to select the display type for the start form. This is where you'll choose whether the form should open in a panel or a modal. This enhancement will require to update the process link configuration modal of a start event to offer the 'Display type' option.
This might sound like a small change, but it's the foundation for the entire feature. Without this configuration option, you wouldn't have the ability to control the display type. It's the key that unlocks the flexibility we're aiming for.
The new option will be intuitive and easy to use. We're not talking about adding a complex set of settings; it's a simple dropdown or radio button selection that allows you to choose between “panel” and “modal.” This simplicity is intentional. We want to make it easy for you to configure your processes without getting bogged down in technical details.
Adapting the 'Start Supporting Process' Button Functionality
The second piece of the puzzle is the 'Start supporting process' button, which you'll find on the Case detail page. This button is what actually triggers the start form, and we need to make sure it respects the display type you've configured. Additionally the functionality which is behind the 'Start supporting process' button needs to be adapted that it takes into account the configured 'Display type' of the corresponding process link.
This means that when you click the button, Valtimo will check the configuration for the selected process and display the start form accordingly. If you've chosen “panel,” the form will slide in as a panel on the side of the screen. If you've chosen “modal,” the form will pop up in a separate window.
This is where the rubber meets the road. It's one thing to have a configuration option, but it's another thing to make sure that option is actually honored when the process is executed. This adaptation of the 'Start supporting process' button functionality is what ensures that your configuration choices have a real impact on the user experience.
So, in essence, we're updating both the design-time and the runtime aspects of Valtimo. We're giving you the tools to configure the display type, and we're making sure that the system respects those configurations when the process is executed. This is a holistic approach that ensures the feature works seamlessly from start to finish.
Requirements Breakdown
Let's break down the specific requirements to make sure we're all on the same page. These requirements act as a checklist, ensuring that the new feature meets our goals and provides the intended functionality.
Display Type Option on Process Link Configuration Screen
The first requirement is clear: “On the Process link configuration screen of a start event, the option 'Select form display type' with values 'panel' or 'modal' is displayed. It defaults to 'modal'.”
This means that when you're configuring a process link on a start event, you'll see a new dropdown or radio button group that allows you to choose between “panel” and “modal.” The default value will be “modal,” so if you don't explicitly choose a display type, the form will open in a modal window. This is a sensible default, as modals are a common and well-understood way to present forms.
This requirement is the cornerstone of the entire feature. It's what gives you the ability to control the display type, and it's essential for achieving our goal of increased flexibility and user experience.
Handling Display Type on Case Detail Page
The second requirement is a bit more detailed: “When on the Case detail page the 'Start' button is clicked and a process is selected the start form will either be displayed in: When the panel is available on the tab and the display type in the configuration is set to 'panel', in the Panel. Otherwise in the Modal.”
This requirement ensures that the display type you've configured is actually respected when the process is started from the Case detail page. It outlines the logic that Valtimo will use to determine how to display the start form.
Let's break it down:
- If the panel is available and the display type is set to 'panel': In this scenario, the start form will be displayed in the panel. This is the ideal case for scenarios where you want to keep the user in context and allow them to see the case details while filling out the form.
- Otherwise: If the panel is not available (perhaps the user is on a screen that doesn't have a panel) or the display type is not set to “panel,” the start form will be displayed in a modal. This ensures that the form is always displayed, even if the panel isn't an option.
This requirement is crucial for ensuring that the feature works as expected in different contexts. It handles the various scenarios that might arise and ensures that the user always has a consistent and predictable experience.
In conclusion, these requirements provide a clear roadmap for implementing the new feature. They ensure that we're building a solution that is both flexible and user-friendly, and that it works seamlessly in different situations.
In a Nutshell
So there you have it, folks! We're making some cool changes to Valtimo that will give you more control over how start forms are displayed. This means a better user experience, less custom code, and more flexibility in designing your processes. Stay tuned for more updates, and let us know what you think!