TRY IT FREE FOR 30 DAYS
Full version  •  Quick installation  •  No spam
Download now

Tech Talk
LIGHTLY TECHNICAL OBSERVATIONS ON PEOPLESOFT, SQR, AND RELATED AND UNRELATED TOPICS

Archives

SQR Code Formatting

Unlike PeopleCode, SQR does not force a particular coding format. Sometimes I wish it did. You know the type:

      BEGIN-PROCEDURE CALC-AMT
      BEGIN-SELECT
      COMPRATE &COMPRATE
      COMP_FREQUENCY &COMP_FREQUENCY
       LET #COMPRATE=&COMPRATE
        LET $COMP_FREQ =  &COMP_FREQUENCY
          DO CALC-AMT-2 !CALCULATE AMOUNT
      END-SELECT
      END-PROCEDURE
      BEGIN-PROCEDURE CALC-AMT-2
      DISPLAY 'CALC-AMT-2'
      IF $COMP_FREQ = 'M'
      SHOW 'M'
      LET #F = 12 !SET F TO 12
      ELSE
       IF $COMP_FREQ = 'Q'
           SHOW 'Q'
                 LET #F = 4
               MOVE 1.0005 TO #NUM
           END-IF
         END-IF
         SHOW #NUM
      LET ...

This example has it all: Inconsistent or no indentation, useless comments, mysterious uncommented literals, DISPLAYs and SHOWs for debugging purposes, no separation between sections and procedures, redundant assignments, and on and on. This example is made up, but we've all seen these "features" in code. How can you maintain code like this?

Rather than try to give a long list of "standards" or rules, let me reduce it down to just a few very simple suggestions. There is, of course, no "correct" way to do this, but the following are, in my opinion only, good ways of formatting code.

  • Begin coding the following in column 1:
    • begin-program (-report), begin-procedure, begin-setup, begin-heading, begin-footing
    • Database column names in a SELECT block (this is required by SQR)
    • Compiler directives: #include, #ifdef, #define, etc.
    • Comments, as appropriate
  • No other elements other than the ones listed above should begin in column 1. Indent everything else using a consistent number of spaces. (I use two spaces.)
  • Indent one level under each of the begin- elements listed above and each if, while, evaluate, when, begin-select, begin-sql. The end should align with this keyword. Rule of thumb: Indent under when and under anything that has an associated end- keyword.
  • Indent within the SQL inside of a begin-select. This means that the SQL (FROM, WHERE) will be indented one level and the SQR code within the block will be indented an additional level.
  • Don't use tabs for indentation. Use spaces instead.
  • Use all upper case for the following:
    • SQL clauses
    • Database column names
    • #define constants
    • Literals, such as 'Y' and 'N'
  • Use lower or mixed case for all other elements.

Here are the reasons for these suggestions. First, $THISISREALLYHARDTOREAD. Code in mixed or lower case is easier to read in general. However, some databases are case sensitive, so I suggest coding SQL in all caps. This also helps to set the SQL off from the SQR code.

Indentation is very important for following the logic of a program. When you come to an if, you often want to find the else or end-if quickly. Without indentation, you need to scan every line...probably forgetting what it was you were looking for.

I place #define and other compiler directives in column 1 to highlight the fact that they are not part of the logic flow of the program. They are processed before the program even starts. Aligning them with the rest of the code would lead the reader to think that they are part of the logic flow.

Why do I suggest not using tabs? Different text editors handle them differently and/or allow different settings for the number of spaces in a tab. Therefore, you don't have any control over how the code will appear to other people if you use tabs. What looks aligned to you may very well end up as a random mess in someone else's editor. Use spaces to indent.

Note that begin-select would never be found in column 1 under the guidelines above. Many programmers assume that it must be there; in fact, only the names of the database columns (fields) that you are selecting must be in column 1.

It's also common practice to use hyphens in procedure names but to use underscores or mixed case in variable names. For example, we would have $variable_name or $VariableName.

So here's an example showing these suggestions in practice:

      !---------------------------------
      begin-procedure Procedure-Name
      !---------------------------------
        begin-select
      FIELD1
      FIELD2
            if &field1 = 'Y'
              if #SomeVariable = 1
                do Other-Proc-1
              end-if
            else
              do Other-Proc-2
            end-if
            do Update-Table
          FROM TABLE_NAME
          WHERE FIELD2 = 123
        end-select
      end-procedure
      !---------------------------------
      begin-procedure Update-Table
      !
      ! What this procedure does.
      !---------------------------------
        begin-sql
          UPDATE ...
          WHERE  ...
        end-sql
      end-procedure

