Code Review in Technical Specifications
What is the Code Review in the technical Specification document.
Hi,
Code review is done by the other member of the team member or by the onsite guy from the clien side or by team SQA.
Each company is having their own way of coding standards and naming conventions. the client always send one template for the same when the project starts.
The developer can not review his object and the third person like SQA of the team will review it and it will done in document which will be kept for reference.
if any changes or comments made by the SQA, then the developer will change the same again.
hope this will help you.
Thanks
Shiva
Similar Messages
-
Technical Specification Peer Review Document
Hi Team
right now i am working in a implementation project where PI system is a middleware system. here i am developing several abap related and PI related objects for that i have developed some Techincal specifications and now my requirement is to do the technical specification peer review. so I want to know more details about technical specification peer review document. Please tell me what is technical specification peer review document and why is used in detail. if possible please provide me the sample technical specification peer review document for my reference. i request you to please explain me more details about the technical specification peer review document because i am having much knowledge and now there is a requirement for me to do technical specification peer review and update in the template, so please do provide me the sample techincal specification peer review template for my better understanding. Thanks in advance.
Regards
RajHi Raj,
I never com across Technical Specification peer review document, We develop TS for every interface which covers
1)Bussiness reuirement
2)Trchnical Description in deatil
3)Bussiness Flow
4)Source and Tget data fromats description
5)Mapping Logic
6)Which adapters are you going to use,ad you need to specify all obejcts required for this interface/developed for this interface
whick convers SLD,ESR,ID ...
fter completion of evry interface we updates the all deatils in TS,then we need to review the same TS.if anything misses of we need to document the same.May be you need to develop one template for to note down all review comments...
Regards,
Raj -
I have an issue installing photoshop CC trial, I currently have elements and wanted to see the differences before buying, when installing through the creative cloud app I get the error message Exit Code: 7 Please see specific errors below for troubleshooting. For example, ERROR: DW041 ... -------------------------------------- Summary -------------------------------------- - 0 fatal error(s), 1 error(s)
ERROR: DW041: INSTALLDIR Volume D:\ doesn't exist. ------------------------------------------------------------------------------------- System Requirements and it will not install, It says cant find the path D: im not sure why because as far as I can see its set to install on drive C: which is where I want it!Exit Code: 6, Exit Code: 7 Installation Errors - http://helpx.adobe.com/creative-suite/kb/errors-exit-code-6-exit.html
Troubleshoot with install logs | CS5, CS5.5, CS6 - http://helpx.adobe.com/creative-suite/kb/troubleshoot-install-logs-cs5-cs5.html for information on how to review your installation logs -
What are the contents in technical specifications
What are the contents in technical specifications
could u plz explain clearlyhi rajeshreddy,
Below are the standards for Tech specs
1.1 Development Attributes
Program Name:
Title:
Application:
Development Class:
Message Class:
Program Type:
Execution Mode:
Schedule Frequency:
Variant:
1.2 Program Functionality
1.3 Output Fields
Output Label
Related SAP table-field (if any)
Length
Output Characteristics
1.4 Proposed Solutions
1.5 Solution to be implemented
1.6 Reasons of selection/rejection
1.7 Pseudo-Code / Flow Logic of the selected solution
1.8 Selection Screen
1.9 Database Tables Used
Table Name
Table Description
How the table is used in the program
1.10 External Files Used
1.10.1 External File Layout <file name>
1.11 Components External to Program Used
1.12 Error Conditions
1.13 Key Technical Test Conditions
1.14 Sample Test Data
1.15 Assumptions
1.16 Comments
regards,
amit m. -
A technical specification for MC007ZE/A
Hello!
Let me know can I get a technical specification for MC007ZE/A. Our organization is going to buy a big batch of these displays. For this we need a technical specification. I've found out this document http://manuals.info.apple.com/MANUALS/1000/MA1554/en_US/LED_Cinema_Display_27-in ch_UG.pdf but it does't containt the number 'MC007ZE/A'. This paper formality associated with the features of our supplier.Click here for information; the ZE and LL are country codes which don't affect the model's specifications.
(106313) -
Technical Specification documentaion
Hi experts
I want to prepare Technical specification documet of my project , can any one please send the sample document , iam new to the BI in my company , so please any one send me the links or send to my id anilk7729atgmail.com. please s
Edited by: ramesh222 on Jul 27, 2010 7:54 AMHi,
TS doc contains all the information about what all the relevant structures has been created by you during the course of your developement. It will also contain the Design of your developement. Once you have entered the design then u have to describe each and every structures used in that design one by one with every minute technical details.
For example: If u have created any DSO...you have to give all the details about the same like all the key fields,and data fields and y the DSO has been created..Also if you have written any routine or code or formula...u have to describe the same also.
Simailarly for Info objects, infocubes , multiproviders and infosets if any created.
Hopeit is clear..
Rgds,
Amit Kr. -
Failed to install Ligthroom CC Exit Code: 9999 Please see specific errors below for troubleshooting. For example, ERROR: Summary 0 fatal error(s), 0 error(s) Mac
Exit Code: 6, Exit Code: 7 Installation Errors - http://helpx.adobe.com/creative-suite/kb/errors-exit-code-6-exit.html
Troubleshoot with install logs | CS5, CS5.5, CS6 - http://helpx.adobe.com/creative-suite/kb/troubleshoot-install-logs-cs5-cs5.html for information on how to review your installation logs -
I have tried downloading about 6 times and this is the message I keep getting. Pls. tell me what I am doing wrong
Exit Code: 7
Please see specific errors below for troubleshooting. For example, ERROR:
-------------------------------------- Summary --------------------------------------
- 0 fatal error(s), 2 error(s)
ERROR: This installer does not support installation on a 64-Bit Windows operating system. Please download the 64-Bit version of Photoshop Elements.
ERROR: System check returned with error : 6I have tried downloading about 6 times and this is the message I keep gettingExit Code: 6, Exit Code: 7 Installation Errors - http://helpx.adobe.com/creative-suite/kb/errors-exit-code-6-exit.html
Troubleshoot with install logs | CS5, CS5.5, CS6 - http://helpx.adobe.com/creative-suite/kb/troubleshoot-install-logs-cs5-cs5.html for information on how to review your installation logs -
Oracle Apps secure code review
Is any documentation available (either Oracle or third party based) to guide secure code reviews for Oracle Apps (or more specifically, Oracle Application Framework)?
I'm aware of the usual sql injection bad practices (as related to JDBC and PLSQL). I'm curious about API abuse, as related to:
- cross-site scripting concerns
- client-side trust issues (e.g., hidden field values)
- improper or inconsistent input validation
- improper error handling
- improper session management
- inappropriate access control
Thanks.Thanks... I looked at that and didn't think it was all in there, but I looked again after I got your reply and it appears to be what we are looking for (at least a starting point).
-
Need clarification from experts regarding few code review comments received
Hi,
I know that this is a very trivial question to post onto in here but just wanted to double check with all the experts out there. I was lately given few code review comments by one of the senior developers in my project which I couldnt completely agree upon. I thought to seek further inputs from the experts out here.
1) Consider the SQL query below:
SELECT orgeh orgtx FROM t527x INTO TABLE ch_org_unit_descs
FOR ALL ENTRIES IN ch_org_unit_list WHERE sprsl = gc_english AND
orgeh = ch_org_unit_list-orgeh AND
endda = gc_endda.
I was instructed not to pass any constant values (like how am passing to SPRSL & ENDDA) as shown above. The code reviewer said that this would result in poor performance & that am supposed to perform a DELETE upon the resulting internal table instead. I did try read around & search the available documentation but could not come up with any similar note anywhere. Can the experts please comment on the credibility of this statement?
2) Also say I am writing a CASE statement then if I say as WHEN 'ATT' does this mean that am hard coding 'ATT' and that I should have gone for a constant instead? Whilst the code reviewer said that I was hard coding text I would have to admit that I haven't ever declared a constant for handling any of the WHEN statements in any of my projects till date. Is this a bad practice from my end or do you think its like imposing double standards?
Regards,
UdayI second both Sandra & Rob on their views on FAE. As Rob has suggested do a runtime analysis or SQL trace and compare the DB execution times.
>
Sandra Rossi wrote:
> We should use a constant when a value is often used or when a name is better than just a meaningless value.
Using constants for any literal used in the code makes it difficult to understand. I have seen codes with something like CALL TRANSACTION c_fb01 or AUTHORITY OBJECT c_s_dataset.
I always make it a point to declare constants for organizational or functional values which might change in future. Declaring constants for elements which are specific to my code is definitely a NO-NO for me. Comments are welcome on this.
BR,
Suhas -
Code Review:: ADF BC applications
Hi,
We would like to know if there's any open source software available for code reviews of ADF applications and how to effectively use to for ADF BC applications?
1) Am I moving in right direction while exploring PMD and Checkstyle? Are these the right candidates for setting automated code reviews for ADF applications?
Is there a specific software recommendation by the forum members which can help me achieve this goal.
2) Can CodeCoach and Audit features available in JDeveloper help me in this?
3) Will I have to necessary create 'Custom Rules' for tasks like validating EO classes are not directly referred in the Controller? Are there some pre-built rule-sets available on this front?
4) Any other suggestions for ensuring better/faster code reviews not necessarily replacing the manual peer review process but reducing the unnecessary headaches that can be fixed by freely available software
SidI started using ADFLogger and added some log statements. When I ran my application in JDeveloper in Embeded OC4J server, these log statements are appearing in JDeveloper server log window. After I deployed this application to Oracle Application Server, these statements are not appearing in the application.log file and also not in any file. Am I missing any configuration setting? The log current level is INFO and I do have few INFO statements, SEVERE statements in my code. Thanks in advance.
-
Functional and Technical Specification
Hi Experts
As a Functional Consultant we prepare Functional Specefication. As I came to know that on the basis of this Technical Specification are prepared.
My querry is what are these two and whats the difference between these. Are we require to check Techniocal Specification before making any change in already prepared Functional specs.
Thanks.Hello,
See the basic difference is Functional Specs are prepared by functional consultant, whereas Techincal specs are prepared by ABAPers.
Functional specs comprises of the logic, which has table & field from which the data has to be fetched. Since ABAPer can write abap code, the document is to guide them in writing the code.
Technical specs is completely prepared by ABAPers only.
No, its not needed to check Technical Specification before making any change in already prepared Functional specs.
Hope this solves your query.
Regards,
Dhananjay -
Any body aware of some nice code review templates available on the net?
Any body aware of some nice code review templates
available on the net?What do you mean by "code review template"?
Reviews (all reviews) are generally part of a process methodology.
The review itself has a procedural form. One can also make specific requirements for the type of review material. For instance one might insist that Software Requirements be testable and that code classes be documented. Those would be guidelines for the review material and would be used to direct how someone creates the material in the first place. The guidelines would be part of the review process. Once a review is done then one can document the result with a review result sheet.
So are you looking for a code review process document?
Or coding guidelines document?
Or a coding review results document?
Or something else?
You might also note that one will get far more bang for the buck (orders of magnitude with formal studies to back it up) by providing process for things like requirements and project planning. Code reviews are trivial in the overall project cost.
Just to check I googled on "code review template" and I didn't see anything that suggested it fit into the above or even fit into anything that I had forgotten (or never knew.) -
Database DAO - JDBC Query Class - Code review please
I use the following class (Database.java) as a DAO for handling all database calls. The class works. You can use this if you're looking for a DAO solution (i.e. a way to query databases using connection pools / JNDI). I am looking for some suggestions on improving this class. Can you help? I.e. suggestions for improving SELECT speed, logic? The class is used by a moderately heavily used Web application (ca. 2000 - 3000 queries a day - so not too much) on a Sun Web Server system.
This class had the following interfaces:
getErrors() // for retrieving any errors that occurred during an query
setSql() // one way to set the SQL that must be run
setDbName() // one way to set the JNDI name of the database resource
getInsertDelete() // run the INSERT/DELETE statement that was provided with setSql
getInsertDelete(String givenSql, String givenDb) // run with provided sql and db
getClobInsert(String givenSql, String givenDb, Hashtable clobHash, String identifierSql) // clobHash contains the column name and the value (which is a string over 4000 chars). Identifier SQL is the SQL for identifying the row, into which the Clob must be inserted. This interface is specific to Oracle.
getSelect() // Query database with set SQL. Return as a vector of hashes so I can close connection.
getSelect(String givenSql, String givenDb) // select with given sqlAnd here is the full class. I know, this is a weird post, but we don't really have a code review process here at work, and I don't have a specific problem. Just want some feedback concerning the way I query our databases. So, any tips or comments are welcome.
package melib.network;
import java.io.Writer;
import java.io.StringReader;
import java.io.IOException;
import java.util.Vector;
import java.util.Hashtable;
import java.sql.Connection;
import java.sql.Statement;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.Clob;
import javax.sql.DataSource;
import javax.naming.InitialContext;
import melib.system.PropertiesReader; // This is just a simple class for pulling values from a .properties file
* Manages database connections.
* @author jetcat33
* @version 2.0, 2006-07-09
public class Database {
protected String sql = "";
protected String dbName = "";
private StringBuffer errors = new StringBuffer();
/** Creates a new instance of Database */
public Database() {
* Check completeness of data
* for example to check if dbname given or
* sql given or to make sure that yikes
* used instead of sccweb in test conditions
protected boolean checkData(){
if(dbName.equals("") || sql.equals("")){
Email.sendMail(PropertiesReader.getValue("statusEmail"),null,"MelibLibraryError","melib error: [Database]","No database selected for query (db: "+dbName+" or sql not included (sql: "+sql+")");
setErrors("No database selected for query (db: "+dbName+" or sql not included (sql: "+sql+")");
return false;
}else{
return true;
* Sets and gets errors resulting from
* exceptions - otherwise would have to
* somehow include errors in the results
* that are returned but that would include
* other more complicated stuff.
private void setErrors(String e){
errors.append("\n"+e);
public StringBuffer getErrors(){
return errors;
* Setter for the sql variable.
* @param givenSql The sql required to process
public void setSql(java.lang.String givenSql) {
sql = givenSql;
* Sets the dbName needed to commect
* to the correct database.
* @param givenDbName Name of the database - name and connections specified within this class
public void setDbName(java.lang.String givenDbName) {
dbName = givenDbName;
* Processes Insert and Delete requests with given SQL and DB Name.
* @param givenSql
* @param givenDbName
* @return String Number of rows affected
public String getInsertDelete(String givenSql, String givenDbName){
sql = givenSql;
dbName = givenDbName;
return getInsertDelete();
* Takes care of insert, update and delete requests.
* Must have set both dbName as well as the sql String.
* Will return number of rows affected as String.
* @return String Number of rows affected
* @exception Exception
public String getInsertDelete() {
int returnValue = 0;
if(checkData()){
Connection conn = null;
InitialContext initContext = null;
DataSource source = null;
Statement stmt = null;
try{
// Get connection from configured pool
initContext = new InitialContext();
source = (DataSource) initContext.lookup("java:comp/env/jdbc/" + dbName);
conn = source.getConnection();
if(conn != null){
stmt = conn.createStatement();
returnValue = stmt.executeUpdate(sql);
}catch (Exception e){
Email.sendMail(PropertiesReader.getValue("statusEmail"),null,"MelibLibraryError","melib error: [Database.getInsertDelete]","getInsertDelete Exception: "+e.toString()+"\nWith: "+sql);
setErrors(e.toString());
}finally{
try{
stmt.close();
}catch(Exception e){
e.printStackTrace();
try{
conn.close();
}catch(Exception e){
e.printStackTrace();
try{
initContext.close();
}catch(Exception e){
e.printStackTrace();
return returnValue+"";
* Processes Insert requests for SQL containing CLOBS
* @param givenSql
* @param givenDbName
* @param clobHash Contains column name of clob and clob text
* @param identifierSql Contains SQL to identify the just entered SQL so the clobs can be filled in.
* @return String Number of rows affected
public String getClobInsert(String givenSql, String givenDbName, Hashtable clobHash, String identifierSql){
sql = givenSql;
dbName = givenDbName;
String returnValue="";
int rv = 0;
if(checkData()){
Connection conn = null;
InitialContext initContext = null;
DataSource source = null;
Statement stmt = null;
try{
// Get connection from configured pool
initContext = new InitialContext();
source = (DataSource) initContext.lookup("java:comp/env/jdbc/" + dbName);
conn = source.getConnection();
if(conn != null){
conn.setAutoCommit(false);
stmt = conn.createStatement();
rv = stmt.executeUpdate(sql); // write first time
// Now get and overwrite "EMPTY_CLOB()"
ResultSet lobDetails = stmt.executeQuery(identifierSql);
ResultSetMetaData rsmd = lobDetails.getMetaData();
if(lobDetails.next()){
for(int i = 1; i <= rsmd.getColumnCount(); i++){
if(clobHash.get(rsmd.getColumnName(i))!=null && !clobHash.get(rsmd.getColumnName(i)).equals("")){
Clob theClob = lobDetails.getClob(i);
Writer clobWriter = ((oracle.sql.CLOB)theClob).getCharacterOutputStream();
StringReader clobReader = new StringReader((String) clobHash.get(rsmd.getColumnName(i)));
char[] cbuffer = new char[30* 1024]; // Buffer to hold chunks of data to be written to Clob, the slob
int nread = 0;
try{
while((nread=clobReader.read(cbuffer)) != -1){
clobWriter.write(cbuffer,0,nread);
}catch(IOException ioe){
//System.out.println("E: clobWriter exception - " + ioe.toString());
}finally{
try{
returnValue+=" Writing: "+rsmd.getColumnName(i);
clobReader.close();
clobWriter.close();
}catch(IOException ioe2){
//System.out.println("E: clobWriter close exception - " + ioe2.toString());
conn.commit();
}catch (Exception e){
Email.sendMail(PropertiesReader.getValue("statusEmail"),null,"MelibLibraryError","melib error: [Database.getClobInsert]","getClobInsert Exception: "+e.toString()+"\nWith: "+sql+"\nAND\n"+identifierSql);
setErrors(e.toString());
}finally{
try{
stmt.close();
}catch(Exception e){
e.printStackTrace();
try{
conn.close();
}catch(Exception e){
e.printStackTrace();
try{
initContext.close();
}catch(Exception e){
e.printStackTrace();
returnValue=rv+" "+returnValue;
return returnValue;
* Takes care of Select statements.
* Must have set both dbName as well as the sql String.
* Will return a vector.
* @return Vector of Hashes containing the Results of the query
* @exception SQLException
* @exception Exception
public Vector getSelect(){
Vector returnValue = new Vector();
if(checkData()){
Connection conn = null;
InitialContext initContext = null;
DataSource source = null;
ResultSet result = null;
ResultSetMetaData rsmd = null;
Statement stmt = null;
try{
// Get connection from configured pool
initContext = new InitialContext();
source = (DataSource) initContext.lookup("java:comp/env/jdbc/" + dbName);
conn = source.getConnection();
if(conn != null){
stmt = conn.createStatement();
result = stmt.executeQuery(sql);
rsmd = result.getMetaData();
while(result.next()){
Hashtable hash = new Hashtable();
for(int i = 1; i <= rsmd.getColumnCount(); i++){
if(result.getString(i) != null){
hash.put(rsmd.getColumnName(i),result.getString(i));
}else{
hash.put(rsmd.getColumnName(i),"");
returnValue.addElement(hash);
}catch (Exception e){
Email.sendMail(PropertiesReader.getValue("statusEmail"),null,"MelibLibraryError","melib error: [Database.getSelect]","getSelect Exception: "+e.toString()+"\nWith: "+sql);
setErrors(e.toString());
}finally{
try{
result.close();
}catch(Exception e){
e.printStackTrace();
setErrors(e.toString());
try{
stmt.close();
}catch(Exception e){
e.printStackTrace();
setErrors(e.toString());
try{
conn.close();
}catch(Exception e){
e.printStackTrace();
setErrors(e.toString());
try{
initContext.close();
}catch(Exception e){
e.printStackTrace();
setErrors(e.toString());
return returnValue;
* Takes care of Select statements with given SQL.
* Must have set both dbName as well as the sql String.
* Will return a vector.
* @return Vector with Results of the query
* @exception SQLException
* @exception Exception
public Vector getSelect(String givenSql, String givenDbName){
sql = givenSql;
dbName = givenDbName;
return getSelect();
}Thank you,
dailysuntoo much code that's repeated. refactor all the code you have for closing resources into a utility class and simply call its methods.
your dao creates the connection, so it can't participate in a transaction. if there are several daos that should be one unit of work, you can't manage it with this framework.
transactions are under the control of a service layer. I think it's better to have the service object get the connection, pass it to all the DAOs needed for that unit of work, and then have the service close it.
e-mailing errors? I don't like it. if you have 2-3K queries a day failing because the database you'll have 2-3K e-mails to delete. better to log messages. if you really want e-mail, you can have Log4J add an e-mail appender. at least that way it's configurable outside the code.
CRUD operations without an UPDATE? You're missing something important.
What if I don't want to get the database from a JNDI datasource? Now you can't use this DAO without an app server.
Your error messages are less informative than a stack trace. Why not throw an exception with detailed info?
have a look at Spring and how it handles persistence. if you insist on writing your own, might want to look at Spring. Rod Johnson has developed a much better, more general way to handle persistence.
http://www.springframework.org
You return a Vector of Hashtables for queries? Two old-school data structures. You understand the implication of choosing those, right? I'd recommend that you change that to a List of Maps. Let the concrete types be ArrayList and HashMap. Interfaces are preferred, because they let you change the implementation without affecting clients. Vector and Hashtable are synchronized by default; ArrayList and HashMap are not. Synchronization is thread safe but slower.
I understand why you chose to return Vector, because you wanted something general that wouldn't force you to deal with object-relational mapping. This way you can just worry about ResultSetMetaData.
A Vector of Hashtables is a row-based view of the ResultSet (one Hashtable per row). Sometimes a column based view can be more convenient. Then it's a Map of Lists.
You gave it a good try, but I think there's a lot of room for improvement.
% -
[svn] 3854: made minor changes after code review
Revision: 3854
Author: [email protected]
Date: 2008-10-23 12:17:50 -0700 (Thu, 23 Oct 2008)
Log Message:
made minor changes after code review
Modified Paths:
flex/sdk/trunk/frameworks/projects/flex4/asdoc/en_US/mx/components/examples/FxListExample .mxmlHi Chuck,
The Error "TDSSNIClient initialization failed with error 0xd, status code 0x10. Reason: Unable to retrieve registry settings from TCP/IP protocol's 'IPAll' configuration key. The data is invalid" Suggest that there is a problem with the data stored in one
of the registry keys related to SQL server start up. Although the information provided is not sufficient to pinpoint to a specific issues. Still try the following step open the SQL server configuration manager
Select SQL server Network Configuration->Protocols for <Your SQLExpress instance Name>
On the right side double click TCP/IP.Select IPAddresses Tab. Scroll the way down till you file IPALL
Make sure that there are only a valid TCP/IP Port number is present. Even the leading or trailing whitespaces could make a difference here. Once you have verified that above two conditions are met. Try starting the SQL server instance.
Also make sure that the TCP/IP port is not being used by any other program.
You can run the command netstat -aon on the command prompt to see the list of ports being used. Make sure that the port you have specified for SQL server is not listed under the TCP protocols.
Hope this helps.
Regards
Sathish S N
Please click the Mark as answer button and vote as helpful if this reply solves your problem
Maybe you are looking for
-
Desktop computer: Product no. KQ497AA-ABA Operating system: Windows Vista Question: Does anyone know how to fix startup issues when you have to push the button on the top of the computer to turn on and off a lot of times to get the computer to move f
-
Problem with package in Eclipse
I am doing in Java codes. There is big problem with those error: package org.eclipse.emf.ecore.xml.type.internal;What I should to do that? Do you think I need to download some package from somewhere for Eclipse? I have already Eclipse. Please help me
-
Hi All, I am trying to write a Java utility that will create a document using Content Server HTTP API in a repository with security turned on. I use SAP SSF classes to calculate the secKey value for my request, but everytime I get HTTP 401 error and
-
Fillable fileds are printing with garbage font, rest of form prints fine.
I've downloaded an application to be filled out and printed. When I print the application, I get some garbage in the fields that I filled out. The rest of the application looks fine. The whole thing looks great on the screen, I just can't print it. T
-
Caching data in stateful sesion bean
Hi, Is it a good idea to cache user dependent data in stateful session beans because of repeated hits to the same data? Is there a better way to do this? Thanks Sandhya