VersionOne Screenshot Utility Sample


Table of Contents

Abstract
Configuration
Usage
Concepts Demonstrated

Abstract

The V1Screenshot utility allows you to easily attach an image currently on your windows clipboard to an item within VersionOne, without having to save to disk and add as an attachment. In addition to uploading the image file as an attachment, it can add the image to the tab menu on the VersionOne details page for easy access (via adding a Link to the attached file using the ‘Add to Menu’ option).

Configuration

The first time you run the application, you’ll be prompted with the configuration dialog, within which you’ll enter your VersionOne application URL, username and password. If you need to change configuration later, there’s a ‘Settings…’ button on the main form.

Additionally, you can modify the default name suggested when attaching images to assets.

Usage

The ‘My Stuff’ tab on the main form of the application lists all ‘open’ workitems (stories, defects, tasks & tests) that you currently own, across all projects that you have access to. Additionally, for any tasks or tests that you own, the list will also include the parent story or defect (whether you own it or not), as that tends to be where screenshots get attached.

The lower section of the main form contains a panel which will display the image that is currently on the windows clipboard. This panel will be blank if the clipboard does not contain an image (e.g. it is empty or contains text). If you copy a different image to the clipboard while the application is running, the panel’s image will update to reflect that new screenshot.

To attach an image to an item, select the item from the list and click ‘Attach Image’. Note that if there is no image displayed in the panel, the ‘Attach Image’ button will not become enabled.

To view the details page for anything listed (e.g. to view the item with its’ new attachment), select it in the list and click ‘View Details…’. Below is an example of the image displayed in the main form diagram (above), now attached to the Warehouse Integration – Receiving story and accessible via a tab named ‘Screenshot’.

If you need to attach a screenshot to an item you do not own, you can switch to the ‘Search’ tab. Simply enter a search string and click ‘Go’ to list any Epics, Stories, Defects, Tasks, Tests, Requests or Issues that contain that text in any of their string attributes (e.g. Name, Description, etc.).

Concepts Demonstrated

The V1Screenshot sample demonstrates the following SDK concepts:

  • Connecting to a VersionOne system, including any exceptions that may occur.

  • Filtering and ordering when retrieving items.

  • Creating Attachments and Links on an item.

  • The type hierarchy within Workitems, PrimaryWorkitems & SecondaryWorkitems.

Copyright © 2008, VersionOne, Inc. All rights reserved. This document was generated 2008-05-22 19:27:48.