Class SY_ConversionDriver

Properties

LOCAL cLogAsInfo$="INFO"  

[String] Log format to indicate log message is for informational purposes, not a failure.

LOCAL cUpdatedTableList$=SEP  
[String] List of tables that have already been physically updated during this conversion run.
LOCAL cModuleListPR$="P/R|"  
[String] Constant used to represent a module list that contains payroll.
LOCAL cModuleListCI$="C/I|"  
[String] Constant used to represent a module list that contains C/I.
LOCAL cModuleListSY$="SYS|"  
[String] Constant used to represent a module list that contains SYS.
PROPERTY LogObj   * Read Only *
[objHandle] Handle to the current log object

Methods

FUNCTION CheckConversionHistory(companyCode$, version$, cnvType$, table$, cnvID$, developerCode$)  

Check if a particular record is in the SY or CI Conversion History file

ParameterDescription
companyCode$ [input, string] Company being converted for company conversions, null to check system conversion history.
version$ [input, string] The version number (formatted).
cnvType$ [input, string] Conversion Type - "DATA", "REMOVEDATA", or "DICTIONARY"
table$ [input, string] Table Name.
cnvID$ [input, string] Conversion ID value.
developerCode$ [input, string] Developer Code.
Returns [boolean] Success if record in conversion history table, otherwise failure.
FUNCTION ConversionRequired(companyCode$)  
FUNCTION ConversionRequired(companyCode$, conversionRequired$)  

Function to check if a company requires conversion

ParameterDescription
companyCode$ [input, string] Company to check if conversion is required
conversionRequired$ {optional} [output, string] List of required conversion records.
Returns [Boolean]
ValueDescription
retFALSE (0) - if conversion is not required
retTRUE (1) - if conversion is required
FUNCTION ConvertCompany(companyCode$)  
FUNCTION ConvertCompany(companyCode$, beginningLevelList$)  

Function to initiate the conversion process of company data

ParameterDescription
companyCode$ [input, string] Company code for the data to be converted
beginningLevelList$ {optional} [input, string] Beginning Module Level + Sub Level before conversion in the format "G/L"+"|"+"04.30"+"|"+"03"+SEP = where the starting G/L level was 4.30 Sublevel 3
Returns [Boolean]
ValueDescription
retFAILURE (0) - if an error was encountered
retSUCCESS (1) - if conversion completed normally
FUNCTION ConvertDictionary(beginVersion$, newVersion$)  
FUNCTION ConvertDictionary(beginVersion$, newVersion$, moduleCode$)  

Function to initiate the conversion of the data dictionary

ParameterDescription
beginVersion$ [input, string] Beginning, or original system version being upgraded from
newVersion$ [input, string] Version being installed or upgraded to
moduleCode$ {optional} [input, string] Default is null, set when installing a stand-alone module such as payroll
Returns [Boolean]
ValueDescription
retFAILURE (0) - if an error was encountered
retSUCCESS (1) - if conversion completed normally
FUNCTION ConvertSystem()  
FUNCTION ConvertSystem(moduleList$)  
FUNCTION ConvertSystem(moduleList$, beginningSystemVersion$)  
FUNCTION ConvertSystem(moduleList$, beginningSystemVersion$, beginningLevelList$)  
FUNCTION ConvertSystem(moduleList$, beginningSystemVersion$, beginningLevelList$, finalVersion$)  

Function to initiate the system conversion process

ParameterDescription
moduleList$ {optional} [input, string] Delimited list of System module codes to be converted in the format "C/M|C/U|P/L|". All system modules except SYS are converted if this is omitted.
beginningSystemVersion$ {optional} [input, string] Beginning, or original system version being upgraded
beginningLevelList$ {optional} [input, string] Beginning Module Level + Sub Level before conversion in the format "SYS"+"|"+"04.30"+"|"+"03"+SEP = where the starting Library Master level was 4.30 Sublevel 3
finalVersion$ {optional} [input, string] The final version to which the software is being upgraded
Returns [Boolean]
ValueDescription
retFAILURE (0) - if an error was encountered
retSUCCESS (1) - if conversion completed normally
FUNCTION InitializeLogObject()  
FUNCTION RemoveData()  
FUNCTION RemoveData(beginningSystemVersion$)  
FUNCTION RemoveData(beginningSystemVersion$, moduleCode$)  

Function to remove system data during upgrade installations

ParameterDescription
beginningSystemVersion$ {optional} [input, string] Beginning, or original system version being upgraded
moduleCode$ {optional} [input, string] Optional module filter. Default "SYS".
Returns [Boolean]
ValueDescription
retFAILURE (0) - if an error was encountered
retSUCCESS (1) - if system data removal completed normally
FUNCTION TablePreviouslyUpdated(tableName$)  

