C. Delivered SQR Common Modules

PeopleSoft is delivered with many common modules that are used by delivered SQR programs. This Appendix lists each delivered common module and its function. Many of the common modules are of no use at all, but it is important to know the ones that could provide functionality to custom SQR programs.

Table C-1. Delivered common module descriptions by type

Type	SQC name	Description
API	prcsapi.sqc	Procedure to update the process scheduler request record
API	prcsdef.sqc	Procedure to define the process scheduler variables.
API	prcslng.sqc	Process scheduler API for multiple language use
API	projapi.sqc	API for creating a new project definition
API	stdapi.sqc	Process scheduler interface
Ask	askactn.sqc	Input logic for user-entered actions
Ask	askaod.sqc	Input logic for user-entered as-of date
Ask	askarea.sqc	Get area code from user
Ask	askbu.sqc	Masking logic for user-entered business unit name
Ask	askcalyr.sqc	Input logic for user-entered calendar year
Ask	askcbrpt.sqc	COBRA ask reprint values
Ask	askdept.sqc	Input logic for user-entered department numbers
Ask	askeffdt.sqc	Asks user to enter effective date
Ask	askftd.sqc	Input logic for user-entered from and through dates
Ask	askjbcde.sqc	Input logic for user for salary mass updates by job code
Ask	askldgr.sqc	Masking logic for user-entered ledger group name
Ask	askledg.sqc	Masking logic for user-entered ledger name
Ask	askprd.sqc	Input logic for user-entered period begin/end dates
Ask	askprins.sqc	Input logic for user-entered process instances (PIS)
Ask	askpygrp.sqc	Input logic for user for salary mass updates
Ask	askreqn.sqc	Input logic for user-entered job requisitions
Ask	asksalpl.sqc	Input logic for user for salary plan
Ask	askselct.sqc	Ask-select masking logic for user input. Asks user to enter data, then masks it
Ask	askslpln.sqc	Input logic for user for salary mass updates by salary plan
Ask	asksrvyr.sqc	Input logic for user-entered service years
Ask	askstpin.sqc	Input logic for user for salary step increments
Ask	askvacnt.sqc	Input logic for user-entered vacant position report request
Ask	askxovrd.sqc	Input logic for user-entered exception/override option
Ask	benasof.sqc	Input logic for user-entered as-of date
Ask	benftd.sqc	Input logic for user-entered from/thru dates
Ask	chgasodt.sqc	Request as-of date and update the PSASOFDATE record
Ask	chgftdts.sqc	Request from date and through date
Calculation	car00l.sqc	Calculate car & fuel benefit charges
Calculation	datemath.sqc	Routines for date arithmetic
Calculation	datewrk.sqc	Computes days worked
Calculation	eeogroup.sqc	Sex/ethnic group analysis
Calculation	eeogrpuk.sqc	Sex/ethnic group analysis for UK
Calculation	fsadates.sqc	Generates Flexible Spending Account dates (1st and last day of year)
Calculation	sqrtrans.sqc	Translate SQR strings to given language
Calculation	timemath.sqc	SQR time arithmetic procedures
COBRA-specific	cbaskval.sqc	COBRA ask values
COBRA-specific	cbgetval.sqc	Mask run control routines
COBRA-specific	cbraddr.sqc	COBRA address
COBRA-specific	cbrdefs.sqc	COBRA defines
COBRA-specific	cbrdeps.sqc	COBRA enrollment form dependent processing
COBRA-specific	cbrncntl.sqc	Retrieves run control for report parameters needed for benefits reports
Define constants	canrpt.sqc	Sets NID_COUNTRY = ‘CAN’ for Canada reporting
Define constants	convdef.sqc	Define conversion constants
Define constants	rdbms.sqc	Define database environment constant
Define constants	setenv.sqc	Define operating system and date constants variables. Includes ‘rdbms.sqc’ and ‘opsys.sqc’.
Define constants	stdvar.sqc	Sets payroll national ID type = ‘PR’
Define constants	usarpt.sqc	Defines NID_COUNTRY as ‘USA’ for USA reporting
Formatting	address.sqc	Converts address fields into display address
Formatting	adformat.sqc	Converts address fields using country settings
Formatting	chgampus.sqc	Change an ampersand to an underscore/back space
Formatting	compnum.sqc	Compares two values; SQR does not always correctly compare values; this is the workaround
Formatting	convtab.sqc	Converts a tab-delimited file to comma-delimited
Formatting	currnd.sqc	Currency rounding common module
Formatting	datetime.sqc	Routines to format dates and times
Formatting	eftkana.sqc	Generate Hankaku characters for Japanese EFT files
Formatting	ldadropt.sqc	Load a lookup table with the paycheck address options
Formatting	ldlifcov.sqc	Load a lookup table with the life and AD&D coverage types
Formatting	ldnumlit.sqc	Create array of literals for number-to-words conversion
Formatting	ldnumtrn.sqc	Language-enabled version of ldnumlit.sqc, used in paycheck
Formatting	ldorgsb.sqc	Load array with symbols to represent org. code
Formatting	ldpgmcur.sqc	Load a lookup table with currency code for benefit program
Formatting	ldplntyp.sqc	Load a lookup table with the plan types
Formatting	namenl.sqc	Change format for Dutch name
Formatting	netintrn.sqc	Language-enabled version of netinwds.sqc
Formatting	netinwds.sqc	Convert net pay to words
Formatting	nidformt.sqc	Formats the national ID according to country settings
Formatting	number.sqc	Routines to format numbers
Formatting	ohsutil.sqc	UK data formatting for OHS reports
Formatting	proper.sqc	Capitalizes the first letter of every word in a string
Formatting	rotnamel.sqc	Convert name from “last,first,prefix” to “first prefix last”
Formatting	rotname2.sqc	Convert name from “last,first,prefix” to “fi mi prefix last”
Formatting	rotname3.sqc	Convert name from “last,first,prefix” to its 3 components
Formatting	rotname4.sqc	Convert name from “last,first,prefix” to “fi last”
Formatting	rotname5.sqc	Convert from “last suffix,first” to “last first suffix”
Formatting	rotname6.sqc	Convert from “last suffix,first” to “last first mid in”
Formatting	rotname7.sqc	Convert from “Last Suffix,First” to “FIn MidIn Last” (remove suffix from name)
Formatting	rotname8.sqc	Convert from “First MidIn Last Suffix” to “First MidIn Last” (remove title and suffix from name)
Formatting	ukutil.sqc	General United Kingdom formatting routines
Get	bendeps.sqc	Select dependent records
Get	curdttim.sqc	Get current system date and time
Get	cvrgcd.sqc	Retrieves description of a coverage code
Get	getactrs.sqc	Get action reason from the action reason table
Get	getasodt.sqc	Get as-of date from PSASOFDATE record
Get	getbalid.sqc	Get balance ID for calendar year from the installation table
Get	getbennm.sqc	Get the benefit name
Get	getbical.sqc	Get billing calendar
Get	getbunam.sqc	Get the description of a business unit code
Get	getcodta.sqc	Get selected fields from the company table
Get	getcurnm.sqc	Get currency name from the currency table
Get	getcvgcd.sqc	Retrieves coverage code info from COVRG_CD_TBL
Get	getdatcd.sqc	Get year, quarter, and month codes from $asofdate variable
Get	getdedbl.sqc	Get deduction balances
Get	getdednm.sqc	Get deduction name from the deductions table
Get	getdptnm.sqc	Get department name from the department table
Get	getempad.sqc	Get basic personal data for an employee
Get	getempna.sqc	Get the nationality of an employee
Get	getempnm.sqc	Get the person’s name from the PS_PERSONAL_DATA record
Get	geternbl.sqc	Get earnings balances
Get	geternnm.sqc	Get earnings name from the earnings table
Get	getestnm.sqc	Get establishment name (used for tips)
Get	getfrmat.sqc	Get format (for diskettes)
Get	getftdts.sqc	Get from date and as-of date from PSASOFDATE record
Get	gethours.sqc	Get hours
Get	getjobtl.sqc	Get job title from the job code table
Get	getlcdta.sqc	Get selected fields from the local tax tables
Get	getlocnm.sqc	Get location name from the location table
Get	getmonnm.sqc	Get month name procedures
Get	getorgsb.sqc	Get symbol for org. code
Get	getpgdta.sqc	Get selected fields from paygroup table
Get	getpgmnm.sqc	Get the name of the current benefit program
Get	getposnm.sqc	Get position name from the position data table
Get	getprvnm.sqc	Get the benefit provider’s name
Get	getqtrcd.sqc	Get quarter and month codes from $asofdate
Get	getrplng.sqc	Get the report language
Get	getrptpd.sqc	Retrieve reporting period for benefits reports
Get	getrpttr.sqc	Get reporting period for benefits reports
Get	getsched.sqc	Get benefits administration schedule ID from the user
Get	getschnm.sqc	Get the name of the current benefits administration schedule
Get	getsetid.sqc	Gets the setID for the system
Get	getslgrd.sqc	Get salary grade data from the salary grade table
Get	getstdta.sqc	Get selected fields from the state tax tables
Get	gettxlnm.sqc	Gets the tax location name from the tax location 1 table
Get	getunion.sqc	Get union fields from the union table
Get	getweeks.sqc	Get weeks
Get	getwrkcn.sqc	Gets fields from the Works Council table (Germany only)
Get	hrsecty.sqc	Get SQR security flag
Get	readxlat.sqc	Read the translate table for the desired values.
Get	validdt.sqc	Routines to validate date
Heading	stdhdg01sqc	Standard heading #1 for printed reports, contains: run date, run time, report title report ID,
Heading	stdhdg02.sqc	Standard heading #2 for printed reports, contains company code and company name, includes stdhdg01.sqc
Heading	stdhdg03.sqc	Standard heading #3 for printed reports, contains: as of date, includes stdhdg01.sqc
Heading	stdhdg04.sqc	Standard heading #4 for printed reports, contains: pay period end date, includes stdhdg02.sqc
Heading	stdhdg05qc	Standard heading #5 for printed reports, contains: check date and time, includes stdhdg02.sqc
Heading	stdhdg06.sqc	Standard heading #6 for printed reports, contains: paygroup information, includes stdhdg04.sqc
Heading	stdhdg07.sqc	Standard heading #7 for printed reports, contains: department ID and name, includes stdhdg04.sqc
Heading	stdhdg08.sqc	Standard heading #8 for printed reports, contains: period from through dates, includes stdhdg01.sqc
Heading	stdhdg09.sqc	Standard heading #9 for printed reports, contains: asofdate, includes stdhdg02.sqc
Heading	stdhdg10qc	Standard heading #10 for printed reports, contains: EMPLID and name, includes stdhdg02.sqc
Heading	stdhdg11.sqc	Standard heading #11 for printed reports, contains: period from through dates, includes stdhdg02.sqc
Heading	stdhdg12.sqc	Standard heading #12 for printed reports, contains: schedule ID, includes stdhdg0l.sqc
Heading	stdhdgpi.sqc	Standard heading for printed reports using payinit.sqc, contains payroll information
Heading	stdhdgtr.sqc	Standard heading #1 for printed reports
Heading	stdhtr02.sqc	Standard heading #2 for printed reports
Heading	stdhtr03.sqc	Standard heading #3 for printed reports
Heading	stdhtr04.sqc	Standard heading #4 for printed reports
Heading	stdhtr05.sqc	Standard heading #5 for printed reports
Heading	stdhtr06.sqc	Standard heading #6 for printed reports
Heading	stdhtr07.sqc	Standard heading #7 for printed reports
Heading	stdhtr08.sqc	Standard heading #8 for printed reports
Heading	stdhtr09.sqc	Standard heading #9 for printed reports
Heading	stdhtr10.sqc	Standard heading #10 for printed reports
Heading	stdhtr11.sqc	Standard heading #11 for printed reports
Heading	stdhtr12.sqc	Standard heading #12 for printed reports
Heading	stdhtrpi.sqc	Standard heading for printed reports using PAYINIT.sqc
Insert	benotr.sqc	Populates tables for PS_BENEFITS_Data
Insert	benpers.sqc	Populates personal data information to benefit tables
Insert	setbuutl.sqc	Inserts rows into the setID table and business unit table
Insert	setidutl.sqc	Inserts rows into the setID table
Pension module	paextrctsqc	Pension administration benefits value extract
Pension module	pafunctn.sqc	Pension administration functions
Pension module	pagetval.sqc	Masks run control date for pension administration
Pension module	pahdg01.sqc	Pension administration worksheet heading
Pension module	pahdg06c.sqc	Pension administration Social Security worksheet heading
Pension module	paresult.sqc	Reads result tables for pension administration
Pension module	parnct11.sqc	Retrieve run control parameters for pension administration human resources reports
Pension module	parnctl2.sqc	Retrieve run control parameters for pension administration human resources reports
Pension module	paservce.sqc	Calculates service for pension administration
Pension module	pat08hdg.sqc	Pension administration trustee extract report heading
Pension module	pat09hdg.sqc	Pension administration trustee detail report heading
Pension module	pay300rt.sqc	Retrieves run control parameters from RTRORQST_RUNCTL
Pension module	pay301rt.sqc	Retrieves run control parameters from RTROREPT_RUNCTL
Pension module	pay302rt.sqc	Retrieves run control parameters from RTROSUMM_RUNCTL
Pension module	pay303rt.sqc	Retrieves run control parameters from RTROTERM_RUNCTL
Pension module	paydelrc.sqc	Deletes payroll run control record
PS Financials	fsbegin.sqc	This is the ps/financials standard report driver
PS Financials	fsgetshr.sqc	This procedure will retrieve the correct setID for the set name being shared
PS Financials	fshdg01.sqc	Standard heading #1 for ps/financials reports
PS Financials	fshdg02.sqc	Standard heading #2 for ps/financials reports
PS Financials	fshdg05.sqc	Standard heading #5 for ps/financials reports
PS Financials	fshdg06b.sqc	Standard heading #6 for ps/financials reports
PS Financials	fsldsdta.sqc	Get data from the ledger definition table
PS Financials	fslgrdta.sqc	Get data from the ledger group definition table
PS Financials	fsprcbll.sqc	This is the highest level procedure in the program. It will process the business unit based upon the ask criteria.
Report-specific	askactop.sqc	Get action option for pos002
Report-specific	askap008.sqc	Input logic for user report app008
Report-specific	askap010.sqc	Input logic for user report app010
Report-specific	askcar.sqc	Input logic for p11d reports
Report-specific	askeecrs.sqc	Input logic for user report per101cn
Report-specific	askp034.sqc	Input for per034a - create internal resume
Report-specific	basdep00.sqc	Benefits administration enrollment form dependent processing
Report-specific	ckeyrctl.sqc	Selects run control fields for delivered general ledger interface
Report-specific	ctxflt4.sqc	Generates form flash for Canadian T4 form
Report-specific	ctxflt4a.sqc	Generates form flash for Canadian T4 form
Report-specific	ctxrctll.sqc	Retrieves run control for report parameters needed for Canadian tax reports
Report-specific	ctxrnctl.sqc	Retrieve data from Canadian process parameters record Canadian tax reports
Report-specific	dddindex.sqc	Audit index
Report-specific	dddtable.sqc	Audit record/SQL table
Report-specific	dddviews.sqc	Audit views
Report-specific	ecbusdoc.sqc	Used when trying to reprocess an inbound data file that was in error
Report-specific	ecin999.sqc	Parses the 999 control records in the flat file. It then validates the control information to make sure further data can be processed
Report-specific	ecmapfld.sqc	No description
Report-specific	ecoutmap.sqc	No description
Report-specific	ec where.sqc	Derive where clause
Report-specific	hdg912.sqc	Print headers for tax912xx
Report-specific	hrtrnrpt.sqc	Scenarios for TN010 and TN011 reports
Report-specific	icclrctl.sqc	Run control for calculation
Report-specific	icelhous.sqc	Incentive comp housekeeping routines for elig./calc.
Report-specific	icgbhous.sqc	Incentive comp housekeeping routines
Report-specific	icmemrpt.sqc	Retrieves incentive comp. run control parameters from IC_MEMRP_RUNCTL
Report-specific	icpayint.sqc	Retrieves incentive comp. run control parameters from IC_PYINT_RUNCTL
Report-specific	icround.sqc	Incentive comp rounding rules routine
Report-specific	masschng.sqc	Mass change processing shared procedures
Report-specific	massfile.sqc	Mass change file unload/load procedures
Report-specific	masslayo.sqc	Mass layout #defines
Report-specific	ohs003gr.sqc	Gets common data for the OHS001 and 004 reports (Germany only)
Report-specific	ohs501uk.sqc	Gets health and safety base locations for United Kingdom reports
Report-specific	ohs701bc.sqc	Used for electronic commerce functionality
Report-specific	ohsget.sqc	Masks health and safety record values for health and safety reports
Report-specific	ohsrnctl.sqc	Run control value selection for health and safety reports
Report-specific	opsys.sqc	Operating system environment
Report-specific	pirunctl.sqc	Payroll interface changes report (delivered payroll interface to external payroll system)
Report-specific	progtype.sqc	Procedure to build PeopleCode program type array
Report-specific	prtssaa.sqc	Print data from transmitter record—SSA format
Report-specific	prtssab.sqc	Print data from basic authorization rec—SSA format
Report-specific	prtssae.sqc	Print data from employer record—SSA format
Report-specific	prtssas.sqc	Print data from employee state record(s)—SSA format
Report-specific	rdtap912.sqc	Read tape file for tax912xx
Report-specific	rptsmmca.sqc	Used by TAX810 series of SQRs (quarterly wage listing) as a summary report
Report-specific	rptsmmry.sqc	Print summary information
Report-specific	stgbhous.sqc	Stock administration housekeeping routines
Report-specific	stw2smry.sqc	State w-2 tape summary report heading include
Report-specific	txovrflw.sqc	Utility for splitting tax amounts that overflow fields
Report-specific	txrnct11.sqc	Retrieves run control for report parameters needed for tax reports
Report-specific	txrnctl2.sqc	Retrieves run control for report parameters needed for tax reports
Report-specific	w2sort.sqc	Control w2 sort
Report-specific	wlgen.sqc	Wlgen.sqc work list generator
Run control	bngetval.sqc	Masks run control routines
Run control	bnrunctl.sqc	Retrieves run control for report parameters needed for benefits reports
Run control	hrctlfra.sqc	Retrieves parameters for France run control
Run control	hrctlnld.sqc	Retrieves parameters for Netherlands run control
Run control	hrgetfra.sqc	France run control masks
Run control	hrgetnld.sqc	Netherlands run control masks
Run control	hrgetval.sqc	Masks run control value
Run control	hrrnct11.sqc	Retrieves run control for the parameters of the human resources reports
Run control	hrrnctl2.sqc	Retrieves run control for list of actions
Run control	hrrnctl3.sqc	Retrieves run control for list of job requisitions
Run control	hrrnct14.sqc	Retrieves run control for list of departments
Run control	payinit.sqc	Payroll report initialization and timing routines
Run control	payrctl2.sqc	Retrieves payroll run control parameters from RC_PAY RECORD
Run control	payrctl3.sqc	Retrieves run control parameters from PS_RC_PAY_UNSHT. Invoked by payroll un-sheet process
Run control	payrnctl.sqc	Retrieves run control for report parameters needed for payroll reports
Run control	pygetval.sqc	Sets defaults for pay run control values
Run control	rdedrctl.sqc	Retrieves run control for report parameters needed for payroll reports which use payinit.sqc
Run control	taxrnctl.sqc	Retrieves data from tax reporting run control record
Run control	tiprnctl.sqc	Gets run control parameters for tips processing run control
Run control	tlgetval.sqc	Gets begin and end dates for time and labor processes
Run control	tlrnctll.sqc	Gets run control parameters for time and labor processes
SQR setup/utility	chkadvpr.sqc	Check and advice printer settings (including MICR settings)
SQR setup/utility	converr.sqc	SQL error procedure for conversion
SQR setup/utility	eoj.sqc	Perform end of job processing if successful status
SQR setup/utility	reset.sqc	Reset printer, print ‘end of report’
SQR setup/utility	setlyo31.sqc	Landscape layout declaration for reports
SQR setup/utility	setlyo3p.sqc	Portrait layout declaration for reports
SQR setup/utility	setlyout.sqc	Set the layout for the sqr report
SQR setup/utility	setori31.sqc	Sets layout constants by evaluating paper size (landscape only)
SQR setup/utility	setori3p.sqc	Sets layout constants by evaluating paper size (portrait only)
SQR setup/utility	setprt3.sqc	Sets printer declaration
SQR setup/utility	setup01.sqc	Standard setup section (portrait orientation)
SQR setup/utility	setup01a.sqc	Printer and page-size initialization (portrait)
SQR setup/utility	setup02.sqc	Standard setup section (landscape orientation)
SQR setup/utility	setup02a.sqc	Printer and page-size initialization (landscape)
SQR setup/utility	setup02b.sqc	Printer and page-size initialization
SQR setup/utility	setup02c.sqc	Printer and page-size initialization
SQR setup/utility	setup03.sqc	Printer and page-size initialization
SQR setup/utility	setup03i.sqc	Printer and page-size initialization
SQR setup/utility	setup031.sqc	Printer and page-size initialization
SQR setup/utility	setup04i.sqc	Printer and page-size initialization
SQR setup/utility	setup041.sqc	Printer and page-size initialization
SQR setup/utility	setup06.sqc	Setup for extract files
SQR setup/utility	setup07.sqc	Printer and page-size initialization
SQR setup/utility	setup10.sqc	Printer and page-size initialization
SQR setup/utility	setup10a.sqc	Printer and page-size initialization
SQR setup/utility	setup31.sqc	Printer and page-size initialization (portrait)
SQR setup/utility	setup32.sqc	Printer and page-size initialization (landscape)
SQR setup/utility	setupdb.sqc	Database-specific setup
SQR setup/utility	sqlerr.sqc	SQL error-handling procedure
SQR setup/utility	stdinit.sqc	Reports initialization and timing routines
SQR setup/utility	tranctrl.sqc	Supports commit, rollback, etc., across platforms. Can be used in other SQRS by performing a “do commit-transaction” rather than a “commit”
SQR setup/utility	useprntr.sqc	Indicates which printer to use for reports
SQR setup/utility	utils.sqc	Printing utilities (word wrap)
System report	sysauthi.sqc	PS operator authorized item edit report
System report	sysauthp.sqc	Verifies that authorized process group operator exists
System report	sysauths.sqc	PS operator authorized sign on edit report
System report	sysclrls.sqc	Audit of audit tables (verifies data in audit tables is exclusive)
System report	sysdbfld.sqc	PS database field definition edits report
System report	sysecmgr.sqc	Report of EDI maps
System report	syshelpi.sqc	PS help index edits report
System report	syshelpt.sqc	PS help text edits report
System report	sysimpdf.sqc	PS import definition edits report
System report	sysimpfd.sqc	PS import definition field edits report
System report	sysimpxl.sqc	PS import translate edits report
System report	syslang, sqc	Audit report of language tables
System report	sysmenud.sqc	PS menu definition edits report
System report	sysmenui.sqc	PS menu item edits report
System report	sysoprdf.sqc	PS operator-definition edits report
System report	syspcmnm.sqc	PS PeopleCode program manager name report
System report	syspcmpr.sqc	PS PeopleCode program manager report
System report	syspnldf.sqc	PS panel definition field count report
System report	syspnlfd.sqc	PS panel field edits report
System report	syspnlgr.sqc	PS panel group edits report
System report	sysprgnm.sqc	PS PeopleCode program name edits report
System report	sysqrybn.sqc	PS query binds edits report
System report	sysqrycr.sqc	PS query definition criteria edits report
System report	sysqrydf.sqc	PS query definition edits report
System report	sysqryfd.sqc	PS query definition field edits report
System report	sysqryrc.sqc	PS query definition record edits report
System report	sysqrysl.sqc	PS query definition selection edits report
System report	sysrecdf.sqc	PS record definition edits report
System report	sysrecfd.sqc	PS record definition field edits report
System report	systreeb.sqc	PS tree branch edits report
System report	systreed.sqc	PS tree definition edits report
System report	systreel.sqc	PS tree level/node/leaf edits report
System report	systrees.sqc	PS tree structure edits report
System report	sysversn.sqc	PS lock version report
System report	sysviewt.sqc	PS view text edits report
System report	sysxlatt.sqc	PS translate table edits report
Upgrade	updvers.sqc	Common upgrade version lock routines
Upgrade	upg.sqc	Common upgrade defines
Upgrade	upgattr.sqc	Upgrade process—comparison & conflict identification
Upgrade	upgcodes.sqc	Upgrade process—load codes
Upgrade	upghdg01.sqc	Upgrade report standard heading #1
Upgrade	upghdg02.sqc	Upgrade report standard heading #2
Upgrade	upgpr.sqc	Upgrade process—common procedures
Upgrade	upgsetup.sqc	Retrieve parameters from command line