Software Requirements Screencast: Pasting Images Into Borland Caliber RM

In the following screencast, I demonstrate how to put images into Borland Caliber RM so that they reliably can be output into document factory. This is a demonstration of part of Anthony C's post in December "3 Big Caliber RM Gotchas And How to Fix Them Part 1".

You can also find this video in the media section of our software requirements resource page.

Screencast: Getting the Most Out of Caliber RM And Your Requirements

In this post, Anothony C describes how to export your Caliber Requirements Grid into an Excel spreadsheet. In the following screencast, I demonstrate how to copy a Traceability Matrix from Caliber RM into Excel using a similar method.



You can find this video as well as many more requirements templates and tools in our resources page.

Four Ways To Get The Most Out Of Borland CaliberRM

We have been using Borland's CaliberRM for awhile now. Overall I really like the tool, but as I mentioned in another blog post there are definitely some issues. We tend to not let the user population and management have direct access which means that we have to be able to generate output in a variety of forms.

In this post I want to provide a few tips that have helped us to generate output in some pretty flexible ways.

1) Getting Appropriately Styled Headers In A Word Doc

Document Factory is the tool which uses a very simple set of commands in a word doc to iterate through your requirements and output them into Microsoft Word. Over time you will grow to love or hate document factory, but the reality is that while it may be difficult to bend to your will, it will generally let you produce the kind of documents that you want to produce.

One of the biggest issues that we have had is how to get doc factory to work with autonumbering. When we modified our existing requirements document templates to work with Document Factory and output the hierarchical numbers from CaliberRM, all of our items were numbered twice.

Plus it was impossible to get CaliberRM to use multiple header level styles. We ended up finding a macro on the Web that solves this problem. First you use a document factory template that labels the headers with special characters. Then you run the macro which parses the "." in the hierarchical number and applies whatever style you want. This is actually a very quick process and allows you to use whatever styles/formatting you want to format your requirements document

2) Getting The Images To Actually Be In Your Document Rather Than Be Referenced By Your Document

When we first started using document factory we discovered that images were not by default stored in the document produced by CaliberRM. What would happen is that we would send the document to someone and all the images would be broken.

It turns out that document factory uses a command called MERGEFORMAT /d which only uses links to images not the images themselves. Joe wrote a messageboard post on the subject here.

The short of it is that you need to reveal codes with Alt-F9. Then do a global search and replace "MERGEFORMAT/d" for "MERGEFORMAT". Hit Alt-F9 again to hide codes and then Ctrl-a to select the whole document. Then hit F9 to update all field codes. Save the document. The way we are sure that it has been updated is that the size of the document should be substantially larger.

3) Outputting A Subset Of The Requirements

If you select a requirement in the tree, then run document factory, document factory will give you the option to only generate requirements for the selected requirement and all its children. This is quite handy and we use it all the time.

More commonly though we use the requirements grid to filter a subset of requirements in the way we want and run document factory on those requirements.

4) Getting Tables Into Your Output

It turns out this is somewhat obscure. In document factory instead of using the BEGIN_SECTION and END_SECTION, you use BEGIN_ROW and END_ROW. Here is an example from a template that we actually use:

Sprint	Hierarchy	ID	Vers	Name	Priority	Status	Effort
$BEGIN_ROW $SORT{hierarchy} <<Release>>	<<hierarchy>>	<<id_number>>	<<version>>	<<name>>	<<User Group Rating>>	<<status>>	<<Expected Effort>> $END_ROW

You can either copy the table into a .dot Word template, or you can download a sample word template. Once you generate the Word doc with document factory, you can just open, select all, copy and paste it into Excel. The table will be maintained.

These are the most common ways of outputting in Borland CaliberRM. There are more advanced techniques as well that involve using the CaliberRM API. But we have found that these steps are good for most cases.

What tips and tricks have you found with Borland CaliberRM? Post your ideas below or put them on the messageboard at www.seilevel.com/messageboard.

5 Big CaliberRM Gotchas And How To Fix Them Part 2

In my last post, I covered three different CaliberRM issues that we've found with CaliberRM. In this one, I'll be covering five more.

Individual Object Delete

If you paste into CaliberRM and it doesn’t look right, it will be extremely difficult to delete it because you can’t highlight and select the delete key. You have to select each individual object and then right click and select delete. Trust me this is hard. The easiest solution is to cancel the save operation and it will revert back to the original state. CTRL-Z also does not work.

Tables From Word Are Too Big

Sometimes if you paste tables from Word they get messed up with one table going off to the right off the edge of the screen. In this case cancel the edit and then paste each table individually.

Caliber Shows Wrong Names

Sometimes caliber will show the wrong names in the tree structure as you click around. Don’t worry about it is just a screen defect.

Adding Files Only Adds A Reference

Do not use your local system as a reference. The best thing is to link to a UNC in SharePoint or other document management system. This isn’t as easy as you would think. With SharePoint, you need to view your file share in an explorer window. Navigate to the correct place. Paste the directory into the reference dialog box, then right click on the file select rename, copy the name, then paste the name into the dialog box. If you lose the link to the file i.e. kill vpn to SharePoint, CaliberRM will show the link as unknown. But once you restore the VPN connection it will be able to find the file if you try to double click it.

Adding Web Links Doesn’t Work

Adding web links seems to not work at all. You click the button and it just creates a blank link.

What workarounds, tips or tricks have you found in CaliberRM? We'd love to hear about them. Post them here or on our messageboard. If you have something that you'd like us to cover, let us know we'll do a post on it as well.