route_veng()

route_veng()

Description

Use route_veng() to send transactions to the SFM for transaction production through a specified engine.

“ENGINE” is all defined production objects defined (use reserved or named declared in the SFM configuration), but an “engine” contains a subset of production objects. If you define “engine to contain all production objects, then it is the same as “ENGINE.”

Transactions routed by an engine qualify against all the production objects specified for this engine in the order they have been declared. The transaction is considered qualified if it qualifies for one or more production objects, otherwise, the transaction is considered unrouteable.

To use the same functionality as route_veng(), but not have the transaction written to the unrouteable log if the transaction is unrouteable (for example, does not qualify, or has a bad route), use route_veng2() instead.

Format

int route_veng(int [flavor] Flavor, string [in] SRCRef, string [in] engName, {string | blob} [in] Data);

Parameter	Description
Flavor	The flavor assigned to the SFM module that should receive the data. If you are running only one copy of the SFM, use a value of zero in this argument.
SRCRef	The Source Reference Name. A user-supplied reference name for the current Acquisition AIM. Allowable characters include A – Z, a – z, 0 – 9. The string datatype is required.
engName	the names of the production objects that should process the data. The names can be a maximum of 32 characters plus a null character. Allowable characters include A – Z, a – z, 0 – 9. A String or blob datatype is required
Data	A blob or string field that contains the transaction’s data.

Parameter

Description

Flavor

The flavor assigned to the SFM module that should receive the data. If you are running only one copy of the SFM, use a value of zero in this argument.

SRCRef

The Source Reference Name. A user-supplied reference name for the current Acquisition AIM. Allowable characters include A – Z, a – z, 0 – 9. The string datatype is required.

engName

the names of the production objects that should process the data. The names can be a maximum of 32 characters plus a null character. Allowable characters include A – Z, a – z, 0 – 9. A String or blob datatype is required

Data

A blob or string field that contains the transaction’s data.

Return values

Integer.

Value	Description
> 0	The SFM has accepted the record and has written it to the transaction log file.
0	General error. Check the error log and the standard UNIX “errno” field.
-1	A transaction could not be passed to the SFM. Your program should check the unrouteable error log to find out why this occurred.
-2	The SFM could not find the names of the production objects in its configuration file.
-3	The SFM could not process the transaction because the log file was full.
-4	The SFM received a transaction larger than the log file’s transaction size.
-5	The SFM refused the record because it is in Refuse mode.
-6	The transaction data did not pass the field object validation or production object qualification checks in the referenced production objects.
-7	There are no valid destinations for the production objects for which the transaction qualified. Occurs when the production objects use the setDestName and/or the setDestNameData dynamic routing built-ins to override the production object’s configured destinations, but the built-ins do not specify valid destinations.
-8	The SFM could not process the transaction because an invalid destination was specified with a dynamic routing built-in filter function.

Value

Description

> 0

The SFM has accepted the record and has written it to the transaction log file.

General error. Check the error log and the standard UNIX “errno” field.

-1

A transaction could not be passed to the SFM. Your program should check the unrouteable error log to find out why this occurred.

-2

The SFM could not find the names of the production objects in its configuration file.

-3

The SFM could not process the transaction because the log file was full.

-4

The SFM received a transaction larger than the log file’s transaction size.

-5

The SFM refused the record because it is in Refuse mode.

-6

The transaction data did not pass the field object validation or production object qualification checks in the referenced production objects.

-7

There are no valid destinations for the production objects for which the transaction qualified. Occurs when the production objects use the setDestName and/or the setDestNameData dynamic routing built-ins to override the production object’s configured destinations, but the built-ins do not specify valid destinations.

-8

The SFM could not process the transaction because an invalid destination was specified with a dynamic routing built-in filter function.