Class SY_Service

Known SubClasses

AP_ACHInterface_svc, AP_ARClearing_Svc, AP_Division_svc, AP_ExpenseDistTable_svc, AP_InvoiceHistoryHeader_svc, AP_Invoice_svc, AP_JobDistributionDetail_svc, AP_OpenInvoice_svc, AP_Options_Svc, AP_RepetitiveInvoice_svc, AP_ReverseCheckWork_svc, AP_SalesTax_svc, AP_TermsCode_svc, AP_TransactionPaymentHistory_svc, AP_Vendor1099Payments_svc, AP_VendorContact_svc, AP_VendorDocumentContacts_svc, AP_VendorDocuments_svc, AP_VendorMemo_svc, AP_VendorPurchasesHistory_svc, AP_Vendor_svc, AR_BillToSoldTo_svc, AR_CustomerContact_svc, AR_CustomerCreditCard_svc, AR_CustomerDocumentContacts_svc, AR_CustomerDocuments_svc, AR_CustomerMemo_svc, AR_CustomerSalesHistory_svc, AR_CustomerShipToTaxExemptions_svc, AR_Customer_svc, AR_Division_svc, AR_InvoiceHistoryInquiry_svc, AR_InvoiceHistoryTracking_svc, AR_Invoice_svc, AR_OpenInvoiceSplitCommissions_svc, AR_OpenInvoice_Svc, AR_Options_Svc, AR_PaymentType_Svc, AR_PriceLevelByCust_svc, AR_RepetitiveInvoice_svc, AR_SalespersonDocuments_svc, AR_Salesperson_svc, AR_TermsCode_Svc, AR_TransactionPaymentHistory_Svc, BC_Keys_svc, BC_Options_Svc, BM_BillHeader_svc, BM_BillOptionCategory_svc, BM_BillOptionHeader_svc, BM_DisassemblyDefaults_svc, BM_Options_svc, BM_ProductionDefaults_svc, BR_Options_Svc, CI_CommodityCode_svc, CI_ExtendedDescription_svc, CI_InactiveReasonCode_svc, CI_ItemCode_svc, CI_Options_svc, CI_UnitOfMeasure_svc, CM_UDT_Svc, CU_Company_Svc, CU_CRMServerOptions_svc, CU_CustomerTemplate_svc, CU_Opportunity_Svc, CU_Person_Svc, CU_Users_Svc, ES_Options_svc, FL_AssetAccount_svc, FL_AssetTemplates_svc, FL_Options_svc, GL_AccountCategory_svc, GL_AccountGroup_svc, GL_AccountStructure_svc, GL_Accounttype_svc, GL_Account_svc, GL_AllocationHeader_svc, GL_AllocationSelection_Svc, GL_Allocation_Svc, GL_Bank_Svc, GL_BudgetRevision_Svc, GL_Budget_svc, GL_CompanyActiveBatch_svc, GL_CompanyMemoManagerSettings_Svc, GL_FinancialTerminology_svc, GL_FiscalYear_Svc, GL_GeneralJournalHeader_Svc, GL_MainAccount_svc, GL_Micr_Svc, GL_Options_Svc, GL_PayOptions_svc, GL_PeriodBudgetDetail_Svc, GL_RecurringJournalHeader_Svc, GL_Rollup_Svc, GL_SourceJournalHistory_Svc, GL_SourceJournal_Svc, GL_SubAccount_svc, GL_TransactionJournalHeader_Svc, IM_AliasItem_svc, IM_AlternateItem_svc, IM_BuyerPlannerCode_svc, IM_CountCardDefaults_Svc, IM_ItemCost_svc, IM_ItemVendor_svc, IM_ItemWarehouse_svc, IM_Options_svc, IM_PriceCode_svc, IM_ProductLine_svc, IM_SalesKit_svc, IM_SalesPromotion_svc, IM_Warehouse_svc, IM_WarrantyCode_svc, IT_Category_svc, IT_Customer_svc, IT_EBusinessManagerUserID_svc, IT_EmailNotification_svc, IT_EMailReasonCode_svc, IT_HTMLTemplate_svc, IT_ItemAttachment_svc, IT_ItemCategory_svc, IT_Item_svc, IT_Options_svc, IT_ShoppingCartItemsSelected_svc, IT_WebMenu_svc, IT_WebTemplateOptions_svc, JC_BurdenRate_svc, JC_Contractor_svc, JC_CostCodeDetail_svc, JC_CostCodeEarningsCode_svc, JC_CostCode_svc, JC_CostType_svc, JC_JobBillingDetail_svc, JC_JobBilling_svc, JC_JobCostCodeDetail_svc, JC_JobCostCode_svc, JC_JobEstimateDetail_svc, JC_JobEstimateItemPrice_svc, JC_JobEstimate_svc, JC_JobFieldReportEntryDetail_svc, JC_JobFieldReportEntry_svc, JC_JobHistoryCostCodeDtl_svc, JC_JobHistoryCostCode_svc, JC_JobHistoryInquiry_svc, JC_JobPostingDetail_svc, JC_JobPosting_svc, JC_JobStatus_svc, JC_JobTypeWIPAcct_svc, JC_JobType_svc, JC_Job_svc, JC_Options_Svc, JC_OverheadRate_svc, JC_UnitOfMeasure_svc, MD_DefaultPerform_SVC, MD_EMailNotification_svc, MD_EMail_svc, PL_Options_svc, PO_CancelReasonCode_svc, PO_LandedCostHistory_svc, PO_LandedCostReceipt_svc, PO_LandedCostType_svc, PO_MaterialReqDefaults_Svc, PO_MaterialReq_svc, PO_Options_Svc, PO_PurchaseOrderDefaults_Svc, PO_PurchaseOrderDetail_svc, PO_PurchaseOrderHistoryInq_svc, PO_PurchaseOrder_svc, PO_ReceiptAppliedPurchaseOrder_svc, PO_ReceiptDefaults_Svc, PO_ReceiptHistoryAppliedPO_svc, PO_ReceiptHistory_svc, PO_Receipt_svc, PO_ReturnDefaults_Svc, PO_Return_svc, PO_ShipToAddress_svc, PO_VendorPriceLevel_svc, PO_VendorPurchaseAddress_svc, RA_Options_Svc, RA_ReceiptsDefaults_Svc, RA_ReceiptsHistory_svc, RA_ReceiptsReceiving_svc, RA_Receipts_svc, RA_ReturnDefaults_Svc, RA_ReturnReasonCode_svc, RA_ReturnToAddressCode_svc, RA_Return_svc, SO_CancelReasonCode_svc, SO_CustomerLastPurchase_svc, SO_InvoiceAppliedSalesOrders_svc, SO_InvoiceDefaults_Svc, SO_InvoiceDetail_svc, SO_InvoiceTracking_svc, SO_Invoice_svc, SO_LastPurchaseHistory_svc, SO_LineItemCommission_svc, SO_Options_Svc, SO_PackageTrackingByItem_svc, SO_PurchaseControl_svc, SO_SalesOrderDefaults_Svc, SO_SalesOrderHistory_Svc, SO_SalesOrder_svc, SO_ShipperID_svc, SO_ShippingOptions_svc, SO_ShippingRate_svc, SO_ShipToAddress_svc, SY_1099Setup_svc, SY_ActivationReq_svc, SY_Activation_svc, SY_BatchManager_svc, SY_BatchOptions_svc, SY_ClassEnhancement_svc, SY_CompanyConversion, SY_Company_Svc, SY_ConfigData_svc, Sy_Console_svc, SY_Country_svc, SY_Developer_svc, SY_EnhancementModule_svc, SY_Enhancement_svc, SY_Maint, SY_MemoDefault_Svc, SY_MemoManager_Svc, SY_Menu, SY_Menu_svc, SY_ModuleDate_SVC, SY_Module_svc, SY_OfficeUserMap_svc, Sy_Options_svc, Sy_PopupItem_Svc, Sy_PopupMenuItem_Svc, Sy_PopupMenu_Svc, Sy_PopupXref_Svc, SY_ProcessFlows_svc, SY_RecordSet, SY_ReportManagerMaster_svc, Sy_ReportSetting_Svc, SY_RoleSecurity_svc, Sy_Role_svc, SY_SalesTaxClass_svc, SY_SalesTaxCodeDetail_svc, SY_SalesTaxCode_svc, SY_SalesTaxScheduleDetail_svc, SY_SalesTaxSchedule_Svc, SY_SalesTaxSchedZIPXref_svc, SY_ServiceNotification_svc, SY_State_svc, SY_TaskType_SVC, SY_Task_SVC, SY_ThemeCode_svc, SY_ThemePreview_svc, SY_URLMaintenance_svc, SY_UserAutoComplete_svc, SY_UserSecurity_svc, SY_UserSettings_svc, SY_User_svc, SY_ZIPCode_svc, VI_ExportJobMaintenance_svc, VI_ImportJobMaintenance_svc, WO_ExplBill, WO_OperationCode_svc, WO_OperationDetail_svc, WO_WorkOrder_svc

