Report Action Parameters Interface

The ICIReportActionParams interface allows you to make changes to transfer-related Events, such as when a file is uploaded or downloaded, using the following properties:

CustomDate

In version 5.2 through 6.0.2:

HRESULT CustomDate([out, retval] long *pVal);

HRESULT CustomDate([in] long newVal);

In version 6.1:

HRESULT CustomDate([out, retval] PredefinedReportPeriod *pVal);

HRESULT CustomDate([in] PredefinedReportPeriod newVal);

Example (VBScript):

Retrieving:

If ReportParams.CustomDate = AllDates Then

MsgBox "All-time report will be generated"

End If

Specifying:

ReportParams.CustomDate = Last12Months

DateFormat

In version 5.2 through 6.0.2:

HRESULT DateFormat([out, retval] long *pVal);

HRESULT DateFormat([in] long newVal);

In version 6.1:

HRESULT DateFormat([out, retval] ReportPeriodType *pVal);

HRESULT DateFormat([in] ReportPeriodType newVal);

Example:

Retrieving:

If ReportParams.DateFormat = Predefined Then

MsgBox "Predefined report range is used"

End If

Specifying:

ReportParams.DateFormat = Range

(Refer also to ReportPeriodType Enumeration and PredefinedReportPeriod.)

FilterAndOr

In version 5.2 through 6.0.2:

HRESULT FilterAndOr([out, retval] long *pVal);

HRESULT FilterAndOr([in] long newVal);

In version 6.1:

HRESULT FilterAndOr([out, retval] ReportFiltersCombiningOperator *pVal);

HRESULT FilterAndOr([in] ReportFiltersCombiningOperator newVal);

Example (VBScript):

Retrieving:

If ReportParams.FilterAndOr = NoCombining Then

MsgBox "Please specify an operator to combine report filters."

End If

Specifying:

ReportParams.FilterAndOr = AndCombining

FilterField1 and FilterField2

HRESULT FilterField1([out, retval] BSTR *pVal);

HRESULT FilterField1([in] BSTR newVal);

HRESULT FilterField2([out, retval] BSTR *pVal);

HRESULT FilterField2([in] BSTR newVal);

FilterOperator1 and FilterOperator2

In version 5.2 through 6.0.2:

HRESULT FilterOperator1([out, retval] long *pVal);

HRESULT FilterOperator1([in] long newVal);

HRESULT FilterOperator2([out, retval] long *pVal);

HRESULT FilterOperator2([in] long newVal);

In version 6.1:

HRESULT FilterOperator1([out, retval] ReportFilterOperator *pVal);

HRESULT FilterOperator1([in] ReportFilterOperator newVal);

HRESULT FilterOperator2([out, retval] ReportFilterOperator *pVal);

HRESULT FilterOperator2([in] ReportFilterOperator newVal);

Example (VBScript):

Retrieving:

If ReportParams.FilterOperator1 = NoFilter Then

MsgBox "Please specify a filter for the report."

End If

Specifying:

ReportParams.FilterOperator2 = ContainsFilter

(Refer to ReportFilterOperator Enumeration for a list of enumerators.)

FilterValue1 and FilterValue2

HRESULT FilterValue1([out, retval] BSTR *pVal);

HRESULT FilterValue1([in] BSTR newVal);

HRESULT FilterValue2([out, retval] BSTR *pVal);

HRESULT FilterValue2([in] BSTR newVal);

FromDate

HRESULT FromDate([out, retval] VARIANT *pVal);

HRESULT FromDate([in] VARIANT newVal);

Name

HRESULT Name([out, retval] BSTR *pVal);

HRESULT Name([in] BSTR newVal);

(Not available in v6.1. This information now can be set/retrieved via the Report property.)

OptionalParameters

HRESULT OptionalParameters([out, retval] BSTR *pVal);

HRESULT OptionalParameters([in] BSTR newVal);

Path

HRESULT Path([out, retval] BSTR *pVal);+

HRESULT Path([in] BSTR newVal);

(Not available in v6.1.  This information now can be set/retrieved via the Report property.)

Report

(Available in v6.1) The ICIReportActionParams::Report property is used to identify the report to generate among other reports. Its value is the ICIReportInfo interface.

HRESULT Report([out, retval] IDispatch** pVal);

HRESULT Report([in] IDispatch* newVal);

Example (VBScript):

Retrieving:

MsgBox ReportParams.Report.Name & " report will be generated."

Specifying:

AllReports = Server.AvailableReports

ReportParams.Report = AllReports(0)

ReportFileFormat

In version 5.2 through 6.0.2:

HRESULT ReportFileFormat([out, retval] long *pVal);

HRESULT ReportFileFormat([in] long newVal);

In version 6.1:

HRESULT ReportFileFormat([out, retval] ReportFormat *pVal);

HRESULT ReportFileFormat([in] ReportFormat newVal);

Example (VBScript):

Retrieving:

If ReportParams.ReportFileFormat = HTMLFormat Then

MsgBox "Report will be generated in HTML format"

End If

Specifying:

ReportParams.ReportFileFormat = PDFFormat

(Refer to ReportFormat Enumeration for the available formats.)

ToDate

HRESULT ToDate([out, retval] VARIANT *pVal);

HRESULT ToDate([in] VARIANT newVal);