Output all Use Case Diagrams and its Use Cases into document

Doc. Composer allow user retrieve and output model details by creating custom templates. In this article we will create custom template to output all use case diagrams and its containing use cases into document.

To output all use case diagrams and its use cases into document:

1. Go to Tools > Doc. Composer > Manage Template XML.
   

   Manage Template XML

2. Select Project in the combo box at the top left corner of the Manage Template XML dialog.
   

   Select Project scope

3. Select Use Case Diagram template, right click on it and select Duplicate… from popup menu.
   

   Duplicate existing template

4. Name the template as All Use Case Diagrams.
   

   Name the template as All Use Case Diagrams

5. Replace the content of the template as follow.

   <?xml version="1.0" encoding="UTF-8"?>
   <ProjectBaseInitiationBlock>
     
     <Text style="@heading+">Use Case Diagrams</Text>
     <ParagraphBreak/>
     
     <HasDiagramChecker diagramType="UseCaseDiagram">
       <ForEachDiagram diagramType="UseCaseDiagram" ignoreLastSeparator="false">
         
         <Inline template="Basic"/>
       
         <TableBlock tableStyle="Summaries">
           <TableRow>
             <TableCell>
               <Text>Use Cases</Text>
             </TableCell>
           </TableRow>
           <IterationBlock ignoreLastSeparator="false">
             <Conditions>
               <ValueChecker property="modelType" value="UseCase"/>
             </Conditions>
             <TableRow>
               <TableCell>
                 <Property property="name"/>
               </TableCell>
             </TableRow>
           </IterationBlock>				
         </TableBlock>
       </ForEachDiagram>
     </HasDiagramChecker>
     
   </ProjectBaseInitiationBlock>

6. Press Save button and close the Manage Template XML dialog.
7. Now go to Tools > Doc. Composer.
   

   Create Doc. Composer

8. Select Build Doc from Scratch.
   

   Select Build Doc from Scratch

9. Select Project root note in Diagram Navigator tree.
   

   Select project root node in Diagram Navigator

10. Drag & drop the All Use Case Diagrams template into document editor.
    

    Drag & drop All Use Case Diagrams template to document editor

Now all use case diagrams in your project and its containing use cases are being outputted into document.

All use case diagrams in project and its use cases are being generated to document

Explanation of the template

The template first check is there any use case diagram in project. If use case diagram do exist then it goes into the ForEach loop.

<HasDiagramChecker diagramType="UseCaseDiagram">
  <ForEachDiagram diagramType="UseCaseDiagram" ignoreLastSeparator="false">

After that call the build in diagram basic template to output its name and diagram image.

<Inline template="Basic"/>

Next we create the table and its header for list out the use cases in diagram.

<TableBlock tableStyle="Summaries">
  <TableRow>
    <TableCell>
      <Text>Use Cases</Text>
    </TableCell>
  </TableRow>

Now we loop through the elements in the use case diagram, and filter out only the use case using the Conditions node and print out its name.

<IterationBlock ignoreLastSeparator="false">
  <Conditions>
    <ValueChecker property="modelType" value="UseCase"/>
  </Conditions>
  <TableRow>
    <TableCell>
      <Property property="name"/>
    </TableCell>
  </TableRow>
</IterationBlock>