Properties

PROPERTY BOF   * Read Only *
PROPERTY CurrentBrowseIndex$   * Read Only *
PROPERTY CurrentIndex$   * Read Only *
PROPERTY EOF   * Read Only *
PROPERTY SecurityAccess   * Read Only *

Methods

FUNCTION BindVariable(src$, col$, var$)  
FUNCTION BindVariable(src$, col$, var$, tmpCtl)  
FUNCTION CheckMainTable()  

Basic check that OpenMainTable did not fail and cFH is not zero. This is a workaround for an issue where the EXIT errOBJECT is ignored in pvxcom.

Returns [bool] True if the open channel can be validated, otherwise false.
FUNCTION Clear()  
FUNCTION Find()  
FUNCTION Find(key$)  
FUNCTION FindById(hexKey$)  

Accepts a hex encoded key, converts it to ASCII and calls _OBJ'Find(key$) with the converted ASCII value.

ParameterDescription
hexKey$ [input,string] Hex encoded key value.
Returns [bool] Success if the key was found, otherwise failure.
FUNCTION GetChildHandle(src$)  
FUNCTION GetChildKeyReference$(src$)  
FUNCTION GetColumns$(src$)  
FUNCTION GetDataSources$()  
FUNCTION GetDataSourcesAddl$()  
FUNCTION GetJson$(columns$)  
FUNCTION GetJson$()  

