Skip to content

Adapter configuration keywords and options

Configurations can be made in the configuration editor or on the preferences page.

Keywords

  • == – „Equals” operator to use within a condition
  • != – „Not equals” operator to use within a condition
  • addressOf – Starts an addressOf condition.
  • baselineSetDefinition – Defines the „Baseline Set Definition” that is to be loaded.
  • baselineSet – Defines the „Baseline Set” that is to be loaded.
  • contains – Constraint for substring check
  • if – Third keyword of an include expression. Starts a block of conditions.
  • if () {} else {} – Conditional expression to map attributes based on constraints
  • in – „In” operator to use within a condition
  • include – Starts an include expression. Artifacts satisfying the expression right from the include keyword will be included in the result set.
  • map – Starts a mapping block.
  • Module – Allows to access the parent module of an object for mapping.
  • modules – Second keyword of an include expression. Defines that the following conditions are evaluated on module level.
  • objects – Second keyword of an include expression. Defines that the following conditions are evaluated on object level.
  • project – Defines which project is to be imported.
  • Project – Allows to access the parent project of an object for mapping.
  • resource – A pattern for a project, folder or file in the workspace.
  • split(,) – Inside an in condition this can split the first parameter at every occurrence of the second parameter and be used as many separate values.
  • switch () { case…*:* … default:} – Conditional expression to map attribute values based on predefined values of another available string for mapping.
  • to – Defines the relation of a custom attribute to the value it is mapped to.
  • valueOf – Starts a valueOf condition.
  • server – Defines the server to be used.
  • port – Defines the port to be used.
  • file – Defines the file to be used for storing.

Options

  • cell – Optional regular expressions for content or address of a cell
  • element matches – XPath expression for the selection of artifacts
  • identified by – Unique key for an artifact in this document.
  • column with header – Defines within a valueOf expression in a configuration of the Excel adapter that the value is contained in a column with a certain column header provided right from the keyword.
  • locate bookmark where subset – Bookmark recognition(s). This can be used to filter valid bookmarks by defining a regular expression on the full label format, see detailed explanation below.
  • locate text where patternRegular expression recognition(s)
  • map – Attribute mappings for custom attributes
  • map to type – ReqIF type long name filter
  • name – Name for the matched artifact
  • resource – File filter pattern
  • sheetRegular expression for the workbook sheet name
  • subset metaclass – Filter elements by meta class
  • subset namespace – Filter elements by namespace
  • subset stereotype – Stereotype filter
  • type – ReqIF specification type long name filter

Configurations

  • … as block|line comment – Specifies whether ANALYZE creates block or line comments for new links.
  • analyze comments of … – Which artifact type represents the C artifact. Possible Values are A and B.
  • create links by … – Specifies how ANALYZE calculates the content of new comments on link creation. The specification is a concatenation of static strings and values of artifact attributes.
  • in – „In” operator to use within a condition
  • locate links by – A regular expression for the text portion in the comment of the C files representing a link.
  • map { … } – As an option, it is possible to define link attributes and derive the attribute values similar to the identifier derivation specified by identified by.
  • separatedby – As an option, it is possible to define a separator, that separates identifiers in a list, e.g., requirement ids that can be linked with ids in one cell of an Excel document.
  • where – Specifies the relevant attributes for the identification of an artifact linked to a C element.