Class SY_ConversionConstant

Properties

LOCAL cnvtagCOLDROP$=""  
LOCAL cnvtagIDXDROP$=""  
LOCAL cnvtagSETDEFAULT$=""  
LOCAL cnvtagSETINVALID$=""  
LOCAL cnvtagSETVALUE$=""  
LOCAL cnvtagTBLCOPY$=""  
LOCAL cnvtagTBLUPDATE$=""  
LOCAL cnvtagTBLDROP$=""  
LOCAL cnvtagRECDROP$=""  
LOCAL cnvtypDATA$="DATA"  
LOCAL cnvtypDICTIONARY$="DICTIONARY"  
LOCAL cnvtypREMOVEDATA$="REMOVEDATA"  
LOCAL cnvtypINFORMATION$  
LOCAL vertokenSYSTEM$=""  
LOCAL vertokenPAYROLL$=""  
LOCAL devcodeSAGE$="000"  

[string] Const. Sage (factory) developer code

LOCAL versionSELECTLENGTH=2  
[numeric] Const. Number of version segments used to seed SY_ConversionDriver record selections

Methods

"FORMAT" - formats the supplied version as #.##.#.# where the second segment is right-zero-filled. "PAD" - formats the supplied version as 00.00.00.00 where the second segment is right-zero-filled, all others are left-zero-filled.

FUNCTION GetValidCnvTags$()  
FUNCTION GetValidCnvTags$(cnvType$)  

Function to return valid conversion tags for a given conversion type, in a SEP separated string.

ParameterDescription
cnvType$ {optional} [input, string] Conversion Type. "DATA","DICTIONARY","REMOVEDATA","INFORMATION"
Returns [string]
ValueDescription
SEP separated list of all conversion tags.
FUNCTION GetValidCnvTypes$()  

Function to return all valid conversion types, in a SEP separated string. Returns the LOCAL variable cAllCnvTypes$

Returns [string]
ValueDescription
SEP separated list of all conversion types
FUNCTION LOCAL FormatVersion$()  
FUNCTION LOCAL FormatVersion$(version$)  
FUNCTION LOCAL FormatVersion$(version$, formatOp$)  
FUNCTION LOCAL FormatVersion$(version$, formatOp$, length)  

Function to format a given version for display or searching conversion history, depending on the supplied format option

ParameterDescription
version$ {optional} [input, string] Version to be formated. Default is the current system version.
formatOp$ {optional} [input, string] Format Option. "FORMAT","PAD", default is "PAD"
ParameterDescription
length {optional} [input, number] Length (number of segments) of the version to return. Default is the max number of segments defined in CI_VersionFormatter.
Returns [String]
ValueDescription
Formated string version
FUNCTION LOCAL GetConstantValues()  

Function to return all valid conversion types and conversion tags, in a SEP separated string. Populates the local variables cAllCnvTypes$ and cAllCnvTags$ by reading the program and scanning for the constant prefixes.

Returns [boolean] Always returns retSUCCESS (1)
FUNCTION LOCAL IsPvxToSQLConversion(company$)  
FUNCTION LOCAL IsPvxToSQLConversion(company$, module$)  
FUNCTION LOCAL IsPvxToSQLConversion(company$, module$, openPvx, createPvx)  

Determines if the data being converted is in ProvideX but this is running in a SQL environment.

ParameterDescription
company$ [input, string] Company code of data to check. Not used for system module check.
module$ {optional} [input, string] Module code of data to check. If omitted, the current object's module will be used if applicable, or C/I is not.
openPvx {optional} [output, numeric] Returns filPVX value to use on OpenTable calls if data is found in Pvx files.
createPvx {optional} [output, numeric] Returns isTRUE to use as pvxFlag on CreateTable & DropTable calls if data is found in Pvx files.
Returns [boolean]
ValueDescription
false (0) - data is not in Providex or this is not a SQL environment
true (1) - data is in Providex and this is a SQL environment
FUNCTION LOCAL IsPvxToSQLTable(tableName$, path$)  

Determines if a Company table is in ProvideX while the system is running in a SQL environment. (Upgrade, Migration, Conversion)

ParameterDescription
tableName$ [input, string] Name of table to check
path$ [input, string] Path constant for the table
Returns [boolean]
ValueDescription
false (0) - The table is not in the file system (Pvx). or this is not a SQL environment.
true (1) - Table is in Providex and this is a SQL environment.