Question

Can someone post a Code Review Checklist for IBM BPM Process Application?

Answer 1

Code Review Checklist

1. Is there sufficient documentation of BPD and Service Artifacts is there and color coding by type of tasks
2. Is Javascript indented and commented properly
3. Is reusable javascript function library created at a central server js file
4. Is appropriate usage of caching there
5. Is a Unit Test harness built for each task and integration service
6. Is sufficient Error Handling in place both at service and BPD level
7. What logging mechanism has been used and is sufficient logging there with appropriate logging levels set i.e. info, debug, error, alert
8. Is there direct access to Process DB (Product DB), it should be only when absolutely necessary since upgrades and migrations may not go through with Product DB changes
9. Is Performance DB being leveraged, has sizing of PDW database needs been done 
10. Is NOLOCK being used for SQL calls
11. Is string concatenation used or StringBuffer
12. what is unit tested load time in Development environment per task and integration
13. Is parametrized query for sql statements being used
14. Is every message on UI and BPD and task attributes connected to a central resource bundle so that they can be changed centrally
15. Is there hard coding of Environment specific variables e.g. hostname, port number, webservice endpoint etc. or they are in the environment configuration of the application
16. Is there a maintenance shutdown for the Process Application feature implemented
18. Are there validation errors in the Process Application
19. Is all the static data appropriately cached, and key based caching used for partially cacheable data
20. Are there default values set/accidentally left out for service input and output variables
21. Are all the static resources for the Process App e.g. css, javascript libraries etc minified and bundled in zip files. images should also be optimized for web delivery
22. Are Artifacts appropriately tagged with Company identifier and type of service
23. Are all the naming conventions adhered to
24. Are decision services being used for business decisions and routing where appropriate
25. If copies of existing controls are made they should be placed in a separate toolkit not mixing up with the Process Application code
26. Is the business data and process data appropriately bundled in context variables at BPD level so that minimal modifications to BPD is needed if additional data elements need to be added.
27. Is autotracking turned off in BPDs
28. Is save execution context checked on
29. Is there service exposure appropriately defined e.g. Admin Services vs Portal Services vs Dashboards
30. Is the exposure of services properly governed by teams and no accidental "All Users" exposures are there.
31. Is only minimal necessary Business Data exposed.
32. Are reusable artifacts e.g. Domain Business Objects, Generic Utility Dashboards etc. properly classified in toolkits.

Answer 2

We have built a automated code review tool "Dosvak Code Analyzer" which checks for the following items

Product Page with Live Demo

	Non-Parametrized queries	1	6	Script
	Compexity Score Per PO	1	7	Application/Model
	Recursive Activity Link BPD	1	10	BPD
	Recursive Component Link	1	10	TWProcess
	Unconverted BPD to Process	1	8	BPD
	Unconverted Services	1	8	TWProcess
	Unconverted HHS to CSHS	1	8	TWProcess
	Combined too many ajax calls in Load handler	1	7	CoachView
	Table control heavily loaded with Coach Views	1	7	CoachView
	Tab / Stack used with too many tabs	1	7	CoachView
	Deeply nested Coach Views	1	7	CoachView
	SQL calls in a loop	1	7	TWProcess
	Java Connector in a loop	1	7	TWProcess
	Web Service invocation in a loop	1	7	TWProcess
	Repeated Ajax Services on Coach	1	7	CoachView
	BPD swimlane assigned to All Users	1	8	BPD
	System Tasks delete at completion not checked	1	8	BPD
	Auto-tracking of BPDs turned on	1	8	BPD
	Large HHS/CSHS Context Size	1	7	TWProcess
	Large BPD Context Size	1	7	BPD
	BPD Claim Check Pattern not used	1	7	BPD
	BPD Envelope Pattern not used	1	7	BPD
	Too Large Variables	1	7	TWClass
	Human Service Complexity Score - Too complex Human Service/CSHS	1	7	TWProcess
	BPD Complexity Score - Too complex BPDs	1	7	BPD
	Direct access to Product DB	1	8	Script
	System Activity as first step of Multi-Instance Loop	1	8	BPD
	Heavily Loaded Coaches	1	7	TWProcess
	Large Number of Steps before Coach	1	7	TWProcess
	Decision Services in Loop	2	5	TWProcess
	Missing Error Handling JavaConnector	2	6	TWProcess
	All User Exposure BPD	2	6	BPD
	Too many steps in a BPD	2	4	BPD
	Script Length > 2000	2	5	Script
	There is no script Content (Empty Script)	2	5	Script
	No Usage of Resource Bundles	2	4	ResourceBundleGroup
	Empty Server Definitions ECM/REST/WEB SERVICE	2	5	Application/Model
	Service Steps with Unknown in Name	2	5	TWProcess
	Dead Branches and steps in BPD	2	5	BPD
	Mixed Brazos and OOB controls	2	4	TWProcess
	Unconnected End Points in BPDs	2	5	BPD
	Unconnected End Points in Human Services	2	5	TWProcess
	Unconnected End Points in services	2	5	TWProcess
	Large Coach Views with too many controls - (Atomic Coach Views)	2	4	CoachView
	Prototype Event Handler not enabled for multiple usages in a Coach	2	5	CoachView

