ardi.frwk
ardi.frwk.addcustompath
Registers additional search path(s) to locate custom modules.
- Syntax
ardi.frwk.addcustompath
- Parameters
-
- -directory
- Value: One or a list of paths separated by blank.
- Returns
- 1 for OK, Python-error in case of error.
ardi.frwk.execute
Executes the current report template.
- Syntax
ardi.frwk.execute
- Parameters
-
- item
- Value: ID
- Returns
- 1 for OK
ardi.frwk.export
Exports the Ms-office report based on current report template.
- Syntax
ardi.frwk.export
- Parameters
-
- -file
- Value: File name of Ms-office report including extension.
- Returns
- 1 for OK, Python-error in case of error.
ardi.frwk.getmasterdocument
Queries the current Ms-office master template file based on current report format (document, presentation).
- Syntax
ardi.frwk.getmasterdocument
- Returns
- The current Ms-office master template file.
ardi.frwk.getreporttype
Queries the Ms-office report type.
- Syntax
ardi.frwk.getreporttype
- Returns
- The current Ms-office report type (word, ppt).
ardi.frwk.newreport
Creates new report template.
- Syntax
ardi.frwk.newreport
- Parameters
-
- -type
- Value: Type of report (word, ppt).
- Returns
- 1 for OK, Python-error in case of error.
ardi.frwk.quit
Quits ARD.
- Syntax
ardi.frwk.quit
- Parameters
- None
- Returns
- 1 for OK, Python-error in case of error.
ardi.frwk.savetemplate
Saves the current report template.
- Syntax
ardi.frwk.savetemplate
- Parameters
-
- -file
- Value: File name of report template.
- Returns
- 1 for OK, Python-error in case of error.
ardi.frwk.setmasterdocument
Sets the Ms-office master template based on current report format (document, presentation).
- Syntax
ardi.frwk.setmasterdocument
- Parameters
-
- -file
- Value: Ms-office master template file.
- Returns
- 1 for OK; Python-error in case of error.
ardi.frwk.setworkdir
Sets the work directory to specified path.
- Syntax
ardi.frwk.setworkdir
- Parameters
-
- -directory
- Value: Path of work directory.
- Returns
- 1 for OK; Python-error in case of error.