Docstoc

CMS Central Application Development Documentation Standards

Document Sample
CMS Central Application Development Documentation Standards Powered By Docstoc
					                           CMS Central Application Development
                                     Documentation Standards




FINALIZED:      08/21/02

Last Revised:   12/17/10
CMS Central Application Development Documentation Standards                                                 FINAL




REVISION CONTROL

Document Title:                    CMS Central Application Development Documentation Standards

Author:                            CMS Central

File Reference:                    CMS Central Application Development Documentation Standards 20080117.doc



 Date            By                    Action                                                    Pages
 10/15/00        Jeanine Lussier       Standardized format. No content changes.                  All
 06/15/01        Stephen Schultz       Updated Fresno’s Abbreviation to FR from FRE              44
 12/05/01        George Mansoor        Added SMA-Sonoma/Maritime Academy to Appendix B           44
 08/01/02        Kristine Brewer       Updated to reflect current standards                      All
 09/30/02        Elmo Carino           QA: Updated references to appendices. Other issues        All
                                       forwarded to CMS Integration for resolution
 10/23/02        Yves Hepperle /       Updated appendices                                        38 to 48
                 Elmo Carino
 12/10/02        Elmo Carino           Correct Northridge designation from NOR to NR             44
 04/09/03        Mick McBride          Updated Appendix B to reflect IDC prefix                  44
 06/13/03        Elmo Carino           Updated San Diego designation from SD to SND              44
                                       (Appendix B)
 03/16/04        George Mansoor/       Added WEBLIB information                                  18, 47
                 Elmo Carino
 07/12/04        George Mansoor        Added SEC (Security) to Product Suffixes                  Appendix C
 06/30/05        George Mansoor        Updated Appendix B to include R25 prefix                  44
                                                                                      rd
 12/01/06        George Mansoor        Updated Appendix B to include new East Bay 3 party        44
                                       object prefixes.
 01/17//08       J Lussier             CMS review with minor updates to support new releases.    All
                                       Added Appendix on developing for Accessibility.
 12/17/10        J Lussier             Updated links to Oracle Accessibility resources to        Appendix G
                                       reference Tools 8.5 release.



Review/Approval History

 Date            By                    Action                                                    Pages
 08/21/02        CMS Integration       Review/approval of document for publication               All
 09/05/02        CMS Integration       Added Workflow related objects and added ‘WF’ to          All
                                       Appendix C Product Suffixes
 04/09/03        Blaine Wright         Reviewed and approved IDC prefix                          44
 12/06/05        Jessie Lum            Reviewed and approved East Bay prefixes                   44




Last Revised: 01/17/08
CMS Central Application Development Documentation Standards                                                                                           FINAL



Table of Contents
                                                                                                                                                      Page

1.0    Documentation .................................................................................................................................... 1
       1.1      PeopleSoft Application Upgrade Projects ................................................................................ 1
       1.2      Documenting in Projects .......................................................................................................... 2
       1.3      Documenting Individual Objects Using the Application Designer ............................................ 3
       1.4      Documenting SQL Text in Both SQL Views and Query Views ................................................ 5
       1.5      Documenting Fields and Translates ......................................................................................... 6
       1.6      Documenting in PeopleCode ................................................................................................... 8
       1.7      Documenting SQR Programs ................................................................................................... 9
       1.8      Documenting Cobol Programs ............................................................................................... 10

2.0    Modification Strategy ........................................................................................................................ 11
       2.1      Examples of the Methods Used to Modify Delivered Objects ................................................ 12

3.0    Naming Standards and Conventions ................................................................................................ 15
       3.1      Directory Naming Conventions .............................................................................................. 15
                3.1.1      Client Workstations .................................................................................................... 15
                3.1.2      File Server .................................................................................................................. 15
                3.1.3      Unix Database Server(s) ............................................................................................ 17

4.0    PeopleSoft Object Naming Standards .............................................................................................. 18
       4.1      Customized Object Prefix ....................................................................................................... 18
                4.1.1      Naming Standards Legend ........................................................................................ 18
                4.1.2      Application Upgrade Projects ..................................................................................... 18
                4.1.3      Menus ......................................................................................................................... 19
                4.1.4      Panel Groups/Components ........................................................................................ 20
                4.1.5      Component Interfaces ................................................................................................ 21
                4.1.6      Business Interlinks ..................................................................................................... 21
                4.1.7      Panels/Pages ............................................................................................................. 22
                4.1.8      Records ...................................................................................................................... 22
                4.1.9      AU DMS Scripts (Version 7.x) .................................................................................... 23
                4.1.10       PeopleSoft Project File ............................................................................................. 24
                4.1.11       Business Processes / Business Process Maps ....................................................... 24
                4.1.12       Derived Work Records ............................................................................................. 25
                4.1.13       Fields ........................................................................................................................ 25
                4.1.14       File Layout Definitions .............................................................................................. 26
                4.1.15       Application Engine Programs ................................................................................... 26
                4.1.16       Approval Rule Sets................................................................................................... 27




Last Revised: 01/17/08
CMS Central Application Development Documentation Standards                                                                                            FINAL



                  4.1.17       Business Process ..................................................................................................... 27
                  4.1.18       Activities ................................................................................................................... 28
                  4.1.19       Function Libraries ..................................................................................................... 28
                  4.1.20       Indexes ..................................................................................................................... 29
                  4.1.21       Index Prefixes........................................................................................................... 29
                  4.1.22       Process Definitions................................................................................................... 30
                  4.1.23       Process Job Definitions ............................................................................................ 30
                  4.1.24       Queries ..................................................................................................................... 31
                  4.1.25       Query Trees ............................................................................................................. 31
                  4.1.26       Query Tree Access Groups ...................................................................................... 32
                  4.1.27       Trees ........................................................................................................................ 32
         4.2      File Naming Standards ........................................................................................................... 33
                  4.2.1      NVision Layout and Report Files ................................................................................ 33
                  4.2.2      Crystal Reports........................................................................................................... 33
                  4.2.3      SQR Programs ........................................................................................................... 34
                  4.2.4      SQC Include Files ...................................................................................................... 34
                  4.2.5      Cobol Programs ......................................................................................................... 35
                  4.2.6      SQR/COBOL Output Files ......................................................................................... 35
                  4.2.7      Database Scripts ........................................................................................................ 36
         4.3      Message Catalog ................................................................................................................... 37

Appendix A: Standard Word Abbreviations ................................................................................................ 40

Appendix B: Campus Abbreviations .......................................................................................................... 44

Appendix C: Product Suffixes .................................................................................................................... 45

Appendix D: Record Prefixes and Suffixes ................................................................................................ 47

Appendix E: Field Suffixes ......................................................................................................................... 48

Appendix F: Field Definition Change Matrix ............................................................................................... 49

Appendix G: Designing for Accessibility .................................................................................................... 50




Last Revised: 01/17/08
CMS Central Application Development Documentation Standards        FINAL




1.0       Documentation
1.1       PeopleSoft Application Upgrade Projects
Purpose


     Projects are used to organize
      development within a PeopleSoft
      application.




     Projects provide the ability to
      group objects together for
      migration from one database to
      another.




Last Revised: 12/17/10                                        Page 1 of 50
CMS Central Application Development Documentation Standards        FINAL




1.2          Documenting in Projects

To update or view the documentation
associated with it:
     File
     Project Properties




The Project Properties dialog box
displays:


Description:
     Enter a brief description of the
      project


Comments:
     Enter an identifier for the project
      title. “CSU Baseline” is the
      recommended identifier.
     Enter the date of the modification
     Enter your NT logon name (i.e.,
      JDoe).
     Enter a detailed description of the
      project, including the Help Desk
      Case number if applicable.




     Enter the modification numbers
      that are contained in the project, if
      applicable.




Last Revised: 12/17/10                                        Page 2 of 50
CMS Central Application Development Documentation Standards                                       FINAL



1.3          Documenting Individual Objects Using the Application Designer
All objects in PeopleSoft can have individual documentation recorded with them. This can help track the
customizations and record the reason the customizations were introduced.

To update or view the object’s
properties sheet dialog box:


     File
     Object Properties




Last Revised: 12/17/10                                                                       Page 3 of 50
CMS Central Application Development Documentation Standards                                        FINAL




The Object Properties Dialog Box
displays:
Description:
   Enter a brief description of the
    object
Comments:
   Enter an identifier for the project
    title. “CSU Baseline” is the
    recommended identifier.
   Enter the date of the modification
   Enter your NT logon name (i.e.,
    JDoe).
   Enter a detailed description of the
    modification, including the Help
    Desk Case number if applicable.




While the Record Comparison Report will show which records are different and attempt to show the
differences, the differences are not always easily seen, particularly the first time these reports are
encountered. Moreover, the reasons for changes could be recorded, within the comments, which makes
the analysis much less time consuming.

To choose options for presenting this
output:
   File
   Page Setup




Last Revised: 12/17/10                                                                        Page 4 of 50
CMS Central Application Development Documentation Standards                                          FINAL




1.4          Documenting SQL Text in Both SQL Views and Query Views
Document any changes to the SQL text of a Query View or a SQL View in its record definition. For
Query Views, the query text can be copy and pasted from the Query tool into the object properties.

To document changes, open the
object properties
     File
     Object Properties
Description:
     Enter a brief description of the
      object
Comments:
     Enter an identifier either for the
      developer or the project title.
      “CSU Baseline” is the
      recommended identifier.
     Enter the date of the modification
     Enter your NT logon name (i.e.,
      JDoe).
     Enter a detailed description of the
      modification including the SQL
      text that has changed, including
      the Help Desk Case number if
      applicable.




It is especially important to document modifications to SQL text in both SQL Views and Query Views
because these changes do not stand out on the Record Comparison report. Each new or modified record
definition must have the changes documented in the Object Properties Comments Box (as seen above).
These comments will appear on comparison reports.




Last Revised: 12/17/10                                                                       Page 5 of 50
CMS Central Application Development Documentation Standards                     FINAL




1.5       Documenting Fields and Translates
Translate values are accessed indirectly from an open record definition.

To open a translate value, open a
record with the field you wish to
document.
     Select the field you want




     Right-Click the mouse button and
      select View Translates to see the
      translate values.




     The translate values display:




Last Revised: 12/17/10                                                     Page 6 of 50
CMS Central Application Development Documentation Standards        FINAL




   Click on the General tab to
    document the modification at the
    field properties level.
   This is done because translate
    values are associated with an
    individual field and not an
    individual record.
   Enter an identifier for the project
    title. “CSU Baseline” is the
    recommended identifier.
   Enter the date of the modification
   Enter your NT logon name (i.e.,
    JDoe).
   Enter a detailed description of the
    modification including the
    translate values that have
    changed. Include the Help Desk
    Case number if applicable.




