File and Object Naming Standards
All PL/SQL programs, forms, reports, tables and other database modules, are stored in the database as Oracle objects. In addition, we need to keep the source code or script that creates the modules so that they may be recreated as needed.
Therefore we have two things to name for each object:
- The source file or script that creates the object
- The name of the object as it will exist in the database
In both cases, unless noted, we follow SCT's naming conventions for Banner programming objects. A complete discussion of Banners naming conventions can be found in chapter one of SCT's General Technical Reference Manual.
SCT has reserved the letters W, Y, and Z for use in Positions 1 and 2 of the names of all UNF-developed applications, forms, reports, tables and modules.
For UNF-developed applications, forms, modules, reports, and tables used within a Banner application (those created in a Banner-provided schema), the SCT system identifier is used as the first character (for example, G for General), and W, Y, or Z should be used as the second character.
For UNF-developed objects created to merely coexist with Banner (those created in a UNF-created schema), W, Y, or Z should be used as the first character.
Tables, Forms, Packages
Names | Banner Schema | UNF Schema |
---|---|---|
Source name: | abcdddd.sql | bcadddd.sql |
Object name: | abcddd | bcaddd |
Procedures, Functions, and Triggers
Names | Banner Schema | UNF Schema |
---|---|---|
Source name: | abcdddde.sql | bcadddde.sql |
Object names: | ||
- Procedure | NFP_ddddddddddddddddddddddddd | NFP_ddddddddddddddddddddddddd |
- Function | NFF_ddddddddddddddddddddddddd | NFF_ddddddddddddddddddddddddd |
- Trigger | NFaT_fffffff_dddddddddddddddd | NFT_fffffff_ddddddddddddddddd |
Where:
A = Banner system*
B = W, Y, or Z
C = (P)rocedure, (F)unction, (T)rigger
D = descriptive name
E = 0-1, A-Z (optional counter for allowing multiple objects with the same name such as multiple triggers on the same table or for breaking a package specification and body into separate files)
F = table name
* Conventions for system identifiers and object type codes are detailed on the next page for UNF schemas.
Naming Conventions for Objects in UNF Schemas
First character:
W Banner related
Y Non-banner related
Z Third party integration (Nolij, Luminus, Recruitment Plus, etc.)
Second character (object type):
A Form
F Function
G Trigger
J Job/Report
K Package
O Oracle object
P Procedure
S Sequence
T Table
V View
Third Character (system):
A Alumni | |
B Internal Integration | NFVIEW |
C Conversion | NFCONV |
F Finance | NFFIN |
G General | |
I Internal Systems | NFINS |
N Position Control | NFHRS |
P HR/payroll | NFHRS |
R Financial Aid | NFAID |
S Student | NFSTU |
T Accounts Receivable | |
U Utility | |
X Security | NFSECR |
Fourth through Seventh Characters
Descriptive name
Column Names
Column names start with the seven-character table name. For example:
GJBJOBS_NAME
APBCONS_PIDM
Column names that correspond to a validation table must contain the seven-character application table name followed by an underscore, the four-character validation table identifier, an underscore, and CODE. For example:
GJBJOBS_PRNT_CODE
APRCATG_DONR_CODE
If multiple columns are needed for the same validation table identifier, column names are made unique by appending a number or a unique name to the end of the name of the column. For example:
GURFEED_PAYT_CODE
GURFEED_PAYT_CODE2
GURFEED_PAYT_CODE_TRANSCRIPT
APBCONS_ATYP_CODE_PREF
APBCONS_APTYP_CODE_CM
The name of the last activity date column begins with the seven-character table name followed by an underscore and ACTIVITY_DATE. For example:
GTVLETR_ACTIVITY_DATE
APBCONS_ACTIVITY_DATE
The name of the updating user ID column begins with the seven-character table name followed by an underscore and USER_ID. For example:
GURAPAY_USER_ID
Validation Tables
The validation table and corresponding form have the same name. Both start with GTV followed by a unique four-character identifier. For example:
GTVCALL
The name of the key column begins with the seven-character table name followed by an underscore and CODE. For example:
GTVCALL_CODE
The name of the description column begins with the seven-character table name followed by an underscore and DESC. For example:
GTVCALL_DESC
The names of columns that are used as indicators begin with the seven-character table name and end with an underscore and IND. For example:
GTVCALL_DUPL_IND
A unique index is created for the validation table using the key columns to prevent duplicates from being added to the system.
Storing Source Code
The scripts or source code used to create UNF-developed modules UNF-developed objects is stored on the Unix server. Separate code trees are available for each database instance, but the structure is the same. For example, /sct/banner/nfdv/norf is the directory for UNF source code for the development instance.The norf directories contain many sub-directories as follows:
NORF sub-directories
C |
Pro*C and C source files, C compile procedures, EXEC INCLUDE files (source files) |
COB |
COBOL source |
CRON |
Cron support |
DBPROCS |
Scripts to recreate database procedures, packages, functions, and triggers |
EXE |
Executables -> pointer to general/exe |
FORMS |
Oracle*Forms .fmb, .fmx, .pll, and .lib files |
GENERAL |
Executables |
JAVA |
Java files |
MISC |
Shell scripts |
PLUS |
SQL*Plus scripts |
VIEWS |
Scripts to create views |
UNF Schemas
Standard schemas for UNF code and tables:
NFAID -- Financial Aid
NFFIN -- Finance
NFHRS -- Human Resources
NFINS -- Internal Systems
NFSTU -- Student