Main Content

slreq.getReportOptions

Get default report generation options

Description

example

myOptions = slreq.getReportOptions returns a structure with the default options for generating reports for requirements sets.

Examples

collapse all

myOptions = slreq.getReportOptions()

myOptions = 

  struct with fields:

      reportPath: 'L:\slreqrpt_20170826.docx'
      openReport: 1
       titleText: ''
         authors: 'Jane Doe'
        includes: [1×1 struct]

Output Arguments

collapse all

Options for report generation, returned as a structure with the following fields:

Options

FieldsData TypeDescription
reportPathcharacter vectorReport file path
openReportlogicalOption to open report automatically after generation
titleTextcharacter vectorReport title
authorscharacter vectorReport authors
includes.toclogicalOption to include table of contents in your report
includes.publishedDatelogicalOption to include the report publish date
includes.revisionlogicalOption to include requirement revision information in your report
includes.propertieslogicalOption to include requirement properties
includes.linkslogicalOption to include requirements links in your report
includes.changeInformationlogicalOption to include change information such as change issues
includes.groupLinksBycharacter vectorOption to group links by Artifact or LinkType
includes.keywordslogicalOption to include requirement implementation status data in your report
includes.commentslogicalOption to include requirement comments in your report
includes.implementationStatuslogicalOption to include requirement implementation status data in your report
includes.verificationStatuslogicalOption to include requirement verification status data in your report
includes.emptySectionslogicalOption to include empty sections in your report
includes.rationalelogicalOption to include requirements rationale in your report
includes.customAttributeslogicalOption to include requirement set custom attributes in your report

Version History

Introduced in R2018a