Comments

Global Change handler	2	5	CoachView
	Excessive change handlers	2	4	CoachView
	Missing JS Null check before method invocation	2	4	Script
	Unconnected Boundary Events on a Coach	2	6	Coach
	Coach views without binding	2	6	CoachView
	Binding and config option usage without NULL check	2	6	CoachView
	Large number of private variables for service	2	5	TWProcess
	Large number of private variables for BPD	2	5	BPD
	Large number of private variables for CSHS/HHS	2	5	TWProcess
	Service private variables not used	2	4	TWProcess
	HHS/CSHS private variables not used	2	4	TWProcess
	Excessive Boundary Events	2	6	CoachView
	Too many custom HTML in a Coach	2	5	Coach
	Default System Service in BPD	2	4	BPD
	Default Human Service in BPD	2	4	BPD
	Un-used Variables	2	4	TWClass
	Auto Save Timer	2	5	CoachView
	Business Data Lookup in a Loop	2	5	Script
	Depcreated Coaches Toolkit Usage	2	5	Application/Model
	Deprecated Responsive Coaches Toolkit Usage	2	5	Application/Model
	Deep Copy in a Loop	2	6	Script
	Wrong version of system toolkit	2	6	Application/Model
	EPVs usage in Server Script	2	4	TWProcess
	Mutually dependent toolkits	2	5	ProjectDependency
	Sequential system lane activities -(String of pearls)	2	5	BPD
	Save execution context checked	2	5	TWProcess
	Level of Business Data Exposure by Application	2	5	BPD
	Level of Business Data Exposure by BPD	2	5	BPD
	Hard Coded WSDL Endpoint	2	5	TWProcess
				TWProcess

---