Last Revised: 12/17/10                                        Page 7 of 50
CMS Central Application Development Documentation Standards                                         FINAL




1.6       Documenting in PeopleCode
The PeopleCode Comparison report shows PeopleCode events and indicates if a difference exists.
However, the report does not show the business reason or the actual modified PeopleCode. Therefore,
when PeopleCode programs are created or modified, organize the modifications by using internal
comments.
When documenting PeopleCode, include a unique identifier (i.e. CSU Baseline), the Modification
Number, the Help Desk Case number, your name, the date modified and why. The dashing of the
comment line out to the width of the edit box makes your comment standout in the comparison report.
Each CSU Baseline modification of either delivered PeopleCode or CSU developed PeopleCode must be
documented as follows:

/* CSU Baseline 07/15/2000 JDoe HD12345*/ - Place at the top of the PeopleCode Event.
…….<Delivered PeopleCode>
…….<Delivered PeopleCode>


/* CSU Baseline 07/15/2000 JDoe HD12345*/ - Place at the beginning of the modification.
/*************************************************************************
MOD#        HD Case #      Date           Developer      Mod Reason/Description
HR98001     12345          07/15/2000     JDoe           Added territory to chart field. Need to verify
                                                         this is a valid territory in the location
                                                         table.

*************************************************************************/
…….<PeopleCode Modification>
…….<PeopleCode Modification>
/* CSU Baseline 07/15/2000 JDoe HD12345 – End of Modification */


The first line contains the unique strings “*CSU*” for quickly finding all CSU modifications with the
PeopleTools SEARCH utility.




Last Revised: 12/17/10                                                                         Page 8 of 50
CMS Central Application Development Documentation Standards                                                     FINAL




1.7      Documenting SQR Programs
When a modification is required, a Modification History comment section is to be added after the
program name. This history will specify the date the change was made, the Revision Number, the
developer’s name, and a description of why the change was made. The description should reference the
related Help Desk Case number.

SQR Modification History Example:
!*****************************************************************************
!**CSU Baseline** Modifications
! DATE            REV# DEVELOPER                        DESCRIPTION
! -----------     -------- --------------------------- -------------------------------------------------
07/15/2000   1.04   JDoe                HD12345 The purpose of this SQR is to build…
!*****************************************************************************

Within the modified program, add a Modification Note at the beginning of the code that was added or
changed. Include an EndNote to specify the end of program modifications. When code is being replaced,
comment out the original code as part of the change. Modification Notes are used to define CSU changes
to the original code. The format consists of ‘START/END ***CSU Baseline***’, followed by the date of
the change, developer’s name, and Help Desk Case/Modification Number.
SQR Modification Notes Example:

!     START ***CSU Baseline***                     07/15/2000           JDoe HD12345
.         .        .          .          .         . <code change #1>
.         .        .          .          .         . <code change #2>
!     END         ***CSU Baseline***                 07/15/2000 JDoe HD12345




Last Revised: 12/17/10                                                                                     Page 9 of 50
CMS Central Application Development Documentation Standards                                                         FINAL




1.8      Documenting Cobol Programs
When a modification is required, a Modification History comment section is to be added after the
program name. This history will specify the date the change was made, the Help Desk Case Number,
developer’s name, and a description of why the change was made.
COBOL Modification History Example:
******************************************************************************
***CSU Baseline** Modifications
*     DATE        HDCase            Developer          DESCRIPTION
* -----------     -----------       ------------------ ----------------------------------------------------------
* 07-15-2000 HD12345                   The purpose of this modification is to calculate a
                                    JDoe
                                       additional earnings by using units and units of measure.
******************************************************************************


Within the modified program, add a Modification Note at the beginning of the code that was added or
changed. Include an endnote to specify the end of program modifications. When code is being replaced,
comment out the original code as part of the change. Modification Notes are used to define CSU changes
to the original code. The format consists of ‘START/END ***CSU Baseline***’, followed by the date of
the change, developer’s name, and Help Desk Case/Modification Number.


COBOL Modification Notes Example:
*     START       ***CSU Baseline***                07/15/2000           JDoe HD12345
.         .        .            .      .          . <code change #1>
.         .        .            .      .          . <code change #2>
*     END       ***CSU Baseline***             07/15/2000 JDoe HD12345




Last Revised: 12/17/10                                                                                        Page 10 of 50
CMS Central Application Development Documentation Standards                                            FINAL




2.0       Modification Strategy
Making modifications to existing applications can be an involved process. There are many design
considerations to examine, since one does not want other existing applications or modules within an
application to be effected.
The following is a list of tips and strategies that should be followed during the development phase of the
CMS Baseline implementation. Following this modification strategy will minimize efforts during the
upgrade process.
         Make creative use of the system. Before deciding to make modifications to the system, attempt to
          use existing product capabilities.
         In general, avoid making changes to delivered PeopleSoft objects. If a modification is
          necessary to a delivered PeopleSoft Object including fields, records, panels/pages, SQRs, crystal
          reports, queries, etc., use the following methods:
      1. Using the object properties, document the modification – In some cases the delivered object can
         be modified with documentation in both the technical specifications and the object properties as
         sufficient support. For example, the Administer Workforce (U.S.) menu is referenced in
         peoplecode throughout the HR system. Generally speaking, you would not want to change the
         menu name that is being used. The exposure of impacting other parts of the system
         unintentionally is too great. If changes are needed on a menu, then manually modify the menu,
         document the change both in the menu properties and the design specification. The comments
         from the object properties (i.e. menu properties) will show up on the object comparison reports.
         This aids in reducing maintenance during an upgrade effort.
      2. Clone the object and create a new object – Before a customization begins, create a custom version
         of the delivered object. For example, if changes are required to the PER099.SQR, save it as
         ‘CSUPR099.SQR’ in a different directory. Most objects provide an easy way to copy the existing
         object, e.g. Business Processes. This helps to ensure that custom objects remain separate from
         delivered objects. If you are cloning a PeopleSoft delivered sqr or crystal remove all PeopleSoft
         proprietary text.
      3. The table on the next page shows several examples of the methods to follow when modifying
         delivered objects.




Last Revised: 12/17/10                                                                          Page 11 of 50
CMS Central Application Development Documentation Standards                                                 FINAL




2.1      Examples of the Methods Used to Modify Delivered Objects

                   Method to          Example of
 Object Type       Follow             Original Object         Step One                    Step Two
 Field             Document           SERVICE_DT              Modify the SERVICE_DT       Document changes in
                   changes                                    object                      Object Properties
 Table             Document           JOB                     Modify the JOB object       Document changes in
                   changes                                                                Object Properties
 Panel/Page        Document           POSITION_DATA1          Modify the                  Document changes in
                   changes                                    POSITION_DATA1 object       Object Properties
 Panel Group/      Document           RUN_PER099              Modify the RUN_PER099       Document changes in
 Component         changes                                    object                      Object Properties
 Menu              Document           Administer Workforce    Modify the Admin            Document changes in
                   changes            (U.S.)                  Workforce (U.S.) menu       Object Properties
 Business          Clone and create   Termination             Clone by copying existing   Modify the
 Process Map/      a new object       Notification            Business Process. Save      CSU_TERMINATION_NO
 Business                                                     the object as:              TIFICATION object.
 Process/                                                     CSU_TERMINATION_NO          Document changes in
 Activity                                                     TIFICATION                  Object Properties
 Query             Clone and create   PER006_EE_Mailing       Save as a new object:       Modify the
                   a new object       _Labels                 CSU_PER006_EE_Mailing       CSU_PER006_EE_Mailing
                                                              _Lbl                        _Lbl object
 Index             Clone and create   BAS_PARTIC.A            Create a new object         Document changes in
                   a new object                                                           Object Properties at the
                                                                                          Record level.
 Xlat Value        Clone and create   HIR                     Create a new object         Document changes in
                   a new object                                                           Object Properties at the
                                                                                          Field level.
 Message           Clone and create   13509.3 – Time &        Create new message          N/A
                   a new object       Labor – Approval        starting at
                                                              Message Set # 26000
 SQR               Clone and create   PER099                  Save object as :            Migrate the
                   a new object                               CSUPR099.SQR object         CSUPR099.SQR object to
                                                                                          the custom SQR directory
                                                                                          on the file server. Modify
                                                                                          the object as needed.
 Crystal Report    Clone and create   PER006_EE_Mailing       Save object as:             Migrate the
                   a new object       _Labels                 CSU_PER006_EE_Mailing       PER006_EE_Mailing_Lbl
                                                              _Lbl                        object to the custom
                                                                                          Crystal directory on the file
                                                                                          server. Modify the object
                                                                                          as needed.
 Process           Clone and create   SR717---                Create a new object as:     N/A
 Definition        a new object                               CSUSR717




Last Revised: 12/17/10                                                                               Page 12 of 50
CMS Central Application Development Documentation Standards                                               FINAL




        Analyze the impact. Before modifying objects, do an object usage search to determine the
         impact of the modification.
        Use custom child records to accommodate modifications to delivered records. Instead of
         adding additional fields to a delivered record, create a custom child record that contains all the
         fields necessary to accommodate the modification request.
        Clearly identify and document all customizations. For example, add comments to PeopleCode
         when making changes (see the section Documenting in PeopleCode). Include the date as well as
         some unique identifier (CSU Baseline) so that the Search PeopleCode utility can be used to find
         customized PeopleCode. Include in the comments the business reason for making the
         customization. This will aid in decision-making later in the upgrade process as PeopleSoft might
         make a change in their new release for the same business reason.
        Document special indexes. When systems are tuned with special indexes, it is important to
         document them. Custom indexes might be lost during a full application upgrade. Knowing
         where these indexes are and what they are used for will make it simple to replace them following
         an upgrade and will assure good performance.
        Keep customization documentation up-to-date. Several variables have an enormous impact on
         the time it takes to complete an upgrade. The volume and complexity of customizations are two
         variables that tend to have a major impact. Another variable that can severely reduce the time
         spent on an upgrade is the quality of the documentation for each customization.
        Avoid making changes to the functional libraries (Records named Funclib). These libraries
         contain many PeopleCode functions. PeopleSoft frequently makes significant change to these
         libraries so it is particularly important to carefully document customizations to these libraries. If
         a custom PeopleCode function is needed, create a new Funclib instead of adding to a delivered
         functional library. Tag custom functional libraries with a unique identifier prefix such as
         CSU_FUNCLIB_HR where CSU denotes that this is a custom object (see the section PeopleSoft
         Object Naming Standards).
        Avoid customizing delivered COBOL programs. Changes to these programs typically turn a
         simple upgrade into a challenging upgrade. The delivered PeopleSoft upgrade tools only handle
         on-line database objects (records, panels/pages, menus, translate values, PeopleCode, etc.). There
         is no automated way to compare and upgrade batch programs (i.e. COBOL). Any changes made
         to batch programs will require analysis and manual changes (re-integration of modifications)
         when upgrading to new releases. In addition, PeopleSoft’s Global Support Center does not
         support custom COBOL programs.
        Do not delete anything that PeopleSoft delivers. Delivered objects are often referenced from
         many different parts of the system. Removing an object can affect all parts of the system which
         access that object. If a particular panel/page is not required, restrict access to it through Operator
         Security instead of deleting it. If a particular data element is not required, remove it from the
         display panel/page, but do not delete it from the record.
        Use the upgrade compare programs to identify customizations. Throughout implementation,
         upgrade utilities can be used to compare the customized database to a vanilla version of that
         database (example: compare a customized HCM or Finance database to the delivered unmodified
         HCM or Finance database). The output from this compare will identify all objects in the
         database, which have been altered from their delivered form. When performing a full application
         upgrade, this compare is performed after freezing development and before upgrading the
         database. Running the compare reports at this time will add a day or two to the preparation for
         the upgrade, but this documentation could save weeks of effort later in the process.



