Table Of Contents

Report Management Functions

generateReport

readReport

Report Management Functions

---

This chapter provides information about the following report management functions:

•generateReport

•readReport

generateReport

Synopsis

Status generateReport(UserToken token, ReportSubject subject, DeviceFilter filter) throws 
RemoteException;

Description

This function generates the specified report and stores the report data at the server. If prior report data exists, a call to this function overwrites the previous report. Only one copy of the report data is stored. This function may take a long time to perform. Only one report can be generated at a time.

Input Parameters

Parameter	Type	Value	Description
token	UserToken, mandatory	—	A token that represents your authorization pass, which is obtained after you invoke the login function and are authenticated by the back-end server. Only an administrator can generate a report.
subject	ReportSubject, mandatory	One of the enumeration values defined in ReportSubject	Enumeration value that represents the subject of the report to be generated.
filter	DeviceFilter, optional	—	The input DeviceFilter object specifies the criteria for searching the defined devices. If the filter is set to null, no filtering is performed. For an audit trail, null should be entered.

Return

This function returns Status objects.

Error and Exception

When an error occurs, information about the error is contained in the returned status object. When a call fails because of a Remote Method Invocation (RMI)-related error, a RemoteException is thrown.

readReport

Synopsis

ReportStatus readReport(UserToken token, ReportSubject subject, OutputFormat 
output_format) throws RemoteException;

Description

This function returns the report most recently generated by the generateReport() function.

Input Parameters

Parameter	Type	Value	Description
token	UserToken, mandatory	—	A token that represents your authorization pass, which is obtained after you invoke the login function and are authenticated by the back-end server.
subject	ReportSubject, mandatory	One of the enumeration values defined in ReportSubject	Enumeration value that represents the subject of the report to be generated.
output_format	OutputFormat, mandatory	HTML, text	Enumeration value that represents HTML or text format.

Return

This function returns a ReportStatus object containing the report, the error code, and the error message.

Error and Exception

When an error occurs, this function returns ReportStatus which contains the none ClmErrors.SUCCESS error code. When the call fails because of a Remote Method Invocation (RMI)-related error, a RemoteException is thrown.