Class SY_Metering

Known SubClasses

FM_QATest

Properties

LOCAL cCrLf$=$0D0A$  

Carriage return + line feed

LOCAL cDisplayMsg=isTRUE  
Indicates whether or not to display a message
LOCAL cUnlimited=-1  
Indicates the subscription level is unlimited
LOCAL cMeterKey$="FEB1A446C219A87E92469DB60F28F6C7867BACB2A939072998024BF2273FEEFB0C3D22AF68A9922ECABD72D132D8B308"  
Key for table
LOCAL cPayrollTierInfringementCode$="1"  
Infringement code for exceeding the payroll tier
PROPERTY PanelMsg$   * Read Only *
Message to display in Payroll Tax Calculations panel

Methods

the service could not be reached.

FUNCTION CheckActiveEmployees()  

This will check if the number of Active Employees is within the subscription level

Returns [boolean] Always returns Success
FUNCTION CheckForUpdates()  

Initiates a call to the entitlement service and displays a message indicating whether registration updates have been installed or not.

Returns [numeric] retSUCCESS if updates were installed, retWARNING if no updates were found, retFAILURE if
FUNCTION CheckSLSClient()  

Wrapper function for SY_Registration'CheckSLSClient().

Returns [boolean] True if the client is available, otherwise false.
FUNCTION CheckSubscription(PR6FH)  
FUNCTION CheckSubscription(PR6FH, processUI)  

This will check if the number of unique Employees being paid in a Calendar Month is within the subscription level

ParameterDescription
PR6FH [input, numeric] Handle to a memory table with an IOL of EmployeeKey$,DepartmentNo$,EmployeeNo$
Returns [boolean] Success if the subscription level is not exceeded, otherwise Failure
FUNCTION ConvertPayroll2(companyCode$)  

Convert existing metering records to use new payroll key.

ParameterDescription
companyCode$ [input, string] The company code of the company being converted.
Returns [boolean] Always returns Success
FUNCTION ConvertPu2()  

Convert to 2016 PU2 Schema

Returns [boolean] Always returns Success
FUNCTION RemoveEmployeeKey(employeeKey$)  

Remove employee key

ParameterDescription
employeeKey$
FUNCTION ReSyncMeteringTable()  

This will drop table SY_Metering, create it and populate it for the current Calendar Month, from PR_PayrollHistoryHeader

Returns [boolean] Success if the re-sync completes successfully, otherwise Failure
FUNCTION LOCAL CountActiveEmployees()  

This will count the number of Active Employees

Returns activeCount [numeric] Number of Active Employees
FUNCTION LOCAL CreateTempTable()  

This will create a temporary table based on the layout of table SY_Metering

Returns tempFH [numeric] Handle for temporary table
FUNCTION LOCAL Find(key$)  

Determines if the key exists in the file.

ParameterDescription
key$ [input, string] The key value
Returns [boolean] True if the key was found, otherwise false.
FUNCTION LOCAL GetPayrollCompanyList$()  

Used to get a list of company codes that have the payroll module activated.

Returns [string] A delimited list of company codes.
FUNCTION LOCAL OpenMeteringTable()  

This will open table SY_Metering, creating it first if missing

Returns meterFH [numeric] Handle for table SY_Metering
FUNCTION LOCAL PopulateMeteringTable(meterFH)  

This will populate table SY_Metering for the current Calendar Month, from table PR_40

ParameterDescription
meterFH [input, numeric] Handle for table SY_Metering
Returns [boolean] Always returns Success
FUNCTION LOCAL Restore(key$, data$)  

Restore the original values.

ParameterDescription
key$ [input/output, string] The key value
data$ [input/output, string$] The data value
Returns [boolean] True if the original values were able to be restored, otherwise false.
FUNCTION LOCAL UpdatePEP()  

Update PEP information

Returns [boolean] Always returns Success
FUNCTION LOCAL Write(key$, data$, overwrite, ch)  
FUNCTION LOCAL Write(key$, data$, overwrite)  
FUNCTION LOCAL Write(key$, data$)  

Write a metering record.

ParameterDescription
key$ [input, string] The key value
data$ [input, string$] The data value
overwrite [input, boolean] Overwrite existing record if true, default is false
ch [input, numeric] Optional file channel, default is cMeterFH
Returns [boolean] True if table was potentially modified, otherwise false.

Properties inherited from: SY_Constant

