Velocity. Defect Tracker 1.0 Manual. Accelerator

Size: px

Start display at page:

Download "Velocity. Defect Tracker 1.0 Manual. Accelerator"

Nigel French
5 years ago
Views:

1 Accelerator Velocity Defect Tracker 1.0 Manual Document Author: Document Owner: Christian Gilbert Date Created: November 6, 2013 Last Updated: December 23, 2013 Project: Company:.

2 Contents Purpose and Overview... 3 Tool Components & Installation... 3 Tool Features and Navigation... 5 Worked Examples... 7 Scalability

3 Purpose and Overview The purpose of the Defect Tracker tool is to log, report and analyze the defects identified in the project lifecycle. This tool is used to track defects and details associated with the defects. The tool supports capturing defects across different types of projects such as Data Warehousing, Data Migration, Data Quality, Data Archive, B2B and Master Data Management. Apart from capturing the defects, this tool also provides the ability to capture details of the solution proposed, analysis done, tests performed and the resolution. This document lists out the features in the tool and describes in detail how the tool can be effectively used to track the defects. Tool Components & Installation NOTE: The Defect Tracker is developed using Microsoft Excel 2010 on Windows 7 Enterprise edition operating system. Each user of the tool is required to install on his/her desktop. Tool Components Component Type Purpose Defect Tracker Instructions.doc (this document) Microsoft Word Provides tool overview and contains detailed instructions to install and operate the tool DefectReport.xls Microsoft Excel Used to capture new defects and make changes to existing defects. This is where the metadata is also captured onetime such as Defect categories, Project Types, Subject Areas, Users etc DefectLog.xls Microsoft Excel Used to record and report the defects in order it was created. Also contains a summary to report number of defects by status, category etc Worked_Example.zip having below files: DefectReport_DWProject.xls DefectLog_DWProject.xls DefectReport_DMProject.xls DefectLog_DMProject.xls Microsoft Excel These contain worked examples of capturing new defects for each project, logging defects in sequence and sample reports Informatica Velocity Accelerator 3

4 Installation Steps NOTE: Steps 1-5 are to be performed by Project Lead or Administrator. And then this can be passed on to other team members to capture defects. Step 0: Enable macros in Excel. In Excel 2010, open, blank workbook, go to File > Options > Trust Center > Trust Center Settings > Macro Settings > Select Enable all macros and click OK couple of times Enable the auto update of links. In Excel 2010, open, blank workbook, go to File > Options > Trust Center > Trust Center Settings > External Content > Select Enable automatic update for all workbook links and click OK couple of times Step 1: Create a project specific folder Step 2: Copy the tool components to the folder - Defect Tracker Instructions.doc, DefectReport.xls and extract contents of Worked_Examples.zip Step 3: Please note the filenames should not be modified Step 4: Open the DefectReport.xls and setup metadata. This is a one time task. These include defining a list of Defect Categories, Project Types, and Statuses of defects, Severity, Business Subject Areas and the User IDs without modifying the column headers. Step 5: Select the Project Type and enter the release details in respective fields. Please note that these are one-time entries and should be fixed for a project. Step 6: Protect the Dropdown worksheet in the DefectReport.xls by opening Dropdown worksheet and going to Review tab > Protect Sheet > Unselect all the options in the Allow all users of this worksheet to and enter a password to protect the sheet. NOTE: Do not protect the DefectDetails worksheet as it will result in unexpected behavior. Also, do not modify the contents related to Fieldnames. Step 7: The DefectReport.xls is now ready to capture defects and can be passed on to other team members, along with DefectLog.xls NOTE: DefectReport.xls and DefectLog.xls should exist in the same folder. It is recommended that defects are logged by a single team member. In case of more than one team member using Defect Tracker to log defects, after the first team member logs defects, updated DefectLog.xls should be passed on to another team member before the other team member can start logging defects. 4