Returns a JSON representation of the current record (requires the key/record to be set).

ParameterDescription
columns$ [input, string] Optional comma separated list of column names for the current object. Default is all columns for the current object.
Returns [string] JSON formatted string containing the data if successfull or an error if not.
FUNCTION GetKey$()  
FUNCTION GetKey$(fromIndex$)  
FUNCTION GetKeyColumns$()  
FUNCTION GetKeyPadded$()  
FUNCTION GetPartialRecord(record$, iol$)  
FUNCTION GetRecord(record$, iol$)  
FUNCTION GetRecordCount(src$)  
FUNCTION GetRecordEx(record$, iol$)  

Extended version of GetRecord that prepends the returned record and iolist with: Id$ - The hex value of the current key. FormattedCode$ - The result of EVS("cCodeFormat$", ERR=*NEXT) FormattedName$ - The result of EVS("cNameFormat$", ERR=*NEXT)

FUNCTION GetResultSets(descColumn$, keyColumn$, dropBoxLoad$, dropBoxTranslate$, filter$, begin$, end$)  
FUNCTION GetResultSets(descColumn$, keyColumn$, dropBoxLoad$, dropBoxTranslate$, filter$, begin$, end$, alternateIndex$)  
FUNCTION GetResultSets(descColumn$, keyColumn$, dropBoxLoad$, dropBoxTranslate$, filter$, begin$, end$, alternateIndex$, distinctOnly)  
FUNCTION GetTable$(src$)  
FUNCTION GetTablePath$(src$)  
FUNCTION GetValue(col$, val$)  
FUNCTION GetValue(col$, val)  
FUNCTION GetValues(columns$, data$)  

