EmailOutput method: ReportDefn class

Syntax

EmailOutput(ProcessInstanceID)

Description

Use the EmailOutput method to email the report generated by the ProcessReport method. This method can be used for bursted and non-bursted reports. You must successfully call the ProcessReport method prior to calling this method.

The report is distributed as an email attachment to the report viewers defined in the report definition, to users defined by the Distribution link during run-time report scheduling, or to external users when the IPT_BIP_EXT_EMAIL_INT:BIP_EMAIL_DATA interface class is implemented.

Parameters

Parameter	Description
ProcessInstanceID	Specify the process instance of the calling process, such as the calling Application Engine program. Note: Invoking this method with a process instance ID of 0 is invalid; the EmailOutput method can only be used for scheduled reports.

Returns

A Boolean value: True if the report was sent (email) successfully; otherwise, False.