5 Tool Features and Navigation The Defect Tracker tool is launched by opening the DefectReport.xls in Microsoft Excel. Initial screen is loaded once the application is launched and it contains the following sections. Each section is a screen that can be launched by clicking on the respective button from the initial screen. The tool is launched by opening the DefectReport.xls Values in Project Type and Release are fixed for Project s release and should not be changed. The following table provides defect attributes and the purpose of each attribute Attribute Description Example Project Type Dropdown and contains different Project MDM Types Release Release details of the project Jan 2013 Existing Defect ID Use this field to modify existing defects. Enter existing Defect ID and click Fetch. It will populate all the fields corresponding to the A defect that was open is now ready to be closed Defect ID. Make necessary changes and click Save Logged By Enter the User Id who has identified or Windows User Id logged the defect. Logged On Date on which defect is logged (mm/dd/yyyy 1/19/2012 format) Subject Area Business Subject Area to which defect Sales belongs to Object name If this relates to a technical object, enter the object name Database object name Defect Category Enter the Category of the defect ETL error Severity How severe the defect is Major Status Enter the Status of the defect Open Summary Briefly describe defect summary Mismatch in Sales numbers Problem Description Describe the defect in detail including the steps to replicate the issue Proposed Solution Explain any investigations made and steps on how to rectify the defect Investigated By Enter the User Id who investigated the defect Windows User Id Investigated On Date on which investigation was done 1/20/2012 (mm/dd/yyyy format) Impact Analysis Explain the Impact analysis done Approved By Enter the User Id who approved the defect Windows User Id Approved On Enter the date on which proposed solution 1/23/2012 was approved (mm/dd/yyyy format) Summary of Fix Explain in detail how fix is performed Fixed By Enter the User Id who fixed the defect Windows User Id Fixed On Enter the date on which defect was fixed 1/25/2012 (mm/dd/yyyy format) Test Summary Explain in detail how tests were performed Tested By Enter the User Id who Tested the fix Windows User Id Date Closed Enter the date on which defect was closed (mm/dd/yyyy format) 1/26/2012 Informatica Velocity Accelerator 5

6 Steps to Log New Defect Step 1: Launch the DefectReport.xls. A popup message will be displayed directing the user to read the Instructions Manual before operating the Defect Tracker. Open the worksheet DefectDetails. NOTE: The DefectLog.xls should not be open while entering new defects or modifying existing defects. Step 2: Project Type and Release should be pre-populated for a project and are static for a project/release. Step 3: Enter the details associated with the defect. If values in the fields are not accurately entered, click the Reset button to reset the values in the sheet. This should be done before generating the defect. Step 4: Click Save. This will generate a new defect. Steps to Modify Defect Step 1: Launch the DefectReport.xls. A popup message will be displayed directing the user to read the Instructions Manual before operating the Defect Tracker. Open the worksheet DefectDetails NOTE: The DefectLog.xls should not be open while entering new defects or modifying existing defects. Step 2: Project Type and Release should be pre-populated for a project and are static for a project/release Step 3: Enter the existing Defect ID in the Cell D5 and click Fetch. This will fetch the details associated with the defect ID and populate the respective fields. If the Defect ID does not exist, it will pop-up a message Defect ID is not valid Step 4: After modifying the details associated with defect and click Save. This will save the changes associated with the defect and pop up a message Changes have been saved Defect Summary and Reports DefectLog.xls contains Summary worksheet which has the following 4 summary reports o A Pie chart showing Number of Open, Closed and Rejected defects. o Pie chart displaying the Number of Defects by Category o Bar charts showing the number of Defects by Severity o Pie chart displaying the Number of Open, Closed and Rejected defects by Category DefectLog.xls also contains DefectList worksheet which stores all the defects for the project in linear fashion. A Third worksheet in DefectLog.xls is Reports worksheet which is used for report calculations, before presenting the facts in the summary worksheet 6