Last Revised: 12/17/10                                                                             Page 13 of 50
CMS Central Application Development Documentation Standards                                          FINAL



        Freeze PeopleTools during a full application upgrade. All tools changes made following the
         start of an upgrade will be lost. This includes Trees, Queries, Panels/Pages, Records, Menus,
         Security, etc. The first step of an upgrade is to make a copy of the Production database and apply
         upgraded objects to that copy. Any changes made to a database other than the copy of Production
         will be lost. This does not apply to Production data as structural changes made during the
         upgrade will eventually be superimposed on Production data. If changes must be made during the
         upgrade process, these changes must be reapplied after the upgrade is completed. The Change
         Control Administrator tool can be used to freeze PeopleTools.




Last Revised: 12/17/10                                                                         Page 14 of 50
CMS Central Application Development Documentation Standards                                                       FINAL




3.0      Naming Standards and Conventions
Naming conventions are used in naming files, directories, modules, procedures, variables, and database
objects (records, fields, etc.). The naming conventions discussed here make it easier for development and
maintenance teams to carry out their work.
3.1      Directory Naming Conventions
3.1.1    Client Workstations
The client workstation contains PeopleSoft directories that are not duplicated on the application file server
or database server. Specifically, the client workstations contain the following directories and
subdirectories:

 Directory                       Subdirectory          Contents
 C:\TEMP                                               Contains Working Storage
 C:\PS                                                 PeopleSoft Directory
                                 CACHE\dbname          Contains the cached *.key and *.dat pairs of files
 C:\USER                                               User Directory
                                 SQR                   Contains User-defined SQR Reports
                                 NVISION               Contains Nvision Report Output


3.1.2    File Server
The File Server contains PeopleSoft delivered software which is not duplicated on individual
workstations. When an operator signs onto PeopleSoft, they are physically connected with the File
Server. PeopleSoft versions are stored on the server under high level directories named with the PS
version number; for example, fs7761, sa761, sa81703, etc.
Below the high level directory, i.e. N:\sa761 or O:\sa81703, there are a number of sub-directories which
are used when performing different PeopleSoft functions. Most of these directories are “read-only”. The
main sub-directories and their contents are as follows:

 Directory               Subdirectory       Contents
 N:\sa761                \BIN               Contains PeopleTools Executables
 O:\sa81703
                         \CBLBIN            Contains delivered COBOL executables
                         \CRW               Contains delivered Crystal Reports
                         \DATA              Contains delivered Data Mover Scripts
                         \EXCEL             Contains PSQuery Excel Interface
                         \NVISION           Contains NVision Macros, Templates, Reports
                         \PSBOOKS           Contains PeopleBooks
                         \SQA6              Contains SQA Regression Testing Tool
                         \SQR               Contains delivered SQR Reports and SQC Files
                         \SQRBINW           Contains delivered SQR Runtime Product




Last Revised: 12/17/10                                                                                      Page 15 of 50
CMS Central Application Development Documentation Standards                                            FINAL




 Directory               Subdirectory     Contents
                         \SQRFONTS        Contains SQR Fonts
                         \SRC             Contains delivered COBOL source members
                         \TUXEDO          Contains delivered Tuxedo Client Support
                         \WINWORD         Contains delivered Word Mail Merge Documents
                         \WEB             Contains delivered Web Client Objects


In order to separate customizations from delivered objects, a separate directory structure is created. By
doing this, time spent on analysis during an upgrade process can be reduced. This separate directory
structure can be a much smaller subset compared with the main executable directory (N:\sa761or
O:\sa81703). The only necessary directories for the possible customizable objects are as follows:

 Directory               Subdirectory     Contents
 N:\CSUSA                \CBLBIN          Contains custom COBOL executables
 O:\CSUsa8
                         \CRW             Contains both custom and delivered Crystal Reports
                         \NVISION         Contains custom NVision Macros, Templates, Reports
                         \SQR             Contains custom SQR Reports and SQC Files
                         \SRC             Contains custom COBOL source members
                         \WINWORD         Contains custom Word Mail Merge Documents and Macros


NOTE – Only one Crystal Report directory (\CRW) can be referenced through the PeopleSoft
Configuration Manager. Due to this constraint, both the delivered and the custom Crystal Reports must
be placed in the same directory. By placing all Crystal Reports in the N:\CSUsa\crw (or O:\CSUsa8\crw)
directory, we leave a copy of the delivered reports untouched in the N:\sa761 (or O:\sa81703) directory.
This will aid tremendously during an upgrade. This is also the case with COBOL.
NOTE – All custom directories used for running reports must be directly under the root directory. This is
due to a 256-character constraint in PeopleSoft process definitions. If the directory is not placed directly
under the root, several custom reports may not run.




Last Revised: 12/17/10                                                                           Page 16 of 50
CMS Central Application Development Documentation Standards                                               FINAL




For report and process development, a staging area for customizations is established on the network. This
allows developers to create a custom object separately from what is currently being accessed by the user
community. This staging area should be created on the network and not on any one personal computer.
This makes it a little more convenient for developers to collaborate on custom objects. It also uses the
power of the network for backup purposes and storage capacity. An example of the directory structure
follows:

 Directory                  Subdirectory       Contents
 N:\CSUsadev                \CBLBIN            Contains custom COBOL executables
 O:\CSUsadev8
                            \CRW               Contains both custom and delivered Crystal Reports
                            \NVISION           Contains custom NVision Macros, Templates, Reports
                            \SQR               Contains custom SQR Reports and SQC Files
                            \SRC               Contains custom COBOL source members
                            \WINWORD           Contains custom Word Mail Merge Documents and Macros


3.1.3    Unix Database Server(s)
The Database Server resides on a UNIX system that contains both the source and binaries for the
PeopleSoft batch processes. There are a number of sub-directories under $PS_HOME which are used
when performing different PeopleSoft functions. These will need to be duplicated for each environment.
The main sub-directories and their contents are as follows:

 Directory           Subdirectory      Contents
 $PS_HOME
                     /BIN              Contains delivered KSH executables
                     /CBLBIN           Contains delivered Cobol executables
                     /INSTALL          Contains Installation Scripts
                     /LOG              Contains report and daemon process log files
                     /OUTPUT           Contains report output listing files
                     /SQL              Contains delivered SQL Scripts
                     /SQR              Contains delivered SQR Reports and SQC Files
                     /SRC              Contains delivered COBOL Programs/Include Files
                     CSUsa/sqr         Contains custom SQR Reports and SQC Files




Last Revised: 12/17/10                                                                              Page 17 of 50
CMS Central Application Development Documentation Standards                                                  FINAL




4.0      PeopleSoft Object Naming Standards
4.1      Customized Object Prefix
Certain types of objects will be customized by both the CMS Baseline development team and by campus-
specific development teams. In order to separate the campus-specific objects from the baseline objects, a
three-character prefix is used to uniquely identify the owner of each object. The CMS Baseline
development team uses ‘CSU’ as a prefix for custom objects. Each campus will use a two-character prefix
to uniquely identify each campus-specific custom object. See Appendix B for a list of campus prefixes.
Exception: WEBLIB Record
An exception applies to iScript/Web Libraries (WEBLIB) records. In order to implement campus iScript
modifications, there is a PeopleTools requirement to name the record WEBLIB_XXXX. Campuses that
need to create a custom WEBLIB should add the campus prefix after the required WEBLIB_ prefix (e.g.,
WEBLIB_LB_CASHNET). Do not start with the identifying campus abbreviation (see Appendix D).
NOTE – The following table illustrates the definition of the headings used in the object naming standard
tables.
4.1.1    Naming Standards Legend

 Heading                      Description
 Name Component               The name of each component that makes up the naming standard
 R                            Required component? (R = Required, A = Automatically Generated, O = Optional)
 Description                  Description of each naming standard component
 Valid Values                 Examples of valid values


4.1.2    Application Upgrade Projects
Selective Application Upgrade Projects are used to track CSU customizations to the PeopleSoft products
and migrations from one environment to another (e.g., DEV to TST and DVL to PRO). Application
Designer allows 30 bytes for project names. Application Upgrade Projects are to be named as follows:

 Name Component          R    Description                                      Valid Values
 PROJECT SCOPE           R    ‘BSL’ for Baseline or Campus Abbreviation (see   BSL or Campus specific
                              Appendix B)                                      abbreviation (i.e. SB = San
                                                                               Bernardino, FR = Fresno)


 UNDERSCORE              R    An Underscore                                    _
 PROJECT TYPE            R    Two characters to identify the type of           FS = Financials
                              application upgrade project
                                                                               HR = Human Resources
                                                                               SA = Student Administration
                                                                               DC = Database Compare
                                                                               PC = Project Compare
 UNDERSCORE              R    An Underscore                                    _
 NAME                    R    A descriptive identifier                         Name of project




Last Revised: 12/17/10                                                                               Page 18 of 50
CMS Central Application Development Documentation Standards                                                  FINAL



Examples:
         NR_HR_POSITION_DATA_RPT                              Campus specific Position Data Report
         FR_FS_GL_ACTUAL_RPT                                  Campus specific General Ledger Report
