Username Generation Prompt

Question

Hello!

If you are using Adaxes version 2018.2, a Custom Command with two Edit box parameters and a PowerShell script can be used. Users will need to enter First Name and Last Name and the script will generate the unique user name based on the values of the parameters and output the username into the execution log.
If you are using Adaxes version 2018.1 or earlier, the Modify User Web Interface action, a Business Rule and a PowerShell script can be used. The Web Interface action will use customized form with only two custom attributes (e.g. CustomAttributeText1 and CustomAttributeText2). The Business Rule triggering After Updating a User will execute the script that will generate a unique username based on the values of the modified properties and output the name into the execution log.
If the solution meets your needs, please, provide all the possible details regarding the username generation and we will provide you with the script and detailed instructions.

commented May 14, 2019 by Support3 (14.9k points)
moved Oct 13, 2019 by Support2

1 Answer

Best answer

Hello,

Thank you for the provided details. To implement the solution:

i. Creating the Business Rule

Launch Adaxes Administration Console.
In the Console Tree, right-click your service node.
In the context menu, navigate to New and click Business Rule.
On step 2 of the Create Business Rule wizard, select User object type.
Select After Updating a User and click Next.
Click Add Action.
Select Run a program or PowerShell script.

Paste the below script into the Script field. In the script:

$firstNameProperty – Specifies the LDAP name of the custom attribute used to enter the first name (e.g. CustomAttributeText1);
$lastNameProperty – Specifies the LDAP name of the custom attribute used to enter the last name (e.g. CustomAttributeText2)
$usernameMaxLength – Specifies the maximum allowed number of characters in the sAMAccountName value (should not exceed 20).

 Import-Module Adaxes

 $firstNameProperty = "adm-CustomAttributeText1" # TODO: modify me
 $lastNameProperty = "adm-CustomAttributeText2" # TODO: modify me

 $usernameMaxLength = 20 # TODO: modify me

 function BuildUsername()
 {
     $samAccountNameBuilder = New-Object "System.Text.StringBuilder"
     for ($i=0; $i -lt $args.length; $i++)
     {
         if (-not($args[$i] -is [array]))
         {
             if (-not([System.String]::IsNullOrEmpty($args[$i])))
             {
                 [void]$samAccountNameBuilder.Append($args[$i].ToLower())
             }
         }
         elseif ($args[$i].length -eq 3) 
         {
             if (-not([System.String]::IsNullOrEmpty($args[$i][0])))
             {
                 $valueLength = $args[$i][1]
                 if ($valueLength -gt $args[$i][0].Length)
                 {
                     $valueLength = $args[$i][0].Length
                 }

                 switch ($Args[$i][2])
                 {
                     "Beginning"
                     {
                         $value = $args[$i][0].SubString(0,$valueLength).ToLower()
                     }
                     "End"
                     {
                         $value = $args[$i][0].SubString($args[$i][0].Length - $valueLength).ToLower()
                     }
                 }
                 [void]$samAccountNameBuilder.Append($value)
             }
         }
         else
         {
             $Context.LogMessage("An error occurred while building a username!", "Error")
         }
     }

     return $samAccountNameBuilder.ToString()
 }

 function IsUsernameUnique($username)
 {
     $user = Get-AdmUser $username -erroraction silentlycontinue
     return $user -eq $Null
 }

 function GenerateUniqueUsername($username, $usernameMaxLength)
 {
     $uniqueUsername = $username
     for ($i = 1; $True; $i++)
     {
         if (IsUsernameUnique $uniqueUsername)
         {
             # The username meets the requirements
             return $uniqueUsername
         }

         $difference = $username.Length + $i.ToString().Length - $usernameMaxLength
         if ($difference -gt 0)
         {
             $username = BuildUsername ($username, ($username.Length - $difference), "Beginning")
         }
         $uniqueUsername = BuildUsername $username $i.ToString()
     }
 }

 # Build the username
 $firstName = $Context.GetModifiedPropertyValue($firstNameProperty)
 $lastName = $Context.GetModifiedPropertyValue($lastNameProperty)
 if ([String]::IsNullOrEmpty($firstName) -or [String]::IsNullOrEmpty($lastName))
 {
     $Context.Cancel("First Name and Last Name must be specified for generating unique username.")
     return
 }
 $username = BuildUsername ($firstName, 1, "Beginning") "." ($lastName, 7, "Beginning")

 #Output unique username
 $uniqueUsername = GenerateUniqueUsername $username $usernameMaxLength
 $Context.LogMessage($uniqueUsername, "Information")

Specify a description for the script.
Click OK.
Right-click the action you created and then click Add Condition.
Select If <property> changed.
Expand the dropdown list and select the Show all properties checkbox.
Select the property used to specify the first name (e.g. CustomAttributeText1).
Click OK.
Repeat steps 11-15 for the custom attribute used to specify the last name.
Click Next and finish creating the Business Rule. Finally, it should look like this:

ii. Creating the Web Interface action

Launch Adaxes Web Interface Customization tool.
Select the Web Interface you need.
On the General tab, click Configure Home Page Actions.
Click Add.
Select Modify User and click Next.
On step 3 of the Add Home Page Action wizard, select Always perform for the current user and click Next.
Select Use customized form and click Customize Form.
Delete all sections except for one (e.g. General).
Delete all properties from the remaining section.
Below Section fields, click Add.
Select the Show all properties checkbox and select the property specified in the Business Rule condition.
Click OK.
Repeat steps 10-12 to add the second property.
Click OK and finish creating the Home Page Action.

iii. Specifying a display name for custom attributes

To change property display names, do the following on each computer where Adaxes components (Adaxes service, Web interface, Administration Console) are installed:
Navigate to folder C:\ProgramData\Softerra\Adaxes 3\.
Open the AttributeFriendlyNames2.eng.xml file (AttributeFriendlyNames2.deu.xml for German, AttributeFriendlyNames2.fra.xml for French) with a text editor.
Add the friendlyNameItem XML element to the end of the file.
Add the ldapName XML element and specify the property LDAP name in it.

Add the friendlyName XML element and specify the property display name in it.

 <friendlyNames>
     ...
     <friendlyNameItem>
        <ldapName>adm-CustomAttributeText1</ldapName>
        <friendlyName>MyDisplayName</friendlyName>
     </friendlyNameItem>
 </friendlyNames>

Repeat steps 3-6 for both custom text attributes you have added to the modify user form.
Save the file.
Restart Softerra Adaxes Service.
Restart IIS.
Restart Adaxes Administration Console.

Username Generation Prompt

Please log in or register to add a comment.

Please log in or register to answer this question.

1 Answer

Please log in or register to add a comment.

Related questions