7 Worked Examples Scenario 1 Data Warehousing Project A large bank is in the process of implementing a Data Warehouse to report and analyze Sales across products and Sales territories. The DW technical team has developed ETL to load the data for account module for the initial DW release. In the process of testing the ETL code for the initial release before it is promoted from test environment to the UAT, testing team has identified a few defects in the Sales numbers corresponding to the Account. The lead tester is given the responsibility of the Project Manager to use the Defect Tracker tool to log all the defects identified by the testing team. First he/she goes through the manual to understand the installation process and completes the installation. Then he/she launches the DefectReport_SalesConsolidation.xls and fills out the following details associated with the defect and clicks Save to generate a new defect Please leave the other fields blank. Close the current workbook. Project Type DW This is a one time entry for the project and should be fixed for all the defects Project Name SalesConsolidation This is a one time entry for the project and should be fixed for all the defects Release Jan 2013 Release Project release information Existing Defect ID <Leave it Blank> This is to be used only to modify existing defects Logged By Jdoe Enter the user id of the person who identified the defect Logged On 10/19/2012 Enter the date on which defect is logged (MM/DD/YYYY format) Subject Area Sales This is a defect identified in Sales module and hence the value Object name m_acct_monthly_sale s_aggr The Defect was identified while testing the data populated by this ETL object (this is an Informatica mapping). This can be left blank if its not a technical defect. Defect Category Data Mismatch The Sales numbers in the DW are not matching with the transaction systems Severity Major This is a major defect since it affects Business reporting Status Open As this is a new defect, leave this open Summary Problem Description Mismatch in Sales numbers <Explain in detail about the mismatch> Gives a brief summary of the defect Give a detailed explanation of the problem. After communication is established with the development team for the related defect, open the DefectLog_SalesConsolidation.xls for the corresponding defect to get the Defect ID and close the DefectLog_SalesConsolidation.xls. Now open the DefectReport_SalesConsolidation.xls, key in the Defect ID and click Fetch Data and this will populate the fields that were entered previously. Enter the proposed solution, Informatica Velocity Accelerator 7

8 investigation details, impact analysis and the approval details (as shown below). And click Save to save the changes and close the workbook. Proposed Solution <Explain how this should be resolved> At this point, communication is sent to the ETL developer who developed the object to look into the issue and enter the proposed solution here Investigated By Jsmith The defect can be investigated by the developer or someone from the development team. Enter the User id of that person Investigated On 10/20/2012 Enter the date of investigation Impact Analysis <Explain how this impacts other objects> Approved By Cbank Enter the User if of the lead approving the proposed solution and the analyzed impact. Approved On 10/23/2012 Enter the approval date Now communication is again established with the development team for the related defect, open the DefectLog_SalesConsolidation.xls for the corresponding defect to get the Defect ID and close the DefectLog_SalesConsolidation.xls. Now open the DefectReport_SalesConsolidation.xls, key in the Defect ID and click Fetch Data and this will populate the fields that were entered previously. Now enter the Summary of how it was fixed and related attributes (as shown below). And click Save to save the changes and close the workbook. Summary of Fix <Explain how the defect is fixed> Fixed By Jsmith Select the User id of the person who fixed the defect Fixed On 10/25/2012 Select the date on which defect was fixed Test Summary <Explain how it is tested> Tested By Jdoe User id of the person who tested the fix Date Closed 10/26/2012 Date on which defect is closed 8

