Where is IAPI_cancel documented?

Question

I want to plug some intelligence into a FFAS cycle.
Validation of source can trap obvious errors e.g. missing keyfields... but it cant trap logical errors like duplicate names and so on.
I guess using this variable is the only way to abort the processing of a logically bad FFAS record.
Question is how its used. The FAQ doesnt attempt to describe it, rather it goes off on a tangent describing how to avoid its use.
What process/processes will reset IAPI_cancel false, if I set it true.
Do I refer to the variable as simply IAPI_cancel.
Has anyone used IAPI_cancel?
any hints or tips accepted

Answer 1

Resource forms are used with Active Sync-enabled adapters in the following ways:
Cancel the processing of the user by setting IAPI.cancel to true. This is often used to ignore updates to certain users.
The following example shows a simple field that will ignore all users with the last name Doe.
<Field name='IAPI.cancel'>
<Disable>
<neq>
<ref>activeSync.lastName</ref>
<s>Doe</s>
</neq>
</Disable>
<expression>
<s>true</s>
</expression>
</Field>
Resource forms include logic for handling the cases of new and existing users, as well as
logic for disabling or deleting the Identity Manager user when a deletion has been detected.
Process Cancel Action
To cancel the processing of a user, set IAPI.cancel to true in the resource form. You can
use this to ignore updates to certain users.
NOTE : If IAPI.cancel is set to a value of true in an Active Sync form, then the process associated with an IAPIUser or IAPIProcess event will not be launched.
from "IDM_Technical_Deployment_Overview_7-0.pdf"