sp_On_File_In

sp_On_File_In

sp_On_File_In is triggered after a new incoming file message has been retrieved.

Remarks

This procedure should not be called directly by developer, it is automatically called by Boomerang services after completion of a File In job. This handler is invoked by Boomerang services both in event of success and failure.

Default body of this procedure is blank, thus user may provide their own code implementation for follow-up purposes.
[important]Any changes to handler parameter list cannot be made. New parameters may add with future Boomerang releases upon which a notice will be sent separately.[/important]

Syntax

exec sp_On_File_In @rKey=...

Parameters

Column Name Data type Direction Description Default Status
@rKey uniqueidentifier in Message key fKey found in IN_FILE table Required

Return Code Values

0 (success) or non-zero (failure)

Examples

Determine if the retrieved file is a PDF

ALTER procedure [dbo].[sp_On_File_In]
(
  @fKey uniqueidentifier
)
as 
begin
 
select * from dbo.IN_FILE where fKey = @fKey and Name like '%.PDF'
if @@ROWCOUNT > 0 
	begin
		Select 'A PDF file was retrived'
	end
end

See Also

Helpers and Event Handlers
IN_FILE