This topic describes the three ways in which Active Directory User properties can be retrieved automatically for a CopiaFacts fax or e-mail transaction.
When the value of environment variable ADP_FAX is not NONE, the Active Directory validation of incoming fax calls is done as soon as the call properties are available. The validation process accepts the call if the incoming dialed number is matched, and also sets the user variables specified in ADP_PROPERTIES from the matched user properties, and the AD_STATE.
Details of the Active Directory validation processing and requirements are as follows:
•The validation process accepts the call if the incoming dialed number is matched, and also sets the user variables specified in ADP_PROPERTIES from the matched user properties. Rejected calls are handled as specified by ADC_FAX_OPTIONS.
•The channel configuration in CFHWL should specify the number of DNIS digits expected, and must specify that all calls are to be handled, by means of either 1 or an odd value in DID type.
•A $dnis_scan command can optionally be used in FAXFACTS.CFG for the channel group receiving incoming fax calls. This will extract a shorter DNIS value from the reported destination number. This DNIS value should then be matched by a suitable Active Directory property named in ADP_FAX, rather than by the full facsimileTelephoneNumber value.
•A $dnis_scan command can optionally be used in FAXFACTS.CFG with the keyword AD instead of the channel group parameter. This will extract, and index on, a shorter DNIS value from the full facsimileTelephoneNumber held in AD (or the property specified in ADP_FAX), before matching against the incoming DNIS. You might need to use this option in a case where a PBX delivers an incoming call with for example the last 4 digits of the fax number.
•A special default user profile which configures the use of the built-in mailbox must be specified as $default_profile for the channel range which accepts inbound fax calls. This can be overridden by the contents of the property specified in ADP_USR. The sample ADFAXIN.USR can be used for this purpose.
 | If you use ADFAXIN.USR, you will need to customize this file to set default options and e-mail addresses. |
| If you use the multipleN keyword in ADC_FAX_OPTIONS, you may need to change PRI_INIT10.IIF in the SCRIPTS folder to handle the maximum number of matched users (with the same fax number) that you decide to support. |
To use AD user properties to control processing of received faxes, see the standard Post Receive Scripts documentation.
When the value of environment variable ADP_EMAIL is not NONE, the Active Directory validation of incoming fax calls is done as soon as the e-mail is received by the Gateway SMTP or POP3 server. If any domain values are present in ADC_EMAIL_OPTIONS, the AD validation is only done for the specified sender domains; other domains will use normal sender template validation.
Details of the Active Directory validation processing and requirements are as follows:
•The validation process accepts the e-mail if the incoming sender e-mail is matched, and also sets variables specified in ADP_PROPERTIES from the matched user properties. Rejected e-mails are handled as specified by ADC_EMAIL_OPTIONS.
•A sender template is built based on the required AD_USER.FST sender template for the sender domain. This filename can be overridden by the contents of the property specified in ADP_FST.
•The ADU_ variables created from the selected user are recorded as $var_def commands in the generated template. The variable definitions are inserted at the start of the file so that they can be used by later commands. If you call $get_ad_user again in the pre-process script, these variables will be overridden.
| Note that an AD_USER.FST template is required. Since validation is done by AD look-up, this is the only sender template needed. This template can use any variables retrieved from AD, as in this example: |
Click to view/copy sample AD_USER.FST
To use other AD user properties to control processing of received e-mails, see the sample standard scripts installed with the CopiaFacts Gateway.
Outbound FFCLIENT Transactions
FFCLIENT includes in each generated FS file a variable FC_LOGIN_USER which contains the login name of the user who is using the FFCLIENT program. When the value of environment variable ADP_EMAIL is not NONE, the login value is used when loading an FS file to match a user cn or name property and retrieve the specifies properties from Active Directory for the matched user.
The ADU_ variable values can be used on cover sheets and fax header lines, as well as in any preprocess scripts specified for the transaction.
