Data Source Properties
Active Directory Data Source
The Active Directory data source allows the creation of an LDAP query to the Active Directory to obtain specific objects and their properties.
An Active Directory data source can be added as a previously configured DEC, or using specific parameters to access the Active Directory.
Configuring an Active Directory Source by DEC
DEC
The Data Enrichment Application. Select from a list of Active Directory DECs
Filter
An Active Directory path by which to filter. For example: OU=NewUsers,DC=Example,DC=Com
Search Scope
Where to search objects. Select from
- Base
- One Level
- Subtree
Properties to Fetch
More properties to fetch in addition to the default (Active Directory properties names). For example:
description, objectClass, sAMAccountName etc.
Configuring an Active Directory Source by Properties
| Property | Description |
|---|---|
| Domain NetBios Name | The Active Directory domain NetBios name Example: CONTOSO |
| Domain DNS Name | The Active Directory domain DNS name Example: <www>.Example.com |
| User / Password | A user from the Active Directory domain with Administrative Rights |
| Port | The connection port. The default is 389 Must be 389 or 636 if SSL is selected |
| SSL | Check this box to use SSL |
| Specific Server | Should use a specific server connection |
| Base DN | Specifies an Active Directory path to search under. Can be used to search in a specific OU. Leave empty if unsure. |
| Filter | An LDAP-syntax filter to refine results. Example: (objectClass=user) This will give you all objects of the "user" class. |
| Search Scope | Where to search objects: Subtree, Base, or One Level. |
| Properties to Fetch | More properties to fetch in addition to the default (Active Directory properties names) For example: description, objectClass, sAMAccountName etc. |
Excel Data Source
You can create an Excel data source from an existing Excel file.
| Property | Description |
|---|---|
| File UNC Path | The file location. This must be a relative UNC since it can be accessed from multiple File Access Manager servers. Example: \file-server\share1\file.xlsx |
| Domain | The domain of the user that has access to the file |
| User / Password | The user that has access to the file |
| Worksheet | The name of the worksheet in the Excel file to query. Example: Sheet1 |
| Custom Columns Letters | The columns to query, comma delimited. Example: A,B,E,Z. Enter a column letter, then select + for each additional column |
| First Row | The first row number to query. First-row columns are headers. Select to read the headers from the Excel sheet. |
Flat File Data Source
You can create a table from a flat file data source (such as *.csv).
| Property | Description |
|---|---|
| Source File Path | The file location. Example: \file-server\share1\file.xlsx |
| Headers Row Structure | The row header (the name of the new table) according to the structure of the file, for example: Users, Roles, Data |
| Delimiter Character | The delimiter separating entries |
| First Row | Specifies a column name. Select to read the headers from the Excel sheet. |
LDAP Data Source
You can create a table from an LDAP query.
| Property | Description |
|---|---|
| Query | The LDAP query that defines the data source. Example: objectClass=user |
| User / Password | The user that has permissions to run the query |
| Server | The server to run the LDAP query |
| Port | The port (default 389) |
| SSL | Should use SSL |
| Expand Multi-value Attributes | If set, will create a row in the data source for each value in a multi-value attribute |
| Search Scope | Where to search objects: Subtree, Base, or One Level. |
| Base DN | The Base DN from which the query should run. Example: DC=Example,DC=COM |
| Properties to Fetch | Type in the name of the property, and select + to add it to the list. Select the delete icon on any item to remove it from the list. |
ODBC Data Source
You can create a table from an ODBC data source.
| Property | Description |
|---|---|
| System DSN | The ODBC file data source name as it is stored in the server |
| Timeout (min) | The ODBC query timeout, in minutes (default is 0) |
| User / Password | Credentials of the user with permissions to run the ODBC query |
| Query | The query to retrieve the required data |
Oracle Database Data Source
You can create a table from an Oracle Database query.
| Property | Description |
|---|---|
| SID | The oracle site identifier. This field is compulsory if the By Properties radio button is checked |
| User / Password | The user with permission to run the query. This field is compulsory if the By Properties radio button is checked |
| Timeout | The query timeout in minutes. This field is compulsory if the By Properties radio button is checked |
| Query | The query that defines the data to retrieve |
SQL Server Database Data Source
You can create a table from an SQL Server Database query.
| Property | Description |
|---|---|
| WPC | The Data Enrichment Application from which to take the parameters (only SQL DECs). This field is compulsory if the BY DEC radio button is checked |
| Server Name / Port / Database | SQL Server Database access. These fields are compulsory if the By Properties radio button is checked |
| User / Password | The user with permission to run the query. This field is compulsory if the By Properties radio button is checked |
| Timeout (min) | The query timeout (default is 0). This field is compulsory if the By Properties radio button is checked |
| Query | The SQL query that defines the data to retrieve |
Static Table Data Source
Create a static custom table by adding or deleting columns and inserting / editing written text in the data grid on the screen.
Edit the headers and content directly in the New Data Source page.
Use the Add Row / Column buttons and the delete buttons to manage the table dimensions.
User Exit Data Source
The User Exit data source executes an external script / executable file, which prints a *.csv-formatted table of data to the Standard Output stream.
| Property | Description |
|---|---|
| File Name | The full path to the file being executed. Examples: c:\temp\UserExitScript.bat \\remotehost\shared_dir\UserExitScript.exe |
| Arguments passed to the file | List of arguments |
| User Name / Password / User Domain | The user running the file execution process |
| Timeout (ms) | The amount of time, in milliseconds, to wait for the process to exit. The maximum is the largest possible value of a 32-bit integer. If the timeout passes, the process terminates. |
| First-row columns are headers | Select to indicate that the csv output contains headers in the first row |
| Values Delimiter Character | The delimiter of the values in each row. Examples: , (comma) | (pipe sign) |
XML Data Source
Create a table from an XML data source file.
| Property | Description |
|---|---|
| XML Namespace | The connection details screen contains a list of namespaces. Add or remove rows pressing the Add Row button, or the delete icon respectively. |
| Prefix | If the source XML has XML namespaces, this is the namespace’s prefix. This field is compulsory if the source XML has XML namespaces. Example: If the namespace is: xmlns:sp=http://some.namespace.uri then the prefix is sp. |
| URI | If the source XML has XML namespaces, this is the namespace’s URI. This field is compulsory if the source XML has XML namespaces. Example: If the namespace is: xmlns:sp=http://some.namespace.uri then the URI is: http://some.namespace.uri |
| Fields | Define the fields within the XML source. Add or remove rows pressing the Add Row button, or the delete icon respectively. |
| Name | Example: The name in this record would be "Job"<record><job>fireman</job></record> |
| XPath | Example: the XPath for this record would be "Job/text()"<br><record><job>fireman</job></record> |
| Type | Example: System.DateTime, System.Int32 |
| Format | If the column is of a Date type, can set the date format. Example: DD’/’MM’/’yyyy |
| Source XML File Path | The path to the source XML file. This is a local path, from which the "File Access Manager User Interface" service is installed |
| Record Base XPath | This XPath query defines the recurring element to use as a base record. The different field definition query from inside this base record. For example, if the XML is: <br><someData xmlns:sp="http://some.namespace.uri"><record><name id="1">john smith</name></record><record><name id="2">john doe</name></record></someData>Then the record base XPath is .someData/record |