Description
RTI_BRWSupport is a helper routine that provides useful actions for the Banded Report Writer to perform.
Syntax
RTI_BRWSupport(Action, Param1, Param2, Param3, Param4, Param5, Param6, Param7)
Parameters
The function has the following parameters:
| Parameter | Description |
|---|---|
Action=LAUNCH | Starts up the Banded Report Designer. |
| Param1 - Param7 | Not used. |
| Returns | Path to the Banded Report Writer .NET assembly. |
Action=READ | Reads and returns the specified report group definition. |
| Param1 | reportGroupName - Name of the report group. |
| Param2 | bLockFlag - Boolean flag to indicate whether the record should be locked. |
| Param3 - Param7 | Not used. |
Returns | The XML definition of the specific report group from the SYSREPOSREPORTS table. |
| Special Note | The XML definition will be returned as a CR/LF delimited string even though OpenInsight stores this as an @FM delimited string. Swapping these delimiters might be necessary in order to use the definition in other commands. The version and dynamic dictionary attributes will not be included in the report group definition. |
| Action=WRITE | Writes a report group definition. |
| Param1 | reportGroupName - Name of the report group. |
| Param2 | reportGroupDefinition - The XML definition of the specific group to be written to the SYSREPOSREPORTS table. |
| Param3 | defaultReport - The report within the group that will automatically run unless a specific report is indicated. |
| Param4 - Param7 | Not used. |
| Returns | Empty string. |
| Special Note | This will create a new report group or it will update an existing report group as applicable. The underlying code attempts to perform a Repository("NEW"...) command first. CR/LF delimiters will be swapped with @FM automatically so no prior corrective action is necessary (see the special notes for the READ action above.) |
| Action=DELETE | Deletes the specified report group definition. |
| Param1 | reportGroupName - Name of the report group. |
| Param2 - Param7 | Not used. |
| Returns | The XML definition of the specific report group from the SYSREPOSREPORTS table. |
| Special Note | The XML definition will be returned as a CR/LF delimited string even though OpenInsight stores this as an @FM delimited string. |
| Action=DISPLAY | Runs and displays the specified report name from a specified report group using OIPI.NET. |
| Param1 | reportGroupName - Name of the report group. |
| Param2 | reportName - Name of the report from within the specified report group to display. (If this is omitted, then the default report for the report group will be displayed.) |
| Param3 | overrideListID - Name of the saved select list in the SYSLISTS table to use as a filter. |
| Param4 | rptDetails - Similar to the rptDetails parameter used by the RTI_BRW_GenerateReport function. This delimited array allows a specific printer and other options to be set: <1, 1> Printer name (as known by the Windows Print Manager) <1, 2> Number of copies <1, 3> 0 or "" for Portrait, 1 for Landscape <1, 4, 1> Left Margin (Hundreds of an inch, i.e., 100=1") <1, 4, 2> Top Margin (Hundreds of an inch, i.e., 100=1") <1, 4, 3> Right Margin (Hundreds of an inch, i.e., 100=1") <1, 4, 4> Bottom Margin (Hundreds of an inch, i.e., 100=1") <1, 5> Page size code <1, 6> Print Preview caption.* (*Only available in OI v10, otherwise, not applicable.) |
| Param5 - Param7 | Not used. |
| Returns | Empty string. |
| Special Note | This is the same as using the LOADREPORT message for the Set_Printer function except that there does not appear to be support for the Append feature. |
| Action=REPORTS | Returns an @VM delimited list of report groups for the current application. |
| Param1 - Param7 | Not used. |
| Returns | An @VM delimited list of report groups for the current application. |
| Action=LIST | Returns an @VM delimited list of report for the specified report group. |
| Param1 | reportGroupName - Name of the report group. |
| Param2 - Param7 | Not used. |
| Returns | An @VM delimited list of report for the specified report group. |
| Action=DEFAULT | Returns the default report from the specified report group. |
| Param1 | reportGroupName - Name of the report group. |
| Param2 - Param7 | Not used. |
| Returns | The default report from the specified report group. |
| Action=KILL | Closes the Banded Report Designer. |
| Param1 - Param7 | Not used. |
| Returns | Empty string. |
