Sunteți pe pagina 1din 35

VCCS Technical Standards Contents This page was last modified on 07/29/05.

General New Projects Converting Existing Customizations New Documentation Location External Vendors and Consultants Technical Documentation Application Object Types Project Menu Field Record PeopleCode Page (Panel in v 7.6) Component (Panel Group in v 7.6) Process Definition Query Component Interface Crystal Reports SQR and SQC Programs Required SQCs File Transfers/Interfaces Moving Source Code Process Scheduler Testing Move Instructions Projects Queries Changes to PeopleSoft Objects History of Changes VCCS Naming Conventions PeopleSoft Naming Conventions Appendix College Abbreviation List General These Technical Standards apply to documentation of the technical changes (custo mizations) made to the VCCS SIS. This is a companion publication to the Function al Standards and Conventions for functional (user) documentation which appear el sewhere on this website. If there are any questions about these Standards, pleas e contact VCCS Change Control staff to schedule a meeting.

Any issue not directly addressed by this document should be referred to the VCCS ITS Management Staff for resolution. TOP New Projects To initiate a new project, open an IssueTrak ticket. Go to the Reports section o f the Queries and Reports site and submit a Report Catalog Entry form (web form) . If the project is a college-specific customization, proceed with development of the project. If the project has system-wide scope, please schedule a review w ith VCCS ASC staff. Converting Existing Customizations All program source code will be maintained only on the central UNIX server in Pe opleSoft Version 8 and cannot be run from college file servers. In order to succ essfully run any custom SQR and/or SQC programs, colleges will need to add them to the VCCS College Menu. Some SQR programs, that may commonly be used by other colleges, can be added to the VCCS Custom Menu. Colleges should review the functionality in PeopleSoft version 8 and determine i f existing custom SQR programs are still needed or if delivered functionality ca n be used instead. If modifications were made to PeopleSoft-delivered SQR programs in version 7.6 a nd run from a college server or client PC without changing the name of the SQR ( using the delivered name), these SQRs will need to be renamed in version 8. Refe r to SQR and SQC Programs section for more information. For reports that are gene rated through push buttons (examples: transcript request and student receipt), colleges who wish to use a custom version of the report may submit a request thr ough IssueTrak. Adding new customizations to version 8: Any college-custom SQRs that have been running on the client in version 7.6 will need to be added to a menu in version 8. Please refer to the VCCS Naming Convent ions section for guidelines on naming SQRs, Crystal Reports and application objec ts. Any naming exceptions must be submitted to and approved by ITS Management. To add a custom SQR to the VCCS College menu or VCCS Custom Menu, follow these s teps in the Application Designer on the client: Create new project Create new (or use existing - preferred when possible) run control record Create new (or clone and rename another existing) run control page (panel) Create new (or add page to an existing) component (panel group) Create new process definition Add component to appropriate menu One run control record and page may be used for multiple processes. To do this, list the same component (panel group) in the process definition for each of the custom SQR processes. The only requirement is that each of the custom SQR progra ms use the same run control record. In addition, each custom SQR program should include the necessary prompts that w ill enable other colleges to use them. For instance, Institution or Business Uni t are common run control parameters that should be included as prompts. These va lues should not be hard coded in the SQR program.

Important Note: Customizations with the VC prefix do not have to be renamed, unles s they need a modification in version 8. In that case, the new naming convention s contained in this document should be used. TOP New Documentation Location A new Technical Documentation folder has been created for version 8 Technical docu ments. All technical documents for version 8 customizations should be placed in the following folder: \\newpsoft on ut21\ASC Development Documentation\Version 8\Technical Documentatio n. A new Testing Plans folder has been created for version 8 Testing Plan documents. All Testing Plan documents for version 8 projects should be placed in the follow ing folder: \\newpsoft on ut21\ASC Development Documentation\Version 8\Testing Plans A new Move Instructions folder has been created for version 8 Move Instruction doc uments. All Move Instruction documents for version 8 projects should be placed i n the following folder: \\newpsoft on ut21\ASC Development Documentation\Version 8\Move Instructions. External Vendors and Consultants College should provide a copy of these Technical Standards to any external vendo r and/or consultants that will be performing development work in the PeopleSoft Student Administration application. External vendors and consultants must follow these standards when creating or modifying PeopleSoft objects and programs. Technical Documentation Technical documentation should be in the form of a Word Document. The document s hould be named with the name of the project and the description of the project. Heres a sample suggested format for the Technical document. Colleges may use what ever format they prefer for the document. * * * S A M P L E * * * Project ID: VX62477 <VX + IssueTrak#> Developer: Linda Silver Institution: VCCS (for ME299) Module: Student Financials Navigation: Home>Manage Student Financials>Bill Customers>Process>Billing Re quest Corp Project Description: VX62477_ME299_CORP_INVOICE Added college custom SQR program to Billing Request Corp component so it can be run from the menu in PeopleSoft Objects and Programs List: <List all application objects, queries, programs , etc. created and/or modified by this project> New Process Definition: VXJFBILL New SQR Program vxjfbill.sqr This program is in production in version 7.6 under the name of vsf019.sqr, it was run from the colleges server. The program has been renamed and modified to run in

