Naming Conventions
The following variable prefixes are used for CopiaFacts variables which are used in connection with Active Directory.
| ADC_ | Environment Variables used to configure the operation of the CopiaFacts AD interface |
| ADP_ | Environment Variables used to specify AD property names to be used for specific purposes. |
| ADU_ | Variables used to return user property values. |
Configuration
The use of Active Directory is optional. It is initiated by the presence of the $ad_connect command in the FAXFACTS.CFG configuration file. This is the only required configuration command; all the variables described below have default values.
 | For new users, the SERCONF program can add the $ad_connect command to your configuration file and will then also add ADP_EMAIL, ADP_FAX and ADP_LOGIN environment variables (described below), which will be defined as "NONE" in SERCONF to suppress automatic AD lookup until you have configured it. |
| If you are not familiar with the names of the properties in your AD database, the CFADEXPLORER program can be used to view the entire database. Only the User properties are currently used by CopiaFacts. |
Additional configuration settings can be supplied using the following variables as $environment commands in FAXFACTS.CFG. This command takes a node name (of the COPIAFACTS engine or of a CGATEWAY node, so multiple different settings are possible. These variables must be set using $environment variables, not as Windows environment variable, and should normally have * as the node parameter so that they apply system-wide.
| The AD interfaces for validation of inbound faxes and e-mails will operate with none of the following variables defined, and will use the default values shown below. |
| ADP_PROPERTIES | A comma-separated list of AD user property names which are to be used to look up Active Directory users or to be returned in ADU_propertyname variables. If ADP_PROPERTIES is not supplied, then only cn, name, facsimileTelephoneNumber, login and mail properties will be available. Tip: ii you have a long list of names, setting word-wrap on the Options menu in COPIAEDIT can make the list easier to edit. |
| ADP_FAX | The name of the AD user property which will be used to match the DNIS on an inbound fax. If not specified, the property facsimileTelephoneNumber will be used. If specified as NONE, Active Directory will not be used to validate incoming DNIS values. The property name must be one of those listed in ADP_PROPERTIES. To use the matched DNIS, it is necessary to set the $default_profile for the inbound channels to be a special profile, such as the sample profile ADFAXIN.USR. See the AD Automatic Lookup topic for more information, and for information about how to use $dnis_scan to restrict matching of incoming DNIS values to the digits at the end of the number. |
| ADP_EMAIL | The name of the AD user property which will be used to match the sender e-mail on an inbound e-mail. If not specified, the property mail will be used. If specified as NONE, Active Directory will not be used to validate incoming sender e-mail addresses. The property name must be one of those listed in ADP_PROPERTIES. See the AD Automatic Lookup topic for more information. To process the incoming e-mail, a special template named AD_USER.FST is required in the sender domain folder. |
| ADP_LOGIN | The name of the AD user property which will be used to match the FFCLIENT login name (in FS file variable FC_LOGIN_USER) in an outbound fax or e-mail. If not specified, the property cn will be used. If specified as NONE, Active Directory will not be used to validate outbound FFCLIENT login names. The property name must be one of those listed in ADP_PROPERTIES, See the AD Automatic Lookup topic for more information. |
| ADP_USR | The name of an AD user property, included in the ADP_PROPERTIES list, of which the contents will be used to override the configured CopiaFacts user profile filename for inbound fax calls. This allows the selection of an alternate user profile for specific fax destinations. If not specified the default user profile for the channel will be used. The value of the specified property should be filename.USR (without path; it is assumed to be found in specified or default User Profiles folder). |
| ADP_FST | The name of an AD user property included in the ADP_PROPERTIES list, of which the contents will be used to override the configured CopiaFacts AD_USER.FST sender template name for incoming e-mails. This allows the selection of an alternate sender template for specific e-mail senders. The value of the specified property should be a valid email address, name@domain, which should match a template name.FST in the domain folder in the Gateway sender templates folder. |
ADC_FAX_OPTIONS This variable should contain one or more of the following option keywords, comma-separated. These options control the use of AD to validate incoming faxes, and do not affect $ad_get_user.
| pass | If the DNIS value is not matched, the incoming fax call will be passed for validation and processing by a USR file with a DNIS number as its filename, for normal processing, instead of being rejected. |
| rejectN | This option specifies as N a SIP or ISDN cause value which will be used to reject the call when the DNIS value is not matched. The default is 603 for SIP and 21 for ISDN. |
| multipleN | This option can be used when there are multiple AD Users who have the same fax number. On matching the number of an incoming call, it will then set up to N separate ADU_ variables for each person's user properties, each with a numeric prefix (e.g. ADU_1MAIL, ADU_2MAIL,...). All the sets of variables are returned in the channel selected for processing the incoming fax, which must then use post-receive scripting to handle the notifications. For more information, see the AD Scripting topic. |
ADC_EMAIL_OPTIONS This variable should contain one or more of the following option keywords/values, comma-separated. These options control the use of AD to validate incoming e-mails, and do not affect $ad_get_user.
| pass | If the sender e-mail value is not matched, the e-mail will be passed for validation and processing by a sender template, if configured. |
| domain | Only incoming e-mail from the domain will be matched against AD; e-mail from other sender domains will be passed for validation and processing by a sender template, if configured. Multiple sender domains may be specified in this value. |
Note that the Active Directory Integration feature currently makes use of the CopiaFacts Call Control DLL and Gateway DLL interfaces, which are therefore unavailable when AD integration is in use.