All User Exposure Service	2	5	TWProcess
	Hard Coded JNDI Name	2	5	TWProcess
	Non-Ending HHS/CSHS	2	4	TWProcess
	Too many steps in a service flow	2	5	TWProcess
	String Concatenation	3	3	Script
	Missing CV Localizations	3	1	ResourceBundleGroup
	Pre/Post of Start and Exit Points	3	3	TWProcess
	No Notes in BPD	3	1	BPD
	Deprecated in Process Label Description	3	2	TWProcess
	Link Name Untitled1-n	3	1	TWProcess
	Too Many Pre Post Defined Service	3	3	TWProcess
	Default Labels for Process Steps	3	2	TWProcess
	Junk Managed Asset uploaded but not saved	3	3	ManagedAsset
	Junk CSHS File created but not saved due to WebPD error PO_NAME 64 char	3	3	TWProcess
	CSHS marked Nested but not used as nested	3	4	TWProcess
	PO Count Too Large Split into multiple applications/toolkits	3	3	Application/Model
	Mix of CSHS and HHS	3	3	Application/Model
	Local floating copies of Controls	3	1	CoachView
	Mixed usage of dojo, jquery and DOM methods	3	3	CoachView
	Controls event handlers not leveraged	3	1	CoachView
	Coaches without validation handlers	3	1	Coach
	Mixed usage of responsive and non-responsive coach views	3	3	CoachView
	Coaches used without templates	3	1	Coach
	Javascript alert messages	3	2	CoachView
	Wrong type of bound data	3	1	Coach
	Coach View services defined but not used	3	1	CoachView
	CSS define after JS (js may be dependent on css)	3	1	CoachView
	Combine multiple css files	3	1	CoachView
	Combine multiple JS files	3	1	CoachView
	Conflicting DOM ids - non-usage of $$viewDOMID$$	3	2	CoachView
	Usage of lifecycle view() in Load	3	3	CoachView
	Usage of lifecycle change() as event handler	3	3	CoachView
	Unused ENV	3	1	EnvironmentVariableSet
	Unused EPV	3	1	EPV
	Regular Coach View Defined as a template	3	2	CoachView
	Not implemented Boundary Event checked	3	1	CoachView
	Resource Bundle linked but not used	3	3	TWProcess
	ENV linked but not used	3	3	TWProcess
	EPV linked but not used	3	3	TWProcess
	Hard Coded Coach Views labels	3	1	CoachView
	Coach View without preview HTML/JS Snipped	3	2	CoachView
	Hidden Coach Views in CSS/HHS	3	1	Coach
	Duplicate CSS class declaration	3	1	CoachView
	Ajax calls without Error Handler defined	3	3	CoachView
	Use of Generics (ANY class)	3	1	TWClass
	Unused JS Functions	3	1	Script
	AMD dependencies defined but not used	3	3	CoachView
	Business objects not needed and not nullified	3	2	BPD
	Duplicate js/css usage in Coach Views	3	3	CoachView
	Style coach view (only css)	3	1	CoachView
	Unwanted artificats (e.g. TODO, 2, "2 2" etc)	3	1	Application/Model
	Javascript set as AMD module but not used	3	1	CoachView
	Unused Config Options in Coach Views	3	3	CoachView
	Serializer Usage	3	2	Script
	EPV and ENV usage without typecasting	3	1	Script
	Duplicate environment variables across Toolkits and Process App	3	2	Application/Model
	Non-standard XML parsing	3	2	Script
	Unused Toolkits	3	3	Application/Model
	Not used Resouce Bundles	3	3	ResourceBundleGroup
	Not used services	3	3	TWProcess
	Floating static resources	3	1	ManagedAsset
	Default values set for input variables	3	3	TWProcess
	Outdated toolkit versions	3	3	Application/Model
	No usage of Decision Services	3	1	Application/Model
	Validation Errors	3	1	TWProcess
	Insufficient Logging	3	1	TWProcess
	JS Code not indented	3	1	Script
	Governance Process not used	3	1	Application/Model
	Missing Error Handling Web Services	3	3	TWProcess
	Missing Error Handling DB/SQL Calls	3	3	TWProcess
	General JS Bad Practices	3	1	Script
	Duplicate Managed Assets	3	2	ManagedAsset
	Naming Convention Check	3	3	ProcessVariable
	Polling pattern in Coach	3	3	TWProcess
	Complicated and Large Validation Logic	3	3	TWProcess
	JS loaded as server file	3	3	ManagedAsset
	Dynamic WSDLs instead of static Local Copies	3	3	TWProcess
	JavaScript Hard Codings	3	2	Script
	Excessive Logging	3	3	Script
	Customization of CSS without themes	3	1	CoachView
	Error Handlers without Human Service	3	3	TWProcess
	Large Toolkits	3	2	ProjectDependency
	Too many Toolkits	3	3	ProjectDependency
	Live Connect Usage	3	2	Script
	Thread.sleep Usage	3	3	Script
	Large Managed Assets	3	2	ManagedAsset
	Repeated JS Functions	3	1	Script
	Loops within Loops	3	3	Script
	Image Optimization	3	2	ManagedAsset
	CSS Minification	3	2	ManagedAsset
	Javascript Minification	3	2	ManagedAsset
	Code Quality Score of Application			Application/Model
	CSS Minification in zip file			ManagedAsset
	js minification in zip file			ManagedAsset
	Too Many Pre Post Defined BPD			BPD
	Unreachable Service Flow (Dead Code)			TWProcess
	Non Ending CSHS			TWProcess
	Validation Errors BPD			BPD
	Modified System Toolkits			ProjectDependency
	Wrong version of system toolkits inside attached toolkits			ProjectDependency
	Unimplemented Service only start and end			TWProcess
	Unimplemented BPD only start and end			TWProcess
	No steps service start->End