Generating a document template with objectiF RM and MS Word

It’s shortly before Christmas. There’s heaps going on, as always. Everything has to be finished quickly before everyone goes on a well-earned holiday. If you work with our tools, then you’re doing pretty fine! Especially because the generation of documents from a template can be done with the press of a button. We deliver a lot with our tools – but anything that’s missing, you can just configure yourself. This task and the general care of document templates is taken over, in most businesses, by the person responsible for processes or the administrator. Like in our example today: Birgit works as a requirements analyst with objectiF RM. She has to generate a requirements document that contains the specified requirements with her description in the model. At the same time she also needs to document, for every single requirement, where they derive from and what the superordinate requirements are.

Birgit looks through the available document. A template for this exact presentation of derived and superordniate requirements is nowhere to be found. But the document has to be finished by tomorrow morning.

Birgit knows that Sven, “her” admin for objectiF RM can create necessary document templates. So she grabs her telephone. “No worries!” answers Sven, and Birgit dedicates herself to the other parts of the document that can already be prepared and generated in chapters.

Sven, who configures objectiF RM to the needs of his colleagues, is already at work. He opens the tool with the user profile specify templates.

Now, slip into the role of Sven. I will describe exactly which steps you need to take to create the desired document template.

Requirements diagram in objectiF RM

Document the superordinate and derivative requirements for reach requirement in MS Word, in text and listed.

The starting point for generating template is the requirements. From them, all deriving from and deriving to relationships will be needed. Your template is comprised of many pieces of template. In total, you need three document templates and perhaps also a fourth for a package to let all the requirements generate a package.

1. Document template for outgoing derivative relationships (define superordinate requirements)

Create a new document template under the document templates in your sysem. Select a suitable name. Select«DerivedReqRship» for the stereotype.

Create a document template for superordinate requirements in objectiF RM

Edit this document remplate. Enter the name of the superordinate requirement. For that, select the TargetRequirement. Name in the text mark area on the right. Click on the Add button. The document should look like this:

Editing the document templates for the superordinate requirements

2. Document template for ingoing derivitive relationships (define derived requirements)

Create a new document template in your system under document templates. Select a suitable name. Select «DerivedReqRship» as the stereotype.

Create document template for derivitive requirements with objectiF RM

Edit this document template. Just enter the names of the derived requirements. In the text mark area on the right, select the property SourceRequirement.Name. Then, click on the add button. The document should now look like this:

Editing the document template for derived requirements

3. Document template for requirements with derived and superordinate requirements

For the next template, both the templates that were just created are required.

Create a new document template in your system under document templates. Select a suitable name. Select «Requirement» for the stereotype.

Create document template for derived and superordinate requirements with objectiF RM

Edit this document template. Add a table or a text, as you wish, to give a frame to the information.

Take your cursor to the part of the document where the name of the requirement should be entered. On the right in the text marking area, select Name under Property. Then, click add.

Now, take the cursor to the part of the document where the superordinate requirements should be displayed. On the right in the text marking area, select ChildDerivedReqRships from the list and select the template from point 2 as the document template.

Then, take the cursor to the part of the document where the derived requirements should be displayed. On the right in the text marking area, select IncomingDerivedReqRships from the list. Select the template from point 2 as the document template.

The document should now look something like this:

This is how the document could look with superordinate and derived requirements

4. Document template for all requirements of a package with derived and superordinate requirements

Create a new document template under document templates. Select a suitable name. Select «Package» as the stereotype.

Create document template for requirements of a package with objectiF RM

Edit this document template. Add the desired text, and the frames into which the information should be entered.

Take the cursor to the part of the document where the name of the package should be entered. Then, on the right in the text marking area, select name under property. Then, click on the add button.

Take the cursor to the point in the document where the requirements should be entered. On the right in the text marking area, select Requirements from the list. Use the document template from point 3 for the template.

Now, the document should look something like this:

The document with requirements of a package could look like this

Finished.

Now you have all the necessary document templates to be able to generate the document.

We will leave Sven and see what Birgit is up to. Sven just emailled her the names under which she can find the document templates in her system. Birgit is happy to have gotten what she needed so quickly. It can be done really fast. What do you have to do?

Create a new document in your system and give it a suitable name. As the document template, select the template created under point 4. As the documented element, select a package that contains the requirements.

Create a document template for requirements with relationships in objectiF RM

After the document has been created, select Generate Content in the context ment and open it. And, voilà! There is the document you wanted.

This is how a document with requirements relationships could look

That was the last chapter that Birgit had to generate. Her requirements document is finished. She sends it, satified, and then it’s finally time to go home. All the work is finished and Christmas can come!