version 8, with the following changes: One field, REVERSAL_IND renamed to SF_REVERSAL_IND on PS_ITEM_XREF record by PeopleSoft version 8 Include statement modified from Stdapi.sqc to stdapi.sqc (UNIX server is cas e sensitive) TOP Unit Test Plan: Verify that program runs from the menu (see navigation above) successfully Work with Mountain Empire IT and Business Office staff to validate that corr ect data appears on the invoice. * * * E N D O F S A M P L E * * *

Technical documents should be placed in the following folder: \\newpsoft on ut21\ASC Development Documentation\Version 8\Technical Documentatio n The architecture of all customizations should be bolt ons; that is, if a new func tion is required or a change to an existing function is needed, the objects will be considered new and are placed on the VCCS Menu. All objects of this nature wil l have VX prefixed names. Typically, these are SQR and SQC programs, Crystal rep orts and Queries. Review the VCCS Naming Conventions and the PeopleSoft Naming Conventions sections be fore creating any new items. Ensure that you update the Object Comments section for all objects that you change. The comments should include the Project ID, dat e, resource name who is making the change, and description. This same process sh ould be done for other items (Queries, SQR programs, etc) in their appropriate co mments area. When the project is complete, update the IssueTrak Solution. Always use the Insert object into project option in Application Designer for all o bjects except Menus. Menus should not be included in projects. All other object types must be inserted in the project. PeopleCode will not be automatically inse rted in the project; it must be a conscious effort. Be sure to only include new objects created and/or objects modified in this project. Do not include objects that currently exist in PeopleSoft and no change has been made to these objects in the project. Include a description of each object that is new or modified. Application Object Types Use these guidelines when creating new objects or renaming objects in Applicatio n Designer. PeopleSoft-delivered objects and objects that are not part of the pr oject should not be renamed. All projects and objects in PeopleSoft Application Designer should have a descri ption under properties. The description will appear in the dialog box when a pro ject or object is opened. The description should be brief, but descriptive. Refe r to the PeopleTools training manual(s) for instructions on how to insert descri ptions in object and project properties. Project All customizations should be contained in projects. See naming conventions below

. New projects should be named with a prefix of VX, followed by the IssueTrak numb er (no space). Example: VX61797. This schema will identify the object as a VCCS modification. All projects must be exported to a shared folder on a drive that i s backed up nightly. It is important that a description and comments are added to the Project Propert ies new or modified projects. The description will appear in the dialog box (nex t to the Project ID). Do not include the description in the Project ID. The desc ription and comments should include: TOP Project ID Date Developers Name Institution Description of new object or modifica tion Example: Menu Do not attach any PeopleCode to Menus. Menus will not be migrated, instructions should be included on the Move Instructions document explaining which menu and m enu bar item that the component should be listed under. Refer to Move Instruction s section for details. Field New fields should be named with a prefix of VX_ (uppercase). It is important that a description and comments are added to the Object Properties of any new objects created or any objects that are modified. The description and comments should i nclude: Project ID Date Developers Name Institution Description of new object or modifica tion Example:

