Please enable JavaScript to view this site.

CopiaFacts™ Reference Manual

Using CopiaFacts AD Variables in Scripts

AD User properties can be accessed from any CopiaFacts script, not only the standard ones which handle incoming fax notification and incoming e-mail transmission by fax.

In a CopiaFacts infobox script, you can use any of the AD user properties which you have specified in an ADP_PROPERTIES environment variable. You can use these properties as search keys to find a user; after a user has been located all the properties are available as CopiaFacts variables named ADU_propertyname, each of which contains the value of the named property.

The first step is to find the user by means of the IIF command $ad_get_user, which allows look-up on up to three property values.  Then the variables are automatically made available as ADU_propertyname variables.

When the ADC_FAX_OPTIONS keyword multipleN is used, up to N separate variables will be set for each property, prefixed with an index number up to N. This option the reports property values for up to N AD user records contain the same fax number, allowing scripting to generate an e-mail to each matched user. The keyword multiple1 is ignored, and if N is larger than 9, two-digit prefixes will be used.

For example, instead of setting ADU_CN and ADU_mail variables for an incoming fax, the system will set ADU_1cn and ADU_1mail, ADU_2cn and ADU_2mail, etc.  In addition, variable ADU_COUNT is generated containing the count of users matched.  See the PRI_INIT10.IIF sample script for an example of how to use these variables.

Examples of the use of the Active Directory properties in scripting are provided in the Standard CopiaFacts Scripts. The AD_STATE variable is used to enable or disable Active Directory integration statements in the standard scripts.

Utility Programs for Testing

The CFTEST collection includes a utility, FFTESTAD, to test connection to an AD database and look up user data. It will use and find only the properties configured in ADP_PROPERTIES.

The CFADEXPLORER utility will open and display the whole AD database, including parts other than the User data accessed using the CopiaFacts AD integration features described above.  You may find this utility helpful in determining which user properties may be useful to you in CopiaFacts applications.

Trace Information