Skip to main content
insightsoftware Documentation insightsoftware Documentation
{%article.title%}
Published:
Was this article helpful?
0 out of 0 found this helpful

Build Noetix Search Instance Documentation

Using Noetix Search Builder, you can generate PDF documents for the roles in a Noetix Search instance for NoetixViews or for the modules in a Noetix Search instance for Noetix Analytics or RapidDecision. The PDF document contains the cover page and table of contents (ToC) only when more than one role or module or object for the role or module is included for generation.

To generate documentation

  1. Perform steps 1 through 5 under the "Build Noetix Search Instances" section. The page to manage your instances appears.

  1. Click Build instance documentation (PDF), and clickNext. The page appears where you can select the instance for which you want to generate the PDF document.

  2. Select the required instance from the list. The page displays details of the selected instance.

  1. ClickNext. The page displays the modules and roles that are available in the selected instance.

  1. Do the following:

      • Select the check boxes for one or more modules, or click the "select all" link to select all the modules.
      • In theOutput folderbox, enter the path where the generated PDF files will be stored. By default, the last used location path will be displayed. ClickBrowseif you want to select another location for the generated documentation. TheOpendialog box appears. Navigate to the folder location under theLook Inlist, select the destination folder, and clickOpen. The destination folder path is updated in theOutput folderbox.
  1. ClickGenerate. You can view the PDF files in the location specified in theOutput folderbox when the "document generation completed successfully" message is displayed in theBuild Documentation Statusbox. Separate PDF files are generated for each of the selected modules. The PDF files are generated into a folder that is dynamically created with the name of the selected instance.

  2. Click Close to exit the Noetix Search Builder wizard.

Note:A log file is created each time you generate or regenerate documentation of a Noetix Search instance. For more information about log files, see Log files.

Published:

Build Noetix Search Instance Documentation

Using Noetix Search Builder, you can generate PDF documents for the roles in a Noetix Search instance for NoetixViews or for the modules in a Noetix Search instance for Noetix Analytics or RapidDecision. The PDF document contains the cover page and table of contents (ToC) only when more than one role or module or object for the role or module is included for generation.

To generate documentation

  1. Perform steps 1 through 5 under the "Build Noetix Search Instances" section. The page to manage your instances appears.

  1. Click Build instance documentation (PDF), and clickNext. The page appears where you can select the instance for which you want to generate the PDF document.

  2. Select the required instance from the list. The page displays details of the selected instance.

  1. ClickNext. The page displays the modules and roles that are available in the selected instance.

  1. Do the following:

      • Select the check boxes for one or more modules, or click the "select all" link to select all the modules.
      • In theOutput folderbox, enter the path where the generated PDF files will be stored. By default, the last used location path will be displayed. ClickBrowseif you want to select another location for the generated documentation. TheOpendialog box appears. Navigate to the folder location under theLook Inlist, select the destination folder, and clickOpen. The destination folder path is updated in theOutput folderbox.
  1. ClickGenerate. You can view the PDF files in the location specified in theOutput folderbox when the "document generation completed successfully" message is displayed in theBuild Documentation Statusbox. Separate PDF files are generated for each of the selected modules. The PDF files are generated into a folder that is dynamically created with the name of the selected instance.

  2. Click Close to exit the Noetix Search Builder wizard.

Note:A log file is created each time you generate or regenerate documentation of a Noetix Search instance. For more information about log files, see Log files.

For an optimal Community experience, Please view on Desktop
Powered by Zendesk