Class SY_OpenObject

Known SubClasses

AP_ARClearingRegister_UI, AP_CheckDataEntryProcesses, AP_CheckReversal_ui, AP_DeleteChangeVendors_ui, AP_EncryptVendorPII_ui, AP_Form1099Minimum_ui, AP_InvoiceRegister_ui, AP_ManualCheckRegister_ui, AP_PURGE1099PAYMENTHISTORY_UI, AP_PurgeHistory, AP_REMOVEINACTIVEVENDORS_UI, AP_REMOVEVOIDEDCHECKS_UI, AP_ReverseCheckRegister_ui, AP_VendorInactivation, AP_VendorInvoiceHistoryInquiry_ui, AR_CheckDataEntryProcesses, AR_ClearCreditCard, AR_CommissionEditRegister_UI, AR_CreditCard, AR_CreditLimit_ui, AR_CustomerInactivation, AR_CustomerInvoiceHistoryInquiry_ui, AR_CustomerRMAInquiry_ui, AR_DeleteChangeCustomers_ui, AR_FinanceChargeJournal_ui, AR_InvoiceHistoryAppliedSOInquiry_ui, AR_PurgeHistory, AR_RECALCULATEHIGHBALANCES_UI, AR_RemoveInactiveCustomers_ui, AR_SalesJournal_ui, BC_PurgeHistory, BM_BillOptionSelection_ui, BM_DefinedOptionCategories_ui, BM_PurgeBillOfMaterialsHist_UI, BM_ReplaceDeleteCompReg_ui, BR_ImportExportSettings_UI, BR_RecalculateUtility_UI, CI_AuditTracking, CI_BackOrderFillPopulate, CI_CommodityCodeImport_ui, CI_CommonAPJournal, CI_CommonCostRollup_Ui, CI_CostRecalc_upd, CI_CreditCardConversion, CI_ItemPrice, CI_PaymentCenter_ui, CI_RecalculateItemHistory_ui, CI_StandardCostAdjustment, CI_TierCostCalc, CI_UpdateDetailToIM, CI_UpdateHeaderToAR, CU_Rebuild_bus, CU_SCRMLink_bus, ES_DisplayDashboard_ui, ES_GenerateData, ES_Setup, FL_FALink, FL_PeriodEndProcessing_ui, FM_DemoDataDateChange_utl, FM_MergeDataDictionary_utl, GL_AccountApply_ui, GL_AccountBySeg_ui, GL_ChangeAccounts_UI, GL_Common, GL_DetailPosting_upd, GL_JournalDrillDown_ui, GL_JournalReversal, GL_RecalcUtility_ui, IM_DeleteChangeItems_ui, IM_ItemQuantityInquiry_ui, IM_ItemTransInquiry_ui, IM_WarehouseInactivation, IT_EMail, IW_Template_svc, JC_CheckDataEntryProcesses, JC_JobBillingRegister_ui, JC_JobCloseOutReport_ui, JC_JobCostHIstoryPurge_ui, JC_JobCostHistoryRestore_ui, JC_JobFieldReportRegister_ui, JC_PurgeArchiveJobs, JC_SummarizeCostDetail, PL_AdvancedOptions_ui, PL_CommonUtility, PL_CommonViewer_ui, PL_ConvertTo2018_utl, PL_EmployeeSelfService_ui, PL_LogMigration_utl, PL_PurgePDFDocuments_ui, PO_CheckDataEntryProcesses, PO_ConvertPOHistory_UI, PO_CreatePOHistory_UI, PO_GeneratePurchaseOrders, PO_PurgeCompletedPurchaseOrder, PO_PurgeMasterRepeatOrder, PO_PurgePOHistory_UI, PO_PurgePOPurchasesHistory, PO_PurgePOPurchasesHistory_ui, PO_PurgePOReceiptHistory, PO_PurgePurchaseOrderRecap, PO_ReceiptApplyPurchaseOrders_ui, RA_CREATECUSTINVOICESEARCH_UI, RA_PURGEEXPIREDRMAS_UI, RA_PURGERETURNREASONDETAIL_UI, RA_PURGERMARECEIPTHISTORY_UI, SO_CheckDataEntryProcesses, SO_CREATESOQUOTEHISTORY_UI, SO_DuplicatePOChecking, SO_InvoiceApplySalesOrders_ui, SO_PURGEEXPIREDORDERSQUOTES_UI, SO_PURGELOTSERIALHISTORY_UI, SO_PURGEORDERQUOTEHISTORY_UI, SO_PurgeSalesHistory, SO_PurgeSalesOrderRecap, SO_RecalcRecaps, SO_SalesJournal_ui, SO_ShippingIntegration, SY_Activation, SY_CompanyConversion_ui, SY_CompileODBCBase, SY_ConfigData, SY_ErrorLogPurge, SY_File, SY_InventoryBalancing_utl, SY_ItemCodeValidation_utl, SY_LevelConversionCommon, SY_LinkMaintenanceBase, SY_LinkMaintenance_utl, SY_MaintUI, SY_MergeFiles_bus, SY_Metering, SY_PII, SY_PIIConsumer, SY_PreMigration_utl, SY_Registration, SY_ReportCommon, SY_ReportCreate, SY_ReportOption, SY_SalesTaxScheduleSelect_ui, SY_SDataSystem, SY_SearchData_Role, SY_Security, SY_Selection, SY_Service, SY_StarShipServer, SY_Token, SY_Views_Utl

