Main Content

RptgenRMI.doorsAttribs

IBM DOORS attributes in requirements report

collapse all in page

Syntax

settings = RptgenRMI.doorsAttribs('show')
tf = RptgenRMI.doorsAttribs('default')
tf = RptgenRMI.doorsAttribs(Name,Value)

Description

settings = RptgenRMI.doorsAttribs('show') returns the DOORS® attribute report settings. The listed attributes are included in generated requirements reports.

example

tf = RptgenRMI.doorsAttribs('default') restores the default requirements report settings for DOORS attributes. The function returns 1 if the settings are changed. The default settings are:

  • Explicitly include the system attributes Object Heading and Object Text

  • Include all other system attributes and user-defined attributes

  • Omit the system attribute Created Thru

  • Omit system attributes with empty string values

  • Omit system attributes that are false

example

tf = RptgenRMI.doorsAttribs(Name,Value) specifies which DOORS attributes to include in generated requirements reports. The function returns 1 if the settings are changed without error.

Note

This function sets settings used when generating reports for requirements in IBM® DOORS. These settings are not applied for generated reports for requirements in IBM DOORS Next.

example

Examples

collapse all

Open Live Script
settings = RptgenRMI.doorsAttribs('show')
settings = 5x1 cell
    {'Object Heading' }
    {'Object Text'    }
    {'$AllAttributes$'}
    {'$NonEmpty$'     }
    {'-Created Thru'  }
Open Live Script

If you change the settings for which DOORS attributes to include in the requirements report, you can restore the default settings.

Change the settings by omitting all attributes other than those that are explicitly included in the report. Show the changed settings.

tf = RptgenRMI.doorsAttribs('type','none');
Excluding attributes...

settings = RptgenRMI.doorsAttribs('show')
settings = 4x1 cell
    {'Object Heading'}
    {'Object Text'   }
    {'$NonEmpty$'    }
    {'-Created Thru' }

Restore the settings to default. Show the default settings.

tf = RptgenRMI.doorsAttribs('default');
settings = RptgenRMI.doorsAttribs('show')
settings = 5x1 cell
    {'Object Heading' }
    {'Object Text'    }
    {'$AllAttributes$'}
    {'$NonEmpty$'     }
    {'-Created Thru'  }

The default settings are:

  • Explicitly include the system attributes Object Heading and Object Text

  • Include all other system attributes and user-defined attributes

  • Omit the system attribute Created Thru

  • Omit system attributes with empty string values

  • Omit system attributes that are false

Open Live Script

Specify that generated requirements reports will include only user-defined attributes.

tf = RptgenRMI.doorsAttribs('type','user');
Including user attributes...

Show the settings.

settings = RptgenRMI.doorsAttribs('show')
settings = 5x1 cell
    {'Object Heading'  }
    {'Object Text'     }
    {'$NonEmpty$'      }
    {'-Created Thru'   }
    {'$UserAttributes$'}
Open Live Script

Include the Last Modified By and Last Modified On attributes.

tf = RptgenRMI.doorsAttribs('add','Last Modified By');
Adding Last Modified By...

tf = RptgenRMI.doorsAttribs('add','Last Modified On');
Adding Last Modified On...

Omit the Object Heading attribute from the requirements report.

tf = RptgenRMI.doorsAttribs('remove','Object Heading');
Removing Object Heading...

Show the Current Settings

settings = RptgenRMI.doorsAttribs('show')
settings = 6x1 cell
    {'Object Text'      }
    {'$AllAttributes$'  }
    {'$NonEmpty$'       }
    {'-Created Thru'    }
    {'+Last Modified By'}
    {'+Last Modified On'}
Open Live Script

Include empty user-defined attributes in the requirements report.

tf = RptgenRMI.doorsAttribs('nonempty','off')
NonEmpty filter off...

tf = logical
   1

Show the current settings.

settings = RptgenRMI.doorsAttribs('show')
settings = 4x1 cell
    {'Object Heading'  }
    {'Object Text'     }
    {'-Created Thru'   }
    {'$UserAttributes$'}

Input Arguments

collapse all

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'type','all'

Types of DOORS attributes to include or omit from the report, specified as 'all', 'user', or 'none'.

Example: 'type','all'

Attributes to add to the generated report, specified as a character array.

Example: 'add','Last Modified By'

Note

The entered character array should be the same as a DOORS predefined system attribute or user-defined attribute.

Attributes to omit from the generated report, specified as a character array.

Example: 'remove','Object Heading'

Note

The entered character array should be the same as a DOORS predefined system attribute or user-defined attribute.

Whether to include or omit empty user-defined attributes in the report, specified as 'on' or 'off'. Empty system-defined attributes are always excluded.

Example: 'nonempty','on'

Output Arguments

collapse all

Current DOORS attribute report settings, returned as a cell array.

Changed settings success status, returned as a 1 or 0 of data type logical.

Version History

Introduced in R2011b

See Also