Check if a table has already been physically updated during this conversion run.

ParameterDescription
tableName$ [input, string] Table Name.
Returns [boolean] Non-zero if table is found in the list of tables that have been previously updated, otherwise zero.
FUNCTION UpdateCompanyVersion(companyCode$)  

Function to update the company version in the SY_Company record and CI_Options to the current SY_System.Version$. This function is meant to only be called by SY_Session'CheckForConversion() when no conversion is required. As a precaution, this function also calls the local ConversionRequired method. If ConversionRequired returns true, then the update is aborted.

ParameterDescription
companyCode$ [input, string] Company to update the CompanyVersion$ for
Returns [Boolean]
ValueDescription
retFALSE (0) - if company requires conversion and company version was not updated.
retTRUE (1) - if company version was updated
FUNCTION UpdateConversionHistory(moduleCode$)  
FUNCTION UpdateConversionHistory(moduleCode$, beginVersion$)  
FUNCTION UpdateConversionHistory(moduleCode$, beginVersion$, companyCode$)  
FUNCTION UpdateConversionHistory(moduleCode$, beginVersion$, companyCode$, endVersion$)  
FUNCTION UpdateConversionHistory(moduleCode$, beginVersion$, companyCode$, endVersion$, cnvType$)  

Function to update the conversion history records when activating a new system or a modules that is new to a company

ParameterDescription
moduleCode$ [input, string] The module to update the conversion history records for
beginVersion$ {optional} [input, string] Specify a beginning version to update the conversion history records for. SY_System.Version$ will be used if left blank.
companyCode$ {optional} [input, string] Specify a companyCode to update the conversion history records for. Leave blank to update system wide module conversion history.
endVersion$ {optional} [input, string] End version. Point at which to stop the update of conversion history records.
convType$ {optional} [input, string] SEP separated list of Conversion type[s]. Defaults to "DATA" + SEP + "REMOVEDATA".
Returns [Boolean]
ValueDescription
retFAILURE (0) - if an error was encountered
retSUCCESS (1) - if conversion history was updated normally
FUNCTION UpdateDictionaryConversionHistory()  
FUNCTION UpdateDictionaryConversionHistory(beginVersion$)  
FUNCTION UpdateDictionaryConversionHistory(beginVersion$, moduleCode$)  

Function to update the dictionary conversion history records for a new install

ParameterDescription
beginVersion$ {optional} [input, string] Specify a beginning version to update the conversion history records for. SY_System.Version$ will be used if left blank.
moduleCode$ {optional} [input, string] Default is null, set when installing a stand-alone module such as payroll
Returns [Boolean]
ValueDescription
retFAILURE (0) - if an error was encountered
retSUCCESS (1) - if dictionary conversion history was updated normally
FUNCTION UpdateProgressBar()  
FUNCTION UpdateProgressBar(text$)  
FUNCTION UpdateProgressBar(text$, percent)  

Function exposed to provide a progress bar to the conversion class

ParameterDescription
text$ {optional} [input, string] Text to be displayed on the progress bar
percent {optional} [input, integer] Force the progress bar to show a certain percentage complete
Returns [Nothing]
FUNCTION UpdateTableList(tableName$)  

Add a table to the list of tables that have already been physically updated during this conversion run.

ParameterDescription
tableName$ [input, string] Table Name.
Returns [Nothing]
FUNCTION WriteToLog(logText$)  
FUNCTION WriteToLog(logText$, logLevel)  
FUNCTION WriteToLog(logText$, logLevel, logRaw)  
FUNCTION WriteToLog(logText$, format$)  

Function exposed to provide access to the conversiona log for the conversion class

ParameterDescription
logText$ [input, string] Text to be written to the conversion log
format$ {optional} [input, string] Use to specify log entry format. Ex. "INFO" creates informational entry without the typical error log info such as program, line number, etc.
logLevel {optional} [input, integer] Use to specify level of detail to be logged
logRaw {optional} [input, integer] Text will be written without formatting
Returns [Nothing]

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_ConversionConstant

cnvtagCOLDROP$, cnvtagIDXDROP$, cnvtagSETDEFAULT$, cnvtagSETINVALID$, cnvtagSETVALUE$, cnvtagTBLCOPY$, cnvtagTBLUPDATE$, cnvtagTBLDROP$, cnvtagRECDROP$, cnvtypDATA$, cnvtypDICTIONARY$, cnvtypREMOVEDATA$, cnvtypINFORMATION$, vertokenSYSTEM$, vertokenPAYROLL$, devcodeSAGE$, versionSELECTLENGTH

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_ConversionConstant

GetValidCnvTags$(), GetValidCnvTypes$(), FormatVersion$(), GetConstantValues(), IsPvxToSQLConversion(), IsPvxToSQLTable()