Record New records should be named with a prefix of VX_ (uppercase). It is important that a description and comments are added to the Object Properties on any new object s created or any objects that are modified. The description and comments should include: Project ID Date Developers Name Institution Description of new object or modifica tion Example: New custom records should be set to a Tablespace of VCDATA, before the record is b uilt. To set TableSpace, the custom record must be open in Application Designer. Go to Tools, Data Administration, Set TableSpace. Select VCDATA from the dropdown box for the Space Name. Refer to screenshot (below). New custom records should be assigned an Index of VCINDEX, before the record is bu ilt. To set the Index, the custom record must be open in Application Designer. G

o to Tools, Data Administration, Indexes. Click Edit DDL button at bottom of scr een. Refer to screenshot (below). Highlight the line under the Oracle platform, with the parameter name of INDEXSP C, then click the Edit Parm button. Enter VCINDEX for the override value and click OK. Confirm that VCINDEX appears in the override value column. Click OK button twi ce to close the dialog boxes. Refer to screenshots (below).

If assistance is needed, contact ITS Management staff. TOP PeopleCode Comments should be added at the top of any new PeopleCode or modifications to Pe opleCode, using this format: /*Project ID Date Developers Name Institution Description of new object or modifi cation MODN #0001*/ Each new modification should be given the new sequential MODN #. This makes it e asier to search within the peoplecode and find a specific MODN #. Retain the original PeopleCode and make a note that it is the original code in y our comments. Use comment lines (/*) before and (*/) after the customization to signify the beginning and end of the modification. Example: /*Begin MODN #0001 - VX12345 */ CODE MODIFICATION /*End of MODN #0001 - VX12345*/ Page (called Panel in version 7.6) New pages should be named with a prefix of VX_ (uppercase). It is important that a description and comments are added to the Object Properties on any new objects created or any objects that are modified. The description and comments should in clude: Project ID Date Developers Name Institution Description of new object or modifica tion Example: Component (called Panel Group in version 7.6) New components should be named with a prefix of VX_(uppercase). It is important th at a description and comments are added to the Object Properties on any new obje cts created or any objects that are modified. The description and comments shoul d include:

Project ID Date Developers Name Institution Description of new object or modifica tion Example: Process Definition New process definitions should be named the same as the process (i.e., SQR Repor t, SQR Process, COBOL or App Engine program or Crystal Reports). Example: Process Definition for VXREVSUM Crystal Report should be VXREVSUM. On the Process Definition Options Page Always select the Server for the Run Location. Select PSUNX as Server Name -- for processes run on central UNIX server (such as S QR, App Engine or COBOL) Select PSNT as Server Name for Crystal Reports (that will run from a menu within P eopleSoft) Select SAALL for the Process Group. In addition, insert another row and select the Process Group (from list below) that includes the functional area that this pro cess pertains to. FAALL Financial Aid SFALL Student Financials SRALL Student Records, Admissions, Advising TOP Query Any custom queries which are being used by colleges in PeopleSoft version 7.6, w ill need to recreated in PeopleSoft version 8 SP1. Queries can not be migrated f rom the previous database version to the new version. ITS staff have been workin g with colleges to develop some commonly used queries which are available to all colleges. These queries have a prefix of VX_. A list of these version 8 VCCS comm on queries is available at this website: http://164.106.10.30/QueriesAndReports Any other custom queries must be recreated by the colleges and the query name mu st begin with a 2 character college identifier. Refer to the College List in the Appendix; e.g., BR291 would have a 2 character identifier of BR. A revised proces s for requesting that queries be moved into Production will be forthcoming. Performance criteria for queries will be defined. Minimally, colleges should ens ure that queries do not timeout in Development or Test and do not contain an exc essive number of table joins. Component Interface New component interfaces should be named with a prefix beginning with VX_. Crystal Reports