PSSQRWhen 1 > 1 (or even 9999) 10-31-2014
SQRSQR colors 08-11-2014
SQRSQR lines, boxes and images 08-10-2014
SQRSQR one-point coordinate grid 08-09-2014
SQRSQR proportional fonts 08-08-2014
SQRSQR print positioning 08-07-2014
SQRSQR reports: The basics 08-06-2014
PS Fear of customization 07-18-2014
SQRSQR variable names 07-02-2014
PS Concatenating strings in PCode05-12-2014
PS HTML and server communication 05-05-2014
PS JavaScript in HTML areas 04-21-2014
PS Using HTML areas 04-18-2014
PS The HTML object 04-11-2014
PS Types of HTML areas 03-14-2014
SQREmbedded SELECTs in SQR 01-31-2014
PS Exporting all PeopleCode 11-30-2013
PS Disabling autocomplete 09-29-2013
SQRSP Debugger for SQR update 09-12-2013
General Stopping... and restarting 09-02-2013
SQRSQR debugger version 2 09-29-2010
SQRA few SQR items 05-20-2009
PS Ignoring "component changed" 05-07-2008
PS App Engine 04-30-2008
PS Commenting code 04-02-2008
PS The "Powered By" page 03-05-2008
PS Formats in PeopleCode vars 01-30-2008
PS Page layout with group boxes 01-09-2008
PS Meta-SQL wrappers 12-19-2007
PS Derived record PeopleCode 12-05-2007
PS A Cancel button 11-28-2007
General "Leading" the test effort 11-07-2007
SQRTemporary tables in SQR 10-31-2007
SQRUpdating long character data 10-24-2007
PS Record.Field specification 10-17-2007
PSSQRRELLANG.SQC 10-03-2007
PS Migrating project definitions 09-26-2007
PS Derived records 09-19-2007
PS Positioning elements on pages 08-29-2007
General Thanks 08-22-2007
SQRSQR "code alerts" 08-08-2007
PS Styles in HTML Areas 08-01-2007
SQRDynamic SQL for performance? 07-25-2007
PS Page Field Name 07-18-2007
PS PeopleCode event order 06-27-2007
SQRFormatting Excel using HTML 06-06-2007
Component-changed state 05-23-2007
PS Selecting styles for page fields05-16-2007
SQRSending email from SQR 05-02-2007
General Contractor networking 04-25-2007
PS Project X--and another project04-18-2007
PS Effective and data entry dates04-11-2007
PS A PeopleSoft home page 04-04-2007
PSSQRHyperion and the future of SQR03-21-2007
General The data doesn't lie 03-14-2007
PSSQRHyperion acquisition 03-07-2007
General Taking ownership 02-28-2007
PS Source control 02-21-2007
PS Sandboxes 02-14-2007
PS Migration instructions 02-07-2007
PS PeopleSoft environment usage 01-31-2007
PS Multiple environment strings 01-24-2007
PS Multiple testing environments 01-17-2007
PS PeopleSoft support environments 01-10-2007
General A single source of truth 01-03-2007
Nothing Smile 12-27-2006
PS Navigating the component buffer 12-20-2006
PS JavaScript and styles 12-13-2006
PS SQL for common HR queries 12-06-2006
SQRSQR program complexity 11-29-2006
SQRFrequent SQR questions 11-22-2006
PS Followup 11-15-2006
PS Expanding subrecords 11-08-2006
PS Bind variables 10-25-2006
PS Attaching objects to projects 10-18-2006
PS Partial transaction completion10-11-2006
PS The multi-process component 10-04-2006
PS Employee rows lost to security09-27-2006
SQRSQR document sections 09-20-2006
PS Empty-string compares in SQL 09-13-2006
SQRNulls, blanks, empty strings 09-06-2006
General Company policy 08-30-2006
PS Auto-lookup exclusion 08-23-2006
PS Effective status 08-16-2006
PS A couple of HRMS/HCM utilities08-02-2006
PS Translate value changes 07-26-2006
General Updating views 07-19-2006
General Set-based updates 07-12-2006
PS SQL set-based processing 07-05-2006
Being happy about bugs 06-28-2006
Busy in the PS marketplace 06-21-2006
General 2-way documentation 06-14-2006
PS Interfaces as views 06-07-2006
PS Hijacked fields 05-31-2006
General Agile software development 05-24-2006
General Working within Waterfall 05-17-2006
General Over the Waterfall 05-10-2006
PS Experimentation in PeopleSoft 05-03-2006
PS Unlimited enhancements? 04-26-2006
PS Testing direct DB updates 04-19-2006
SQRDelayed evaluation of SQL 04-12-2006
PS Database compares 04-05-2006
General Support problem? Call FBI! 03-29-2006
SQRFinding SQR errors 03-22-2006
PS Finding PeopleSoft Queries 03-15-2006
PS PeopleSoft Query support 03-08-2006
PS JOB table and SetIDs 03-01-2006
PS Migrating the project 02-22-2006
PS Compare and Report options 02-15-2006
PS Comparing and migrating projects 02-08-2006
PS Object security in App Designer 02-01-2006
PS Automation of App Designer 01-25-2006
General Contractors on PS projects 01-18-2006
General "Smart coding" 01-11-2006
SQRDebugger tricks 01-04-2006
PS EFFDT and component processing12-28-2005
PS Referential integrity 12-21-2005
PS Menu navigation using SQL 12-14-2005
SQRA coding standards wish list 12-07-2005
PS More App Designer options 11-30-2005
PS Pages in App Designer 11-23-2005
PS Finding objects on the menu 11-14-2005
PS Magic search record fields 10-31-2005
PS Documenting object attributes 10-24-2005
PS Monitoring server performance 10-17-2005
PS Searching PeopleCode 10-10-2005
PS Speeding up App Designer 10-03-2005
PS Using the message catalog 09-26-2005
PS Good ideas that sometimes aren't09-19-2005
PS And now Siebel 09-12-2005
SQRDate comparisons 09-05-2005
PSSQRFTP options 08-29-2005
PSSQRMoving code across environments08-22-2005
PS Spring cleaning 08-15-2005
SQRBuild your own SQR "IDE" 08-08-2005
PS Change control in App Designer08-01-2005
PS App Engine: disadvantages 07-25-2005
PS App Engine: advantages 07-18-2005
SQRCoding Excel file output 07-11-2005
General Creating Excel files 07-05-2005
PS Dave's next move 06-27-2005
SQRSQR variable oddities 06-20-2005
SQRSQR arrays 06-13-2005
SQRCompiling SQRs 06-06-2005
PS 5-character SETIDs 05-30-2005
PS Use all of the keys 05-23-2005
SQRDynamic SQL in SQR 05-16-2005
PS Running the in-place conv 05-09-2005
PS Searching for fields in DB 05-02-2005
PS Converting setup data 04-25-2005
PS Associating effective-dated tables 04-18-2005
PS Upgrading without an upgrade 04-04-2005
PS Scheduling patches 03-28-2005
PS To patch or not? 03-21-2005
PS Basic tools 03-14-2005
SQRWay back with sqrtools.com 03-07-2005
PS Meta-SQL 02-28-2005
PS Dropping the user index 02-21-2005
PS User indexes 02-14-2005
PS Page changes in App Designer 02-07-2005
General Generate SQL from SQL 01-31-2005
SQRSQR report viewer 01-24-2005
General Bug or enhancement? 01-17-2005
PSSQRTagging objects and code 01-10-2005
General Issue tracking 01-03-2005
PS PeopleSoft 10? 12-27-2004
PS Purging tables 12-20-2004
PS Acquisition 12-13-2004
PS Exporting PCode as text 12-06-2004
PS Simplify SQR code 11-29-2004
PS New site for SQR info 11-22-2004
PS Comparing objects 11-08-2004
PS Applying SQL-from-SQL 11-01-2004
General Generating SQL with SQL 10-25-2004
General Generating SQL 10-18-2004
PS Scrambling data 10-11-2004
PS What's going on with PS? 10-04-2004
SQRPrint positioning in SQR 09-27-2004
PS Oracle vs. PeopleSoft 09-13-2004
General Word, email, and lava lamps 09-06-2004
PS Custom run control: tips 08-30-2004
PS Custom run control: building 08-23-2004
PS PeopleCode, behind the scenes 08-16-2004
PS Language-specific pages 08-09-2004
SQRUsing substitution variables 08-02-2004
SQRSQR substitution variables 08-02-2004
PS HTML areas 07-19-2004
SQRRecursion in SQR 07-12-2004
SQRSQR code formatting 07-06-2004
SQRDebugger beta release 06-28-2004
PS Application Designer tidbits 06-27-2004
PS Configuration for custom SQR 06-14-2004
PSSQRModify or clone? 06-07-2004
PS Identifying custom objects 06-01-2004
PS EFFDT again 05-24-2004
General Change-only interface: impl 05-17-2004
General Change-only interface: concept05-10-2004
PS Cache troubles 05-03-2004
PS Component PeopleCode 04-25-2004
PS EFFDT and EFF_STATUS 04-18-2004
PS SETID in subselects 04-11-2004
PS Denormalized tables 04-04-2004
PS Documenting retired custom 03-28-2004
PS Sharing login IDs 03-21-2004
SQRGlobal and local SQR variables03-14-2004
SQRDISPLAY and MOVE 03-07-2004
PSSQRRun control in SQR 02-29-2004
SQRCommon sources of SQR bugs 02-22-2004
PS Implementation setup data 02-15-2004
PS Managing setup data 02-08-2004
PS Managing objects 02-01-2004
PS Make a home page 01-01-2004