Adding and Editing Data Sources
The following screen is used to add new data sources and to edit existing sources.
When editing a source, the data source type cannot be changed. If necessary, remove the source and add a new source.
NOTE: Different fields are shown on the screen depending on which data source type is selected. The above screenshot is for a directory-based source. (see also Access and SQL source-specific fields).
Standard Settings
Select Data Source
This is the type of the source. Select either a directory-based source, Access or SQL. Then enter the source name / path or browse using the ellipsis (...) button:
- Directory-based: the name of a server containing a directory
- Access: the full file path to the database
- SQL: the name of the server running the SQL service
Friendly Name
This is a free-text name that will be used to identify the source when running Directory Integrator.
NOTE: For source-specific settings see below.
Authentication Details
Should the source require authentication details, enter the username and password. The user account that is currently logged-on is used by default to access directory and SQL sources.
Read / Write Status - Secondary
If ticked, this makes this source a secondary data source. See Data Sources for more details.
Read / Write Status - Update
If ticked, the source can be updated by Directory Integrator. Changes made to the data through the software can be written back to the source. Otherwise, the source is used just to present data.
NOTE: Normally, only primary data sources are set as updateable. For information on setting secondary sources as updateable, see Data Sources.
Read / Write Status - Reference Data Source by ID
Normally, when accessing records on the data source, the full path of the object is used (e.g., ADSPath on Active Directory). If the data has Unique ID values, selecting this option will force Directory Integrator to use this ID value instead.
Description Field
When carrying out certain tasks, e.g., searching for people, it is useful to have more information, other than just first and last names, to allow a precise selection to be made. The field selected here will also be displayed along with the name information.
For example, selecting Job Title would allow a choice to be made between John Smith - Manager and John Smith - Nurse.
Source-Specific Settings
Base
This is the OU on the directory from which Directory Integrator will retrieve information. All person objects and OU's below this base OU will be displayed. Select a base using the ellipsis (...) button.
Leaving this blank will display the entire directory.
Restrict Container view to this level only
When used with a base, only the person objects in the base OU itself will be shown. When unticked, all sub-OU's and content will also be shown.
By default, Directory Integrator retrieves user objects from the directory only. Setting an LDAP filter here can force Directory Integrator to retrieve other objects as well.
For example, (&(objectCategory=user)(objectCategory=person)) will retrieve both user and contact objects.
Database Name
This setting is not required for Access Sources.
Table Name
The name of the table in the database that contains the data.
NOTE: A query can be written in the Access source and used in this setting if required.
Group Field
The database source will have all its data in one place, i.e., it will have a "flat" structure. An artificial tree structure can be created by selecting a field to group by from the list.
Database Name
The database name to use in the SQL service.
Table Name
The name of the table in the database that contains the data.
NOTE: A query can be written in the SQL source and used in this setting if required.
Group Field
The database source will have all its data in one place, i.e., it will have a "flat" structure. An artificial tree structure can be created by selecting a field to group by from the list.