Properties

LOCAL cLockInfoNOKEY$="**NONE**NONE**"  

[string] Constant for Lock File Key when there is no specific key

Methods

FUNCTION CheckWhoHasLock(table$, message$)  
FUNCTION CheckWhoHasLock(table$, message$, docKey$)  

Function checks the SY_LockFileInfo table and returns a formatted message about the user and task that last locked the given table or table & key.

ParameterDescription
table$ [input, string] Name of the table that is locked.
message$ [output, string] Returned formatted message to be displayed, that contains the user name and task, that has the table locked.
docKey$ [input, string] {Optional} Specific document key that is locked.
Returns [boolean]
ValueDescription
retSUCCESS(1) If a record was found in the SY_LockFileInfo table and a message is returned.
retFAILURE(0) If a record was not found in the SY_LockFileInfo table, no message will be returned.
FUNCTION CreateLockInfo(table$)  
FUNCTION CreateLockInfo(table$, docKey$)  
FUNCTION CreateLockInfo(table$, docKey$, channel)  
FUNCTION CreateLockInfo(table$, docKey$, channel, comp$, user$, task$)  

Creates/updates record for the table/documentkey combination that is locked. It records the current user, company and task within the record in the SY_LockFileInfo table.

ParameterDescription
table$ [input, string] Name of the table being locked.
docKey$ [input, string] {optional} Specific document key that is locked within the table given. If blank, indicates that table is locked.
channel [input, fileHandle] {optional} Channel that the lock file is currently open on
comp$ [input, string] {optional} company code that is locking the table/key combination
user$ [input, string] {optional} user logon that is locking the table/key combination
task$ [input, string] {optional} task name of the task that is locking the given table/key combination
Returns Always returns retSUCCESS(1)
FUNCTION RemoveLockInfo()  
FUNCTION RemoveLockInfo(table$)  
FUNCTION RemoveLockInfo(table$, docKey$)  
FUNCTION RemoveLockInfo(table$, docKey$, channel)  

Removes Lock information after the record/table lock is released, if no arguments are given then all the information for the current workstation + processID will be removed.

ParameterDescription
table$ [input, string] {optional} Name of the table being locked.
docKey$ [input, string] {optional} Specific document key that is locked within the table given. If blank, indicates that table is locked.
channel [input, fileHandle] {optional} Channel number the lock file that is being closed was open on
Returns [integer] number of records removed
FUNCTION LOCAL OpenTable(fileName$, path$, options, wdxFlag, opt$, ddfTable$)  
FUNCTION LOCAL OpenTable(fileName$, path$, options, wdxFlag, opt$)  
FUNCTION LOCAL OpenTable(fileName$, path$, options, wdxFlag)  
FUNCTION LOCAL OpenTable(fileName$, path$, options)  
FUNCTION LOCAL OpenTable(fileName$, path$)  
FUNCTION LOCAL OpenTempFile(baseName$, keyDef$, fileIolist$, recSize, useGlobalChan, useMemoryFile)  
FUNCTION LOCAL OpenTempFile(baseName$, keyDef$, fileIolist$, recSize, useGlobalChan)  
FUNCTION LOCAL OpenTempFile(baseName$, keyDef$, fileIolist$, recSize)  
FUNCTION LOCAL OpenTempFile(baseName$, keyDef$, fileIolist$)  
FUNCTION LOCAL OpenTempFile(baseName$, keyDef$)  
FUNCTION LOCAL OpenTempFile(baseName$)  

Create and open temporary file on disk as alternate to using a memory file (created in user TEMP folder); if temporary file cannot be created/opened, a memory file will be used instead

ParameterDescription
baseName$ [input, string] Base name to use for file; will add company code and a timestamp to create actual name for temporary file
keyDef$ [input, string] {optional} Key definition to use when creating the temporary file
fileIolist$ [input, string] {optional} IOLIST to use when opening the temporary file
recSize [input, int] {optional} Record size to use when creating the temporary file; for memory files this will be the BSZ value
useGlobalChan [input, boolean] {optional} When set to isTRUE (1) the file will be opened on a global channel
useMemoryFile [input, boolean] {optional} When set to isTRUE (1) amemory file will be used instead of a file on disk
Returns fileHandle if file is successfully created and opened; otherwise returns zero