R12.1-2025Jul03

Configure Advanced Settings for Word Export

Content Settings

Content Settings determine what contents are included in the exported Word document from a map. The left pane displays the table of contents of the document, which can be renamed, moved up/down, and removed. The right pane is where you can define the text of the document. You can customize the contents of the Word document or import a Word Template.


The content categories in the Word document are introduced below:

  • Topology Map: Visio Map — If this checkbox in the right pane is selected, a Visio map will be embedded in the Word document.
  • Path: Path item that can be added to the Word document if a path is drawn on the map. In the left pane, the Source and Destination of the path on the map are shown. In the right pane, you can select the specific contents to be exported. 
    • Property: The path properties, such as name, direction, and data source.
    • Path Overview: The general path information, such as path number and device note related to the path. 
    • Execution Log: The execution log for path-based automation will be exported. 
  • Device Configuration: This section will define what device configuration will be added to the exported Word file. 
    • Insert configuration file: Select the checkbox to insert the configuration file into the Word document. 
    • File type: You can choose to display the full configurations or select part of the configurations to be added to the Word document. 
    • Display Mode: Select the layout of the device configuration. Two modes are provided: Horizontal and Vertical. 
    • Display configuration in the Word and limit the size to: Enable displaying configuration in the Word document and give the upper limit to the size of the configuration to be displayed. 
  • Device Asset Data: You can specify device asset data to export. Check the checkbox in the left pane, then this item will be added to the Items Selected list to the right. Click the icon to remove a selected item. By default, the following asset data are selected: Hostname, Mgmt IP, Device Type, Vendor, Model, Software Version, Serial Number.

    Information Note: Hostname is selected by default and cannot be removed from the list.
  • L2 Interface Asset Data: Select L2 interface asset data to be added to the Word document. Select the checkbox of asset data to move the item to the Items Selected list to the right. 

    • Interface Scope: You can select all the interfaces or select Visible Interfaces Only to add only the interfaces shown on the map to the Word document. 
    • Interface Filter: Input keywords to search for the interfaces associated with the map devices. Fuzzy match is supported, and it is not case-sensitive, e.g., you can input 'vla' to search for vLAN interfaces. 
      Information Note: Wildcard characters are supported in the searching interface. For example, you can input 'vlan*' to search for interfaces having a name starting with 'vlan'. 
  • L3 Interface (IPv4) Asset Data: Select L3 (IPv4) interface asset data to be added to the Word document. The operations and logic are the same as those for adding L2 Interface Asset Data.
  • L3 Interface (IPv6) Asset Data: Select L3 (IPv6) interface asset data to be added to the Word document. The operations and logic are the same as those for adding L2 Interface Asset Data.
  • Data Table: Select data tables to export, such as Route Table, NDP Table, NAT Table and NCT Table. Select a table from the right pane, and then the table will be added under the Data Table node in the left pane. 
  • Data View: The data view saved within the map can be applied to the map. Data View of the map can be exported to the Word document.
    • Data Table — Data table of devices related to the Data View.
    • Monitor Chart — Only include monitor charts with errors or warnings from the Data View.
    • Time Range: Set the time span for obtaining the Monitor Chart data of the Probe Data View generated in this period to export to a Word document. 

Import and Export Content Settings

Another way of creating a Word template is to export the current content settings (the exported content settings template file is in JSON format) and modify it as a template. Then the exported file can be imported into the system to be used as a Word template. 

Word Template

For your convenience, the system provides the capability of using a default Word template or a customized Word template. 

Default Word Style Template

To define and use the default word template, follow the steps below:

  1. Click Advanced Settings to open the Export to Word - Advanced Settings dialog. 
  2. In the Word Template field, click , and then click the settings icon  next to the Default Word Style option.
  3. In the pop-up dialog, define the following:
    • Title: The title inputted here will be shown on the cover page of the exported Word document.
    • Author: The current user is automatically filled in this field. If another user logs in to NetBrain, the contents in this field will change accordingly. 
    • Company: Type the company name.
    • Abstract: Provides a concise summary of the document’s purpose, key contents, and intended audience.

  4. Click Save to save the settings to the default Word template.

  5. Select Default Word Style from the Word Template dropdown menu to apply the default template to the exported Word document.

Customize a New Template

Follow the steps below to customize a new template using the Word Style Manager.

  1. In the Word Template field, click , and then click the Word Style Manager from the dropdown.
  2. In the Word Style Manager dialog, define the following for the selected template:
    1. Description: Add a description for your template.
    2. Style: Define the style of content and different levels of headers. 

    3. Table: Define the style of the table header and table row of the table in the exported Word doc. 

      Information Note: Check the Repeat header rows on each page checkbox; the header will appear on each page if the table is separated by multiple pages. 
    4. Extension: If the Display creation information on cover page checkbox is enabled, the creation time of the Word doc will be added to the exported Word file. 

  3. Click Save to complete the settings. 

Edit Word Template via Download/Upload

You can now manage and download multiple customized Word style templates instead of using only the default template. This provides a flexible way to modify a Word template using the following process: Download → Modify Externally → Upload.

Follow the steps to complete this process:

  1. In the Word Template field, click , and then click the Word Style Manager from the dropdown.

  2. In the Word Style Manager, hover over the desired default word style, click and select Download.

    Modify the downloaded Word Template, e.g., changing the background pic on the cover page, changing the company name, and more. 

  3. To add the modified template, click Upload Word Style. You can also customize styles in the Table and Extension tabs.


Export a Map to a Word Document Export a Map to Visio, Xmap, or an Image