4.1.3    Menus
The PeopleSoft Application Designer allows 30 bytes for menu names. Menu names should be simple
and intuitive, so developers do not have to second-guess the contents or purpose of a menu. The
underlying record definition and panel/page definition names should not drive menu-naming conventions.
Rather, developers should be influenced by how the operators will naturally use the application. All
custom PeopleSoft menu names will have the following components:

 Name Component           R    Description                                     Valid Values
 FACILITY                 R     ‘CSU’ for Baseline or Campus Abbreviation      CSU or Campus specific
                               (see Appendix B)                                abbreviation (i.e. SB = San
                                                                               Bernardino, FR = Fresno)
 UNDERSCORE               R    Separation                                      _
 MENU NAME                R    A name used to describe the contents of the     Developer Defined
                               menu items in a menu group.


NOTE – Custom menus, which have been cloned from delivered menus, may require a name similar to
the delivered menu. Many peoplecode programs begin by evaluating the first few characters of the menu
name before executing. If the new menu requires the same peoplecode edits, it may be more efficient to
adopt a name that starts the same as the delivered menu, then is appended with a unique character(s).
For example, in the HR system several version of the RECRUIT_WORKFORCE menu have been cloned
for security reasons. The new menus have been named RECRUIT_WORKFORCE_F (for Faculty
recruits), RECRUIT_WORKFORCE_PTF (for Part Time Faculty), etc.




Last Revised: 12/17/10                                                                             Page 19 of 50
CMS Central Application Development Documentation Standards                                                    FINAL




4.1.4    Panel Groups/Components
A panel group/component is a set of panels/pages that should be processed as if it were one panel/page.
Panels/pages in a panel group/component share the same basic key structure and the same search record.
The search record is defined at the panel group/component level. What you name the panel/page
definition when you add the panel/page definition of each panel/page in the group is unimportant,
however you may want to give them similar names to make them easily recognizable as a “group” of
panels/pages.

 Name Component           R    Description                                        Valid Values
 FACILITY                 R    ‘CSU’ for Baseline or Campus Abbreviation          CSU or Campus specific
                               (see Appendix B)                                   abbreviation(i.e. SB = San
                                                                                  Bernardino, FR = Fresno)
 UNDERSCORE               R    Separation                                         _
 PANEL GROUP/             R    A name used to describe the contents of the        (i.e. RUNCTL, JOB_DATA,
 COMPONENT                     panel(s)/page(s) in a group. It is recommended     APP_PERSONAL_DATA)
                               that you use the primary record definition name.


Examples:
         CSU_RNCTL_CSUPY001                 Contains the panel(s)/page(s) to run the CSUPY001.SQR
                                            program
         CSU_COMBO_EDIT                     Contains the panel(s)/page(s) to perform Combo Edit functions
         CSU_RUNCTL_PAYROLL                 Contains the panel(s)/page(s) to run a group of payroll reports or
                                            programs
NOTE – Custom panel groups/components, which have been cloned from delivered panel
groups/components, may require a name similar to the delivered panel groups/components. Many
peoplecode programs begin by evaluating the first few characters of the panel group/component name
before executing. If the new panel groups/components requires the same PeopleCode edits, it may be
more efficient to adopt a name that starts the same as the delivered panel groups/components, then is
appended with a unique character(s). For example, in the HR system a few versions of the JOB_DATA
panel groups/components have been cloned due to CSU requirements. The new panel
groups/components have been named JOB_DATA_CSU_REHIRE (Temporary Faculty Rehire),
JOB_DATA_CSU_CON (Temporary Faculty Concurrent Hire), and JOB_DATA_CSU_HIRE
(Temporary Faculty Applicant Hire).




Last Revised: 12/17/10                                                                                Page 20 of 50
CMS Central Application Development Documentation Standards                                             FINAL




4.1.5    Component Interfaces
The Component Interface exposes a PeopleSoft component for synchronous access from another
application. External applications need not be concerned with the details of page structures and
component definitions in order to access the underlying data and business logic through component
interfaces. PeopleSoft component interfaces can be accessed from the following applications:
        Microsoft's Component Object Model (COM)
        C/C++ shared libraries
        Java
        PeopleCode
 Name Component           R    Description                                       Valid Values
 FACILITY                 R    Constant ‘CSU’                                    CSU
 UNDERSCORE               R    Separation                                        _
 PRODUCT SUFFIX           O    Product Suffixes are used to denote the           See Appendix C – Product
                               functional area.                                  Suffixes
 UNDERSCORE               R    Separation                                        _
 FILE LAYOUT NAME         O    A name used to describe the purpose of the File   i.e ADM_APPL_PROG
                               Layout Definition



Examples:
         CSU_AD_ADM_APPL_PROG
4.1.6    Business Interlinks
Business Interlinks enable you to perform component-based, real-time integration from PeopleSoft to
external systems. Business Interlinks do this by creating synchronous transactions that allow PeopleSoft
applications to pass data to and receive data from the external system in real time. You can use Business
Interlinks to integrate PeopleSoft with external systems, with another PeopleSoft application, and systems
on the Internet. The PeopleSoft Application Designer allows 30 bytes for Business Interlink names.

 Name Component           R    Description                                       Valid Values
 FACILITY                 R    Constant ‘CSU’                                    CSU
 UNDERSCORE               R    Separation                                        _
 PRODUCT SUFFIX           O    Product Suffixes are used to denote the           See Appendix C – Product
                               functional area.                                  Suffixes
 UNDERSCORE               R    Separation                                        _
 FILE LAYOUT NAME         O    A name used to describe the purpose of the        i.e
                               Business Interlink                                CREDITCARD_TRANSACTION


Examples:
         CSU_SF_ CREDITCARD_TRANSACTION




Last Revised: 12/17/10                                                                            Page 21 of 50
CMS Central Application Development Documentation Standards                                                  FINAL



4.1.7    Panels/Pages
Panel/Page names can contain up to 18 characters and must be unique. The limited size will likely
require the use of abbreviations for all names. All Campus specific custom panel/page names will be
constructed using the following components:

 Name Component          R    Description                                          Valid Values
 CONSTANT                R    ‘CSU’ for Baseline or Campus Abbreviation (see       CSU or Campus specific
                              Appendix B)                                          abbreviation (i.e. SB = San
                                                                                   Bernardino, FR = Fresno)
 UNDERSCORE              R    An Underscore                                        _
 PANEL/PAGE TYPE         O    This is used to help identify the purpose of the     (i.e. RUNCTL)
                              different types of panel/page definitions. It is
                              mainly used for run control panels/pages.
 PANEL/PAGE NAME         R    A name used to describe the contents of the          See Appendix A – Standard
                              panel/page. It is recommended that you use the       Word Abbreviations
                              primary record definition name.
 PANEL/PAGE              O    This is used to help identify the purpose of the     ADJ (adjustment panel/page)
 SUFFIX                       different types of panel definitions. These naming
                              conventions are used for panel/page definition       SBP (sub-panel/page)
                              names.                                               SEC (secondary panel/page)
                                                                                   TBL (prompt/edit table
                                                                                   panel/page)
 PANEL/PAGE              O    When more than one panel/page is in a                1
 SEQUENCE                     panel/page group, the optional panel/page
                              Group/Component Sequence Number will be              2
                              appended to the panel/page name.                     …


Examples:
         SB_RUNCTL_HR                           Campus specific HR run control panel/page
         FR_RUNCTL_PO                           Campus specific Purchasing run control panel/page
4.1.8    Records
All custom PeopleSoft record names created by the application developers may have up to 15 characters.
Due to this limitation, the use of standard word abbreviations will likely be required. All campus specific
custom PeopleSoft record names will have the following components:

 Name Component           R   Description                                          Valid Values
 FACILITY                 R   ‘CSU’ for Baseline or Campus Abbreviation (see       CSU or Campus specific
                              Appendix B)                                          abbreviation (i.e. SB = San
                                                                                   Bernardino, FR = Fresno)
 UNDERSCORE               R   An Underscore                                        _
 RECORD NAME              R   Record Name                                          See Appendix A – Standard
                                                                                   Word Abbreviations
 PRODUCT SUFFIX           O   Product Suffixes are used when a functional area     See Appendix C – Product
                              applies to many products.                            Suffixes
 RECORD SUFFIX            O   Identify the purpose of different types of record    See Appendix D – Record
                              definitions.                                         Suffixes



Last Revised: 12/17/10                                                                                Page 22 of 50
CMS Central Application Development Documentation Standards                                                  FINAL




Examples:
         SB_RUNCTL_BB                       Campus specific Base Benefits run control table
         FR_RUNCTL_AP                       Campus specific Accounts Payable run control table


4.1.9    AU DMS Scripts (Version 7.x)
AU DMS scripts will be used to migrate Campus Development projects from the campus environment to
the SOSS staging environment. Two files that need to be included when requesting the migration of a
campus modification are DMS and DAT. The file names will use the following naming convention:

 Name Component          R    Description                                             Valid Values
 PREFIX                  R    Two characters to identify the dms script as an AU      AU
                              (Application Upgrade) script
 UNDERSCORE              R    An Underscore                                           _
 PROJECT NAME            R    Same as the Application Upgrade Project                 i.e.,
                                                                                      (NR_HR_POSITION_DATA_RP
                                                                                      T, FR_FS_GL_ACTUAL_RPT)
 UNDERSCORE              R    An Underscore                                           _
 DATE                    R    Date the script was created                             MMDDYYYY
 FILE EXTENSION          R    Two extensions will be used to identify the script      .DMS = Script
                              files and the data files.
                                                                                      .DAT = Data


Examples:
         AU_NR_HR_POSITION_DATA_RPT_04292002.DMS                                   Campus Position Data Report
         AU_NR_HR_POSITION_DATA_RPT_04292002.DAT
         AU_FR_FS_GL_ACTUAL_RPT_04292002.DMS                                       Campus specific General
                                                                                   Ledger Report
         AU_FR_FS_GL_ACTUAL_RPT_04292002.DAT




Last Revised: 12/17/10                                                                                Page 23 of 50
CMS Central Application Development Documentation Standards                                                    FINAL




