QA Navigation Software Lifecycle Manager Documentation


Table of Content

Customizing the Software Lifecycle Manager

Introduction

Customizing Labels and Wordings

Customizing Values

Re-Designing the SLM

Model View Control

Adapting Reporting Panels

Manipulating Reports

Adapting Views

Customizing Status

Status Label

Submitting a Status

Handling a Status

Effects of a Status

Report Lists

Code Sources


Customizing the Software Lifecycle Manager

Introduction

The QA Navigation Software Lifecycle Manager (SLM) is not a monolithic application but rather a smart set of tools, ready to be customized to meet your requirements.

The SLM can be customized in three different ways:


Customizing Labels and Wordings

All labels and wordings displayed by the user interface or send by the mail system are defined in properties files, one per language supported.

The properties files consist of a simple <key> = <value> entries. To change the wordings and labels simply replace the values with the required wording and copy the changed properties file to the SLM installation.

The properties files are located at <Your SLM Installation>/WEB-INF/classes and are named QNLabels_<country code>.properties. (QNLabels.properties is the properties file for the default language.)


Customizing Values

Data that have a low change frequency and are not interlinked are kept in lists rather than in the Database, for simplicity reasons. Changing the data in these lists is immediately effective. The lists are located in <SLM Installation Path>/data.

List of Customization Data

FileDescriptionUsed for
CRExtSource.lstList of external CR sourcesCR Reports
CRExtStat.lstList of external CR statusCR Reports
CRType.lstList of CR typesCR Reports
ExtTRSrc.lstList of external technical report sourcesTechnical Reports
FixSections.lstList of sections of fixes (key - value pairs)Fixes for Technical Reports
List.lstTest list
UCSection.lstList of Use Case sectionsTechnical Reports
UseCase.lstList of Use CasesTechnical Reports

For data that have a high frequency of changes and/or need to be linked to other data a multi-purpose Table in the database is provided. As a template how to use it the processing of


Re-Designing the SLM

Model View Control

tdb


Adapting Reporting Panels

tdb


Manipulating Reports

tdb


Adapting Views

tdb


Customizing Status

The status of a document and the actions related to this status defines the life cycle of a document.

To add or change a status there are several tasks to be visited:

Status Label

The Label of a status defined in the Label Properties Files. The key - value pair looks like this:

valStat_as = Assigned

"valStat_" is static, "as" is the status key. The combination of both selects the language specific label. Make sure the key is unique.

Submitting a Status

The submission of a status, if not automatically set by another process, is done by providing a button in the relevant panel (document view frame, e.g. VTRFr.jsp). Follow the example of one of the status buttons in the panel.

The submission is processed by a Java Script. If no further action is required, setStat() (located in RepVTools.js) does that.

To control the appearance of the button adapt the according status control object (CRRepStat.java, FixRepStat.java, IssRepStat.java, TRStat.java). The applicable status object is a member of the Report Object of the panel and can be accessesd through it.

Handling a Status

UpdQNDoc.java handles the processing of a status as a Web Service. If no further processing than setting the status is required, no further adaption is required. The default status handler will set the status.

Effects of a Status

The status of a document defines not only what can be done to the document, but also by whom. To adapt the roles and responsibilities UserRoleTool.java needs to be changed. The UserRoleTool object is a member of the Report Object of the panel and can be accessesd through it.


Report Lists

tdb


Code Sources

SourceDescriptionRemark
<SLM Installation Path>
CRListFr.jspCR List Frame
CRRepLst.jspCR Report List
EditCR.jspEdit CR Panel
EditCRFr.jspEdit CR Frame
EditTR.jspEdit TR Panel
EditTRFr.jspEdit TR Frame
ErrMsg.jspError Message Panel
ErrPage.jspError Message Panel
FileUpload.jsp(Test Code)
FixListFr.jspFix List Frame
FixLst.jspFix List
index.jspStart Panel, contains all frames
IssListFr.jspIssue List FrameOutdated, not in use
IssRepLst.jspIssue Report ListOutdated, not in use
LogdOff.jsp
QNNav.jspHome Panel
RepIss.jspIssue EditorOutdated, not in use
ShpDocListFr.jspShipments Documents List Frame
ShpDocLst.jspShipments Documents List
Test.jspTest Code
Test2.jspTest Code
TRListFr2.jspTR List Frame
TRLst2.jspTR List
VCRRepFr.jspCR Report View Frame
VFixFr.jspCR Report View
VIssRepFr.jspIssue Report View FrameOutdated, not in use
VTRFr.jspTR Report View Frame
Welcome.jsp
<SLM Installation Path>/WEB-INF/classes
AdmUser.javaUser administration services (Servlet)
Ajax.javaAjax Services
AjxDocInfo.javaDocument Information Services (ajax)
AjxGetListData.javaData List Services (ajax)
QNRepSrvc.javaRM Document Services (Servlet)
TExecRep.javaWeb Service for Reporting TRs (Servlet)
TstSrvl.java(Test Code)
UpdQNDoc.javaRM Document Update Services (Servlet)
VQANavDoc.javaRM Document View Services (Servlet)
<SLM Installation Path>\WEB-INF\classes\RTObj
CRLstObj.javaCR List Services
CRRepBld.javaCR Report Builder
CRRepObj.javaCR Report Base Object
ExecRepBld.javaTest Execution Report Builder
FixDocBld.javaFix Builder
FixObj.javaFix Base Object
FixRepBld.javaFix Report Builder
RepCRObj.javaCR Report Services
RTEditFrmObj.javaRM Edit Services Base Class
RTFrameObj.javaRM Frame Services Base Class
RTIFObj.javaRM Base Class
RTLstLstObj.javaRM List Services Base Class
RTLstObj.javaRM List Base Class
RTRepObj.javaRM Report Base Class
RTtoolsObj.javaRM Tools Base Class
ShpDocBld.javaShipment Document Builder
TRLstObj.javaTR List Services
TRObj.javaTR Base Class
TRRepBld.javaTR Report Builder
TRRepObj.javaTR Report Base Class
VCRRepObj.javaCR View Services
VFixObj.javaFix View Services
VTRRepObj.javaTR View Services
<SLM Installation Path>\WEB-INF\classes\RTtools
CRRepStat.javaCR Report Status Services
ExtCallHooks.javaPlug In for Status Changes
FixRepStat.javaFix Report Status Services
IssRepStat.javaIssue Report Status Services
QNDocMan.javaRM Document Manipulation Services
QNDocStat.javaRM Document Status Base Class
RTDataList.javaRM Data List Services
SrvltBaseTools.javaServlet Basic Tools
TBox.java(Test Code)
TestRTT.java(Test Code)
TRStat.javaTR Status Services
UserMailTool.javaUser Mail Serivces
UserRoleTool.javaUser Role Services
UserSrvcTool.javaUser Services & Tools