New custom Crystal Reports can either be run within PeopleSoft (from a menu) or outside of PeopleSoft (on the client). New Crystal Reports should be named with a prefix of VX. Colleges should follow the naming conventions defined VCCS Naming Conventions (at the end of this document) for any Crystal reports that are to be run from a menu in PeopleSoft. For those that will be run outside of PeopleSoft, colleges shoul d begin the report name with the first 8 characters following the guidelines at the end of the report (must be unique). After these 8 characters, colleges may a dd an underscore and use the remaining character limit for a better description, if desired. Colleges should create a new process definition for any new custom Crystal Repor ts that will be run from a PeopleSoft menu. The Process Type should be Crystal. On the Process Definitions Options Page, the Run Location should be Server and the S erver Name should be PSNT. Refer to screenshot (below). The process definition sho uld be given the same name as the Crystal Report (example: VXREVSUM). A new component and page must be created to hold the run control parameters. The component must be attached the menu. All of these application objects (includin g the process definition) should be included in a new project. Please refer to t he PeopleTools training class manual for specifics on how to create or modify an y of these application objects. Example: SQR Programs Colleges should refer to the VCCS Naming Conventions section for guidelines on nam ing new custom SQRs and SQCs. When a PeopleSoft-delivered program (SQR or SQC) i s modified, a new name must be assigned so that source code is not accidently lo st or overwritten. Refer to the PeopleSoft Naming Conventions for suggestions on appropriate names that will make it easier to identify the process or business. Names should not contain blanks or special characters. All names need to be rev iewed by VCCS ITS Management Staff before development begins. This will assure t hat liked named programs are not accidently overwritten. All SQR program names m ust be in lowercase. New custom SQR programs should not contain any hard coding (such as data values, file paths or filenames). Prompts should be added to the program and the run co ntrol page for key fields (such as Business Unit, Institution, etc.) so that oth er colleges could use the program. All SQRs must be run from a central UNIX server in PeopleSoft version 8 and laun ched from a PeopleSoft web page from within the application. SQRs can no longer be run on the client and PeopleSoft no longer bundles client SQR capability with the client installation. Any custom SQRs that were run on the client outside of the PeopleSoft application will need to have the necessary run control records, pages, components, and/or process definitions created and attached to either th e VCCS or College Custom Menu. These SQR programs must be modified to include st andard process scheduler logic (explained below). Modifications to read paramete rs from run control records will probably be needed as well. Important Note: The names of any SQCs included in a SQR program (using Include s tatement) must be in lowercase or the program will fail. Future plans are to consolidate all custom run control records into just a few p er functional area. This will not take place until well after Version 8.0 implem entation and will be coordinated by VCCS ASC.

TOP Required SQCs It is important that the name of any SQC programs included in a SQR program be i n lowercase or the program will fail. There are 2 SQC programs that must be incl uded in every SQR program, they are: stdapi.sqc vx9000.sqc SQC Procedure Description stdapi.sqc Do Stdapi-Ini PeopleSoft standard Process Scheduler Initializa tion Procedures stdapi.sqc Do Stdapi-Term PeopleSoft standard Process Scheduler Terminatio n Procedures vx9000.sqc Do P9000-Get-Sys-Info Custom logging statement designed to hel p in customer support and troubleshooting The Stdapi-Init procedure should be called at the beginning of the program to star t process scheduler and the Stdapi-Term procedure should be called at the end of t he program to end the process scheduler. If these procedures are not called by t he program, it will fail to process. The vx9000.sqc program contains procedures that generate system information at the top of the program log file that can be helpful in resolving support issues. Th e P9000-Get-SysInfo procedure should be included in the every custom SQR program. This procedure should be called near the beginning of the program, either at the end of the initialization procedure or after the Init-Report procedure in the p rogram. Example #1 of Program Logic (procedures calling these 3 required SQC procedures) Begin-Program do Init-Report do Stdapi-Init do P9000-Get-SysInfo << new procedure do Process-Main do Stdapi-Term End-Program File Transfers/Interfaces To transfer a file from the NT (network) drive to the central UNIX m the central UNIX server to a NT (network) drive, colleges should m File Transfer Process developed by VCCS ITS staff for version 8. m process that transfers a file from NT to UNIX or from UNIX to NT is Custom File Transfer Process. server or fro use the Custo Any new custo should use th

College IT staff will need to help users complete the initial File Transfer Setu p page which contains specific details on the file path/name, type of file trans fer, etc. No further programming is needed by college IT staff. Functional users can run the Custom File Transfer process. Details on how to setup and use the g eneric file transfer process and what to incorporate into new custom SQR program s can be found in the following document: \\newpsoft on ut21\ASC Development Documentation\Version 8\Technical Documentatio n\ VX61797_Custom_File_Transfer_Process.doc

