Developing applications collaboratively can sometimes feel like juggling—keeping track of who is working on what, ensuring no one steps on each other’s toes, and maintaining a smooth workflow. We’re excited to announce a new feature in Nitro App Builder (NAB) that aims to make this juggling act a whole lot easier: the Check-Out/In system.
In this blog post, we’ll walk you through how this new feature works and how it can enhance your development experience on the IBM i platform.
Why a check-out/in system?
Previously, when a developer began editing a Data Source, Widget, or Application in NAB, the item would be locked automatically until they saved and exited. While this mechanism prevented simultaneous edits and potential conflicts, it also had some drawbacks:
- Temporary Locks: Items were only locked while you were actively editing them. Once you exited, the lock was released—even if your work was incomplete. This meant that other developers could start editing the same item, potentially leading to conflicts or overwriting your unfinished work.
- No Change Isolation: Any changes made were immediately reflected for all users upon saving, which could lead to incomplete features being visible to others.
The new Check-Out/In feature addresses these issues by allowing developers to keep items checked out until their work is complete, providing better control and reducing the risk of conflicts.
How does it work?
Enabling the Feature
Before you can start using the Check-Out/In system, you need to enable it:
- Open the Valence Portal Admin application
- Navigate to the Settings section
- Find the NAB group within the settings
- Check the box labeled “Enable Check-Out/In Feature”
Once this feature enabled, you’re all set to start using the Check-Out/In system. All subsequent NAB object edits will require a “checkout” action before you can make any changes.
Checking Out an Item
Before you start making changes to a Data Source, Widget, or Application, you’ll need to check it out:
- Navigate to the item you wish to edit within NAB
- Click on the desired “Check Out” option – “Checkout” to merely check out the object, or “Checkout & Edit” to both check it out and begin editing
The item is now checked out to you, and only you can make changes to it.
NAB Checkout Characteristics
- Checked out objects will be highlighted in yellow, with the user identified in the “Checked out by” column
- Other developers cannot edit or check out such items until checked back in
- While a NAB object is checked out to a user, any changes saved are only visible to that user
- Other team members can still view or run the item in its last committed state, but they won’t see changes until the developer decides to commit them
Saving/Committing or Discarding Changes
When checkout/checkin functionality is active, the Save dialog will look a bit different:
- Save – this will save your changes while leaving the item in a checked-out state. The changes will only be visible to you.
- Commit – this will save your changes in a public manner, so others can see your work in progress. The item remains checked out to you.
- Commit & Check In – this will both commit your changes and check in the item, making it available for others to subsequently check out and edit
Alternatively, you can Discard your changes if you decide not to keep them, as shown here:
When you discard changes, the NAB object will revert to your last commit, or if no commits have occurred it will revert to the state at the original checkout.
Viewing Your Checkouts
- A new section called “Checkouts” is available within the NAB Designer app
- Here, you can see all the items you currently have checked out
- This makes it easy to keep track of your work and manage your tasks efficiently
Handling absences with NAB Checkout Manager
What happens if someone forgets to check in an item before going on vacation?
Introducing the NAB Checkout Manager application, which should appear in your Valence Portal launchpad upon updating to build 6.3.20241025.0 or later.
- This new app allows authorized individuals to check in items on behalf of others
- It’s especially useful for administrators or team leads to manage check-outs when team members are unavailable
- This ensures that development doesn’t come to a halt due to inaccessible checked-out items
Benefits of the check-out/in system
- Controlled Access: Only one person can edit a specific item at a time, preventing conflicts and overwriting of changes.
- Work Isolation: Changes made by the developer are isolated until they decide to commit and check in, ensuring that incomplete or experimental changes don’t affect others.
- Persistent Locks: You can keep items checked out until you’re completely done with your work, providing flexibility and control over the development process.
- Accountability: Clear ownership of changes enhances responsibility and traceability within the team.
- Efficient Project Management: The ability to view all checked-out items helps in planning and coordinating development activities.
Conclusion
The new Check-Out/In feature in Nitro App Builder is designed to streamline your development process on IBM i. By providing a clear structure for editing items and enhancing team collaboration, we’re confident this feature will make your development experience smoother and more efficient.
Ready to take it for a spin? Update your NAB today, enable the feature, and start exploring the possibilities!
Need Assistance?
If you encounter any challenges or have questions about the setup process, feel free to reach out to our support team or consult the detailed Nitro App Builder documentation.