Class PM_Options_bus

Known SubClasses

PM_SetupWizard_bus

Properties

LOCAL cMainTable$="PM_Options"  

[string] Name of the table being maintained by this business objects

LOCAL cIsSysDB=isFALSE  

[boolean] Flag to indicate whether main table is defined in the MAS_SYSTEM directory

LOCAL cCanEditAutoIssueLabor=-1  

[boolean] Flag to indicate whether the Auto Issue Labor field can be edited, False if Work Ticket Class records are setup to auto issue labor

LOCAL cCanEditAutoIssueMaterials=-1  

[boolean] Flag to indicate whether the Auto Issue Materials field can be edited, False if Work Ticket Class records are setup to auto issue materials

LOCAL cCanEditBackflushLabor=-1  

[boolean] Flag to indicate whether the Backflush Labor field can be edited, False if Work Ticket Class records are setup to backflush labor

LOCAL cCanEditBackflushMaterials=-1  

[boolean] Flag to indicate whether the Backflush Materials field can be edited, False if Work Ticket Class records are setup to backflush materials

LOCAL cModuleCode$="P/M"  

[string] Module Code for Production Management

PROPERTY APIsSetup   * Read Only *

[boolean] Flag to indicate the Accounts Payable module is setup for this company

PROPERTY BMIsSetup   * Read Only *

[boolean] Flag to indicate the Bill of Materials module is setup for this company

PROPERTY GL_FiscalYearsLoad$   * Read Only *

[string] SEP ($8A$) separated list of fiscal years defined

PROPERTY GL_PeriodsLoad$   * Read Only *

[string] SEP ($8A$) separated list of fiscal periods for the current fiscal year selected

PROPERTY IM_BaseInvPeriodOnCalFiscYr$   * Read Only *

[string] I/M Setup option value to base inventory on "C"-Calendar or "F"-Fiscal years.

PROPERTY IM_MultipleWarehouses$   * Read Only *

[string] I/M Setup option value on whether RequireMultipleWarehouses$ either "Y" or "N"

PROPERTY POIsSetup   * Read Only *

[boolean] Flag to indicate the Purchase Order module is setup for this company

PROPERTY PRIsSetup   * Read Only *

[boolean] Flag to indicate the Payroll module is setup for this company

Methods

FUNCTION LaborEntryInProgress()  

Function checks the number of records in the PM_LaborEntry table.

Returns [boolean]
ValueDescription
TRUE if there are records in the PM_LaborEntry table
FALSE if there are no records in the PM_LaborEntry table
FUNCTION SetCurrentPeriod(value$)  

Sets the CurrentPeriod to the value given, tests to see if in the range of periods for the CurrentFiscalYear and adjusts value, if outside the range.

ParameterDescription
value$ [input/output, string] Value to set the current period to. If adjusted value will be returned with adjusted value.
Returns Always returns retSUCCESS(1)
FUNCTION SetDefaults()  

Sets default values of the options record, this function is an override to the base class SY_Maint.

Returns Always returns retSUCCESS(1)
FUNCTION SetKey(value$)  

Override to the base class SY_Maint method, that sets the key to the record. This is overridden to turn off integration flags to other modules if they are not setup.

ParameterDescription
value$ [input, string] Value to set the key to.
Returns Returns value from base class call
FUNCTION Write()  

Override to the base class SY_Maint method, that writes changes to the record. Overridden to capture changes and update the system activity log with the changes.

Returns Returns value from base class call
FUNCTION LOCAL CheckWorkTicketClassIssueMethods(canEditAutoIssueLabor, canEditAutoIssueMaterials, canEditBackflushLabor, canEditBackflushMaterials)  

Check work ticket class records for labor and material issue methods used. This determines if the issue method related fields in options can be edited to 'N'

ParameterDescription
canEditAutoIssueLabor [output, numeric] can the AutoIssueLabor field be set to 'N'
canEditAutoIssueMaterials [output, numeric] can the AutoIssueMaterials field be set to 'N'
canEditBackflushLabor [output, numeric] can the BackflushLabor field be set to 'N'
canEditBackflushMaterials [output, numeric] can the BackflushMaterials field be set to 'N'
Returns Always returns retSUCCESS(1)
FUNCTION LOCAL SetChildColl()  

Defines the referential file validations

Returns Always returns retSUCCESS(1)
FUNCTION LOCAL SetIMChildColl()  

Defines the referential file validations for the Inventory Module, which may not exist. Only called if Inventory is setup.

Returns Always returns retSUCCESS(1)
FUNCTION LOCAL ValidateAllowEntryPunchInOutTime(value$)  

Validation for AllowEntryPunchInOutTime field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateAutoIssueLabor(value$)  

Validation routine for the AutoIssueLabor column.