retFAILURE, retSUCCESS, retNEW, retWARNING, retCANCEL, retYES, retNO, msgYES$, msgNO$, msgCANCEL$, msgOK$, msgRETRY$, msgABORT$, msgIGNORE$, msgNOTONFILE$, msgTIMEOUT$, msgDISABLE, msgACTIVE, msgLinkHELP$, msgLinkMSG$, isFALSE, isTRUE, isYES$, isNO$, isBUSY$, edtNONE, edtEXISTS, edtNEW, ctlDISABLE, ctlENABLE, ctlSHOW, ctlHIDE, ctlLOCK, ctlUNLOCK, ctlLOCKORDISABLE, ctlUNLOCKORENABLE, popHIDE, popDISABLE, popSHOW, popSHOWCHECKED, grdMODEVIEW, grdMODEMAINT, grdMODEADD, filCREATE, filLOCK, filCREATELOCK, filGLOBAL, filCREATEGLOBAL, filLOCKGLOBAL, filCREATELOCKGLOBAL, filCHANNEL, filRAW, filPURGE, filLOAD, filINPUT, filNOOBJECT, filPVX, filREFRESH, filPVX4$, filPVX5$, pthCOMPANY$, pthOTHERCOMPANY$, pthPRCOMPANY$, pthOTHERPRCOMPANY$, pthSYSTEM$, pthUSER$, pthSOA$, pthHOME$, pthROOT$, pthDICTIONARY$, pthTEXTOUT$, pthLOCK$, pthLOCKSYS$, pthPREFIX$, pthARCHIVE$, pthLOGFILES$, folderCOMMONPROGRAMFILES, folderCOMMONAPPLICATIONDATA, errOBJECT, errSYSTEMLOCK, errCONTINUE, errEMBEDDEDIO, errSYSLOCK, extSQLCREATETABLE$, extSQLALLOWNULLDATES$, dbALL$, dbNONE$, dateTOSTRINGFORMAT$, dateLONGMASK$, dateSHORTFMT, dateLONGFMT, dateYEARFIRST, dateMONTHFIRST, dateDAYFIRST, timeMINUTESMASK$, timeMINUTES24MASK$, timeSECONDSMASK$, timeSECONDS24MASK$, idxPRIMARY$, idxBATCH$, idxDISPLAY$, dirFIRST, dirLAST, dirNEXT, dirPREVIOUS, typALPHANUM, typZEROFILL, typCHARNUM, typMASTERNUM, typALPHANUMNF, typMASTERNUMC, typALPHA$, typNUMBERS$, typALPHANUM$, typALPHANUMNF$, typCHARNUM$, typMASTERNUM$, typMASTERNUMCLEN, modTASKOTFDISALLOW$, logALLACTIVITY$, logACTIVITY$, logERROR$, logACTNEWCUSTOMER$, logACTDATASYNC$, logACTDATAIMPORT$, logACTOPTIONCHANGED$, logACTPROGRAMLAUNCH$, logDFDM$, logSECURITY$, logTASKSCHEDULER$, logWEBERROR$, logVISUALINTEGRATOR$, logEntryIDLength, chkOFF$, chkON$, chkGRAYED$, secVIEWONLY, secCREATEONLY, secMODIFYONLY, secCREATEMODIFY, secDELETEONLY, secCREATEDELETE, secMODIFYDELETE, secFULLACCESS, secDEFAULTUSER$, secDEFAULTROLE$, regHKEY_CLASSES_ROOT, regHKEY_CURRENT_USER, regHKEY_LOCAL_MACHINE, regHKEY_USERS, regHKEY_CURRENT_CONFIG, regODBC_PATH$, regMAS_PATH$, E3_MYHANDLE, E3_TASK, E3_QUIT, E3_COCHANGE, E3_DATECHANGE, E3_USERCHANGE, E3_SRVRPATH, E3_HELPFILE, E3_TECHSUPPORT, E3_QUERYTOQUIT, E3_SUPERVISOR, E3_CUSTOMIZE, E3_SWITCHMODULE, E3_DISABLEWIN, E3_CURSOR, E3_USERID, E3_PRIVATETASK, E3_CHAT, E3_BROADCAST, E3_RELOAD, E3_PASSTHROUGH, E3_EXECUTE, E3_EXPCOCHANGE, E3_EXPTASK, E3_EXPLAUNCH, E3_SILENT, E3_DIRECT, E3_NODELIST, E3_OCXITEM, E3_MODULEID, E3_CUSTFAV, E3_HOMEPAGE, E3_MINIMIZE, E3_UNDOCKED, E3_DOCKED, E3_PUBLICTASK, E3_LAUNCHURL, E3_BTNCHANGE, E3_STDBTNRELOAD, E3_MYBUSINESS, E3_REGLOADED, E3_LOADED, E3_V4TASK, E3_PUBMODIFY, E3_TASKRELOAD, E3_SETAUTOHIDE, E3_COCHANGE2, E3_TASK_NC, E3_V4TASK_NC, E3_TASK_ALTC, E3_V4TASK_ALTC, E3_PASSWORD, E3_LAUNCHVIEW, E3_LAUNCHBIETASK, E3_CLEANUPBIE, E3_STARTVIEW, E3_BIE_ADMIN, E3_HELPPATH, E3_CUSTOMERID, E3_MASVERSION, E3_LAUNCHEMBEDDED, E3_LAUNCHERMENU, E3_APP_POINTSIZE, E3_LAUNCHERVERSION, E3_DISABLE, E3_ENABLE, E3_SHOW, E3_HIDE, E3_REFRESH, E3_LIBMASTER, WM_COPY, wtsINITIALPROGRAM, wtsAPPLICATIONNAME, wtsWORKINGDIRECTORY, wtsOEMID, wtsSESSIONID, wtsUSERNAME, wtsWINSTATIONNAME, wtsDOMAINNAME, wtsCONNECTSTATE, wtsCLIENTBUILDNUMBER, wtsCLIENTNAME, wtsCLIENTDIRECTORY, wtsCLIENTPRODUCTID, wtsCLIENTHARDWAREID, wtsCLIENTADDRESS, wtsCLIENTDISPLAY, wtsCLIENTPROTOCOLTYPE, thmNORMAL, thmMETAL, thmOLIVE, rptREPORTTYPESTD, rptREPORTTYPELABEL, rptREPORTTYPEMULTCOL, rptISTRUE, rptISFALSE, rptISDEFAULT, rptPORTRAIT, rptLANDSCAPE, rptASCENDING, rptDESCENDING, rptRIGHTALIGN, rptLEFTALIGN, rptHORCENTERALIGN, rptLSSINGLELINE, rptSTSUM, rptSTAVERAGE, rptSTCOUNT, rptDFLTHSPACING, rptDFLTVSPACING, rptDFLTFONTSIZE, rptDFLTLEFT, rptDFLTTOP, rptTWIPSPERCHARW, rptTWIPSPERCHARH, rptSVTREPORTTITLE, rptEDTDISKFILE, rptGCANYVALUE, rptGCDAILY, rptCRDATEFIELD, rptCRDATETIMEFIELD, crEFTCrystalReport, crEFTRichText, crEFTWordForWindows, crEFTExcel, crEFTPortableDocFormat, crEFTHTML32, crEFTHTML40, crEFTExcelRecord, crEFTText, crEFTCharacterSeparatedValues, crEFTTabSeparatedText, crEFTEditableRTF, crEFTXml, crEFTRPTR, crEFTExcelWorkbook, cContextKeyLen1, cContextKeyLen2, cContextKeyLen3, adCmdText, adCmdStoredProc, adClipString, adExecuteNoRecords, adVarChar, adInteger, adParamInput, adParamOutput, adParamInputOutput, adParamReturnValue, adTextNoRecords, adOpenForwardOnly, adOpenStatic, adLockReadOnly, adUseServer, adUseClient, dbTMP$, dbTEMPDB$, dbSYSDB$, dbPVXDDF, dbPVXDB, dbMYSQL, dbADO, dbSQL, LastErrorMsg$, LastErrorNum$, SageCloudAppDesc$, IolNomads$

