Programming the Reader Configuration

When the reader is launched from rules or Java code, you can set options to tweak the reader's behavior.
A Java snippet is available in the Javadoc of the class DoorsReader.

Programming the items scope

You can define the scope of the reader, to restrict the modules to be read or to force them to be loaded at once, using a ReaderScope.

Programming the baselines

You can specify for each formal module which baseline should be used, using a BaselineDescriptor.

Programming the views

You can specify for each formal module which specific view should be used over the default one, using a ItemScope.

A Filter instance might also be set to introduce additional filtering on top on the one provided by the current view.

Note that a DOORS client doesn't provide any mean to read a baseline using a specific view when the baseline is not open and visible in the DOORS client.

Connecting to DOORS in batch mode

The reader usually requires a DOORS client to be open in order to access the data. It is possible to configure the reader so that DOORS is executed in batch mode, provided you give the reader the DOORS user identity to connect to. To use the batch mode, you need to set the Common.PREFERENCE_DOORS_IS_SILENT property, as described in the snippet in DoorsReader. The option Common.OPTION_DOORS_APPLICATION shall also be used to share a DOORS batch client between a model reader and a DXL command to update DOORS data

Note that, even in batch mode, on-demand loading is still supported (a hidden DOORS client is kept alive as long as data is retrieved).

Programmatic Properties

The model reader can be configured using many options, which are defined in the class Common.

Here is a list of the most significant options:

• Common.OPTION_IGNORE_CONNECTOR_UI
  • Determines whether the connector selection dialog should be avoided. You should turn on this setting when the ReaderScope is programmatically set.
  • Default: false
  
  
• Common.OPTION_SCOPE
  • The scope of the model reader. This setting must be an instance of ReaderScope. It may be used to to restrict the modules to be read or to force them to be loaded at once.
  • Default: null
  
  
• Common.OPTION_IGNORE_RICH_TEXT
  • Determines whether Object Text and Heading formatting (bold, italic, etc.) is to be ignored when reading data. If the formatting is useless in a particular context, turning on this setting can improve reader's performances.
  • Default: false
  
  
• Common.OPTION_IGNORE_IMAGE
  • Determines whether Object image is to be ignored. If images are useless in a particular context, turning on this setting can improve reader's performances.
  • Default: false
  
  
• Common.OPTION_IGNORE_OLE_OBJECTS
  • Determines whether OLE objects are to be ignored. If OLE objects are useless in a particular context, turning on this setting can seriously improve reader's performances. If OLE object preview image is of interest, the Common.OPTION_IGNORE_OLE_PREVIEW_IMAGES option must be set to true.
  • Default: false
  
  
• Common.OPTION_IGNORE_TABLE
  • Determines whether DOORS internal table objects (Table and Row) are to be ignored. These objects are usually not used. Note: Objects contained in table cells are always read and not affected by this setting.
  • Default: true
  
  
• Common.OPTION_IGNORE_DISCUSSIONS
  • Determines whether Discussions and Comments are to be ignored. These objects are usually not used.
  • Default: true
  
  
• Common.OPTION_ENUMERATION_LITERAL_SEPARATOR
  • Determines the separator used when reading multi-valued enumerated attributes. Enumeration literals will be concatenated with the chosen separator when being set in InstantiatedAttribute.value. The default value is a comma (","), for historical reasons. As this character might be used in an enumeration literal, it is recommended to use another separator, like "\n" or any other character that cannot be used in a literal.
  • Default: ","
  
  
• Common.OPTION_RESOURCE_URL
  • Determines whether to read the Item or Object resource URL instead of the DOORS legacy URL. If DOORS Web Access is configured, the resource URL uses an http protocol whereas the DOORS legacy URL uses a doors protocol.
  • Default: false
  • Required DOORS Version: DOORS 9.3 and higher
  
  
• Common.PREFERENCE_DOORS_IS_SILENT
  • Requests to connect to DOORS in batch mode, instead of requiring a DOORS client to be open. If set to true, this setting requires additional properties:
    • Common.PREFERENCE_DOORS_PATH - the full path of doors.exe, used to launch DOORS
    • Common.PREFERENCE_DOORS_PORTSERVER - the port and server name of the database to connect to (e.g. 36677@myServer)
    • Common.PREFERENCE_DOORS_USER - the name of the DOORS user to make the connection
    • Common.PREFERENCE_DOORS_PASSWORD - the password of the DOORS user to make the connection
    The property Common.OPTION_IGNORE_CONNECTOR_UI should also be set true in such use case.
    If a DOORS batch client is to be shared between a model reader and a DXL command to update DOORS data, then consider using the Common.OPTION_DOORS_APPLICATION instead.
  • Default: false
  
  

Reading DOORS data