Provisioning Reference Guide › Common Program Exit Reference › Custom Function Program Exits

Custom Function Program Exits

A custom function program exit is invoked from an account template rule expression. Custom function program exits share the following characteristics:

• The exit type is always CUSTOM_FUNCTION. There are no PRE or POST variants.
• The exit must be a common program exit (DLL or SOAP). Native exits cannot be used to compute the custom function.
• The exit must be registered in the same domain as the account being created or updated from the policy. The reference to a custom function program exit (%$funcname(…)%) contains the name of the exit (funcname), but there is no rule string syntax to let you specify the domain of the program exit so it is always presumed to be in the domain of the account.
• The input to the program exit includes zero or more single- or multi-valued parameters.

For example, if the global user for the account being created or updated has the following attribute settings:

eTCustomField01:  { value1a, value1b }      (that is, two values assigned)
eTCustomField02:  value2

The %*$FuncName(%*UCU01%, %UCU02%)% rule expression is evaluated.

The input XML passes all values of eTCustomField01 and the value of eTCustomField02 as follows:

<eTExitInvoke eTExitType=CUSTOM_FUNCTION>
   <eTFunction>
      <eTFuncParam1>value1a</eTFuncParam1>
      <eTFuncParam1>value1b</eTFuncParam1>
      <eTFuncParam2>value2</eTFuncParam2>
   </eTFunction>
   <Authentication>
      <Type>GLOBAL_USER</Type>
      <User>{the DN of the global user}</User>
      <Password>{the password of the global user}</Password}
   </Authentication>
</eTExitInvoke>

The output from the program exit can indicate an error (as with any other program exit) so that the creation or update of the account is not attempted, or can contain a single- or multi-valued output parameter. For example, a program exit could return the following XML block to indicate two values (ReturnValue1 and ReturnValue2) to set for the corresponding account attribute:

<eTExitReturn>
   <eTExitReturnCategory>SUCCESS</eTExitReturnCategory>
   <eTExitReturnNative>0</eTExitReturnNative>
   <eTExitContinue>TRUE</eTExitContinue>
   <eTExitCustom>
      <eTFuncReturn>ReturnValue1</eTFuncReturn>
      <eTFuncReturn>ReturnValue2</eTFuncReturn>
   </eTExitCustom>
</eTExitReturn>

The function rule expression controls the number of values to set as follows:

• If the $FuncName in the rule expression is preceded by * (asterisk) as in the example above, this will set 0 or more values of the attribute depending on what is included in the output XML document.
• If the function rule expression does not have the * preceding $FuncName, only the first value returned is relevant. Additional values are ignored.