Properties inherited from: SY_OpenObject

cLockInfoNOKEY$

Properties inherited from: SY_Password

AESCipher$, AES256Cipher$

Methods inherited from: SY_Constant

GetNOMADSIolist$(), MaskString(), RawString(), ClassValidateEMailAddress(), dateTODAY$(), Element$(), fmtMODCODE$(), fmtMODPREFIX$(), PERFORM FunctionBreak(), GetExceptionMsg$(), GetFileName(), GetJobTitles(), GetPrinterProps(), GetRecordCount(), isALPHA(), isDATE(), isNUMERIC(), MsgPath$(), ParseString(), ParseTagField(), Position(), QUO$(), ValidateFormatType()

Methods inherited from: SY_OpenObject

CheckWhoHasLock(), CreateLockInfo(), RemoveLockInfo(), OpenTable(), OpenTempFile()

Methods inherited from: SY_Password

ConfirmAESKey(), ConfirmPassword(), EncryptAESData(), EncryptAESKey(), EncryptAESPassword(), EncryptPassword(), GetAESDataTest$(), PasswordAcceptable(), ValidateAESData(), ValidateAESPassword(), ValidatePassword(), VerifyAESDataEncryption(), DecryptAESData(), DecryptAESKey(), DecryptAESPassword(), DecryptAltAESData(), DecryptPassword(), EncryptAltAESData(), GetKEK$(), InitAESKey(), InitializeAES(), InitializeAltAES(), ValidateAltAESData(), VerifyAltAESDataEncryption()