Skip Headers

Oracle Application Change Management Pack for Oracle E-Business Suite User's Guide
Release 3.1
Part Number E14530-03
Go to Table of Contents
Contents
Go to previous page
Previous
Go to next page
Next

Customization Manager Coding Standards

Customization Manager Coding Standards

Customization Manager has a standards checker to check the that the files included in a custom package meet certain coding standards. This checker tests all code for standards compliance and cannot be turned on or off.

Some standards are mandatory and will result in failure when Customization Manager attempts to build the package. Other standards are recommended, and the standards checker will give a warning but the package will be built.

Mandatory Standards

The standards in the following table must be met. If a file does not meet these standards then Customization Manager will not build the package containing it.

Standard Name Description
Header Check Each file must have an Oracle-compliant source header present.
PLD File Location Standard PLD files must be located somewhere under one of following directories: resource, plsql, graphs.
SQL using CONNECT Standard SQL files using a "connect" statement must have a valid dbdrv hint provided within the file.
Java Destination Path Standard For Java files within a package, the destination path must start with "java".
Java Package Path Standard For Java files within a package, the destination path for the Java file must match its package structure.

Other Standards

The following table lists standards that if not met, will result in a Warning but the package will still be built.

Standard Name Description
Java SOP Check Java files must not use System.out.print
Java System.gc() Check Java files must not use System.gc
SQL dual reference check SQL files must not use System.dual, instead use dual
PERL module location Perl module must be located anywhere under perl directory
PERL file location Perl files must be located under one of following directories: bin, patch/[release]/bin,admin/template,admin/template/*.
SQL comment standard SQL file should not have -- as comment
SQL file (!) check SQL file should not have ! character
PLS (!) check PLS file should not have ! character
JRAD halign check JRAD XML files should not contain hAlign
Java package name check All Java classes must be in packages beginning with: oracle.apps.[prod_name]
Java System.err Check Standard Java files must not use System.err
SQL file location check SQL files must be located under one of following directories: admin/sql,admin/template,admin/template/*,patch/ [some dir]/sql,sql
Drvx file location check Drvx files must be located under one of following directories: patch/[some dir]/driver, admin/template,admin/template/*
Driver File Location Standard Driver files must be located under one of following directories: admin/driver,patch/[some dir]/driver, admin/template,admin/template/*
LCT File Location Standard LCT files must be located under one of following directories: admin/import,patch/[some dir]/import,upgrade/[some dir]/import,admin/template,admin/template/*
LDT File Location Standard LDT files must be located under one of following directories: admin/import,patch/[some dir]/import,help,,admin/template,admin/template/*
PKG File Location Standard Package files must be located under one of following directories: admin/sql,patch/[some dir]/sql,admin/template,admin/template/*
RTF File Location Standard RTF files must be located under : patch/115/publisher/templates
XSS Location Standard XSS files must be located under one of following directories: html,admin/template,admin/template/*
HCT Location Standard HCT files must be located under one of following directories: patch/[some dir]/import,admin/template,admin/template/*
HDT Location Standard HDT files must be located under one of following directories: patch/[some dir]/import,admin/template,admin/template/*
PDT Location Standard PDT files must be located under one of following directories: patch/[some dir]/import,admin/template,admin/template/*
JavaScript Location Standard JavaScript files must be located under one of following directories: html,patch/[some dir]/html,upgrade/[some dir]/html,admin/template,admin/template/*
PrintStackTrace Check Using printStackTrace is not recommended
Workflow Location Standard Workflow files must be located under one of following directories: admin/import,patch/[some dir]/import,admin/template,admin/template/*
XDF Location Standard XDF files must be located under one of following directories: admin/xdf,patch/[some dir]/xdf,patch/[some dir]/xdf/aw/US
Absolute URL Check Standard Check for absolute URLs
Report Printer Def File Report printer files must be located under one of following directories: reports,admin/template,admin/template/*
Form Location Standard Form files must be located under one of following directories: forms,admin/template,admin/template/*
JAR Location Standard Jar files must be located under one of following directories: java/3rdparty,java/3rdparty/stdalone,admin/template,admin/template/,patch/115/jar/bpel
JSP Location Standard JSP files must be located under one of following directories: html,html/jsp/[PROD],html/jsp/[PROD]/[MOD],html/jsp/[PROD]/[MOD]/[sub MOD],admin/template,admin/template/*
Dependency Files Location Standard Dependency files must be located under one of following directories: java/make,admin/template,admin/template/*
Cmd file Location Standard Cmd files must be located under one of following directories: admin/template,admin/template/*,bin
XML Location Standard XML files must be located under one of following directories: html,java,mds,patch/115/publisher/defs,admin/template,admin/template/*,patch/115/manualsteps.
XGM Location Standard XGM files must be located under one of following directories: patch/[some dir]/xml/US,admin/template,admin/template/*
XSL Location Standard XSL files must be located under one of following directories: html,admin/xdf/xsl,patch/[some dir]/xdf/xsl,patch/[some
ForceViewCheck One must use FORCE in CREATE statements in view creation scripts
Show Error Check SQL scripts must not contain the Show errors command
Absolute URL Check Having absolute URLs is not recommended
Pkg Replace Check Use CREATE OR REPLACE PACKAGE for package creation. Do not omit OR REPLACE
Pkg Create IS Check Package creation must not use IS. Instead should always use AS
Xml Parse Standard XML files should be well-formed
Control M Standard Text files should not have control M [^M] character
SQL NoLogging Check Using NOLogging in SQL scripts is not recommended
SQL Serveroutput Check Using set serveroutput on in SQL scripts is not recommended
Wfx File Naming Standard WFX filename must end in s, e, or a, ie. [s|e|a].wfx.
16.3 File Naming Standard Filename should adhere to the 16.3 naming standard
Set Scan Off Standard Package creation scripts containing ampersand must have SET SCAN OFF
Drop Table check Drop table should not be used in SQL/PLSQL files as it can result in loss of data
SQL Max Line LengthStandard No line in a SQL file should be longer than 255 characters
FNDSLOAD Check Standard FNDSLOAD is obsolete. No dbdrv: hints should refer to FNDSLOAD
Drop Column check Drop Column should not be used in SQL/PLSQL files
Long Raw check LONG or LONG RAW columns should not be used
Insert Column check INSERT SQL statements, should explicitly list the columns about to insert
FNDLOAD/FNDLOADSO syntax check FNDLOAD/FNDLOADSO must have correct syntax
Admin Dbdrv none check All files under [PROD_TOP]/admin must have only dbdrv: none
NLADD Sql Check There should be no [PROD]NLADD.sql files in R12 patches
FNDLOAD ldt phase dbdrv: FNDLOAD ldt files must have correct phase
Menu file location Menu files must be located under one of following directories: resource,admin/template,admin/template/*
WFX file location check WFX files must be located under one of following directories: patch/[some dir]/xml,admin/template,admin/template/*
Create single line check In SQL files, CREATE command must occur on one line only.
SQL exit check SQL files must end with exit
Package SpecBody Same file The package specification and body should be in different files
SQL Absolute path Check SQL files should not have absolute path in a @ or @@ statements
Calling SQL script check Use start or @ when calling a SQL script within a SQL script. Do not use @@.
Applsyspub Schema Check Custom scripts are not allowed to modify APPLSYSPUB schema
Custom File Naming Standard All files involved in the package must be for a product prefixed with xx""
Pkg body creation Standard Package body creation scripts should not be in pkh files
Pkg spec creation Standard Package Spec creation scripts should not be in pkb and plb files
Mview Build deferred Standard Materialized Views must be created with BUILD DEFERRED option
Mview Parallel Standard Materialized Views should not be created with parallel command
Mview prebuilt Standard Materialized Views must not be created with ON PREBUILT TABLE option
Report Location Standard Report files must be located under one of following directories: reports,admin/template,admin/template/*
Import stmt Check Java import statements must reference fully qualified Class names