4.1.10 PeopleSoft Project File
The AU data mover script method for delivering projects changed in 8.x. Project files can now be
exported directly. A folder with the same name as the PeopleSoft project will be created. It is important
that the folder name is identical to the initialization file contained within the project folder. These project
files can be imported into other 8.x environments.

 Name Component          R    Description                                            Valid Values
 PREFIX                  R    ‘BSL’ for Baseline or Campus Abbreviation (see         BSL
                              Appendix B)
 UNDERSCORE              R    An Underscore                                          _
 VERSION                 R    The version of PeopleSoft to which this project will   8
                              be applied.
 UNDERSCORE              R    An Underscore                                          _
 MODULE                  R    Product suffix                                         See Appendix C – Product
                                                                                     Suffixes
 HELP DESK CASE          R    The Help Desk Case assigned to this fix or update      HDnnnnn (nnnnn = case
                                                                                     number)



4.1.11 Business Processes / Business Process Maps
The PeopleSoft Application Designer allows 30 bytes for business process names. Both business
processes and business process maps force all custom objects to be uppercase. This makes it fairly easy to
distinguish between delivered and custom objects. All custom PeopleSoft business process names will
have the following components:

 Name Component          R     Description                                           Valid Values
 FACILITY                R     ‘CSU’ for Baseline or Campus Abbreviation (see        CSU or Campus specific
                               Appendix B)                                           abbreviation (i.e. SB = San
                                                                                     Bernardino, FR = Fresno)
 UNDERSCORE              R     Separation                                            _
 JOB NAME                R     Use a descriptive name                                (i.e. Administer Workforce)


Examples:
         CSU_ADMINISTER_WORKFORCE                        CSU Custom Administer Workforce Process
         CSU_BASE_BENEFITS                               CSU Custom Base Benefits Process Map




Last Revised: 12/17/10                                                                                  Page 24 of 50
CMS Central Application Development Documentation Standards                                                  FINAL



4.1.12 Derived Work Records
Derived Work Records are used when data is needed on a panel/page but will not be stored on the
database. These are commonly used for both derived fields and fields needed for other processes such as
for workflow or temporary calculations. Derived work records are not created as Oracle tables but are
only created in Application Designer. Only one custom derived record should be necessary per module.

 Name Component           R   Description                                          Valid Values
 FACILITY                 R   Constant ‘CSU’                                       CSU
 UNDERSCORE               R   Separation                                           _
 RECORD NAME              R   Constant ‘DERIVED’ denoting the record type          DERIVED
 UNDERSCORE               R   Separation                                           _
 PRODUCT SUFFIX           R   Product Suffixes are used to denote the functional   See Appendix C – Product
                              area                                                 Suffixes


Examples:
         CSU_DERIVED_HR                     CSU Custom HR Derived Record
         CSU_DERIVED_BN                     CSU Custom Benefits Derived Record
         CSU_DERIVED_PY                     CSU Custom Payroll Derived Record


4.1.13 Fields
In general, field names may consist of four parts: a constant which denotes a CSU specific field, a name
describing the contents of the field, a Field Prefix and a Field Suffix (see table below). Either the Field
Prefix or the Field Suffix may be used, but only on push button fields. Underscores are also used to break
up data names wherever a space would normally be used in a written name.

 Name Component           R    Description                                         Valid Values
 FACILITY                 R    Constant ‘CSU’                                      CSU
 UNDERSCORE               R    Separation                                          _
 FIELD PREFIX             O    Field Prefixes are only used on push button         XFR_ = Panel/Page Transfer
                               fields to indicate push button functionality.
                                                                                   RFR_ = Refresh a scroll
                                                                                   POP_ = Pop-up panel/page
                                                                                   RUN_ = Run a job via process
                                                                                   scheduler
 FIELD NAME               R    A name used to describe the contents of the field   See Appendix A – Standard
                                                                                   Word Abbreviations
 FIELD SUFFIX             O    Field Suffixes are only used on push button         _PB = Push button field
                               fields.


Examples:
         CSU_RETIREMENT_AMT                 CSU Custom Retirement Amount Field
         CSU_RETIREMENT_PCT                 CSU Custom Retirement Percentage Field



Last Revised: 12/17/10                                                                               Page 25 of 50
CMS Central Application Development Documentation Standards                                               FINAL




4.1.14 File Layout Definitions
A File Layout is a definition (or mapping) of a file to be processed. It identifies where in a file data fields
are located. Once a File Layout has been created, you can write PeopleCode programs that use the file
object, which in turn use the File Layout, to either read data from or write data to a file. The PeopleSoft
Application Designer allows 30 bytes for File Layout names.

 Name Component           R    Description                                    Valid Values
 FACILITY                 R    Constant ‘CSU’                                 CSU
 UNDERSCORE               R    Separation                                     _
 PRODUCT SUFFIX           O    Product Suffixes are used to denote the        See Appendix C – Product
                               functional area.                               Suffixes
 UNDERSCORE               R    Separation                                     _
 FILE LAYOUT NAME         O    A name used to describe the purpose of the     i.e
                               File Layout Definition                         MENTOR_UDGRAD_EXPRESS



Examples:
         CSU_AD_MENTOR_PROSPECT
4.1.15 Application Engine Programs
Application Engine is the PeopleTool that you use to develop batch or online programs that are effective
alternatives to COBOL or SQR programs (for non-report processing). Using Application Engine, you can
create programs that perform high-volume, background processing against your data. All custom
PeopleSoft Application Engine program names created by the application developers may have up to 12
characters. Due to this limitation, the use of standard word abbreviations will likely be required. All
campus specific custom PeopleSoft application engine names will have the following components:

 Name Component           R    Description                                        Valid Values
 FACILITY                 R    Constant ‘CSU’                                     CSU
 UNDERSCORE               R    Separation                                         _
 PROGRAM NAME             O    Use a descriptive program name.                    i.e. SAP_3C


Examples:
         CSU_HR_ITYPE                        CSU_SR001
         CSU_SAP_3C




Last Revised: 12/17/10                                                                             Page 26 of 50
CMS Central Application Development Documentation Standards                                          FINAL



4.1.16 Approval Rule Sets
An Approval Rule Set is a Workflow map representing all the criteria for determining what approvals are
required for a transaction. The components of the map are individual approval steps, one for each level of
approval. All custom PeopleSoft Approval Rule Set names created by the application developers may
have up to 30 characters. All campus specific custom PeopleSoft record names will have the following
components.

 Name Component           R    Description                                   Valid Values
 FACILITY                 R    Constant ‘CSU’                                CSU
 UNDERSCORE               R    Separation                                    _
 PRODUCT SUFFIX           O    Product Suffixes are used to denote the       See Appendix C – Product
                               functional area.                              Suffixes
 UNDERSCORE               R    Separation                                    _
 APPROVAL RULE            O    A name used to describe the purpose of the    i.e FEE_REFUND
 SET NAME                      Approval Rule Set


Examples:
         CSU_SF_FEE_REFUND


4.1.17 Business Process
A Business Process is a Workflow object that represents a complete business task, consisting of one or
more activities. Business processes can include other business processes. Normally, you use this
functionality only when designing maps for use in PeopleSoft Navigator. All custom PeopleSoft Business
Process names created by the application developers may have up to 30 characters.

 Name Component           R    Description                                   Valid Values
 FACILITY                 R    Constant ‘CSU’                                CSU
 UNDERSCORE               R    Separation                                    _
 PRODUCT SUFFIX           O    Product Suffixes are used to denote the       See Appendix C – Product
                               functional area                               Suffixes
 UNDERSCORE               R    Separation                                    _
 BUSINESS PROCESS         O    A name used to describe the purpose of the    i.e PREHIRE_APPLICANTS
 NAME                          Business Process


Examples:
         CSU_SS_STDNT_ENR                   Student Enrollment Review




Last Revised: 12/17/10                                                                         Page 27 of 50
CMS Central Application Development Documentation Standards                                               FINAL



4.1.18 Activities
Activities are Workflow subprocesses of a Business Process. They are comprised of one or more steps.
All custom PeopleSoft Activity names created by the application developers may have up to 30
characters.

 Name Component           R    Description                                         Valid Values
 FACILITY                 R    Constant ‘CSU’                                      CSU
 UNDERSCORE               R    Separation                                          _
 PRODUCT SUFFIX           O    Product Suffixes are used to denote the             See Appendix C – Product
                               functional area                                     Suffixes
 UNDERSCORE               R    Separation                                          _
 ACTIVITY NAME            O    A name used to describe the purpose of the          i.e ADMIN_INQUIRY
                               Activity


Examples:
         CSU_WF_SS_ADMIN_INQUIRY


4.1.19 Function Libraries
If a processing routine is to be used in more than one panel/page, or the field is referenced in more than
one record, a PeopleSoft application specific function should be defined. Functions are common routines
that are called by other PeopleCode programs. All functions reside in function libraries that are derived
work records. Wherever possible, use existing field names to attach functions to, instead of creating new
fields. All functions written will use the PeopleCode type of “FieldFormula”. The function name should
be descriptive of the processing taking place. The declaration statement in the calling program specifies
which function library to execute the function from.

 Name Component           R   Description                                          Valid Values
 FACILITY                 R   Constant ‘CSU’                                       CSU
 UNDERSCORE               R   Separation                                           _
 RECORD NAME              R   Constant ‘FUNCLIB’ denoting the record type          FUNCLIB
 UNDERSCORE               R   Separation                                           _
 PRODUCT SUFFIX           O   Product Suffixes are used to denote the functional   See Appendix C – Product
                              area.                                                Suffixes


Examples:
         CSU_FUNCLIB_HR                     CSU Custom HR only functions
         CSU_FUNCLIB_PY                     CSU Custom Payroll only functions
         CSU_FUNCLIB                        CSU Custom Global functions




Last Revised: 12/17/10                                                                              Page 28 of 50
CMS Central Application Development Documentation Standards                                                 FINAL



4.1.20 Indexes
PeopleSoft indexes are automatically created when an SQL Create or SQL Alter is performed. The
indexes are automatically named as follows:

 Name Component           R    Description                                       Valid Values
 IDX PREFIX               A    Identifies special types of indexes               PS_ = Key or duplicate order
                                                                                 key
                                                                                 PSn = Alternate search key
                                                                                 PS# = List box item-only
                                                                                 PSa = Custom Indexes
 IDX NAME                 A    Identifies the name of the record definition      See record names


4.1.21 Index Prefixes
        Key or duplicate order key indexes if at least one field in the table is a key or duplicate order
         key. The index contains all key and duplicate order key fields. If duplicate order keys exist, then
         list item fields are also added to the index. The system automatically names this index with the
         prefix of PS_.
        Alternate search key indexes for each alternate search key. The system automatically names
         this index with a prefix of PSn, where n is a number between 0 and 9.
        List box item-only indexes if no duplicate order keys exist for the table and it contains at least one
         field that is a list item, but not a key field. (Alternate search keys are not considered key fields in
         this type of index.) The system automatically names this index with a prefix of PS#.
        Custom indexes can be defined with the Change, Indexes, Add Index dialog. The system
         automatically names this index with a prefix of PSa, where a is a letter A, B, C and so on.