Alternate method to GetPartialRecord(), but can pass in a comma-separated list of column names, instead of a compiled Providex IOList.

ParameterDescription
columns$ [input/output, string] comma separated list of field names for the current object, these will be compiled into an IOList and the data returned. If thie list sent in does not have $ on the string variables these will be converted and sent back in this argument.
data$ [output, string] SEP (hex 8A), separated list of data that was requested.
Returns [boolean] Success - if data was returned from the list of fields given. Failure - if IOList could not be compiled due to a bad list of fields.
FUNCTION IsValid()  
FUNCTION IsValid(key$)  
FUNCTION IsValid(key$, fromCols$, toCols$)  
FUNCTION MoveFirst()  
FUNCTION MoveLast()  
FUNCTION MoveNext()  
FUNCTION MovePrevious()  
FUNCTION ReadAdditional()  
FUNCTION ReadAdditional(src$)  
FUNCTION SetBrowseFilter(browseFilter$)  
FUNCTION SetBrowseIndex(newBrowseIndex$, newIndex$)  
FUNCTION SetCacheMode(cacheMode$)  
FUNCTION SetIndex(newIndex$)  
FUNCTION SetKeyValue(col$, val$)  
FUNCTION SetParentColumns()  
FUNCTION SetParentColumns(fromCols$, toCols$)  
FUNCTION SetParentHandle(parentTable$, parentHandle, src$, srcMap$, dstMap$)  
FUNCTION SetUIHandle(uIHandle)  
FUNCTION LOCAL PERFORM ClearEditRcd()  
FUNCTION LOCAL FormatJson$(columns$)  

Local function to format the column values, dates, strings, numbers, for the current record into JSON format.

ParameterDescription
columns$ [input, string] Comma separated list of column names for the current object to return data for.
Returns [string] JSON formatted string containing the data if successfull or an error if not.
FUNCTION LOCAL GetAddlDataSources()  
FUNCTION LOCAL GetDateColumns$(columns$)  
FUNCTION LOCAL InitChildCollection(childId$, className$, keyReference$, index$, fil$)  
FUNCTION LOCAL InitChildCollection(childId$, className$, keyReference$, index$, fil$, srcMap$, dstMap$)  
FUNCTION LOCAL MoveFirstLast(direction)  
FUNCTION LOCAL MoveNextPrevious(direction)  
FUNCTION LOCAL OpenMainTable()  
FUNCTION LOCAL ParseKeyDef(newIndex$)  
FUNCTION LOCAL ParseKeyDef(newIndex$, mainTblFH)  
FUNCTION LOCAL PrepareKeyDef(tblFH)  
FUNCTION LOCAL ReadRec(key$)  
FUNCTION LOCAL ResolveColumnList$(columns$)  

Resolves whether individual columns, in a list if they do not include a $ for the string name (ie CustomerName vs CustomerName$), thus can put string names without the $ in a list of fields and they can be verified here and changed if the field is in the iolist of cFH, otherwise it will remain unchanged.

ParameterDescription
columns$ [input, string] Comma separated list of variable names, the string names, that are columns in the main table do not have to include the '$'
Returns On Success: returns a comma separated list of uppercase variable names, converting the string names that came in to include the $
FUNCTION LOCAL SetControls()  
FUNCTION LOCAL SetCurrentKey(key$)  
FUNCTION LOCAL UseKeyColl(method$)  

Properties inherited from: SY_OpenObject

cLockInfoNOKEY$

Methods inherited from: SY_Common

FormatAddress(), ParseCityStateZip(), ClassValidateDirectory(), DirectoryCheck(), GetNextSequence(), GetUNCNamedDrive(), IsInstalled(), LocalizeFileIOList(), LocalizeIOList(), PackSequence$(), UnpackSequence(), UseChildKeyColl()

Methods inherited from: SY_OpenObject

CheckWhoHasLock(), CreateLockInfo(), RemoveLockInfo(), OpenTable(), OpenTempFile()