Input formats

REQCHECKER™ car read requirement statements and coverages from several data sources:

An Java API is provided to develop your own data source. Contact support team to get it.

Format features

The table below presents the format that are managed and for each format the available features.

  • Track Change: the track change is available and the text is read after applying the change.
  • Page Number: the page or slide number is available.
  • Heading Number: the positions detail the chapter heading number. Such format allows to create requirement directly from chapter heading number.
  • Table cell: the text is extracted from tables. Cell Text feature is available for custom tags (see GUI Custom Tags).
  • Style filter: the style names are extracted.

Microsoft Office formats

Format Track Change Page Number Heading Number Table cell Style filter
Microsoft WORD >2007 (.docx .docm) NO NO YES YES YES
Microsoft WORD 97 (2) (.doc) YES NO YES NO NO
Microsoft EXCEL 2007 (.xlsx .xlsm) N/A N/A N/A YES (1) NO
Microsoft POWERPOINT 2007 (.pptx) N/A YES N/A NO NO
Microsoft EXCEL 97 (2) (.xls) N/A N/A N/A YES (1) NO

Note

(1) Each cell is read as a new line

(2) MS Word or MS Excel must be installed

Google Document formats

Format Track Change Page Number Heading Number Table cell Style filter
Google Docs (.gdoc) NO NO YES YES YES

Note

(1) You must allow the REQCHECKER Reader Google application to access the reading of your Google documents. The authorization page opens during the first calculation.

(2) Please read the REQCHECKER privacy policy

Source Code

REQCHECKER™ is able to read the statements and/or coverage in the comment in the following source code.

Format Track Change Page Number Heading Number Table cell Style filter
C/C++ source code (.cpp .hpp .c .h .inc) NO N/A NO NO N/A
Java source code .java NO N/A NO NO
JavaScript source code .js NO N/A NO NO
C# source code .cs NO N/A NO NO
XML file .xml NO N/A NO NO
Python source file .py NO N/A NO NO
Python for Windows script .pyw NO N/A NO NO
Windows batch script .bat NO N/A NO NO
Linux shell script .sh NO N/A NO NO

Other documents

Format Track Change Page Number Heading Number Table cell Style filter
Adobe PDF (.pdf) N/A YES YES (1) YES (1) NO
OpenOffice WRITER (2) (.odt) NO YES YES NO YES
Markdown (basic support) (.md) NO NO NO NO NO

Note

(1) Only some PDF heading number patterns are supported. The experimental heuristic algorithm automatically detects headings. The table of content is ignored. Standard patterns like "1.1 1.2.1.." and "1. A. 1. B.." are supported. Only some PDF structures are supported. The table cell recognition for PDF is an experimental feature.

(2) OpenOffice WRITER must be installed

Tabulated formats

The required columns are described here

Format Track Change Page Number Heading Number Table cell Style filter
REQCHECKER XLSX reports (.xlsx) NO NO NO N/A NO

Redmine reader

Redmine is an open-source flexible project management web application. It can be used to record tickets defining the need for a software or system change. The tickets are then similar to requirements or requirement groups. This reader extracts the tickets from a Redmine custom query and import them as requirements. The .redmine file format is a text file that defines the connection properties to your custom query.

Format Track Change Page Number Heading Number Table cell Style filter
Redmine connection file (.redmine) NO NO NO NO NO

Main use case

To retrieve the list of ticket as requirements, you have to:

  1. Go to the Issues tag of the Redmine project
  2. Define your filters and sort options
  3. Save the custom query. Its name does not matter.
  4. Create a new text file (e.g. with Notepad) and write query=
  5. Copy the value of the query in the URL bar of your browser.
  6. Paste the value of the URL in the text file. The result looks like query=http://myredmine/projects/myproject/issues?query_id=1
  7. If your Redmine project is not public, add your login and password in the query definition. The result looks like query=http://login:password@myredmine/projects/myproject/issues?query_id=1
  8. Save the text file with the .redmine extension, e.g. myprojectquery.redmine
  9. Add this file in your Reqchecker project in Data Sources tab > Add File button.
  10. In the list Statement retrieval from:, select Database
  11. Run your project and check that the tickets are correctly imported

Warning

If your Redmine project is not public, you must check that REST API is enabled: go to Redmine Administration > Settings > API > Enable REST API.

File format

The syntax is query=HTTP://LOGIN:PASS@SERVER:PORT/projects/PROJECTID/issues?query_id=QUERYID Where:

  • HTTP is either HTTP or HTTPS
  • LOGIN:PASS@ (facultative for public projects) is a text that defines the user login and the user password, or the API key.
  • SERVER is the IP or DNS name of the server
  • PORT (facultative if 80) is the port
  • PROJECTID is the Redmine project identifier defined in the project page > Settings > Project > Identifier.
  • QUERYID is the query number (integer) that is visible at the end of the URL in the browser

Note

The query can be tested if you paste it in the URL bar of your browser. This is a way to test that there is no error in your Redmine file.

Examples

The following are examples of the contents of Redmine data import files (file with .redmine extension).

Connection without login

query=https://www.redmine.org/projects/redmine/issues?query_id=84

Connection with login and password

query=http://johndoe:apassword@myredmine/projects/myproject/issues?query_id=2

Connection with API key

To avoid writing your password in a project file that is shared with other users, you can identify yourself with your API key. In Redmine, go to My Account, on the right pane click on API access key > Show and copy the value. The result is something likea89987536fcd37d69ed887ec80adda144b48d329.

query=http://a89987536fcd37d69ed887ec80adda144b48d329@myredmine/projects/myproject/issues?query_id=2