Here is a high-level overview of how the process works: Transfer a file from NT (network) to UNIX (Transfer IN) Create Setup (if new file transfer) college IT needs to help with this specify path/name where files located on NT (network) specify path/name where file will be placed on UNIX server Run the Custom File Transfer Process (VXFLTRAN) file will be moved to specified path/name on UNIX server View Inquiry page copy UNIX file path/name paste UNIX file path/name on run control of process that needs to run ne xt Run delivered or custom process Picks up file from specified path/name on UNIX server) Transfer a file from UNIX to NT (network) (Transfer OUT) Create Setup (if new file transfer) college IT needs to help with this specify path/name where file is located on UNIX server o specify path/name where file will be placed on NT View Inquiry page copy UNIX file path/name paste UNIX file path/name on run control of process that needs to run ne xt Run delivered or custom process Creates file in path/name on UNIX server Run Custom File Transfer Process (VXFLTRAN) file is moved to specified path/name on NT (network) The Custom File Transfer File can be used to move multiple files for a PeopleSof t-delivered process. A Setup must be created for each file path/name and given a unique sequence number. A Setup must be created for the file that contains a li st of the file path/names of each of the multiple files that will be moved. TOP Moving Source Code to UNIX Server Colleges should use the custom Source Control process being developed by VCCS IT S staff to copy source code files (i.e., SQR and SQC programs, Crystal Reports, etc.) from their NT directory to the central UNIX server development environment for testing. This process will also enable colleges to copy source code files f rom production to their NT (network) directory. Further details to be provided. Process Scheduler Create a new Run Control ID the first time you run a new process or report. A Ru n Control ID should contain a minimum of three characters in length and is case sensitive. Special characters should not be used. Once a Run Control ID is estab lished it can be used to run any PeopleSoft process or report. Choose a Run Cont rol ID that is easy to remember. On the Process Scheduler Request page, always select the Server Name PSUNX. For Pr ocess Type of SQR Report and Crystal Report, select Web for the Type and PDF for the Format. For the Process Type of Application Engine or COBOL processes, leav e Type set to None and Format set to None. PeopleSoft version 8 sends all SQR output (reports, program logs, flat files, et

c.) to a Report Repository that can be viewed on the web. Testing A separate document should be created for the Testing Plan for the project. Desc ribe the business application that this customization resolves. Depict the flow of the entire procedure, including intervening functional processes when appropr iate. Outline the method for testing the customization. Use a Word document to d escribe the order and details of any procedure used. Include or describe the sam ple test data used to validate the customization. The Testing document will be named with the name of the project (see above), fol lowed by a suffix of T to indicate Testing, then any descriptive name that is desire d. Place the document in the following network directory: \\newpsoft on ut21\ASC Development Documentation\Version 8\Testing Plans Move Instructions Projects Create a separate Word Document for the Move Instructions. Move instructions are needed for all projects except Query Migration. In its simplest form, a screen shot as described below may be all that is necessary. If there are special instr uctions, include them after the screen shot. The document should be named with the name of the project (see above), followed by a suffix of M to indicate Move Instructions, then any descriptive name that is de sired. Place the document in the following network directory: \\newpsoft on ut21\ASC Development Documentation\Version 8\Move Instructions. Fully describe all the objects that need to be moved in the project from one ins tance of the database to another. Include a count of all objects within the proj ect. The following is a sample vanilla Move Instructions that will apply to most customizations; however, some may require special actions such as a COBOL compi le, BUILDS, etc. Include these in the correct sequence. In the IssueTrak Next Action note, specify the from and to instances of the data base and reassign the Issue to the Change Control staff. * * * S A M P L E * * * Move Instructions - VX22576_STUGROUP_PSPATCH Be sure that you include the Output Window in the screen shot(s) and the results tab, not just the Project Workspace. The Project Workspace does not include all object types; e.g., Business Processes, Process Definitions, Queries, etc. To g et the correct values, open the project and click on the update tab. Immediately make a screen shot; it may take more than one screen shot to include the comple te Project Workspace and Output Window. The names of all objects in the project need to be listed in the Technical Docum ent. Also include in the Move Instructions document the names of SQRs, SQCs and Cryst al Reports that need to be moved to the next instance of the database. Changes t o MACROs need special instructions for their distribution and upgrade. Please con sult the ITS Management Staff for details.