9 Scenario 2 Data Migration Project A manufacturing company is replacing legacy CRM and has developed scripts to migrate data from legacy to new CRM. The quality assurance team is in the process of testing the scripts by each module. The lead tester is given the responsibility of the Project Manager to use the Defect Tracker tool to log all the defects identified by the testing team. First, he/she goes through the manual to understand the installation process and completes the installation. Then he/she launches the DefectReport spreadsheet and fills out the following details associated with the defect and Saves it to generate a new defect. Project Type DM This is a one time entry for the project and should be fixed for all the defects Project Name CRMMigration This is a one time entry for the project and should be fixed value for all the defects Release Jan 2013 Project release information Release Existing Defect <Leave it Blank> This is to be used only to modify existing defects ID Logged By Jdoe Enter the user id of the person who identified the defect Logged On 10/19/2012 Enter the date on which defect is logged (MM/DD/YYYY format) Subject Area Customer This is a defect identified in Customer module and hence the value Customer Object name m_cust_addr The Defect was identified while testing the data populated by this ETL object (this is an Informatica mapping). Note: Leave it blank if it s not a technical defect. Defect Category Data Quality Addresses in the old CRM are missing zip codes Severity Major This is a major defect since it affects address data Status Open As this is a new defect, leave this open Summary NULL addresses Gives a brief summary of the defect Problem Description <Explain in detail about the mismatch> Give a detailed explanation of the problem. After communication is established with the development team for the related defect, open the DefectLog_CRMMigration.xls for the corresponding defect to get the Defect ID and close the DefectLog_CRMMigration.xls. Now open the DefectReport_CRMMigration.xls, key in the Defect ID and click Fetch Data and this will populate the fields that were entered previously. Enter the proposed solution, investigation details, impact analysis and the approval details (as shown below). And click Save to save the changes and close the workbook. Proposed <Explain how this Solution should be At this point, communication is sent to the ETL developer who developed the object to look into the issue and enter the proposed solution here resolved> Investigated By Jsmith The defect can be investigated by the developer or someone from the development team. Enter the User ID of that person Investigated On 10/20/2012 Enter the date of the investigation Informatica Velocity Accelerator 9

10 Impact Analysis <Explain how this impacts other objects> Approved By Cbank Enter the User if of the lead, approving the proposed solution and the analyzed impact. Approved On 10/23/2012 Enter the approval date Now communication is again established with the development team for the related defect, open the DefectLog_CRMMigration.xls for the corresponding defect to get the Defect ID and close the DefectLog_CRMMigration.xls. Now open the DefectReport_CRMMigration.xls, key in the Defect ID and click Fetch Data and this will populate the fields that were entered previously. Now enter the Summary of how it was fixed and related attributes (as shown below). And click Save to save the changes and close the workbook. Summary of Fix <Explain how the defect is fixed> Fixed By Jsmith Select the User id of the person who fixed the defect Fixed On 10/25/2012 Select the date on which defect was fixed Test Summary <Explain how it is tested> Tested By Jdoe User id of the person who tested the fix Date Closed 10/26/2012 The Date on which defect is closed Scalability Phase I Current phase of Defect Tracking tool supports capturing and logging defects in a MS Excel spreadsheet format. Different worksheets are used for capturing and logging defects. Data in the reports are dynamic and have reference to the Defect Log sheet where defects are logged. This is achieved through reporting templates that are pre-built in the summary section of Defect Log spreadsheet This tool can be used to capture defects across different project types such as Data Quality, B2B and other project types. Phase II Phase-II of the Defect Tracker will provide the capability of logging defects through the MS- Excel interface used in Phase-I but the key difference will be managing the data in the backend. Managing data in the backend will be handled through RDBMS such as Oracle and MS SQL Server. Data in the reports will be refreshed from these databases that manage the data. 10

11 Phase III Integration of defect data with other pieces of Project metadata through Informatica Metadata Manager for Data Lineage and tracking project statuses Example: If a defect is associated with a Report, we already have a field to capture object name in the Defect Report. Defect Tracker data will have the Report name captured and if this is integrated with Reporting metadata in Informatica Metadata manager, it is easier to drill down and do further analysis. Informatica Velocity Accelerator 11

2. create the workbook file

2. create the workbook file Excel documents are called workbook files. A workbook can include multiple sheets of information. Excel supports two kinds of sheets for working with data: Worksheets, which