It's all about the answers!

Ask a question

Extracting Individual Use Cases from a Word Document into RRC

Steven Witty (736) | asked Sep 05 '12, 9:07 a.m.
edited Sep 05 '12, 9:19 a.m.

I have a Use Case document which contains over 200 Use Cases. As an example each one follows a similar format to this in regards to headings:

  • Use Case Name
    • Goal
    • Description
    • Precondition
    • Post Condition
    • Main Success Scenario

Under each heading is descriptive text as appropriate.

What I want to do is, import each Use Case from the above document as its own artifact, so each artifact has the correct name, and within the Primary Text field in RRC, has all the above sub headings with their texts.

At the moment, if I use the inbuilt tool to try and do this, RRC extracts every single sub heading from above as its own individual artifact, so rather than 200 Use Cases, I end up with 4k+ artifacts, which is not helpful!

Is it possible to extract each Use Case from my word document so each becomes a single artifact with the sub headings and associated text for each Use Case in the Primary Text field? I know how to do this manually but need an auto process if it's possible. I am using RRC v4.0.

Accepted answer

permanent link
Daniel Moul (4.9k1318) | answered Sep 05 '12, 11:18 a.m.
Correcting myself:  rather than keywords I think you would use text delimiters in the import wizard to mark the beginning and end of each use case.

After a quick search I haven't turned up any good example data that I can share with you. I suggest you make up your own delimiters in a test doc and play with it.
Steven Witty selected this answer as the correct answer

Steven Witty commented Sep 05 '12, 11:26 a.m.

In theory that does make more sense, but just pretend for a moment I have no idea what a delimiter is.....

Happy to play with a test document I have, but not sure where to even start. Do I simply add something like "Start" at the beginning and "Stop" at the end? A gentle prompt in the roughly right direction would help :)

5 other answers

permanent link
Daniel Moul (4.9k1318) | answered Sep 05 '12, 9:20 a.m.
I see two options:
  1. You could use the keyword feature in the import wizard to mark the beginning and end of each use case. Requires you to add the keywords in the Word doc first.
  2. You could import the entire document as one RRC artifact then manually highlight each use case and extract and save it as its own artifact (see icon on the edit menu). With "only" 200 you could probably do this manually in an hour or so.

Steven Witty commented Sep 05 '12, 9:44 a.m.

Hi Daniel, thanks for the speedy response. Im already familiar with 2 in your answer and am happy to do this if it's the best/only method, but with the expectation of having to do this for a number of other documents, ideally I want a process thats fairly automatic. I would like to get master Use Case document and import the individual Use Cases as single artifacts.

I looked at keywords but couldn't find anything helpful that explains how to use them, how would I set this up? If this works, I could then insist on any future Use Case documents having this built in to them thus making my life a lot easier. Any explanation on how I can use keywords would be hugely helpful.

permanent link
Daniel Moul (4.9k1318) | answered Sep 05 '12, 11:30 a.m.
I haven't played with importing using text delimiters myself either.  I assume you pick any two strings that will be unique in your document and obvious to a reader that they are not part of the "normal" text.

For example:
  • $$USE-CASE-END$$

permanent link
Steven Witty (736) | answered Sep 06 '12, 6:15 a.m.

Well Im happy to report that the example you gave does in fact work Daniel, so thanks for that.

On reflection, it would 1) take ages to put them into my document and 2) take longer than just importing as a rich text document and manually extracting them, so that's what Im going to do.

permanent link
Robin Bater (3.4k47) | answered Sep 10 '12, 6:05 a.m.
FYI: If not used in the document, I often use either { and } or [ and ] for my delimiters.

permanent link
Patrick FitzGerald (31113) | answered Apr 29 '13, 6:53 a.m.
Just a comment in here, for future readers of this.

It does not take a long time to add delimiters in if you use a pretty basic VBA macro to do so. If enough of you reply OK to this, I will post one up.

  • Don't look to get RRC to do all the work for you. Sounds like you guys have done a great job getting the use cases into one document. Consolidation and review is great for consistency. Don't put garbage into RRC - it won't clean it up for you. 
  • Any program of any decent size (e.g. 200 use cases) should have at least one BA who can do VBA to get the delimiters etc in order. It is pretty easy.
  • You can do a lot with Use Cases - you can even put Flow: in the heading name of a flow, and create a specialised requirement from it, from which you can create a test case or test suite (depending on how you are cutting your cloth).

Your answer

Register or to post your answer.

Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.