Class SY_DictionaryConversionCommon

Known SubClasses

SY_DictionaryConversion0500

Properties

No Properties

Methods

FUNCTION ConvertDictionary(beginVersion$)  
FUNCTION ConvertDictionary(beginVersion$, moduleCode$)  
FUNCTION ConvertDictionary(beginVersion$, moduleCode$, endVersion$)  

Generic conversion routine used to convert the dictionary definition of a table. The routine will execute all current DICTIONARY records from the driver table.

ParameterDescription
beginVersion$ [input, string] Beginning, or original system version being upgraded from
moduleCode$ {optional} [input, string] Used to filter conversion for stand-alone modules such as Payroll. Default "SYS"
endVersion$ {optional} [input, string] Ending, or new version being upgraded to.
Returns [boolean]
ValueDescription
retFAILURE (0) - an error was encountered
retSUCCESS (1) - conversion logic was processed without error
FUNCTION DropColumn(table$, columnList$)  

Function to delete a column or a list of columns from the data dictionary

ParameterDescription
table$ [input, string] Table from where the columns are to be deleted
columnList$ [input, string] Comma separated list of columns to be deleted
Returns [Boolean]
ValueDescription
retFAILURE (0) - if an error was encountered or a column is currently used in one or more keys
retSUCCESS (1) - if the column(s) dropped successfully or do not exist
FUNCTION DropIndex(table$, indexList$)  

Function to delete an index or a list of indexes from the data dictionary

ParameterDescription
table$ [input, string] Table from where the indexes are to be deleted
columnList$ [input, string] Comma separated list of indexes to be deleted
Returns [Boolean]
ValueDescription
retFAILURE (0) - if an error was encountered
retSUCCESS (1) - if the index(es) dropped successfully or do not exist
FUNCTION DropTable(table$)  

Function to delete a table definition from the data dictionary

ParameterDescription
table$ [input, string] Table to be deleted
Returns [Boolean]
ValueDescription
retFAILURE (0) - if an error was encountered
retSUCCESS (1) - if table was dropped successfully or the table does not exist
FUNCTION RemoveExtensionValue(entityType$, entityName$, extnName$, extnValue$)  

Function to remove an Extension value (Custom Info) from a table, column, or class. Only string values are valid as numeric values are not merged.

ParameterDescription
entityType$ [input, string] DDF, DDE, or DCL. Determines if the extension is for a table, column, or class.
entityName$ [input, string] The name of the table, column, or class. Column names use the format "TableName" + "." + ColumnName. Ex. "AR_Customer.CustomerName"
extnName$ [input, string] The variable name for the extension value being removed. Ex. For table business objects: "busobj$".
extnValue[$] [input, string] The extension value to be removed.
Returns [boolean]
ValueDescription
retFAILURE (0) - an error was encountered
retSUCCESS (1) - The extension value was removed or did not exist
FUNCTION SetPropertyValue(tableName$, columnName$, propertyName$, propertyValue)  
FUNCTION SetPropertyValue(tableName$, columnName$, propertyName$, propertyValue$)  

Function to set a dictionary property for a table or column. Use this method to reduce a value, such as a column length since the merge logic will only increase such values.

ParameterDescription
tableName$ [input, string] Table name
columnName$ [input, string] Column name - blank to set table property
propertyName$ [input, string] Property to set (matches dde/ddf column name)
propertyValue[$] [input, numeric/string] Numeric or string property value
Returns [boolean]
ValueDescription
retFAILURE (0) - an error was encountered
retSUCCESS (1) - The property was set without error
FUNCTION WriteToLog(logText$, format$)  
FUNCTION LOCAL GetDictionaryObject(oDictionary)  

Function to create and return a handle to a "*dict/dictionary" object.

ParameterDescription
oDictionary [output, object] Handle to the dictionary object
Returns [boolean]
ValueDescription
retFAILURE (0) - an error was encountered
retSUCCESS (1) - The dictionary object was created successfully
FUNCTION LOCAL RemoveAndGenerateNewExtension(oldExtn$, extnPfx$, extnName$, extnValue$, newExtn$)  

Private function to remove an Extension value and return the new Extension (without the value)

ParameterDescription
entityType$ [input, string] DDF, DDE, or DCL. Determines if the extension is for a table, column, or class.
entityName$ [input, string] The name of the table, column, or class. Column names use the format "TableName" + "." + ColumnName. Ex. "AR_Customer.CustomerName"
extnName$ [input, string] The variable name for the extension value being removed. Ex. For table business objects: "busobj$".
extnValue[$] [input, string] The extension value to be removed.
Returns [boolean] retSUCCESS
FUNCTION LOCAL UpdateProgressBar()  
FUNCTION LOCAL UpdateProgressBar(text$)  
FUNCTION LOCAL 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] percentage to force the progress bar to show
Returns [numeric]
ValueDescription
retSUCCESS (1)
FUNCTION LOCAL WriteToLog(logText$)  
FUNCTION LOCAL WriteToLog(logText$, logLevel)  
FUNCTION LOCAL WriteToLog(logText$, logLevel, logRaw)  

Writes text to the conversion log.

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()

Methods inherited from: SY_FunctionHook

PostTableRead(), PreNextRecord(), PreTableWrite()