Package com.ptc.windchill.enterprise.report

Class ReportHelper

java.lang.Object

com.ptc.windchill.enterprise.report.ReportHelper

All Implemented Interfaces:

Externalizable, Serializable

public class ReportHelper
extends Object
implements Externalizable

Supported API: true
Extendable: false Not all methods in this class are supported. Only the methods which are marked as supported true should be used ReportHelper class may undergo changes in near future. ReportHelper class may undergo changes in near future, but supported API may remain intact.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final ReportService	manager	Supported API: true

Method Summary

Modifier and Type	Method	Description
static boolean	deleteCognosReports(Hashtable nv, Hashtable cmd_line, Vector return_objects)	Deprecated.
static boolean	deleteWindchillReports(Hashtable reportHashTable, Hashtable cmd_line, Vector return_objects)	Method to delete Report on Windchill side via a data loader Supported API: true
static boolean	updateWindchillReports(Hashtable reportHashTable, Hashtable cmd_line, Vector return_objects)	Method to update Report on Windchill side via a data loader.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

manager

public static final ReportService manager

Supported API: true

Method Details

deleteCognosReports

@Deprecated
public static boolean deleteCognosReports(Hashtable nv,
 Hashtable cmd_line,
 Vector return_objects)

Deprecated.

Method to delete Report on Cognos side via a data loader

Supported API: true

Parameters:

nv - Name/Value pairs of attributes specified in the load file for example please refer $WT_HOME/loadFiles/reports/DeleteOOTBCognosReports.xml.

cmd_line - Name/Value pairs of attributes specified on the command line. For report to be deleted from Cognos, mention report folder and its defaultName, which will be found under properties file for particular report. If you don't find properties for your report, check its folder path from Cognos UI If Cognos service is not running warning would be logged, and method will be executed successfully. If specified report not found inside cognos, warning will be logged and method will be executed successfully.

Returns:

boolean This method will return true always whether particular reports exists or does not exits, gets deleted or not gets deleted.

deleteWindchillReports

public static boolean deleteWindchillReports(Hashtable reportHashTable,
 Hashtable cmd_line,
 Vector return_objects)

Method to delete Report on Windchill side via a data loader

Supported API: true

Parameters:

reportHashTable - Name/Value pairs of attributes specified in the load file, Please refer for example $WT_HOME/loadFiles/reports/DeleteOOTBWindchillReports.xml

cmd_line - Name/Value pairs of attributes specified on the command line. It will accept Windchill report name as first paramter invalid input: '&' container reference as scond parameter. To delete report from Windchill DB mention report name as a parameter.

Returns:

updateWindchillReports

public static boolean updateWindchillReports(Hashtable reportHashTable,
 Hashtable cmd_line,
 Vector return_objects)
                                      throws WTPropertyVetoException

Method to update Report on Windchill side via a data loader.

Supported API: true

Parameters:

reportHashTable - Name/Value pairs of attributes specified in the load file, Please refer for example $WT_HOME/loadFiles/mpml/R12UpdateMPMLinkReports.xml

cmd_line - Name/Value pairs of attributes specified on the command line. It will accept Windchill report name as first paramter invalid input: '&' container reference as scond parameter. To update report from Windchill DB mention report name, container Path and folder Path as a parameter.

Returns:

Throws:

WTPropertyVetoException