Class SY_SearchData_ACenc

Inherits

SY_Constant

Properties

LOCAL cDefaultFieldSep$=SEP  

Default field separator

LOCAL cIndexAlternateSep$=$FF$+SEP  

Alternate field separator to be used when writing index to ensure all results are found

PROPERTY EncryptedIndexName$   * Read Only *

Name to use for the search index file(s); will default to "INDEX" when not set

PROPERTY EncryptedIndexPassword$   * Read Only *

Password to use to open encrypted index

Methods

FUNCTION BuildIndex(company$, entity$, oEntityKey, oEntityName, oDocumentKey, oDocumentData, oDocumentStored, oDocument, compTypes$, statusMsg$)  

Build the data index for the specified enties in company

ParameterDescription
company$ [input, string] Company code for tables to use to create the data for the search index
entity$ [input, string] A name used to identify the application entity to be associated with the data
oEntityKey [input, object] Reference to EntityKey object for index
oEntityName [input, object] Reference to EntityName object for index
oDocumentKey [input, object] Reference to DocumentKey object for index
oDocumentData [input, object] Reference to DocumentData object for index
oDocumentStored [input, object] Reference to DocumentData object for index
oDocument [input, object] Reference to Document object for index
compTypes$ [input, object] list of company types to rebuild index for this could be any value in "LADT", a blank value will rebuild for all companies
statusMsg$ [output, string] Status message for actions performed by build process
Returns [boolean] 0 - Failure, 1 - Success
FUNCTION GetDataFields$(entity$)  

Get list of fields to use for separating the search data stored in the DocData field in the search index.

ParameterDescription
entity$ [input, string] A name used to identify the application entity to be associated with the data
Returns [string] List of fields to use for DocData field in the search Index
FUNCTION GetDataIOL$(entity$)  

Get IOList to use for separating the search data stored in the DocData field in the search index into fields.

ParameterDescription
entity$ [input, string] A name used to identify the application entity to be associated with the data
Returns [string] IOLIST to use for DocData field in the search Index
FUNCTION GetMlacExpressions(entity$, out.DisplayExpr$, out.ReturnExpr$)  

Get expressions to be override Auto-Complete defintion used in *obj/mlac for data display and returned value

ParameterDescription
entity$ [input, string] A name used to identify the application entity to be associated with the data
out.DisplayExpr$ [output, string] Expression to be used to create data value to display in selection list
out.ReturnExpr$ [output, string] Expression to be used to set the data value to be returned for selected row in selection list
Returns [boolean] retSUCCESS(1) when override values are defined, retFAILURE(0) when no override values are defined
Info

This method should be implemented in child class to define IOLIST for data to display to allow for greater flexibility when using Advanced Search

FUNCTION GetResultsFields$(entity$)  

Get list of fields to use for Report View when using the Advanced Search

ParameterDescription
entity$ [input, string] A name used to identify the application entity to be associated with the data
Returns [string] List of fields to use for DocData field in the search Index
FUNCTION GetResultsFormat$()  
FUNCTION GetResultsFormat$(entity$)  

Get format definition to use for the display of the search results in the Report-View of the Advanced Search

ParameterDescription
entity$ [input, string, optional] A name used to identify the application entity to be associated with the data
Returns [string] Format definition used to display search results in Advanced Search dialog
FUNCTION GetResultsIOL$(entity$)  

Get IOList to use for data to load into the Report View when using the Advanced Search

ParameterDescription
entity$ [input, string] A name used to identify the application entity to be associated with the data
Returns [string] IOLIST to use for data to load into Reort View to display the search results in Advanced Search dialog
FUNCTION GetStoredFields$(entity$)  

Get list of fields to use for separating the stored data stored in the DocStored field in the search index into fields.

ParameterDescription
entity$ [input, string] A name used to identify the application entity to be associated with the data
Returns [string] List of fields to use for DocData field in the search Index
FUNCTION GetStoredIOL$(entity$)  

Get IOList to use for separating the stored data stored in the DocStored field in the search index into fields.

ParameterDescription
entity$ [input, string] A name used to identify the application entity to be associated with the data
Returns [string] IOLIST to use for DocStored field in the search Index
Info

This method can be implemented in child class to define IOLIST for data to be stored in the search index but not included as part of a search

FUNCTION GetStoredValue$(entity$, company$, dataRec$, dataIOL$)  

Get data value (not translated) for the DocStored field in the search index

ParameterDescription
entity$ [input, string] A name used to identify the application entity to be associated with the data
company$ [input, string, optional] Company code
dataRec$ [input, string] A string containing the field data values for entity main file record
dataIOL$ [input, string] An IOLIST for entity main file
Returns [string] Stored data record to use for DocStored field in the search Index
Info

This method can be implemented in child class to define the data to be stored in the search index but not included as part of a search. This stored data can be used in the results format to show formatted data or other information.

FUNCTION IsIndexEncrypted()  

Is index encrypted?

Returns [boolean] 0 - Not Encrytped, 1 - Encrypted
Info

This method must be implemented in child class if associated index is encrypted

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$, folderPROGRAMFILES, folderPROGRAMFILESX86, folderCOMMONAPPLICATIONDATA, folderCOMMONPROGRAMFILES, folderCOMMONPROGRAMFILESX86, errOBJECT, errSYSTEMLOCK, errCONTINUE, errEMBEDDEDIO, errSYSLOCK, extSQLCREATETABLE$, extSQLALLOWNULLDATES$, envSPP$, envDEFAULT$, 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, typMASTERNUMI, 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$, closeTaskLAUNCHERQUIT, closeTaskSHUTDOWNALL, closeTaskMASTERCONSOLE, closeTaskAUTOLOGOFF, closeTaskDESCRIPTIONS$, secVIEWONLY, secCREATEONLY, secMODIFYONLY, secCREATEMODIFY, secDELETEONLY, secCREATEDELETE, secMODIFYDELETE, secFULLACCESS, secDEFAULTUSER$, secDEFAULTROLE$, secDEFAULTCOMPANY$, 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, usrDspLOGON$, usrDspNAME$, usrDspCODE$, usrDspEMAIL$, 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, sqlSQLOLEDB$, LastErrorMsg$, LastErrorNum$, RoleTypes$, SageCloudAppDesc$, IolNomads$

Methods inherited from: SY_Constant

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