Examples:
         PS_BENEF_PLAN_TBL                 Primary index for PS_BENEF_PLAN_TBL
         PS0BANK_TBL                       Alternate search key index for BANK_TBL
         PSn_BENEF_PLAN_TBL                List Box item-only index for PS_BENEF_PLAN_TBL
                                           where n=number between 0 and 9.
         PSAPAY_CHECK                      Custom Index for PS_PAY_CHECK table

NOTE: Indexes must be encapsulated in an Application Designer project to deliver in the baseline
software (i.e., not delivered as database level sequel scripts). Campus custom indexes may be overwritten
by baseline indexes and will need to be restored via communication with the Technical Services group.




Last Revised: 12/17/10                                                                              Page 29 of 50
CMS Central Application Development Documentation Standards                                                   FINAL




4.1.22 Process Definitions
The PeopleSoft Process Scheduler allows 8 bytes for process definition names. The limited size for
definition names may require the use of abbreviations for some names. All custom PeopleSoft definition
names will have the following components:

 Name Component           R    Description                                      Valid Values
 FACILITY                 R    ‘CSU’ for Baseline or Campus Abbreviation        CSU or Campus specific
                               (see Appendix B)                                 abbreviation(i.e. SB = San
                                                                                Bernardino, FR = Fresno)
 PRODUCT                  R    Two character Product Abbreviation (i.e., HR,    See Appendix C – Product
                               GL, etc.)                                        Suffixes
 SEQUENTIAL               R    Sequential number starting with ‘001’ which      001
 NUMBER                        identifies a specific CSU customization and is
                               assigned from the name of the program that is    002
                               used. (i.e. SQR, Crystal, Nvision)               …


Examples:
         AD705                             Delivered – Admissions Region Table Process
         CSUAD705                          CSU Custom – Admissions Region Table Process


4.1.23 Process Job Definitions
Multiple process definitions can be logically linked into a job request to process each request serially or
parallel, and optionally initiate subsequent processes based on the return code from each prior request.
The PeopleSoft Process Scheduler allows 8 bytes for process job definition names. The limited size for
job definition names may require the use of abbreviations for some names. All custom PeopleSoft job
definition names will have the following components:

 Name Component           R    Description                                      Valid Values
 FACILITY                 R    ‘CSU’ for Baseline or Campus Abbreviation        CSU or Campus specific
                               (see Appendix B)                                 abbreviation (i.e. SB = San
                                                                                Bernardino, FR = Fresno)
 JOB NAME                 R    Use an intuitive name 5 characters in length.    (i.e. HRALL)


Examples:
         CSUHRALL                          CSU Custom – All HR Processes
         CSU3CYSTL                         CSU Custom – 3 Crystal Processes




Last Revised: 12/17/10                                                                              Page 30 of 50
CMS Central Application Development Documentation Standards                                                  FINAL




4.1.24 Queries
The PeopleSoft Query Designer allows 30 bytes for Query names. The following naming conventions
apply to all CSU custom public queries:

 Name Component           R    Description                                     Valid Values
 FACILITY                 R    ‘CSU’ for Baseline or Campus Abbreviation       CSU or Campus specific
                               (see Appendix B)                                abbreviation (i.e. SB = San
                                                                               Bernardino, FR = Fresno)
 UNDERSCORE               R    Separation                                      _
 QUERY NAME               R    Descriptive name for the query                  Developer Defined


Examples:
         CSU_ TRN004__TRAINING_SCHEDULE                        CSU Custom Training Schedule Query


4.1.25 Query Trees
The PeopleSoft Tree Manager allows 18 bytes for tree names. Query trees delivered by PeopleSoft
follow the naming convention QUERY_<name> or QRY_<name>. CSU query trees will follow the same
naming convention except they will include the CSU_ prefix. The following naming conventions apply to
all CSU added Query Trees:

 Name Component           R    Description                                     Valid Values
 FACILITY                 R    ‘CSU’ for Baseline or Campus Abbreviation       CSU or Campus specific
                               (see Appendix B)                                abbreviation (i.e. SB = San
                                                                               Bernardino, FR = Fresno)
 UNDERSCORE               R    Separation                                      _
 PRODUCT                  R    Two character Product Abbreviation              See Appendix C – Product
                                                                               Suffixes
 UNDERSCORE               R    Separation                                      _
 TREE NAME                R    Use a simple, intuitive name.                   QUERY_TREE


Examples:
         CSU_ HR_QUERY_TREE                         CSU Custom HR Query Tree
         CSU_ BN_QUERY_TREE                         CSU Custom Benefits Query Tree




Last Revised: 12/17/10                                                                             Page 31 of 50
CMS Central Application Development Documentation Standards                                              FINAL



4.1.26 Query Tree Access Groups
The PeopleSoft Tree Manager allows 30 bytes for Query Tree Access Group names. The limited size for
PeopleSoft names may require the use of abbreviations for some names. All custom PeopleSoft Query
Tree Access Group names will have the following components:

 Name Component           R    Description                                 Valid Values
 FACILITY                 R    ‘CSU’ for Baseline or Campus Abbreviation   CSU or Campus specific
                               (see Appendix B)                            abbreviation (i.e. SB = San
                                                                           Bernardino, FR = Fresno)
 UNDERSCORE               R    Separation                                  _
 PRODUCT CODE             R    Two character Product Abbreviation          See Appendix C – Product
                                                                           Suffixes
 UNDERSCORE               R    Separation                                  _
 ACCESS GROUP             R    Use a simple, intuitive name.               ACCESS_GROUP


Examples:
         CSU_HR_ACCESS_GROUP                        CSU Custom HR Access Group
         CSU_BN_ACCESS_GROUP                        CSU Custom Benefits Access Group


4.1.27 Trees
The PeopleSoft Tree Manager allows 30 bytes for Tree names. The limited size for PeopleSoft names
may require the use of abbreviations for some names. All custom PeopleSoft Tree names will have the
following components:

 Name Component           R    Description                                 Valid Values
 FACILITY                 R    ‘CSU’ for Baseline or Campus Abbreviation   CSU or Campus specific
                               (see Appendix B)                            abbreviation (i.e. SB = San
                                                                           Bernardino, FR= Fresno)
 UNDERSCORE               R    Separation                                  _
 PRODUCT CODE             O    Two character Product Abbreviation          See Appendix C – Product
                                                                           Suffixes
 TREE NAME                R    Use a simple, intuitive name.               (i.e. DEPT_SECURITY)


Examples:
         CSU_REPORTING_ROLLUP                       CSU Custom Reporting Rollup Tree
         CSU_DEPT_SECURITY                          CSU Custom Department Security Tree




Last Revised: 12/17/10                                                                         Page 32 of 50
CMS Central Application Development Documentation Standards                                                       FINAL



4.2      File Naming Standards
4.2.1    NVision Layout and Report Files
PeopleSoft nVision Layout and Report filenames can have as many characters for their names as the
current Operating System allows. Each layout and report filename must be unique. In order to keep the
name consistent with PeopleSoft Query naming standards, it should not exceed 30 characters. The
following naming conventions apply to all CSU custom nVision Layout and Report filenames:

 Name Component           R   Description                                           Valid Values
 FACILITY                 R   ‘CSU’ for Baseline or Campus Abbreviation (see        CSU or Campus specific
                              Appendix B)                                           abbreviation (i.e. SB = San
                                                                                    Bernardino, FR= Fresno)
 UNDERSCORE               R   Separation                                            _
 DESCRIPTION              R   A description of the functionality of the layout or   (i.e. Job code by
                              report. Nvision can be used to automatically          FTE/Department)
                              generate Report Files with several different
                              variable filenames.
 File Name Extension      R   3 character file extension                            .xnv or .xls


Examples:
         CSU_Jobcode by Division.xnv                 CSU Custom Jobcode by Division Layout
         CSU_Jobcode for STAFFAIRS.xls               CSU Custom Jobcode for the Student Affairs Division
4.2.2    Crystal Reports
PeopleSoft Crystal Reports can have as many characters for their names as the current Operating System
allows. Each report name must be unique. In order to keep the name consistent with PeopleSoft Query
naming standards, it should not exceed 30 characters. The following naming conventions apply to all
CSU custom Crystal Reports:

 Name Component           R    Description                                          Valid Values
 FACILITY                 R    ‘CSU’ for Baseline or Campus Abbreviation            CSU or Campus specific
                               (see Appendix B)                                     abbreviation (i.e. SB = San
                                                                                    Bernardino, FR= Fresno)
 UNDERSCORE               R    Separation                                           _
 QUERY NAME               R    One or more of the queries that the report is        Developer Defined
                               built from.
 File Name Extension      R    3 character file extension                           .rpt


Examples:
         CSU_HEADCOUNT.rpt                           CSU Custom Headcount Report

NOTE – Custom Crystal Reports that are executed from a panel/page require a naming convention of 8
characters in length. The Crystal Report name should be the same as the Process Definition name (see
the section for Process Definition naming convention). This allows for the Process Scheduler to execute
the intended Crystal Report.



Last Revised: 12/17/10                                                                                  Page 33 of 50
CMS Central Application Development Documentation Standards                                                          FINAL



4.2.3    SQR Programs
PeopleSoft SQR programs can only have 8 bytes for their names and must be in lower case for Unix.
Each name must be unique. The following naming conventions apply to all CSU custom SQR programs:

 Name Component           R    Description                                             Valid Values
 FACILITY                 R    ‘CSU’ for Baseline or Campus Abbreviation               CSU or Campus specific
                               (see Appendix B)                                        abbreviation (i.e. SB = San
                                                                                       Bernardino, FR = Fresno)
 PRODUCT                  R    Two character Product Abbreviation (e.g., HR,           See Appendix C – Product
                               GL, etc.)                                               Suffixes
 SEQUENTIAL               R    Sequential number starting with ‘001’ that              001
 NUMBER                        identifies a specific CSU customization.
                                                                                       002
                                                                                       …
 File Name Extension      R    A three-character string that identifies the file as    sqr
                               an SQR program.


Examples:
         CSUPY001.SQR                       CSU Custom Payroll SQR Module
         CSUPR099.SQR                       CSU Custom Payroll SQR Module


4.2.4    SQC Include Files
PeopleSoft SQC programs can have as many characters for their names as the current Operating System
allows. Each program name must be unique. In order to keep the name consistent with other customized
filenames, it should not exceed 30 characters. The following naming conventions apply to all CSU
custom SQC programs:

