Preemitter in Flow Service (com.ibi.agents.XDPreemitAgent)

Syntax:

com.ibi.agents.XDPreemitAgent

iIT Service Object:

emit: Preemitter in Flow

operations: Preemitter in Flow

Description:

Runs a specified preemitter. This service is usually used before an emit service.

Parameters:

Parameter	Description
Preemitter	Name of the defined preemitter to run. If blank, standard selection is used.
return*	Output is the preemit result. If the preemitter fails: status. Status document will become the output document. input. Input document will become the output document
Call at EOS? *	In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message. The default value is false.

Parameter

Description

Preemitter

Name of the defined preemitter to run. If blank, standard selection is used.

return*

Output is the preemit result. If the preemitter fails:

status. Status document will become the output document.
input. Input document will become the output document

Call at EOS? *

In a streaming environment, EOS (End of Stream) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message. The default value is false.

Edges:

The following table lists the available line edges for the Preemitter in Flow Service (com.ibi.agents.XDPreemitAgent).

Line Edge	Description
OnError	Error
OnSuccess	Success
OnFailure	Failure
OnCustom	OnError OnSuccess OnFailure fail_preemit

Example:

Running this service with XDCharRepl, the following result is provided:

<?xml version="1.0" encoding="UTF-8" ?> 
<emitstatus status="1">
<protocol>preemit</protocol>
<parms>
   <parm name="wanteos">false</parm>
   <parm name="return">status</parm> 
   <parm name="name">com.ibi.preemit.XDCharRepl</parm>
</parms>
<timestamp>2009-01-28T00:26:14.113Z</timestamp>
<status>1</status> 
</emitstatus>