Difference between revisions of "How to use the DLS CRO Issue Management Tool"
m (Protected "How to use the DLS CRO Issue Management Tool" ([edit=sysop] (indefinite) [move=sysop] (indefinite)))
Revision as of 10:43, 7 March 2013
This tool is based on a commercial issue tracking application called JIRA, which has been specially configured to meet the needs of the CRO. The tool is used to manage problem reporting and requests for interoperability testing and is now available for use. Below is an explaination of how the tool should be used. If you do not have a login for the tool and think you need one please email us.
- 1 Basic Concepts
- 2 The Problem Report Workflow
- 3 The Inter-operability Testing Workflow
- 4 Some useful JIRA features
There are a number of basic concepts that need to be defined before the workflow can be described.
- Roles. These are used in the definitions of privileges and notifications etc.
- Groups. These define groups of users and are used primarily to control access to issues.
- Security Levels. These determine which users may see individual issues.
- Issue types. The concept of an 'issue' is central to JIRA. We have defined a limited set of issue types.
Types of Issue
JIRA manages 'issues'. For managing problem reporting and investigation by the CRO three types of issue have been defined: i) a problem report ii) a problem investigation and iii) a sub-task, and for managing interoperability testing requests a fourth type of issue is defined iv) an interop testing request.
- Problem reports are used to record problems with any part of the data link services implementation. Typically these are raised by link stakeholders and describe the observed problem.
- Problem investigations are used by the CRO core team to confidentially record the ongoing investigation of a problem report. A problem investigation will be linked with the corresponding problem report but access will be restricted to people directly involved in the investigation to protect confidentiality. As the investigation progresses the corresponding problem report may be updated to report progress. Log files etc. will normally be attached to problem investigations to keep them confidential.
- Sub-tasks are used to break down the work that may be required to resolve a particular problem report. Sub-tasks are used to record actions and assign them to individuals. They are always associated with a parent problem report, but in many ways are treated the same as problem reports within the tool (as it is based on tracking 'issues' and both problem reports and sub-tasks are types of issue).
- Interop testing request (ITRs) are used to request the support of the Data Link testing Facility at EEC Brétigny for inter-operability testing of ATN/VDL-M2/CPDLC Airborne and Ground systems prior to their operational use.
The following roles are defined:
- CRO registered users: A person who is considered a member of the CRO and has been given access to the issue management tool. Each organisation participating in the implementation of the data link services is expected to have at least one CRO registered user.
- Reporter: The CRO registered user who created the issue.
- Assignee: The CRO registered user who is currently responsible for the issue.
- CRO Coordinator. This person is responsible for managing the overall process and is assigned the responsibility for a problem report when it is first assigned to the CRO. The CRO Coordinator has the right to then assign the PR to members of the CRO Core team to analyse.
- Datalink Test Facility Manager. This person is responsible for managing the interoperability testing and will be assigned all interop testing request type issues.
- CRO Core Team. This is the team of subject matter experts (SMEs) at EUROCONTROL who will analyse the problem reports submitted to the CRO.
There are a number of different groups of people defined. These groups are used when determining which registered users should be allowed to see a particular issue. A group is defined for each organisation which will include all CRO registered users working for that organisation and the CRO Core Team. For example a group will be defined for "DFS+CRO Core" to include all registered users from DFS and the CRO core team members.
It is recognised that the contents of some PRs may be sensitive, and as such the person reporting it may not want it to be made available to the whole CRO community. So it will be possible to restrict the visibility of PRs to be just the person reporting the problem and the CRO core team (who will not make specific details about the problem available to others). However in the interests of generally improving awareness among the CRO community, users are requested to make the PRs visible to all CRO registered users whenever possible.
The following security levels are defined. They determine which users may see any particular problem report.
- Reporter and CRO Core. This is the default security level applied when a problem report is first created. It restricts the visibility to just the user that raised the problem report and the CRO core team.
- Organisation members and CRO. When this security level is selected the problem report will be visible to all CRO registered users from the same organisation as the reporter and the CRO core team.
- None. When this security level is selected the PR will be visible to all CRO registered users.
The Problem Report Workflow
The workflow for a problem report issue is as shown in the diagram below. The workflow is designed to accomodate the inclusion of problem reports that may be analysed and resolved locally (i.e. without sending the problem report to the CRO for investigation). Whilst the problem report is in the OPEN state it is under the responsibility of the local CRO member. If the problem is resolved locally then the resolution can be recorded against the problem report and the report closed by the local CRO member. It is hoped that local CRO members will record their problems in the CRO tool even if they are resolved and closed locally, in order to allow the CRO to maintain an overall picture of the problems being raised within the community.
If the problem cannot be resolved locally then the problem report is assigned to the CRO and the CRO Core team becomes responsible for resolving and then closing the issue. When moving through the various statuses, for those problem reports that the user is permitted to see they will be presented with buttons giving them the options to move the problem report into the next state, and may be prompted to complete additional information when doing so.
Here is a description of what it means when a problem report has a particular status (note the Create status is a starting state and is only shown for completeness):
- OPEN.The PR is assigned to the reporter. At this stage the PR may be investigated locally.
- ASSIGNED TO CRO. The PR is assigned to the CRO Core team for investigation and resolution. The CRO coordinator will assign the PR to the appropriate SME to investigate.
- RESOLVED.A resolution to the problem has been identified and may have been implemented.
- CLOSED.The problem has been solved, any proposed solutions have been implemented and no further action is required.
- REOPENED.The problem requires further investigation. Previously proposed resolutions may have proved ineffective or not possible to implement.
Raising a Problem Report
Creating an issue
It's really simple to create a problem report. Simply click on the 'create issue' link at the top right hand corner of the starting dashboard, as illustrated below.
You will then be presented with the problem report form to fill in as shown below. It consists of a single form with a number of tabs. The contents of the various tabs and fields are described in the next section.
Contents of a Problem Report
A problem report consists of a set of fields presented on four different tabs within a window. The fields on each tab, their possible values and what those values mean are all explained in the table below.
|Problem Description||Summary||Free text||A title for the problem|
|Description||Free text||A detailed description of the problem|
|Environment||Free text||A description of the specific environment in which the problem occurs, e.g. which type of aircraft, which type of groundstation etc.|
|Attachment||Any type of file||Used to attach files to the problem report|
|Linked Issues||Select one of: 'blocks', 'is blocked by', 'clones', 'is cloned by', 'duplicates', 'is duplicated by', and 'relates to' and then select the appropriate problem report||Indicates other PRs which are related|
|Affected area||Impacted Areas||A series of check boxes identifying parts of the overall system e.g. CPDLC service, controller HMI, specifications and standards||Check the boxes which indicate which aspects of the overall system are impacted by the problem.|
|Priority||Priority||Major||A problem that has a significant operational impact on the provision of datalink services|
|Medium||A problem having an operational impact on the provision of datalink services|
|Minor||All other problems.|
|Visibility||Security Level||Reporter and CRO Core Team||Only the reporter and the CRO core team will be able to see this PR.|
|Organisation and CRO Core||Only other members of the reporters organisation and the CRO core team will be able to see the PR.|
|CRO members||All registered members of the CRO will be able to see this PR.|
|None||Any anonymous user can see the PR. Note at the moment there is no intention to have anonymous users but this option is preconfigured by JIRA and can't be removed.|
The Inter-operability Testing Workflow
The workflow for an inter-operability testing request is as shown in the diagram below.
Here is a description of what it means when a interoperability testing request has a particular status:
- OPEN.The request is assigned to the Datalink Test Facility Manager.
- RESOLVED with Resolution Completed or Rejected. The test session has been Completed or the test request has been Rejected
- CLOSED. After the test session has been resolved
Raising a Testing Request
Creating Issue First
It's really simple to create a Testing request. Simply click on the 'create issue' link at the top right hand corner of the starting dashboard as for Problem Reporting
Creating an Interop Testing Request
Select Interop Testing Request in the ‘Issue Type’ field, as illustrated below. You will then be presented with the Interop Testing request form to fill in as shown below. It consists of a single form with a number of tabs. The contents of the various tabs and fields are described in the next section.
The Interop Testing Request Form
Contents of an Inter-operability Testing Request An Interop Testing Request consists of a set of fields presented on seven different tabs within a window. Common Tabs Five of the tabs are common to all kind of requests. The fields on each tab, their possible values and what those values mean are explained in the table below.
|Request Description||Summary||Free text||A title for the request|
|Description||Free text||A detailed description of the request|
|Requestor||Free text||Name and organisation plus email address of the requester.|
|Request Start Date||Date format dd/mmm/yy||Date for start of testing period, selected from calendar|
|Expected Duration||Free text||Expected duration of the testing period|
|Attachment||Any type of file||Used to attach files to the testing request (e.g. Inter-operability Test Plan, Architecture description)|
|Linked Issues||Select one of: 'blocks', 'is blocked by', 'clones', 'is cloned by', 'duplicates', 'is duplicated by', and 'relates to' and then select the appropriate problem report||Indicates if the testing is related to any registered CRO Problem Report.|
|Affected area||Impacted Areas||A series of check boxes identifying parts of the overall system e.g. CPDLC service, controller HMI, specifications and standards||Check the boxes which indicate which aspects of the overall system are impacted by the testing.|
|Priority||Priority||Major||A request related to an issue that has a significant operational impact on the provision of datalink services|
|Medium||A request related to an issue having an operational impact on the provision of datalink services|
|Minor||All other requests.|
|Visibility||Security Level||Reporter and CRO Core Team||Only the reporter and the CRO core team will be able to see this request.|
|Organisation and CRO Core||Only other members of the reporters organisation and the CRO core team will be able to see the request.|
|CRO members||All registered members of the CRO will be able to see this request.|
|None||Any anonymous user can see the ITR. Note at the moment there is no intention to have anonymous users but this option is preconfigured by JIRA and can't be removed.|
Three Tabs are customised according to the type of request, which could be:
- Test Env Air side : Air side testing environment (Avionics Vemdors, OEMS, Airlines, CRO),
- Test Env Ground side: Ground side testing environment (for ANSPs, Industrial Partners, CRO),
- Test Env A/G: Air/Ground testing environment (CSPs, CRO):
Only one Tab can be selected for a single test request and one Tab selection will lead to a customised form to be displayed. The customised forms and associated fields are detailed below:
Test Env Air side Form
Test Env Ground side Form
Test Env A/G Form
Some useful JIRA features
The problem reporting tool has a number of useful features 'out of the box'. A few are highlighted below, but the documentation for JIRA is available on line and pretty good.
- Comments. Comments may be added to an issue at any stage.
- Notifications. Emails will be sent to the reporter and assignee whenever anything changes on the problem report.
- Search. There is a rich search facility that allows you to set up complex searches and save them as filters.
- Watch. It is also possible to 'watch' a problem report that is of particular interest to you. When you watch a problem report you will be sent email notifications of any changes. You have to be eligible to see a problem report before you will be able to watch it.
- Dashboards. It is possible to configure your start screen to contain a number of gadgets to show you information that is of particular interest to you.