ajLDAPLogin function
Description
The ajLDAPLogin function authenticates users with LDAP directory. It returns TRUE if password is correct for the user_id.
Syntax
ajLDAPLogin(user_id, password, [ldap_source_id], [run_condition], [run_by_function_point_only])
Argument Name | Argument Type | Description |
---|---|---|
user_id (required) | String | The user ID to check. |
password (required) | String | The password of the user ID. |
ldap_source_id (optional) | String | The LDAP source ID defined in worksheet ##ExternalResources The default value is "primary". |
run_condition (optional) | Boolean | The function will run when the value is TRUE. Otherwise, it will not run. The default value is TRUE. |
run_by_function_point_only (optional) | Boolean | If it equals FALSE, the function can be executed through ‘Excel Calculation’ (can be either Automatic or Manual, Calculate Now or Calculate Sheet) or Preview Function Point. If it equals TRUE, the function can be executed with Preview Function Point (AlchemyJ ribbon \ Preview Function Point) only. The default value is TRUE. |
The function will return:
1) Return Value: TRUE, FALSE
2) Return Type: Single Value
Example
In the External Resources Definition, create a new LDAP connection record in the LDAP Connection table.
Once it is created, we can proceed to test this function.
As you can see from the example above, the authentication is successful and the result returned is TRUE. If the authentication is unsuccessful, it will return a FALSE.
Click here to download the use case workbooks for further reference.
Error Scenarios
It will return #VALUE! when missing any required parameter or mismatch parameter type. Besides, system will raise error for below scenario(s).
Error Scenario |
---|
User id is empty. |
LDAP server connection error. |
Invalid ldap source id. |