If your customization included the addition of a field to a record, document the Build, Alter instructions; if it included the addition of a new record, documen t the Build, Create instructions. If the project includes Views, document the order in which the tables must be bu ilt. Document the source and nature of any Data Mover Scripts in the project. The scr ipts should have a meaningful name preceded by the Project number. Provide instructions for moving HTMLs from one instance of the database to anothe r. Note any changes that must be made to the Access Groups, as this will require ch anges by the Security Administrator. * * * E N D O F S A M P L E * * * TOP Queries Colleges who wish to have queries that are created and tested in Development and migrated to the Production SIS should proceed with the following Steps. Review Queries to insure there are no hard coded variables that should be su bstitution variables, excessive numbers of table joins (greater than 5), and poo r query construction, for example, sub selects that cause table scans for large tables. Test the query or report to ensure that it generates the appropriate results . Submit an IssueTrak to your CSL with the Query/Report Migration Form (web fo rm). Submit the Query Migration Form (web form). Include the test parameters in the Query Migration Form so they may be used when testing the query. Once approved by ITS staff, the queries will be moved from Development to Produc tion. Changes to PeopleSoft objects Changes made to PeopleSoft delivered code need to record the original PeopleSoft name and the VX name. Describe how the object was changed. In those cases where bolt on clone approach is not the best or safest approach, consult the ITS Manageme nt Staff. Upon approval by the appropriate governance, a change to a delivered SQR should be made as follows: Copy the delivered SQR to the user/SQR folder but do not change the name Make the change to the SQR and add comments to the beginning of the code. Update the Customization Objects spread sheet in the Customizations folder o n the ASC shared drive. If no changes were made to the PeopleSoft delivered code, put Not applicable under this item. History of changes

Add a new comments box after the last one to describe the changes made under thi s Issue Trak. VCCS Naming Conventions The following naming conventions should be followed for new custom SQR programs and Crystal Reports. The names should be 7-8 positions in length, as follows: 1st 2 positions = VX 3rd position = FRS college letter designation (List appears at end of this d ocument), ASC ITS designation will be X 4th position = R for Records, F for Financials, A for Financial Aid, V for Advising and M for Admissions 5th thru 8th position = 3 to 4 numbers or characters (taken from delivered p rocess name) Example #1: V 7.6 Crystal Report is: SR201.rpt V 8 college custom name would be: VXXR201 .rpt (custom Student Records process developed by ASC ITS) Example #2: V 7.6 program name is: SFAPRFND.sqr V 8 college custom name woul d be: VXCFRFND.sqr (custom Student Financials process developed by CVCC) Review the documentation in the PeopleSoft Naming Conventions document for names for objects. No names should contain blanks or special characters. All names ne ed to be reviewed by the Change Control staff prior to beginning development. For new records and fields and other application objects, refer to Application Ob jects Types section (above) for instructions on naming conventions. This schema w ill identify the object as a VCCS modification. For Queries, the name starts with a college identifier and an underscore; e.g., TC295_ACADEMIC STANDARDS. Common queries ASC ITS begin with a prefix of VX_. Howe ver, if these queries are attached to a Crystal Report that is run from a People Soft menu, follow the naming conventions under the Crystal Reports section (above) . If colleges have questions about these Standards, a meeting should be scheduled with the Change Control staff to answer their questions. TOP PeopleSoft Naming Conventions The field and record definition naming standards described in this Appendix appl y to names for fields and records used within PeopleSoft software. Abbreviations PeopleSoft uses abbreviations in object names as needed. We use a list of standa rd abbreviations for words that are only abbreviated when required by object len gth limitations. When an object name must be abbreviated because of length limit ations, the procedure for determining the correct name is the following: Use standard abbreviations until the length of the name is less than 19 char acters.

Minimize the number of words abbreviated in a single object name. Rather tha n abbreviate every word in some way, abbreviate as few words as possible. So, qu eries made against object names can anticipate that words are spelled out. This section provides lists of standard abbreviations for words. In some cases, several words may share the same abbreviation. Usually, other parts of the objec t name will help place the abbreviation in context. You can make additions to th is list by submitting requests to the development team librarian. 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 Balance BAL Business Unit BU Calculation calc Calendar CAL Catalog CAT Category CATG Cause CSE COBRA cbr Code CD

Column COL Command CMD Company CO Comparative compa Confirmation conf Control CNTL Conversation CONVR Conversion / Convert CNV Course crse Coverage covrg Create CRE Credit CR