ParameterDescription
value$ [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateAutoIssueMaterials(value$)  

Validation routine for the AutoIssueMaterials column. Setting this column to "N" will set other columns to "N"

ParameterDescription
value$ [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateBackflushLabor(value$)  

Validation routine for the BackflushLabor column.

ParameterDescription
value$ [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateBackflushMaterials(value$)  

Validation routine for the BackflushMaterials column.

ParameterDescription
value$ [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateCaptureTimeInLaborEntry(value$)  

Validation routine for the CaptureTimeInLaborEntry column. Setting this column to "N" will set AllowEntryPunchInOutTime to "N"

ParameterDescription
value$ [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateCombineMaterialLineComments(value$)  

Validation for CombineMaterialLineComments field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateCreateWTWithMaterialsFrom(value$)  

Validation routine for the CreateWTWithMaterialsFrom column. If Bill of Materials Integration is turned off, will only be able to set this field to "W" for Work Ticket Template

ParameterDescription
value$ [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateCurrentCalendarYr(value$)  

Validates the CurrentCalendarYr column.

ParameterDescription
value$ [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateCurrentFiscalYr(value$)  

Validates the CurrentFiscalYr column. Validates against using GL_FiscalYear_svc to enforce that the year has been setup in G/L. Also, will adjust CurrentPeriod value if it exceeds number of periods..

ParameterDescription
value$ [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateCurrentPeriod(value$)  

Validates the CurrentPeriod column. Validates using GL_FiscalYear_svc to enforce that the value is valid for the current fiscal year. If using Calendar Year in Inventory will make sure period is between 1-12

ParameterDescription
value$ [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateDefaultStockWorkTicketClass(value$)  

Validates the Default Stock Work Ticket Class using child collection for the Work Ticket Class. The Class would have to be a MakeToStock class.

ParameterDescription
value$ [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateDynamicLabor(value$)  

Validates the DynamicLabor flag. Will not be able to change flag while Labor Entry is in progress.

ParameterDescription
value$ [input, string] value to be validated
Returns retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed
FUNCTION LOCAL ValidateDynamicMaterials(value$)  

Validates the DynamicMaterials flag. Will not be able to change flag while Transaction Entry is in progress.

ParameterDescription
value$ [input, string] value to be validated
Returns retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed
FUNCTION LOCAL ValidateFutureDaysToPrintWorkTickets(value)  

Validates the FutureDaysToPrintWorkTickets field

ParameterDescription
value [input, numeric] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateGroupAutoIssueMaterials()  

Validates any field in the ValidationGroup = AutoIssueMaterials, as specified in the dictionary.

Returns [boolean]
ValueDescription
retSUCCESS(1) If the AutoIssueMaterials field = "Y"
retFAILURE(0) If the AutoIssueMaterials field <>"Y"
FUNCTION LOCAL ValidateGroupPrintBackOrder()  

Validates any field in the ValidationGroup = PrintBackOrder, as specified in the dictionary.

Returns [boolean]
ValueDescription
retSUCCESS(1) If the PrintBackOrderFillReport field = "Y"
retFAILURE(0) If the PrintBackOrderFillReport field <>"Y"
FUNCTION LOCAL ValidateGroupPrintPickingSheets()  

Validates any field in the ValidationGroup = PrintPickingSheets, as specified in the dictionary.

Returns [boolean]
ValueDescription
retSUCCESS(1) If the PrintPickingSheets field <>"N"
retFAILURE(0) If the PrintPickingSheets field = "N"
FUNCTION LOCAL ValidateIntegrateAccountsPayable(value$)  

Validates the IntegrateAccountsPayable field. When turning flag off, checking against data entry in progress will be done and setting to "N" will fail.

ParameterDescription
value [input, numeric] value to be validated
Returns [boolean]
ValueDescription
retSUCCESS(1) If validation passed, and if setting to "N" that no data entry with Work Tickets is in progress
retFAILURE(0) If validation failed or if data entry was in progress when setting value to "N"
FUNCTION LOCAL ValidateIntegrateBillOfMaterials(value$)  

Validates the IntegrateBillOfMaterials field. Valid values "Y" or "N". Can only set to "Y" if Bill of Materials Module is setup.

ParameterDescription
value [input, numeric] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, and retFAILURE(0) If validation failed
FUNCTION LOCAL ValidateIntegratePayroll(value$)  

Validates the IntegratePayroll field. When turning flag off, checking against data entry in progress will be done and setting to "N" will fail.

ParameterDescription
value [input, numeric] value to be validated
Returns [boolean]
ValueDescription
retSUCCESS(1) If validation passed, and if setting to "N" that no labor entry is in progress
retFAILURE(0) If validation failed or if data entry was in progress when setting value to "N"
FUNCTION LOCAL ValidateIntegratePurchaseOrder(value$)  

Validates the IntegratePurchaseOrder field. When turning flag off, checking against data entry in progress will be done and setting to "N" will fail.

ParameterDescription
value [input, numeric] value to be validated
Returns [boolean]
ValueDescription
retSUCCESS(1) If validation passed, and if setting to "N" that no data entry with Work Tickets is in progress
retFAILURE(0) If validation failed or if data entry was in progress when setting value to "N"
FUNCTION LOCAL ValidateMaterialsPrintFormat(value$)  

Validation for MaterialsPrintFormat field. Can only be set if the PrintMaterialsListOnWorkTicket is set to "Y"

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateMaximumNoOfMonthsToSched(value)  

Validation for the MaximumNoOfMonthsToSched field. This will validate the range of the number 1-999.

ParameterDescription
value [input, numeric] Value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateMinVarianceCloseMissingCostRpt(value)  

Validation for MinVarianceCloseMissingCostRpt field. Can only be set if the PrintCloseVorFroStdRpt is set to "Y"

ParameterDescription
value [input, numeric] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateMinVarianceCloseStdRpt(value)  

Validation for MinVarianceCloseStdRpt field. Can only be set if the PrintCloseMissingCostRpt is set to "Y"

ParameterDescription
value [input, numeric] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateMinVarianceMissingCostRpt(value)  

Validation for MinVarianceMissingCostRpt field. Can only be set if the PrintCloseMissingCostRpt is set to "Y"

ParameterDescription
value [input, numeric] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateMinVarianceStdRpt(value)  

Validation for MinVarianceStdRpt field. Can only be set if the PrintCompletionVarFromStdRpt is set to "Y"

ParameterDescription
value [input, numeric] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateNextTransactionNo(value$)  

Validation for NextTansactionNo field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidatePrintBackOrderFillReport(value$)  

Validation for PrintBackOrderFillReport field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidatePrintCloseMissingCostRpt(value$)  

Validation for PrintCloseMissingCostRpt field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidatePrintCloseVarFromStdRpt(value$)  

Validation for PrintCloseVarFromStdRpt field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidatePrintCompletionMissingCostRpt(value$)  

Validation for PrintCompletionMissingCostRpt field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidatePrintCompletionVarFromStdRpt(value$)  

Validation for PrintCompletionVarFromStdRpt field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidatePrintMaterialsListOnWorkTicket(value$)  

Validation for PrintMaterialsListOnWorkTicket field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidatePrintPickingSheets(value$)  

Validation for PrintPickingSheets field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidatePrintWorkTicketOnBOFillReport(value$)  

Validation for PrintWorkTicketOnBOFillReport field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateRedisplayAllDocuments(value$)  

Validation for RedisplayAllDocuments field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateRedisplayPickingSheets(value$)  

Validation for RedisplayPickingSheets field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateRedisplayWorkTickets(value$)  

Validation for RedisplayWorkTickets field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateSummarizeMaterialLines(value$)  

Validation for SummarizeMaterialLines field.

ParameterDescription
value [input, string] value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.
FUNCTION LOCAL ValidateYearsToRetainWorkTicketHist(value)  

Validation for the YearsToRetainWorkTicketHist field. This will validate the range of the number is 2-99.

ParameterDescription
value [input, numeric] Value to be validated
Returns [boolean] retSUCCESS(1) If validation passed, retFAILURE(0) if validation failed.

Properties inherited from: PM_Constant

actClassEMPLOYEE$, actClassGENERAL$, actClassMACHINE$, actClassOUTSIDESVC$, capTimeNO$, capTimeNOEDIT$, capTimeYES$, earnTypeALLOCTIPS$, earnTypeEXCLUDETIPCALC$, earnTypeEXEMPTTIPS$, earnTypeFRINGE$, earnTypeMISC$, earnTypeOVERTIME$, earnTypeREGULAR$, earnTypeTAXABLETIPS$, earnTypeTIMEOFF1$, earnTypeTIMEOFF2$, earnTypeTIMEOFF3$, cAllEarningsTypes$, earnMethodADDAMOUNT$, earnMethodFIXED$, earnMethodSTANDARD$, cAllEarnMethods$, lttLABOR$, lttCREW$, lttMISC$, lttINOUT$, lttCOST$, dpcSTANDARD$, dpcAVERAGE$, dpcLAST$, overheadTypeAMOUNT$, overheadTypePERCENT$, prtPickNONE$, prtPickBYWHSE$, prtPickBYTICK$, tcmCodeACTUAL$, tcmCodeBUDGET$, tcmCodeSTANDARD$, tcmCodeLOWER$, tcmDescACTUAL$, tcmDescBUDGET$, tcmDescSTANDARD$, tcmDescLOWER$, trnLABOR$, trnMATERIALS$, trnCLOSE$, trnCOMPLETION$, trcSTATUS$, trcLABOR$, trcINVENTORY$, trcDIRECTCHARGE$, trcINVOICE$, trcCLOSE$, trcSCRAP$, udiSTRING$, udiNUMBER$, udiYESNO$, udiCODE$, udiDATE$, mftCodeSALESORDER$, mftCodeSALESORDERLINE$, mftCodeWORKTICKET$, mftCodeINVENTORY$, mftDescSALESORDER$, mftDescSALESORDERLINE$, mftDescWORKTICKET$, mftDescINVENTORY$, wtsOPEN$, wtsQUOTE$, wtsRELEASED$, wtsCLOSED$, wtsDELETED$, lbrIssMethodAUTOISSUE$, lbrIssMethodBACKFLUSH$, lbrIssMethodMANUAL$, matIssMethodAUTOISSUE$, matIssMethodBACKFLUSH$, matIssMethodMANUAL$, prtWORKTICKET$, prtOPERATIONTICKET$, prtCOMPLETEMISSINGCOST$, prtCOMPLETEVARFROMSTD$, prtCLOSEMISSINGCOST$, prtCLOSEVARFROMSTD$, prtCLOSECOSTLEDGER$, prtPICKSHEET$, drtBACKOUT$, drtADDIN$, drsNEW$, drsUPDATED$, drsCOMPLETED$, schFIXED$, schACTSPERHOUR$, schHOURSPERACT$, scaleNOSCALING$, scalePRODUCTIONRUN$, scalePARENTSPERTEMPLATE$, scaleTEMPLATESPERPARENT$, stepZERO$, dfltClosureWorkCenter$

Properties inherited from: SY_Maint

cActionWrite, cActionDelete, cActivityLogFilePrefix$, DocDateWarnDisplayed, DocDateWarnStatus, EditState, RecordChanged, FirstFailure$, DocumentTotal, ReadOnlyReason$, UDTValidation$, ViewOnly, CurrentPrecision, DocDateWarnForceOff, DocDateWarnObject, ScriptObject, ImportTest, SkipNullCheck$, AFSRequiredFields$

Methods inherited from: CI_Account_Val

ClassOverrideAccount(), ClassValidateAccount(), ResetAccountIndex()

Methods inherited from: CI_StatusCode_Val

ClassValidateStatusCode()

Methods inherited from: CI_Warehouse_Val

SetAllowInactiveRestrictedWhse(), ClassValidateWarehouse(), GetClassName$()

Methods inherited from: CI_WorkTicketClass_Val

ClassValidateWorkTicketClass()

Methods inherited from: PM_Constant

BuildAlternateIOL$(), BuildMemoryFile(), ConvertCalendarToJulian(), ConvertJulianToCalendar$(), FormatTime$(), HHMMToMinutes(), HHMMToNum(), LoadCustomLabelConstants(), NumToHHMM$(), TimeToHHMM()

Methods inherited from: SY_Maint

ChangedRecordCompare(), ChangedRecordInfo(), Clear(), ClearRecord(), ConfirmDelete(), CopyFrom(), ExportToCSV(), GetColumnInfo(), GetColumnProperties$(), GetDefaults(), GetOrigRecord$(), GetPropertyValue(), GetValidationGroups$(), ResetDocDateWarnState(), SetCopyKeyValue(), SetDocDateWarnDisplayed(), SetDocDateWarnOff(), SetKey(), SetKeyValue(), SetPartialRecord(), SetRecord(), SetToReadOnly(), SetValue(), SetValues(), Write(), ActivityLogCreateFile(), ActivityLogPrepare(), ActivityLogSetMessage$(), ActivityLogWrite(), CallScript(), CheckForAdvancedFieldSettings(), CheckForScripts(), CheckNullRequiredField(), PERFORM ChildValidate(), ClassValidateDate(), ClassValidateTelephoneNo(), ClearSetFiles(), ColInfoInitAll(), ColInfoInitDefaults(), CommitRow(), GetPropertyCommon(), InitColInfo(), InitScriptEngine(), InitSearchForUpdate(), InitWorkTable(), IsColInIOList(), IsValid(), LoadColInfo(), OpenMainTable(), ParseExtField(), PreWriteScripts(), RemoveColToSkip(), ResetRow(), RetrieveColInfo(), SetDefaults(), SetFilter(), SetMode(), SetParentHandle(), SetValueNoValidate(), StoreColToSkip(), ValidateAll(), ValidateAllRecord(), ValidateColInfo(), ValidateRule()