report::frwk

The Report Framework enables you to execute and export the report.

::rpti::frwk start -name new_report_session1 set frwk [::rpti::item getinterface -name new_report_session1]

report::frwk addcustompackage

Registers .tcl package to load containing custom module.

Syntax
$frwk addcustompackage
Parameters
-directory
Value: Directory that contains .tcl package
-packagename
Value: Name of .tcl package.
Returns
1 for ok; .tcl-error in case of error.

report::frwk addcustompath

Registers .tcl package to load containing custom module.

Syntax
$frwk addcustompath
Parameters
-directory
Value: Directory that contains .tcl package
-packagename
Value: Name of .tcl package.
Returns
1 for OK; .tcl-error in case of error.

report::frwk appendtemplate

Appends the specified report template to existing report template.

Syntax
$frwk appendtemplate
Parameters
-file
Value: File name of report template.
Returns
1 for OK, .tcl-error in case of error

report::frwk execute

Executes the current report template.

Syntax
$frwk execute
Parameters
-id
Value: ID of the items to be executed.
Default value: "root" all items in the report will be executed.
Returns
1 for OK

report::frwk export

Exports the Ms-office report based on current report template.

Syntax
$frwk export
Parameters
-file
Value: File name of Ms-office report including extension.
Returns
1 for OK, .tcl-error in case of error.

report::frwk exportas

Exports Office document as specified format.

Syntax
$frwk exportas
Parameters
-file
Value: File name of Ms-office report including extension.
-format
Value: PDF, ODT/OD & HTM.
Returns
1 for OK, .tcl-error in case of error.

report::frwk geterrorcount

Get number of errors.

Syntax
$frwk geterrorcount
Parameters
None.

report::frwk getexportitems

Get number of items marked for export.

Syntax
$frwk getexportitems
Parameters
None.

report::frwk::getmasterdocument

Queries the current Ms-office master template file based on current report format (document, presentation).

Syntax
$frwk getmasterdocument
Returns
The current Ms-office master template file.

report::frwk getreporttype

Queries the Ms-office report type.

Syntax
$frwk getreporttype
Returns
The current Ms-office report type (word, ppt).

report::frwk getsyncitems

Get number of items marked for sync.

Syntax
$frwk getsyncitems
Parameters
None.

report::frwk getunexecuteditems

Get number of not executed items.

Syntax
$frwk getunexecuteditems
Parameters
None.

report::frwk getworkdir

Queries the current work directory.

Syntax
$frwk getworkdir
Parameters
None.
Returns
The current work directory.

report::frwk ispaused

Check if report execution is paused.

Syntax
$frwk ispaused

report::frwk isrunning

Check if report execution is running.

Syntax
$frwk running

report::frwk isstarted

Check if report execution is started.

Syntax
$frwk isstarted

report::frwk loadtemplate

Loads the specified report template.

Syntax
$frwk loadtemplate
Parameters
-file
Value: File name of report template.
-filelist
Value (optional): list of file names as seen on Report Template dialog or as passed or as used in the order of running HyperWorks in batch mode. See HyperWorks documentation "barchmode" parameter "-tplParams"
Returns
1 for OK, Tcl-error in case of error.

report::frwk newreport

Creates new report template.

Syntax
$frwk newreport
Parameters
-type
Value: Type of report (word, ppt).
Returns
1 for OK, Tcl-error in case of error.

report::frwk quit

Quits ARD.

Syntax
$frwk quit
Parameters
-mode
Value: Interactive (interactive with GUI) mute (engine only, no GUI).
Returns
1 for OK, Tcl-error in case of error.

report::frwk redraw

Notifies all registered views to redraw itself.

Syntax
$frwk redraw

report::frwk registertype

Register a new type relating to an editor.

Syntax
$frwk registertype
Parameters
-type
Value: Unique one-word, all lowercase identifier for the new type. This is the identifier you will need to specify in the module's .xml file.
-class
Value: ITcl class that contains the editor code. Make sure to use proper name space for your custom editor to avoid naming clashes.
Returns
1 for OK, Tcl-error in case of error.

report::frwk savetemplate

Saves the current report template.

Syntax
$frwk savetemplate
Parameters
-file
Value: File name of report template.
Returns
1 for OK, Tcl-error in case of error.

report::frwk setmasterdocument

Sets the Ms-office master template based on current report format (document, presentation).

Syntax
$frwk setmasterdocument
Parameters
-file
Value: Ms-office master template file.
Returns
1 for OK, Tcl-error in case of error.

report::frwk setworkdir

Sets the work directory to specified path.

Syntax
$frwk setworkdir
Parameters
-directory
Value: Path of work directory.
Returns
1 for OK, Tcl-error in case of error.

report::frwk startexec

Flags execution start.

Syntax

$frwk startexec

report::frwk stop

Flags stop execution.

Syntax
report::frwk stop

report::frwk sync

Syncs the Ms-office report based on current report structure.

Syntax
$frwk sync
Parameters
-file
Value: File name of Ms-office report including extension.
Returns
1 for OK, Tcl-error in case of error.

report::frwk templateloadpostcommand

Specify the callback to be called after a new report template got loaded.

Syntax
$frwk templateloadpostcommand
Parameters
-command
Value: Command, Tcl procedure or ITcl method to be called.
Returns
1 for OK, Tcl-error in case of error.

report::frwk templateloadprecommand

Specify the callback to be called before a new report template is being loaded.

Syntax
$frwk templateloadprecommand
Parameters
-command
Value: Command, Tcl procedure or ITcl method to be called.
Returns
1 for OK, Tcl-error in case of error.

report::frwk validate

Validate an item.

Syntax
$frwk validate
Parameters
-id
Value: Specify item ID to validate.