Before getting started, here is the documentation on the SSO/LDAP mode integrated to SAFE X3:annex documentation.
This function is used to declare a LDAP directory which is take into account if the SSO mode is activated.
Two types of information are declared in this function:
This panel contains the way in which the connection to the directory is made (the name of the LDAP server, a port number, an access account and a password).
Two additional setup fields define how to inquire the directory.
There is a correspondence between the fields of the LDAP directory and the fields of the X3 user record or the user setup values.
Four field types exist:
The X3 field in the user record ADDNAM is a unique identifier in X3 and in the directory. It must have the type 'Identifier' and is associated by default with the directory field distinguishedName.
Case where the setup valueSSOREFMAJ is equal to 1:
When the field of type 'identifier' is not updated in the field ADDNAM of the user record, this second identifier is taken into account to match in a unique way a X3 user with a directory user.
As a general rule, the login field of the X3 user record which will be linked to the field sAMAccountName of the directory is used.
Case where the setup valueSSOREFMAJ is equal to 2:
The search is first performed with the field of type 'identifier 2' and then with the field of type 'identifier'.
This is a field from the X3 user record, which will be updated from the directory.
This is the value of a user setup, which will be updated from the directory.
Type | X3 field | Title | Directory field |
Identifier | ADDNAM | AD reference | distinguishedName |
Record | NOMUSR | Name | DisplayName |
Record | ADDEML | Email address | |
Identifier 2 | LOGIN | Login | sAMAccountName |
Record | OBJGUID |
| objectGUID |
Setup | DATSTADEB | Statistics start date | WhenCreated |
Refer to documentation Implementation
Presentation
Two blocks need to be entered: the first one contains the configuration information that enables SAFE X3 to dialog with the directory, the second one defines the information exchanged during this stage.
Close
Fields
The following fields are present on this tab :
Block number 1
| This code identifies the created records in a unique manner. |
| Enter the description of the relevant record. This long description is used as a title in screens and reports. |
| Select this check box to activate the current record. Disabled records keep their content and setup but cannot be used (by recalling their code) on other records (documents, settings ...), or for mass processes. The authorizations to a given function can prohibit the creation of an active record. In this case, the check box is disabled by default. It can only be modified by an authorized user or through a signature Workflow. |
Configuration
| The domain name is used to find the directory code that will be used to log in the user connected. If the domain name is empty, the active directory code with empty domain will be used. If the domain name is not empty, the active directory code with domain -of the connected user- will be used. In both cases, if an active record is not found, the connection will be denied. |
| Is used to define the server name on which the LDAP directory is to be opened. |
| Is used to define the second server name on which the LDAP directory is to be opened if the first one has errors. |
| This is the directory query port. By default this number is set to 389. |
| This identifier is used for the search in the LDAP. |
|   |
| This is the password of the identifier used for the search in the LDAP. |
| When searching a user in the LDAP directory, the properties associated with a node in a hierarchical tree. This setup is used to defined where the hierarchy must start the search when the user wants to find information linked to the user. Moreover, this search will be carried out by setting a condition based on the value of the field Identifier 1 or Identifier 2 given in the setup table. |
| the execution engine of the SAFE X3 platform uses 3 search instructions in the directory. This setup is used to define the search instruction that will be launched by the engine when checking the existence of a user in the LDAP database. It can take the following values:
An example of menu is given in the introduction of the technical appendix of the LDAP setup; in this example, 3 frameworks define these 3 levels of search. |
Grid Mapping
| This type of setup is used to manage the fields of the LDAP directory. |
| Is used to enter a field in the AUTILIS table if the field type is "Identifier/Identifier2/Record" or a general setup code if the field type is "Setup" |
|   |
| Is used to enter the attribute name in the LDAP directory. |
| This formula is used to enter the search criteria in the LDAP in order to update the users. For instance, let us consider the formula (&(objectclass=user)(sAMAccountName=%%toupper("$$4$$")%%)) It is also possible to enter (&(objectclass=user)(sAMAccountName=$$4$$)) |
Close
This button is used to generate the processing which will be used to access the directory when connecting to SAFE X3. |
Is used to modify the password in the directory.
Presentation
This is used to test the connection to the LDAP directory.
And then to carry out a LDAP query by setting up the fields of the directory which are to be recovered.
Close
Fields
The following fields are present on this tab :
Block number 1
|   |
| LDAP query complying with the standardized syntax of the directory. |
Grid Columns
| Field of the directory which has been set up. |
|   |
Close