Name Component           R    Description                                             Valid Values
FACILITY                 R    ‘CSU’ for Baseline or Campus Abbreviation               CSU or Campus specific
                              (see Appendix B)                                        abbreviation (i.e. SB = San
                                                                                      Bernardino, FR = Fresno)
DESCRIPTION              R    A description of the functionality of the program.      Developer Defined
File Name Extension      R    A three-character string that identifies the file as    .sqc
                              a SQC include program.


Examples:
         CSUPRINTP.SQC                      CSU Custom Printer Format SQC (Portrait)




Last Revised: 12/17/10                                                                                      Page 34 of 50
CMS Central Application Development Documentation Standards                                                     FINAL



4.2.5    Cobol Programs
PeopleSoft COBOL programs can only have 8 characters and each name must be unique. The following
naming conventions apply to all CSU custom COBOL programs:

 Name Component           R    Description                                           Valid Values
 FACILITY                 R    Constant ‘CS’                                         CS
 FILE TYPE                R    A single character that identifies the type of file   C = Cobol Copylib
                                                                                     P = Cobol Program
 PRODUCT                  R    Two character Product Abbreviation (e.g., HR,         See Appendix C – Product
                               GL, etc.)                                             Suffixes
 SEQUENTIAL               R    The numeric portion must be padded with               001
 NUMBER                        leading zeros to fill the eight-byte name.
                                                                                     002
                                                                                     …
 File Name Extension      R    A three-character string that identifies the type     .cbl
                               of data the file contains. When choosing a file
                               type, consider the default file type before
                               creating a new one. Using a default file type
                               helps to limit the number of unique file types
                               that reside on the system.


NOTE – COBOL programs should not be modified until a thorough analysis is done on the impact of the
modification. Also, the filename must be uppercase and file extension for COBOL programs must be
lowercase.
Examples:
         CSCPY001.cbl                       CSU Custom Payroll Copylib Module
         CSPPY001.cbl                       CSU Custom Payroll Program Module
4.2.6    SQR/COBOL Output Files
All output files should have the same name as the SQR/COBOL program that created them. If an SQR
program creates more than one output file, then append an alphabetic character to distinguish the file
names (a., b., c., etc.). The output files should have the appropriate file extension for the type of file
created (e.g., ‘CSV’ or comma delimited, ‘DAT’ for fixed length file format, ‘TXT’ for text, ‘LIS’ for
PeopleSoft SQR output and ‘SPF’ for SQR Viewer output).




Last Revised: 12/17/10                                                                                   Page 35 of 50
CMS Central Application Development Documentation Standards                                                   FINAL




4.2.7      Database Scripts
Database scripts are used to create/modify database objects, unload/load data in database tables, and
perform maintenance operations (apply grants, truncate tables, etc.). These scripts can be in Data Mover
format (executed with the PeopleSoft Data Mover PeopleTool) or Native Database format (executed with
the Oracle SQL*Plus tool).

 Name Component           R    Description                                          Valid Values
 Operation Prefix         R    The operation performed by the script                IM_ = Import
                                                                                    EX_ = Export
                                                                                    C_ = Create
                                                                                    A_ = Alter
                                                                                    D_ = Drop
                                                                                    L_ = Load
                                                                                    T_ = Truncate
 Version                  R    Identifies version 7 or 8                            _7, _8
 Database Object Name     R    The name of the database object                      Database Object Name
                               (tables/indexes) the script operates on.
 SEQUENCE                 O                                                         _1, _2, _3
 Date                     R    Date the script was created                          _MMDDYYYY
 File Name Extension      R    Three character file extension that identifies the   .dms = datamover format
                               type of database script
                                                                                    .sql = database format


Examples:
           IM_7_CSU_CAT_TERM_04292002.sql                        Database script to IMPORT the
                                                                 CSU_CAT_TERM table
           EX_8_CSU_PERM_EV_TBL_04292002.sql                     Database script to EXPORT the
                                                                 CSU_PERM_EV_TBL table
           C_8_CSU_PAY_DISTR_0_04292002.sql                      Database script to CREATE the
                                                                 CSU_PAY_DISTR table
           A_7_CSU_PAY_DISTR_0_04292002.sql                      Database script to ALTER the
                                                                 CSU_PAY_DISTR table
           D_7_CSU_SUPV_TEMP_0_04292002.sql                      Database script to DROP the obsolete
                                                                 CSU_SUPV_TEMP table
           L_8_CSU_PAY_DISTR_0_04292002.dms                      Data Mover script to LOAD the
                                                                 CSU_PAY_DISTR table




Last Revised: 12/17/10                                                                                  Page 36 of 50
CMS Central Application Development Documentation Standards                                        FINAL




4.3         Message Catalog
All error and warning messages should be stored in the PeopleSoft Message Catalog to avoid hard-coding
these within the PeopleCode. Using stored messages will also help to standardize the text used when an
error or warning condition applies to multiple fields, panels/pages or applications. The Message Catalog
Panel/Page is used to add messages to the system.

Navigate to this panel/page by
selecting
     Go
     PeopleTools
     Utilities
     Use
     Message Catalog
     Update/Display




The Message Catalog Panel/Page
displays:




NOTE - Any message set number above 24999 is reserved for custom messages. All custom messages
should be added to Message Set # 25000 and above.




Last Revised: 12/17/10                                                                       Page 37 of 50
CMS Central Application Development Documentation Standards                                            FINAL



To store a message in the PeopleSoft Message Catalog, the message key consists of a Message Set
Number and a Message Number. The standard sets of messages used in the Message Catalog are as
follows:

 Message Set # From        Message Set # To     Description
 00000                     19999                Reserved for PeopleSoft Messages
 20000                     20099                Global HR/PR Messages
 20100                     20199                Benefits Administration (BA) Messages
 20200                     20299                Human Resources (HR) Messages
 20300                     20399                Payroll (PR) Messages
 20400                     20499                Benefits (BN) Messages
 20500                     20599                Time and Labor (TL) Messages
 20600                     20699                Pension Administration (PA)
 20700                     20799                Flexible Spending Accounts (FSA) Messages
 20800                     20899                Payroll Interface (PI) Messages
 20900                     20999                Not Used
 21000                     21099                Global SA Messages
 21100                     21199                Admissions (AD) Messages
 21200                     21299                Campus Community (CC)
 21300                     21399                Degree Audit (DA)
 21400                     21499                Financial Aid
 21500                     21599                Student Financials (SF)
 21600                     21699                Student Records (SR)
 22000                     22099                Global FS System Messages
 22100                     21199                General Ledger (GL)
 22200                     22299                Accounts Payable (AP)
 22300                     22399                Accounts Receivable (AR)
 22400                     22499                Budget (BD)
 22500                     22599                Billing (BI)
 22600                     22699                Financials (FS)
 22700                     22799                Asset Management (AM)
 22800                     22899                Inventory (IN)
 22900                     22999                Project Control (PC)
 23000                     23099                Manufacturing (MG)
 23100                     23199                Order Management (OM)
 24000                     24199                Global Messages from Common Modules (HR, SA, FS)
 25000                     25999                All CMS Central Custom Human Resource Messages
 26000                     26999                All CMS Central Custom Benefits Messages




Last Revised: 12/17/10                                                                           Page 38 of 50
CMS Central Application Development Documentation Standards                                     FINAL




 Message Set # From        Message Set # To     Description
 27000                     27999                All CMS Central Custom Payroll Messages
 28000                     28999                Reserved for CMS Central
 29000                     29999                Reserved for CMS Central
 30000                     30999                Reserved for CMS Central SA
 31000                     31999                All Campus Custom Messages




Last Revised: 12/17/10                                                                    Page 39 of 50
CMS Central Application Development Documentation Standards                                           FINAL




Appendix A: Standard Word Abbreviations
PeopleSoft uses abbreviations in object names as needed. This is a list of standard abbreviations for
words that are only abbreviated when required by object length limitations. When an object name must
be abbreviated because of length limitations, the procedures for determining the correct name is as
follows:
    1. Use standard abbreviations until the name fits.
    2. Minimize the number of words abbreviated in a single object name. Rather than abbreviate every
       word in some way, abbreviate as few words as possible. Queries made against object names can
       anticipate that words are spelled out.
The Table below provides a list of standard abbreviations for words. In some cases, several words may
share the same abbreviation. Usually, other parts of the object name will help the abbreviation in context.

 Word                                     Abbreviation
 Account                                  ACCT
 Accounting                               ACCTG
 Accumulated                              ACCUM
 Acquisition                              ACQ
 Action                                   ACTN
 Additional                               ADDL
 Address                                  ADDR
 Adjustment                               ADJ
 Allocation                               ALLOC
 Amount                                   AMT
 Annual                                   ANNL
 Applicant                                APP
 Application                              APPL
 Approval                                 APPRVL
 Balance                                  BAL
 Bank                                     BNK
 Business Unit                            BU
 Calculation                              CALC
 Calendar                                 CAL
 Campus Object Migration Request          COMR
 Cash                                     CSH
 Category                                 CATG
 COBRA                                    CBR
 Code                                     CD
 Company                                  CO



Last Revised: 12/17/10                                                                         Page 40 of 50
CMS Central Application Development Documentation Standards         FINAL




 Word                                     Abbreviation
 Comparative                              COMPA
 Confirmation                             CONF
 Control                                  CNTL
 Conversation                             CNVR
 Convert, Conversion                      CNV
 Count                                    CNT
 Country                                  CNTRY
 Course                                   CRSE
 Coverage                                 COVRG
 Credit                                   CR
 Currency                                 CURR
 Current                                  CUR
 Customer                                 CUST
 Date                                     DT
 Day                                      DY,DD
 Debit                                    DR
 Deduction                                DED
 Default                                  DFLT
 Definition                               DEFN
 Department                               DEPT
 Dependent                                DEP
 Depreciation                             DEPR
 Description                              DESCR
 Destination                              DEST
 Detail                                   DETL
 Discount                                 DISC, DSCNT
 Distribution                             DIST
 Duplicate                                DUP
 Earnings                                 EARN
 Effective                                EFF
 Effective Date                           EFFDT
 Effective Date Sequence                  EFFSEQ
 Eligibility                              ELIG
 Employee                                 EE
 Employee ID                              EMPLID
 Employer                                 ER
 Financial                                FIN




