DECOR-issues

General

The issues element of a DECOR project file holds the issues of the project. It occurs exactly once in a DECOR file.

Attributes of element issues

@notifier

The Automatic Notifier System (if activated) notifies all authors of the project about changes of any project issue. It can be switched "on" or "off", default is "on".

<issues notifier="on">
  <issue ... />
</issues>

List of labels

Issues may have labels to categorize them. With every tracking or assignment you may update these and the latest set is considered the active set. Labels need to be predefined in the issues/labels element. Example:

<labels>
    <label color="#228B22" code="CA" name="Committee approved">
        <desc language="en-US">The approval committee has approved this change</desc>
    </label>
    <label color="#FF4500" code="CD" name="Committee rejected">
        <desc language="en-US">The approval committee has rejected this change</desc>
    </label>
</labels>

Attributes of element label

@code

Required attribute containing a project unique code for the label. This code is used in tracking/@label and assignment/@label.

@name

Required attribute containing the short display name for the label

@color

Optional attribute containing an HTML compatible reference to a color. Examples for the color red: red, #ff0000, rgb(255,0,0)

label/desc

Describes what the label is meant to represent/do. Format: string with optional HTML tagging (XHTML). Supports @language, see @defaultLanguage.

List of issues

Subsequently a list of issue elements represents the issues. An issue has

  • 0..* object elements
  • ...a choice of 0..* tracking and assignment elements.
<issue id="2.16.578.1.34.77.6.1" priority="LL" displayName="Codes separate?" type="CLF">
  <object id="2.16.578.1.34.11.2" type="VS" effectiveDate="2011-07-01T00:00:00"/>
  <tracking effectiveDate="2013-01-29T14:11:22" statusCode="open">
  ...
  </tracking>
  <assignment to="3" name="Rana Tempo" effectiveDate="2013-01-30T13:22:00">
  ...
  </assignment>
</issue>

Attributes of element issue

@id

The unique id of this issue.

@type

The type of this issue.

Code Description
INC Incident
RFC Change Request
FUT For future consideration
CLF Request for Information/Education

@priority

The priority level of this issue, defaults to normal.

Code Description
HH Highest
H High
N Normal
L Low
LL Lowest

@displayName

A short text to describe the issue (headline).

object

There may be 0..* object references where this issue refers to. It has the following attributes in order to reflect a proper reference.

<object id="2.16.578.1.34.11.2" type="VS" effectiveDate="2011-07-01T00:00:00"/>

object/@id

The id of the object that is subject to the issue; either id or name of the object should be given.

object/@name

The name of the object that is subject to the issue; either name or id of the object should be given.

object/@type

The type of the object that is subject to the issue.

Code Object with issue is a...
DS ...Data Set
DE ...Data Element
SC ...Scenario
TR ...Transaction
VS ...Value Set
TM ...Template
EM ...Template Element
IS Object with reference to another issue

object/@effectiveDate

The optional effectiveDate of the object that is subject to the issue.

Tracking / Assignments

An issue may have 0..* issue trackings and / or assignments in any sequence.

issue/tracking

This reflects the list of historic events in terms of comments tracking.

<tracking effectiveDate="2013-01-29T14:11:22" statusCode="open">
  <author id="1"/>
  <desc language="en-US">Why do the Norwegians have <i>different</i> codes 
    for divorced man-woman vs man-man vs woman-woman relationships?</desc>
</tracking>
tracking/@effectiveDate

Identifies the effective date and time of the tracking.

tracking/@statusCode

The status code of the issue associated with this tracking. There is an underlying status machine:

Code Description
new Issue just created. It is new and will soon become a draft/open/finalized issue. Beyond the author, nobody should look at this issue unless it's status code is open or beyond.
open Issue is open, ready for actions to take on, also open for comments
inprogress Issue is in progress
feedback Issue is in progress but needs feedback from others
closed Issue is closed including an solution
rejected Issue is rejected
deferred Issue is deferred
cancelled Issue is cancelled
tracking/@label

References one or multiple label codes as defined in issues/labels. This is a space separated list.

tracking/author

An author element, see Authors of trackings or assignments

tracking/desc

What is the description or question associated with this tracking. Format: string with optional HTML tagging (XHTML). Supports @language, see @defaultLanguage.

issue/assignment

This reflects the list of historic events in terms of assignments of an issue to a person or group.

<assignment to="3" name="Sandro Torres" effectiveDate="2013-01-30T13:22:00">
  <author id="1">dr Kai U. Heitmann</author>
  <desc language="en-US">Please follow-up on this, Sandro.</desc>
</assignment>
assignment/@to

Identifier of the person or group where this issue has been assigned to.

assignment/@name

Name / label of the person or group where this issue has been assigned to.

assignment/@effectiveDate

Identifies the effective date and time of the assignment.

assignment/@label

References one or multiple label codes as defined in issues/labels. This is a space separated list.

assignment/author

An author element, see Authors of trackings or assignments

assignment/desc

What is the description or question associated with this assignment. Format: string with optional HTML tagging (XHTML). Supports @language, see @defaultLanguage.

Authors of trackings or assignments