Page History

To generate a Web Publisher report

1. Open the Magic Library.mdzip sample project from the <MagicDraw_home>/samples/case studies directory.

2. Click Tools > Report Wizard. The Report Wizard dialog will open.

   Image Modified

3. In the Select Template pane, select Default Template > Web Publisher 2.0, and click Image Modified. 

4. You can either:

   •  select the built-in report data or click Image Modified to create a new one. Type the new report name and description, and then click Image Modified.

     Info

     In the Select Report Data pane, you can create a new set of Report Data for the Web Publisher template. The Report Data is a container for a set of custom-defined fields in the template. It can be used to group different report versions. To edit or create a variable in the report data by clicking Image Modified, edit or delete information for predefined custom fields or create a new one, and click Image Modified. Image Modified

5. Click Image Modified.
6. Select the element(s) from the model that you want to include in the report data, and click Image Modified. Select the scope of the report in the open package tree. Select the Model package if you want to have a web-based report of your entire project.
   
   Image Modified
   
   
7. Click Image Modified.

8. Click theImage Modified button to locate the report file location.

9. Select the file location, type the report name, and click Image Modified. A generated web report will include a number of folders and files.

10. Select the report image format: *.png, *.jpg or *.svg.

11. Select an option to display empty value information, either Empty text or Custom text.

    Info
    In some cases, the query may return an empty value that creates blank fields in the report. The Display empty value as option is useful when you have a standard representation for blank fields.

    
    

12. Select the Image Modified check box to open the report document with the default editor.

13. After all options have been selected, click Image Modified.

To hide or show the

Containment menu

• Click the CONTAINMENT menu to hide it, and click it again to show it.

Image Modified
Hiding the Containment Menu.

To expand or collapse the Containment tree

• Click the “+” button in the Containment tree to expand it, or click the “-” button to collapse it.

Image Modified

The button to expand or collapse the Containment tree.

To reduce or increase the Containment tree width

• Drag the separator line between the containment and the content panel to reduce or increase the width of the Containment tree.

  Info
  The Web Publisher 2.0 report interface uses a horizontal scrollbar, which appears when the length of an element's name exceeds the current width of the Containment tree. The default width of the containment tree is 20% of the web browser width.

To show or hide element contents

• Click and re-click the arrow button to show and hide the contents.

  Image Modified

  Showing and hiding element contents

• .

To show an element specification, active hyperlink, Submachine of state, or behavior of the Call Behavior action

•  Click a diagram's element to show the shorcut menu for opening its specification, Active Hyperlink, Hyperlink, submachine of state, or behavior of the call behavior action.

  Image Modified

  Web Publisher 2.0 context menu

• .

To

add an Active Hyperlink to a model

You can add an active hyperlink to any symbol on a diagram. There are three kinds of hyperlinks: Element, File, and URL. However, the Element type hyperlink is available for the Active Hyperlink column on the Generic Table diagram image only.

You can navigate to the target if you double-click the hyperlinkon the diagram in the Web Publisher report. The following figure below shows the Submachine State hyperlink in the Web Publisher report.

Image Modified

The Submachine State hyperlink in the Web Publisher report.

If you double-click the Submachine State in the above example, it navigates to the target and opens it for you as shown in the following figure.

Image Modified

The hyperlink navigates to the target in the Web Publisher report.

MagicDraw elements in the Active Hyperlink column in the Generic Table diagram link to the associate elements. If you click an element in this column, you will be navigated to the Specification page of the associated element.

Image Modified

MagicDraw elements in the Active Hyperlink column in the Generic Table diagram links to the associated MagicDraw elements in the Specification page.

To display a property ID in the Containment tree

1. Click Tools > Report Wizard > Variable to open the Report Variable dialog.
2. Select the DisplayTreeElementId variable and enter the value true.

3. Click OK to show the requirement property IDs in the Containment tree.

   Image Modified
   
   The requirement property IDs also appear in the Containment tree of Web Publisher.

1. Image Modified

To go to the index page

• Click the MagicDraw Web Publisher 2.0 at the top-left corner of the screen to go to the index page.

Image Modified

Shortcut to the index page

.

To

see the description of an element

• On the Specification tab, move your mouse over an element to see the description in a tooltip.
  

  Image Modified

  Showing an element description

• .

To

show property visibility of your report

• In the Specification tab, select Standard, Expert, or All from the Mode drop-down menu. The mode appears in the property visibility depends upon the mode that you have selected in MagicDraw.

  Image Modified

  Property visibility mode types

• .

To

open an Activity, a State Machine, a Collaboration, or an Interaction sub-diagram

• Click an Activity, State Machine, Collaboration, or Interaction diagram to open a sub-diagram associated with an element.

• Image Modified

Clicking a diagram name to open its subdiagrams

.

To

open the sub-diagrams of a state with Submachine

1. Double-click either a state with a Submachine or a call behavior action of which behavior is specified. For example, double-clicking the last Submachine State Request Access : Connection in the following figure.
   Image Modified

1. 
   When you double-click it, the associated diagram opens (see the following figure).
   Image Modified
   

   State machine diagram viewed in web publisher interface.

1. Click the “+” button in the Containment tree to expand it, or click the “-” button to collapse it.

Image Added

The button to expand or collapse the Containment tree.