IncludeOffSheetLines
IncludeOffSheetLines determines whether to read local reported values for off-sheet lines all at once or one at a time. These settings are available:
| Value | Description |
|---|---|
| 0 | |
| 1 | Processes off-sheet lines using existing local reported values only from the database and then translates those values (as though part of the current schedule) without recalculating or writing back data |
- Off-sheet lines are lines that are directly referenced by at least one formula line on the schedule being consolidated but are located on a different schedule.
- The LevelDepth parameter does not support the UseOffSheetLines parameter (when set to 1).
- If IncludeOffSheetLines is set to 1 and UseNetOffsheetData is set to 1, then the consolidation does not respect the UseNetOffsheetData setting.
- The memory required for a consolidation increases in proportion to the number of off-sheet lines included. For example, a 20-line schedule with five off-sheet references requires 25% more memory than a consolidation with no off-sheet lines.
To ensure accurate consolidation results, IncludeOffSheetLines should be avoided for certain types of off-sheet references. This table shows when the parameter is allowed.
| Formula_type Lines | Allow IncludeOffSheetLines? | |
|---|---|---|
| A | Allocation | No |
| B | Beginning Balance | Yes |
| D | Data Entry | Yes |
| F | Formula | Maybe (if unsure, No) |
| I | Intercompany | No |
| O | Opening Balance | Yes |
| Q | Acquisition | No |
| T | Downfoot | Maybe (if unsure, No) |
| X | Currency Translation Adjustment (CTA) | No |
You can use this parameter only for off-sheet lines that are considered detail lines or downfoot lines that contain correct submitted data in local values. If you are unsure, test your consolidation requests with the parameter on and off. If you get different results, do not use this parameter.
The parameter should never be used with allocation or currency translation adjustment (CTA) off-sheet lines because their results are only correct when the formula is executed for translated periodic data. Likewise, if a type "F" line performs division or multiplication operations on off-sheet lines, you should not use the parameter. In addition, you should not use this parameter for downfoots derived from allocation or currency exchange translation adjustment lines.
Type: Scripting parameter
Related parameters: ProcessUnsubmittedStatements, UseNetOffsheetData