Currency CURR Current CUR Customer CUST Date DT Day DY, DD Debit DR Deduction ded Default DFLT Defect DEF Definition DEFN Department DEPT Dependent DEP

Depreciation DEPR Description DESCR Destination DEST Detach DTCH Detail DETL Discount DISC Display DISP Distribution DIST Duplicate DUP Earnings earn Effective EFF Effective Date EFFDT

Effective Date Sequence EFFSEQ Eligibility elig Employee EE Employee ID EMPLID Employer ER Equation EQ Error ERR Evaluation EVAL Feature FEAT Financial FIN Flowstep FLOW Frequency FREQ

Garnishment garn Group GRP Header HDR Hours HRS Identifier ID Incomplete INC Injury inj Inspection INSP Inter-Unit IU Interface INTFC Investment invest Journal JRNL

Layout LAY Ledger LED Length LEN Limit LIM Line LN Location LOC Lower Acceptance Limits LAL Lower Specification Limits LSL Maintenance MAINT Maker MKR Maximum MAX Measurements,Features,Dimensions,Specifications MFDS

Messages MSG Minimum MIN Modify MOD Monitor MNTR Month MN, MM Month-to-Date MTD Number NBR Observation OBSERV Operator OPR Order ORD Parameter PARM Percent PCT

Period PD Period-to-Date PTD Points PTS Position posn Preference PREF Preliminary PRELIM Priority PRIO Procedure PRCD Process ID PROC Product PROD Profile PROF Quantity QTY

Quarter-to-Date QTD Queue QUE Rate RT Reason RSN Recalculate RECALC Received RECV Reconciliation RECON Record REC Reduction RED Reference REF Report RPT Request / Required / Requisition REQ

Requirements rqmt Resource RES Result RSLT Retire / Retirement RET Salary sal Schedule sched Security SEC Select SEL Sequence SEQ Session sessn Specification SPEC Statistics STAT

SubGroup SGRP Summary SUM Supervisor SUP Supplemental supl Synchronize SYNC Template TMPL Total TOT Training trn Transaction TRANS Transfer XFER Tuition tuit Unit of Measure UOM

Upper Acceptance Limits UAL Upper Specification Limits USL Vacation vacn Variable VAR Vehicle veh Violation VIO Year YR, YY Year-to-Date YTD TOP Field Naming Standards This section describes field-naming standards. Reserved Words Certain words are reserved by programming languages and database management syst ems as keywords (command verbs) and cant be used as names of database objects suc h as databases, tables, rules, defaults, columns, and so forth. For example, the words read and write are reserved as keywords in COBOL, so you should not name fields in record definitions READ or WRITE. To avoid this problem, we recommend that you do not use English words as names of objects. For example, instead of n aming a field TRIGGER, you should name it TRIGGER_FLG. You can, however use rese rved words for the names of local variables and for stored procedure parameter n ames. Please refer to your Administration Tools for a list of reserved words for your database platform.

Underscores Underscores are used to break up data names, such as NEXT_EXAM_DT, wherever a sp ace would normally be used in a written name. Field Lengths To facilitate double-byte character set, field length should be even, not odd. F or example, BLDG is defined as 6-character field. In double-byte character set, 3 characters can be entered. However, if BLDG is defined as a 7-character field, in double-byte character set, only 3 characters can be enteredessentially one by te of space is wasted. Standard Suffixes Where it applies, field names can consist of two parts: a name describing the co ntents of the field, and a suffix specifying the fields data type. We use suffixe s to differentiate similar fields of different types so the fields will display together when listed alphabetically, for example: RETIREMENT_AMT RETIREMENT_PCT Suffixes are used where appropriate. Not all field names many require suffixes. For example, the name BK_COST implies an amount. It does not need the AMT suffix to it. Some common suffixes are as follows: Suffix Type Definition AMT Amount Numeric value of currency type e.g. ITEM_AMT CD Code User-defined value determined by a Translate Table or other code table. e.g. EXP ENSE_CD CNT Count Numeric value containing a count. e.g. FORM_ALIGNMENT_CNT DT