Last Revised: 12/17/10                                        Page 41 of 50
CMS Central Application Development Documentation Standards         FINAL




 Word                                     Abbreviation
 Frequency                                FREQ
 Garnishment                              GARN
 Group                                    GRP
 Header                                   HDR
 Hours                                    HRS
 Identifier                               ID
 Injury                                   INJ
 Interface                                INTFC
 Inter-Unit                               IU
 Investment                               INVEST
 Invoice                                  INV
 Journal                                  JRNL
 Ledger                                   LED
 Length                                   LEN
 Limit                                    LIM
 Line                                     LN
 Location                                 LOC
 Maintenance                              MAINT
 Match                                    MTCH
 Maximum                                  MAX
 Messages                                 MSG
 Minimum                                  MIN
 Month                                    MN, MM
 Month-to-Date                            MTSD
 Number                                   NBR
 Operator                                 OPR
 Panel                                    PNL
 Parameter                                PARM
 Payment                                  PYMNT
 Percent                                  PCT
 Period                                   PD
 Period-to-Date                           PTD
 Position                                 POSN
 Process                                  PRCS
 Profile                                  PROF
 Quantity                                 QTY
 Quarter-to-Date                          QTD




Last Revised: 12/17/10                                        Page 42 of 50
CMS Central Application Development Documentation Standards         FINAL




 Word                                     Abbreviation
 Rate                                     RT
 Reason                                   RSN
 Received                                 RECV
 Reconciliation                           RECON
 Record                                   REC
 Reduction                                RED
 Re-evaluation                            RVL
 Reference                                REF
 Report                                   RPT
 Request, Required, Requisition           REQ
 Requirements                             RQMT
 Retire, Retirement                       RET
 Salary                                   SAL
 Schedule                                 SCHED
 Security                                 SEC
 Select                                   SEL
 Sequence                                 SEQ
 Session                                  SESSN
 Statistics                               STAT
 Summary                                  SUM
 Supervisor                               SUP
 Supplemental                             SUPL
 Template                                 TMPL
 Total                                    TOT
 Training                                 TRN
 Transaction                              TRANS
 Transfer                                 XFER
 Tuition                                  TUIT
 Unit of Measure                          UOM
 Vacation                                 VACN
 Vehicle                                  VEH
 Vendor                                   VNDR
 Voucher                                  VCHR
 Year                                     YR, YY
 Year-to-Date                             YTD




Last Revised: 12/17/10                                        Page 43 of 50
CMS Central Application Development Documentation Standards                                                   FINAL




Appendix B: Campus Abbreviations

    Abbreviation                     Description
    BAK                              Bakersfield
    CHI                              Chico
    CI                               Channel Islands
    COO                              Chancellor’s Office
    DH                               Dominguez Hills
    FR                               Fresno
    FUL                              Fullerton
    HAY                              East Bay (Formerly Hayward)
    3rd Party Objects: HAD, HCY,
    HSR, HFA, HTC, HSF, and HAA1
    HUM                              Humboldt
    IDC                              IDC (Cashnet: Vendor Abbreviation)
    LA                               Los Angeles
    LB                               Long Beach
    MA                               Maritime Academy
    MB                               Monterey Bay
    NR                               Northridge
    POM                              Pomona
    R25                              CollegeNET PSSA-R25 Interface
    SAC                              Sacramento
    SB                               San Bernardino
    SND                              San Diego
    SFO                              San Francisco
    SJ                               San Jose
    SLO                              San Luis Obispo
    SMA                              Sonoma/Maritime Academy
    SMO                              San Marcos
    SON                              Sonoma
    STA                              Stanislaus




1
 Additional campus prefixes for East Bay (formerly Hayward) are only approved for 3 rd party objects (sqr, Crystal,
nVision)


Last Revised: 12/17/10                                                                                 Page 44 of 50
CMS Central Application Development Documentation Standards                                        FINAL




Appendix C: Product Suffixes
Product Suffixes are used when a functional area applies to many products. The following are the product
suffixes:

 Abbreviation                      Description
 AA                                Academic Advisement
 AB                                ABS Modification
 AD                                Admissions
 AM                                Asset Management
 AP                                Accounts Payable
 AR                                Accounts Receivable
 AW                                Administer Workforce
 BA                                Benefits Administration
 BB                                Base Benefits
 BD                                Budget
 BE                                Budgets & Encumbrances
 BI                                Billing
 BN                                Benefits
 CC                                Campus Community - HR
 CCS                               Campus Community - SA
 CF                                Chartfields
 CM                                Common Modules
 CS                                Campus Systems
 DA                                Degree Audit
 ES                                Education Services
 FA                                Financial Aid
 FS                                Financials
 FSA                               Flexible Spending Accounts
 GL                                General Ledger
 HR                                Human Resources
 IN                                Inventory
 KK                                Commitment Control
 LA                                Leave Accounting
 MG                                Manufacturing
 OM                                Order Management
 PA                                Pension Administration
 PC                                Position Control




Last Revised: 12/17/10                                                                       Page 45 of 50
CMS Central Application Development Documentation Standards               FINAL




 Abbreviation                      Description
 PI                                Payroll Interface
 PO                                Purchasing
 PY                                Payroll
 RR                                Report Regulations
 RW                                Recruit Workforce
 SA                                Student Administration
 SEC                               Security
 SF                                Student Financials
 SR                                Student Records
 SV                                SEVIS
 TF                                Temporary Faculty Modification
 TL                                Time and Labor
 WS                                Work Study Modification




Last Revised: 12/17/10                                              Page 46 of 50
CMS Central Application Development Documentation Standards                                                    FINAL




Appendix D: Record Prefixes and Suffixes

 Abbreviation                      Description
 Prefixes
 WEBLIB_                           Used to create WEBLIB records. Always start with the prefix “WEBLIB” (e.g.,
                                   WEBLIB_LB_CASHNET). Do not start with the identifying campus
                                   abbreviation.
 Suffixes
 _DVW                              Identifies a dynamic view
 _FUNCLIB_CSUx                     Function Library. Record containing PeopleCode functions that are shared
                                   across an application; normally, one per product.
 _LNG                              Related language record.
 _SBR                              Identifies record definitions created as sub-records.
 _SBP                              Identifies a sub-panel record.
 _SRCH                             Search record; usually associated with a view. This is not always required
                                   since a lot of views are also used as search records. Views will usually have
                                   the _VW suffix.
 _TBL                              Can be used to identify an edit or prompt table that contains data used for
                                   validation, as opposed to data maintained by the application. Suffix is not
                                   always required. It is recommended where the suffix will help distinguish it
                                   from the application table. For example, you may want to track all the skills an
                                   employee has in the SKILL table. You can then use SKILL_TBL to store all
                                   the codes defining the various skills such as typing and programming.
 _TMP                              Temporary records used by batch processing.
 _VW                               Identifies a record definition that is physically implemented by defining a SQL
                                   view.
 _WL                               Identifies a worklist record definition.
 _WRK                              Identifies record definitions created as derived/work records for online
                                   processing.




Last Revised: 12/17/10                                                                                  Page 47 of 50
CMS Central Application Development Documentation Standards                                              FINAL




Appendix E: Field Suffixes

 Suffix     Type          Definition                                               Example
 AMT        Amount        Numeric value of currency type                           ITEM_AMT
 CD         Code          User-defined value determined by a Translate Table       EXPENSE_CD
                          or other code table
 CNT        Count         Numeric value containing a count                         FORM_ASSIGNMENT_CNT
 DT         Date          Date value of format YYYY-MM-DD                          BEGIN_DT
 DTTM       DateTime      Date and time value of format YYYY-MM-DD and             LAST_UPDATE_DTTM
                          HH:MM:SS.ttt
 FLG        Flag          User can select one of the possible values defined for   CREDIT_MEMO_FLG
                          field. Usually has more than 2 values. Also see SW
                          (switch)
 ID         Identifier    Value used to make reference unique.                     PROJECT_ID
 SW         Switch        Field typically has two values. It usually is a Yes or   TAX_CREDIT_SW
                          No switch
 PCT        Percent       A percentage value stored internally as a decimal        CHANGE_PCT
                          (e.g., 50% is stored as .5)
 RT         Rate          Numeric field expressing an amount per some unit of      CUR_EXCHNG_RT
                          coverage
 TM         Time          Time field measured in hours, minutes, and seconds       STRT_TM




Last Revised: 12/17/10                                                                             Page 48 of 50
CMS Central Application Development Documentation Standards                                     FINAL




Appendix F: Field Definition Change Matrix

                                       Table Structure              Indexes
                                        (Requires SQL            (Requires SQL
            Characteristics          CREATE/ALTER table)      CREATE/ALTER index)   Online System
 Field Characteristics
 Field Name                                                           
 Field Type                                                           
 Field Length                                                         
 Help Context                                                                            
 Short Name                                                                              
 Long Name                                                                               
 Use Characteristics
 Add/Delete Key                                                        
 Add/Delete Duplicate Order Key                                        
 Add /Delete Alternate Search Key                                      
 Add/Delete Desc Key                                                   
 Add New Search Key                                                    
 Change Key Order                                                      
 List Box Item (if new key)                                                             
 Auto-Update                                                                             
 Defaults                                                                                
 Audit                                                                                   
 Help Context                                                                            
 Edits Characteristics
 Required Field (not char or                    
 numeric)
 Required Field (char or numeric)                                                        
 Edits                                                                                   
 Reasonable Date Check                                                                   
 PeopleCode                                                                              




Last Revised: 12/17/10                                                                    Page 49 of 50
CMS Central Application Development Documentation Standards                                       FINAL




Appendix G: Designing for Accessibility
The following resources should be used by developers to understand the requirements for delivering an
accessible product.


Oracle Accessibility Program
CMS works closely with Oracle, the provider of our Financials, Human Resources, and Campus
Solutions products to ensure that the delivered product software meets accessibility standards,
and to apply their published development standards to the CMS Baseline.
   Oracle Accessibility Program
    Link to the Oracle website accessibility program information

   Voluntary Product Accessibility Templates (VPAT)
    Lists the Oracle Product Accessibility Status for each bullet of the Section 508 requirements.

Oracle Accessible Development

   Application Developer PeopleBooks - Tools 8.5 (.pdf)New
    See Chapter 8s: Developing Accessible Page

   PeopleTools 8.5 VPAT New
    Changes that Oracle put into place with the delivery of the 8.5 toolset.

Additional Training Resources

The following links are additional resources that can be utilized to obtain accessibility training.

Software Development

   508 In Depth

   Web Aim Section 508 Checklist

   Software Accessibility Guidelines




Last Revised: 12/17/10                                                                      Page 50 of 50

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:3
posted:2/12/2012
language:
pages:54