# Failure

## Program ID

MetraPipeline.FailurePlugIn.1

## Description

The Failure plug-in is used to fail a session even if no errors occur. This is useful for testing the Pipeline server’s error functionality and auditing capability. The Failure plug-in can be configured to fail a transaction at a specific interval or if a string property is set to a certain value, or both. The examples shown below describe the three modes of operation.

## Required input properties

N/A (see description)

## Required output properties

N/A (see description)

## Additional configuration tags

None.

## Configuration Example

In the following sample configuration information, the current transaction fails after two transactions are processed:

<configdata>
<failevery ptype="INTEGER">2</failevery>
</configdata>

In the following sample configuration information, the transaction fails if the specialinfo property is equal to FORCE FAILURE:

<configdata>
<failif>
<name>specialinfo</name>
<value>FORCE FAILURE</value>
</failif>
</configdata>

In the following sample configuration information, the current transaction fails after two transactions are processed and if the specialinfo property is equal to FORCE FAILURE:

<configdata>
<failevery ptype="INTEGER">2</failevery>
<failif>
<name>specialinfo</name>
<value>FORCE FAILURE</value>
</failif>
</configdata>

## Remarks

The Failure plug-in is useful in a development environment but is not recommended for a production system. Use of this plug-in could cause seemingly random failures.

## See also

This plug-in is also documented in the Platform Programmer’s Guide.