ICIReportActionParams Interface

The ICIReportActionParams interface allows you to make changes to report actions in Event Rules.

interface ICIReportActionParams : IDispatch

See also ICIServer Interface::GenerateReport

Properties

  • Property CustomDate As PredefinedReportPeriod

    • Retrieves or specifies a predefined report period.

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

    Example:

    Retrieving:

    If ReportParams.CustomDate = AllDates Then
MsgBox "All-time report will be generated"
End If

    Specifying:

    ReportParams.CustomDate = Last12Months

    EFT v5.2 and later

  • Property DateFormat As ReportPeriodType

    • Retrieves or specifies the report period (predefined or a FROM-TO range).

    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

    EFT v5.2 and later

  • Property FilterAndOr As ReportFiltersCombiningOperator

    • Retrieves or specifies a filter.

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

    Example:

    Retrieving:

    If ReportParams.FilterAndOr = NoCombining Then
MsgBox "Please specify an operator to combine report filters."
End If

    Specifying:

    ReportParams.FilterAndOr = AndCombining

    EFT v5.2 and later

  • Property FilterField1 As String

    • Retrieves or specifies a filter.

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

    EFT v5.2 and later

  • Property FilterField2 As String

    • Retrieves or specifies a filter.

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

    EFT v5.2 and later

  • Property FilterOperator1 As ReportFilterOperator

    • Retrieves or specifies a filter operator.

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

    Example:

    Retrieving:

    If ReportParams.FilterOperator1 = NoFilter Then
MsgBox "Please specify a filter for the report."
End If

    Specifying:

    ReportParams.FilterOperator2 = ContainsFilter

    EFT v5.2 and later

  • Property FilterOperator2 As ReportFilterOperator

    • Retrieves or specifies a filter operator.

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

    EFT v5.2 and later

  • Property FilterValue1 As String

    • Retrieves or specifies a filter value.

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

    EFT v5.2 and later

  • Property FilterValue2 As String

    • Retrieves or specifies a filter value.

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

    EFT v5.2 and later

  • Property FromDate As Variant

    • Retrieves or specifies the FROM date for the report.

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

    EFT v5.2 and later

  • Property OptionalParameters As String

    • Retrieves or specifies optional parameters used to generate the report.

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

    EFT v5.2 and later

  • Property Report As Object

    • Retrieves or specifies a report.

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

    EFT v6.1 and later

  • Property ReportFileFormat As ReportFormat

    • Retrieves or specifies the report format.

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

    Example:

    Retrieving:

    If ReportParams.ReportFileFormat = HTMLFormat Then
MsgBox "Report will be generated in HTML format"
End If

    Specifying:

    ReportParams.ReportFileFormat = PDFFormat

    EFT v5.2 and later

  • Property ToDate As Variant

    • Retrieves or specifies the date for the report.

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

    EFT v5.2 and later

Dialog Box Equivalents