Class SY_Report

Inherits

SY_Maint, SY_MaintSet, SY_ReportCommon, SY_Selection

Properties

LOCAL cMainTable$="SY_ReportSelection"  
LOCAL cIsSysDB  
LOCAL cCommonElements$  
PROPERTY CurrentFiscalYear$  
PROPERTY CurrentPeriod$  
PROPERTY ReportID$   * Read Only *
PROPERTY UseWorkstationDfltPntrStdRpt$  
PROPERTY UseWorkstationDfltPntrStdForm$  
PROPERTY ReportSettingPrinterName$  

[string] Printer name from SY_ReportSetting.M4T - Used when printing without UI (Object Interface).

PROPERTY RecordSet   * Read Only *

[object] Public object handle to SY_RecordSet used to read the current, populated work table

Methods

FUNCTION AppendReportOptions(vars$, vals$)  

This function will append the list of name value assignments stored in cOptionsString$ which is EXECUTED when certain reports run.

ParameterDescription
vars$ [input, string] comma separated list of variable names that corresponds with the values sent in.
vals$ [input, string] SEP (hex 8A) separated list of values that corresponds with the variable names sent in.
Returns [boolean]
ValueDescription
Success if values and variables matched and could be successfully assigned.
Failure if the number of variables and values do not match up, or if any one of the assignments could not be executed.
FUNCTION BuildExtendedSort(workFileFH, workTableName$)  

Builds extended key for report where key exceeds 127 primary key limitation, kALT and SortField2$ required in worktable

ParameterDescription
workFileFH [input, Integer] file handle to report work table
workTableName$ [input, String] name of worktable so it can be opened on a second channel
Returns [boolean] returns retSUCCESS (1) if successful or retFAILURE (0) if unsuccessful.
FUNCTION GetCurrentClause(clause$)  
FUNCTION GetFiscal(fiscalYR$, fiscalPeriod$, StartDate$, EndDate$)  
FUNCTION GetLocal(var$, value$)  
FUNCTION GetOptions(options$)  
FUNCTION GetRecordSettings(record$, iol$)  
FUNCTION OpenRecordSet()  

Initializes a SY_RecordSet object open to the current work table

Returns [boolean] returns retSUCCESS (1) if successful or retFAILURE (0) if unsuccessful.
FUNCTION ParseOptionsGrid(optionString$)  
FUNCTION ProcessReport(destination$)  
FUNCTION ProcessReportWorkTable()  

Wrapper function that exposes the LOCAL PopulateWorkTable function.

Returns [boolean] returns retSUCCESS (1) if successful or retFAILURE (0) if unsuccessful.
FUNCTION ReplaceDefault(optionString$, defaultVar$, defaultValue$)  
FUNCTION ResetWorkTables()  
FUNCTION SelectReportSetting(setting$)  
FUNCTION SetDefaults(optionsString$)  
FUNCTION SetOptions(options$)  
FUNCTION SetRecordSettings(record$)  
FUNCTION SetRecordSettings(record$, key$)  
FUNCTION SetReportObjectPrinterProps(tmpSetting$)  
FUNCTION SetReportWhereClause(ex.whereClause$)  

This function will set the value of the LOCAL variable cReportWhereClause$. This value is used by SY_Selection'GetWhereClause() and SY_Selection'GetBeginEnd() to derive the selections used when the report runs.

ParameterDescription
ex.whereClause$ [input, string] Selection string formatted/encoded as it would be obtained from the selection grid in the report UI.
Returns [boolean] returns retSUCCESS (1) if successful or retFAILURE (0) if unsuccessful.
FUNCTION LOCAL GetOperandStartEnd(operandRow$, operandAbbreviation$, rowDescriptor$, startOfRange$, endOfRange$, rowOperand$)  
FUNCTION LOCAL GetSelectCriteria(maxRows, gridSelections$, rowLabel$, startOfRange$, endOfRange$, rowOperand$)  
FUNCTION LOCAL GetSelectOperandValues(selection$, shortSelection$)  
FUNCTION LOCAL SetChildColl()  
FUNCTION LOCAL WriteWorkstationPrinter(destination$)  

Write the Workstation name in SY_ReportSetting

ParameterDescription
<[input, string] desitination of output, Print, Preview, Export, ExportData, CSV, Deferred >
Returns retSUCCESS when workstation name is written

Properties inherited from: SY_Maint

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

Properties inherited from: SY_Selection

cDefaultOperand$, cMaintenanceOption, cSkipPromote, Category1Desc$, Category2Desc$, Category3Desc$, Category4Desc$

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(), InitWorkTable(), IsColInIOList(), IsValid(), LoadColInfo(), OpenMainTable(), ParseExtField(), RemoveColToSkip(), ResetRow(), RetrieveColInfo(), SetDefaults(), SetFilter(), SetMode(), SetParentHandle(), SetValueNoValidate(), StoreColToSkip(), ValidateAll(), ValidateAllRecord(), ValidateColInfo(), ValidateRule()

Methods inherited from: SY_Selection

BuildSelectDefaults(), ChangeOperand(), ChangeValue1(), ChangeValue2(), ClassOnFocusGrid(), ClassOnFocusGridSetKey(), CreateSelectWhere(), GetWhereClause(), LoadGrid(), LoadRow(), OnExitGrid(), PostLoadGrid(), ReadSelectDefault(), ResetALL(), ReturnReportSelection(), ReturnSetupGrid(), ReturnSetupTable(), RowMods(), SaveRow(), SetOperand(), SetRowState(), AddRecPrefix$(), PERFORM BuildClause(), FindMultiSepChar(), FixDepartment(), FixDivision(), PERFORM FormatValue(), GetBeginEnd(), GetBeginEndCol(), PERFORM GetSelection(), IsUDFReportSelection(), PERFORM JoinClause(), PfxWhereClause(), PostLoad(), PromoteCacheMode(), RefreshSelectionGrid(), PERFORM ResetValue1(), PERFORM ResetValue2(), SaveRowWrite(), SearchOutsideQuotes(), SelectionResetRow(), SetAutoComplete(), SetupForDateSelections(), SubstituteOutsideQuotes(), PERFORM SYSResolveSelectToken()