Date Date value of format YYYY-MM-DD. e.g. BEGIN_DT DTTM DateTime Date and time value of format YYYY-MM-DD and HH:MM:SS.ttt. e.g. LAST_UPDATE_DTT M FLG Flag User can select one of the possible values defined for field. Usually has more than 2 values. Also see SW. e.g. CREDIT_MEMO_FLG ID Identification Value used to make references unique. e.g. PROJECT_ID SW Switch Field typically has 2 values. It usually is a Yes or No switch. e.g. TAX_CREDI T_SW PCT Percent A percentage value stored internally as a decimal (e.g., 50% is stored as .5) e. g. CHANGE_PCT RT Rate Numeric field expressing an amount per some unit of coverage. e.g. CUR_EXCHNG_RT TM

TIME Time Time field measured in hours, minutes, and seconds. Record Naming Standards This section describes record naming standards. TOP Record Prefixes Record names generally use prefixes to represent a functional area within a prod uct. For example, DEMAND is used as prefix in the inventory product. Examples of record names with DEMAND prefix include: DEMAND_ALLOC_VW, DEMAND_FDBCK_VW, DEM AND_INV, DEMAND_PICK_VW, DEMAND_REQ_INV. Once a prefix has been used by an appli cation, other applications should not use the same prefix. In addition to the fu nctional prefixes, in some cases, we also use prefixes to identify special types of records definitions:

Abbreviation Description R_ Identifies record definitions created as temporary record definitions for SQR re ports. The remainder of the record name consists of the program or report ID. ( HRMS only) AUDIT_ Identifies record definitions used to store audit information for other record d efinitions in the database Record Suffixes Product suffixes are used when a functional area applies to many products. For e xample, business unit tables are named BUS_UNIT_TBL_AM, BUS_UNIT_TBL_AP. The fol lowing are the product suffixes: Abbreviation Description _AD Admissions (Higher Education)

_AM Asset Management _AP Accounts Payable _AR Accounts Receivable _BA Benefits Administration _BD Budget _BI Billing _BN Benefits (_BEN is ok). CE_ Cost Enhanced (if used by Manufacturing) _CM Common Modules (Higher Education) CM_ Cost Management (if used by Inventory only) _CS Campus Systems (Higher Education) _DA Degree Audit

EG_ Engineering EN_ Bills and Routings EP_ Enterprise Planning _FA Flexible Spending Accounts (FSA is ok) _FS Financials GF_ Government Financials _GL General Ledger _HR Human Resources _INV Inventory _MG Manufacturing _OM Order Management _PA Pension Admin.

_PI Payroll Interface (_DED is ok) PL_ Production Planning _PY Payroll (_PAY is ok) _SA Student Aid (Higher Education) _SF Student Financials (Higher Education) SF_ Production Management (Shop Floor) _SR Student Records (Higher Education) _TL Time and Labor TOP To help identify the purpose of different types of record definitions, PeopleSof t recommends that you adopt our naming conventions for record definition names, and use the following suffixes where applicable: Abbreviation Description _DVW Identifies a dynamic view. _FUNCLIB_xxxx 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 subrecords. _SBP Identifies a subpanel 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 _V W suffix. _TBL Can be used to Identify an edit or prompt table that contains data used for vali dation, 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 employe e has in the SKILL table. You can then use SKILL_TBL to store all the codes def ining 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. _WRK Identifies record definitions created as derived/work records for online process ing. APPENDIX College Abbreviation Codes College Prefix # Letter Blue Ridge Community College BR Central Virginia Community College Dabney S. Lancaster Community College Danville Community College DC Eastern Shore Community College

291 CV 279 ES

A 292 DL D 284

B 287 E

Germanna Community College GC J. Sargeant Reynolds Community College John Tyler Community College JT Lord Fairfax Community College Mountain Empire Community College New River Community College NR Northern Virginia Community College Patrick Henry Community College Paul D. Camp Community College Piedmont Virginia Community College Rappahannock Community College RC Southside Virginia Community College Southwest Virginia Community College Thomas Nelson Community College Tidewater Community College TC Virginia Highlands Community College Virginia Western Community College Wytheville Community College WC System Office SO 261 X or 0 TOP

297 SR 290 LF ME 275 NV PH PC PV 278 SV SW TN 295 VH VW 288

F 283 H 298 299 K 280 285 277 282 P 276 294 293 U 296 286 Y

G I J L M N O Q R S V W

S-ar putea să vă placă și