Developing Custom VersionOne Apps 101 Series Guide
In this article, you'll test drive a sample custom VersionOne app, the Feature Requestor
. If you're not sure why you'd ever use this app, or want to learn why we built it, go to previous article, VersionOne Feature Requestor Sample Custom App: Introduction and Why You'd Need It
. Forkable source code for it is on GitHub
Feature Requestor: a sample custom VersionOne app
We developed the VersionOne Feature Requestor App
as a usable, customizable example to help you in the the scenarios described in the previous article
. To quote from that article:
Why Would I Need to Use the Feature Requestor App?
- Do you have a customer/facing or user/facing web site with a form for change requests or enhancements?
- Do lots of new people bringing up ideas in meetings and you cannot waste time creating new accounts for all these people just to get their ideas into VersionOne?
- When you walk the halls with your iPad or Android tablet, do users throw ideas off to you, and you want to capture those ideas quickly?
- Or, when conduct usability and testing labs for your own products with your users, do you wish you could use your tablet to jot down change requests and feedback as painlessly as possible in VersionOne?
What is the Feature Requestor App built with?
It's a simple app, built on the open source jQueryMobile
How to use the Feature Requestor with your VersionOne Instance (Zero installation!)
Are you familiar with the idea of user scripts
You can find thousands of them on Userscripts.org
. We have two versions of the Feature Requestor. One is a user script that can be temporarily "injected" into a VersionOne instance, while the other is downloadable and installable on a web server.
If you already use VersionOne, and want to try the Feature Requestorwithout needing to install anything, then do this:
- Using Google Chrome, navigate to your VersionOne instance and login with your username and password.
- Then, create a new bookmark with the following definition:
- Alternatively, you could actually paste that whole line into the browser address bar and hit enter. But, saving it as a bookmarklet will make it something you can load again later without going through this step again.
You'll know it worked if you see the page transform into a new "app", like in the screenshot in the next section.
You can follow along with the screenshots at http://eval.versionone.net/platformtest/v1requestor
Note: some of the items may look a little different if people have been playing around, but the basic workflow is the same.
- If you search for something that doesn't exist, it is blowing up right now :) Will fix soon! Stick with the script for now!
- So far, the app works in Google Chrome. It partially works in FireFox, but I'm having some issues with the Save buttons.
The home page has a simple search box where you, or your customer, can search for a Project by name. Type
to pull up the example 'System (All Projects)` project.
Search for a project
and hitting enter, it will return the project into the list:
Select project to pull up a new Request form
Click the item, and it will open up a new Request entry form:
Enter new Request details
Fill in some details, and select a
priority (if your request is awesome!)
Save new Request
Once, you've typed in the Request details, click the
button on the bottom right. It should display a green success message at the top. You can keep modifying the details if you'd like to add in more info, or click
from the top to start a brand new Request.
Select Request from list
button from the top left. This takes you back tot he list of Requests for the Project. Your new item should be there at the top of the list now. You can click on that to edit it, or just keep following along with the screen shots.
Modify and save Request
After picking a Request, and modifying its details, click the
button. It should display a green success message.
Note: if you empty out the
, a required field, it will highlight the field and show a big bad red error message. Try it.
View Requests list in VersionOne
If you login to the test VersionOne instance, athttp://eval.versionone.net/platformtest
with username / password of
admin / admin
, then you can click the
tab and see the list with your new entry in it:
View Request detail in VersionOne
Click the item to popup the lightbox with details:
Edit Request in VersionOne
And, you can then click the
button on the right to edit and save your changes:
Up next: getting technical
I'm still working up a technical deep dive of the Feature Requestor app, so try these next instead:
If you want background on the web and HTTP, skip to Hello HTTP: How to GET What You Want and POST What Ya Got on the Web
If you know HTTP fairly well, but want more info about REST, see Understand How and Why REST APIs Work // Demonstrated with the VersionOne Data API
Good with those already? Then writing your own code against the API at How To Query the VersionOne REST Data API for User Stories in JSFiddle with jQuery, JSON, HTTP GET, and 9 Lines of Code
Want to skip way, way ahead to the most advanced example? Then try the Metamorformizr
. It uses the VersionOne Data, Meta, and Localization REST APIs with Backbone.js and Backbone Forms to create a powerful, low/custom/code (137 lines) Story Editor.