Home The Workings Help Site
Milestones Charter Strategies Mission & Scope
Previous TOC Next
strategies 1 | strategies 2 | strategies 3 | strategies 4
strategies 5 | strategies 6 | strategies 7 | strategies 8
Brandeis PEAK Project
Naming Convention & SQR/Crystal Version Control
Purpose
Definitions
Customization
Accomodation
Process
Modifying Tables
Modifying Panels
Modifying SQRs
SQR Version Control
SQR Heading and Description
SQR Change Control
SQR Documentation for Paragraphs
SQR Documentation for Changes to Code
Click here to access a printable Adobe Acrobat .pdf file of this Issues Naming Convention Document.
Get Adobe Acrobat Reader - needed to view this pdf file,
up
Purpose
Naming conventions are set up to ensure that:
All Brandeis-developed tables, fields, panels, etc. are easily identified, and
The upgrade path is clear of unidentifiable objects.
up
Definitions
Customization: any change that is made to an existing PeopleSoft delivered table, panel, report, process, menu, field, etc. This can have a major impact on the upgrade process and at times can prevent other PeopleSoft delivered processes from running correctly.
Accommodation: a Brandeis-developed solution to a business problem that stands alone or to the side within the PeopleSoft Application. This may include new tables, fields, panels, search records, SQRs, Query/Crystal, PS nVision reports, and so on. For example the Labor Distribution System might be a candidate for accommodation. An accommodated element is linked or bridged to existing PeopleSoft elements, but does not change the PeopleSoft elements.
up
Process
Since all PeopleSoft tables start with 'PS', we will precede customized tables with just 'BR_'. Because the systems will be in separate instances, we do not need a distinction between Finance, Human Resources, or Student Administration.
New tables will be called - BR_tblname
New fields will be called - BR_fldname
New panels will be called - BR_pnlname
New SQR/Crystal reports will be called - BR_name.sqr
We need to establish naming standards to bring order to the work. These are not meant to encourage modifications to PeopleSoft delivered tables, panels, SQRs, or Crystal.
Modifying Tables
When modifying an existing table first save the original version under the name tblname_ORIG so it will always be possible get back to the original. After preserving the ORIG version, copy the current version using tblname_DATE (YYMMDD, e.g. 000829 = Aug 29,2000) to rename the version taken out of use, then make the changes.
Modifying Panels
When modifying an existing panel first save the original version under the name pnlname_ORIG so it will always be possible get back to the original. After preserving the ORIG version, copy the current version using pnlname_DATE (YYMMDD, e.g. 000829 = Aug 29,2000) to rename the version taken out of use, then make the changes.
Modifying SQRs
When modifying an existing SQR:
Save the original version under the name SQRname.sqr.date or SQCname.sqc.date, so that it will always be possible to get back the original.
Leave the renamed original version in the original SQR directory.
Create a directory named BR_SQR for modified SQRs and all other Brandeis SQRs (named BRxxxxxx.sqr or BRxxxxxx.sqc).
Place all modified SQRs in the directory.
Modify the search path for SQR to search BR_SQR first, before searching SQR directory.
Append the modification date to the name of the SQR version that will no longer be used in order to track subsequent modifications in the BR_SQR directory.
Document all modifications made to the code within the body of the SQR. Version control, will be recorded at the top of the SQR, as described below.
up
SQR Version Control
SQR Heading and Description
The following is an example of SQR Heading and Description:

SQR Change Control
The following is an example of SQR Change Control:

SQR Documentation for Paragraphs
The following is an example of SQR Documentation for Paragraphs:

SQR Documentation for Changes to Code
The following is an example of SQR Documentation for Changes to Code:
up
Previous TOC Next
Home | The Workings | Overview | Help | Site
Search
Milestones | Project Charter | Strategies | Mission & Scope
About us
bps site v1.0, last modified: 1/3/2002, 04:30 PM