Contents
Watermarks
for Requirements that originated from this document
Embedding
additional Requirements in this document
Embedding
Different Fields (Attributes) of a Requirement
Step
2 : Import the Word Template
Step
3 : Regenerate the Word Document
Synopsis
This document describes how you can Re Generate your Word Documents with latest information about your Requirements embedded in it.
Use Case
You started with a document, and identified different sections of the document as Requirements. At the end of this process, you are left with a shell of your original document, because TraceCloud has sucked the text out of the document, created a Requirement in the database, and left a watermark in the document. Once your Requirements are in the database, you can use the power of TraceCloud to organize your Requirements into folders, set attribute values, do traceability, track their progress using Dashboard reports and report on the metrics.
When a need arises to re-generate your document, you can leverage the ‘Generate Word Report’ feature, to rebuild your original document, with the latest information about Requirements from the database.
TraceCloud also supports a model, where you can embed any Requirement from the project into your Word document. I.e. you can embed not only those Requirements that originated from this document, but any Requirement that you have read access to. This reference manual shows how you can use a simple syntax to embed a rich set of reports and requirements, along with their collateral into your word document.
Step 1: Word Template
Watermarks for Requirements that originated from this document
Once you upload your word document and use the ‘Create Requirements’ feature to create Requirements out of this document, TraceCloud leaves behind a watermark in place of the original text. The watermark is just a hyperlink showing the Tag of the Requirement. In case where ‘Multiple Requirement per Table’ method was used, then the watermark left behind indicates the Tag:Attribute name.
Watermark left after a requirement is created:
Watermark left after a requirement is created (using Multiple Requirements per Table method):
Embedding additional Requirements in this document
TraceCloud lets you consolidate
all your Requirements in one document. For example, you can collect
Requirements that originated outside a document and embed them in to a Word
Report.
At any place you
want to embed Requirement Content, create a hyper link. In Word 07, you
can see the screen shot below.
For example, if
you want to embed Requirement PR-1, at a point in your word document, simply
create a hyperlink, and put PR-1 in both ‘Text to Display’ and in ‘Address’
fields.
TraceCloud lets you use a simple syntax to embed
more than one requirement at a time.
·
To
embed a single requirement use PR-1 syntax.
·
To
embed multiple requirements, Comma separates them. I.e. PR-1, PR-2, PR-3.
·
To
embed a range of requirements do this: PR-1...PR-35. This will print all the Reqs from PR-1 till PR-35
·
To
embed ALL the requirements of a requirement type, use REQUIREMENTTYPE-Business
Requirements (where Business Requirements is the name of the requirement type
you want to embed).
·
To
embed ALL the requirements in a Folder and all its sub folders, use FOLDERPATH-TestCases/Speical (Where TestCases/Special is the folder path where all your requirements
are located).
·
To
embed all the requirements that would be returned by one of your saved reports
(List or Trace Tree), do this: REPORTID-2026 (where 2026 is the report Id).
·
Feel
free to mix and match any of the above combinations.
See these screenshots.
To embed a report, you may need to get
a report Id. The best way to do it is to open any of your saved reports, and
click on ‘Show Filter’. See the image
below.
See the
screenshot below that summarizes the entire concept.
Embedding Different Fields (Attributes) of a Requirement
To identify text in your word documents using hyperlinks, select the text that forms the requirement, right click, and select ‘Hyperlink’. Ensure that you put ‘REQ’ in the ‘Address’ box, so that TraceCloud parsing engine knows that this hyperlink is actually a Requirement. Continue doing this to identify all the Requirements in your document.
Step 2: Import the Word Template
Once the word template is ready, we import it into the TraceCloud system. To import a word template into a TraceCloud folder, you will need to have ‘Create’ permission on this folder.
Important: You need to import a word template, only if you have modified the template the created by the system. To elaborate here are the scenarios:
· You had a document, you imported it into TraceCloud, used the ‘Create Requirements’ tool which created the Requirements and left watermarks in the document. The document is now a shell of its former self and will be called a Template going forward. If you just need to regenerate the original document, you ignore this step, and do directly to Step 3.
· If you have modified the Template in the above bullet point, to either include additional Requirements or Saved Reports using Step1, or if you have created a new Template (Essentially any word document), but embedding your own watermarks for Requirements, Reports (Using Step1) etc.., then you will need to import the template into the TraceCloud system.
Notes:
· Select the folder you want to import the document to
· Click on ‘Word Docs’ tab
· If you need a quick overview of this feature, click on ‘More Info’ or on the ‘video’ icons at the top
· If you need to create a Structured document shell to collect your Requirements for Step 1, you will see the link for that in this screen
· Select if this doc should be visible to general public and locate the file and hit upload.
Once this Template is imported, then it’s ready ‘Generate Word Report’ out of it.
Step 3: Regenerate the Word Document
To regenerate the word document, locate the Template, and click on ‘Generate Word Report’
At this point, you get to select how your output should appear.
· TraceCloud follows its security policy and shows you ONLY those Requirements that you have ‘Read’ access to
· So, if you were to embed PR-1, PR-2, and FR-1...FR-100 and if FR-50 to FR-100 are in a folder that you don’t have Read access to, Requirements from FR-50 to FR-100 will be redacted.
· If you had saved a report (REPORTID-123) and this report returns a result set of Requirements, and for a sub set of them you don’t have Read permissions, then the subset will be redacted.
· For every embedded Requirement that TraceCloud finds, you can choose to display additional collateral from the database. For example, other than Name, Description of the Requirement, you can choose to embed the attributes, the approval status, the testing status, folder etc..
· If you had embedded your Requirements with the ‘RequirementTag:Attribute’ format (Eg : PR-1:name, PR-2:description), then you don’t need to select any ‘Display Attributes’ . The Display attributes are defined in the embedding.
· You can also choose to have your Requirements print out as
o ‘One Requirement per Table ‘, where all the information about the Requirement is printed in a Attribute Name – Value combination in a 2 columned Table
o Or as ‘One Requirement per Row’, in which each Requirement is printed in a separate row, but each column has an attribute value. See screenshots below.
o Note that ‘One Requirement per Row’ comes with certain limitations
o
If choose to
display a lot of columns, then this row can get quiet wide and is best viewed
in a 'Web' or 'Outline' or 'Draft' layout. If your Word document is in
'Normal' layout, wide tables will look messy.
o Please Note that MS Word has a limitation, where your page width cannot exceed 22 inches and you cannot have more than 63 columns. If you try to cross either of these limits, MS Word does not display your tables gracefully.
Example of ‘One Requirement per Table’ output format
|
BR-923 : There are 5 ways to
create Requirements from a word document.... |
|
|
Trace
From |
|
|
Baselines |
|
|
Folder
Path |
Business
Requirement |
|
collateral |
|
|
Customer |
|
|
Deliverability |
Desirable |
|
Impact to customer |
yes |
|
Severity |
3 |
|
Type |
Bug |
|
Name |
There
are 5 ways to create Requirements from a word document. |
|
Description |
There
are 5 ways to create Requirements from a word document. |
Example of ‘One Requirement per Row’ format
|
Tag |
Name |
Description |
collateral |
Customer |
Deliverability |
Impact to customer |
Severity |
Type |
|
BR-923 |
There are 5 ways to create Requirements from a word
document. |
There are 5 ways to create Requirements from a word
document. |
|
|
Desirable |
yes |
3 |
Bug |
Push a copy to TDCS
TDCS (TraceCloud Document Control System) is an elegant system where you can take a snapshot of your documents and reports at certain points in time, and save it in a non-deletable format for future reference. For example, you have a document (Business Requirements, Functional Specs, Test Plans) and the Requirements in them keep on changing. At significant milestones in the project, you would like to take a snapshot of this document and store it away for future. You can do that using TDCS.
When you are in a document template, click on ‘Push to TDCS’, give the document a title, description, select the Requirement output format and the display attributes and click ‘Push Report to TDCS’. The system will generate the report and save it to TDCS and give you the TDCS number.
Any time you want to locate this report, simply go to the ‘TDCS’ link on the top left hand side of the page, and use the filter on top to locate your document. As you continue to add additional versions of the report to the system, they will all be versioned and saved.
Note:
· TDCS documents cannot be deleted by any one. Only when the Project is terminated by the administrator are the TDCS documents deleted.
· TDCS can also be used to save snapshot of Reports and TraceTrees. Please see the documentation on TDCS.
