Customizing New-User-Account Form

Make certain fields in the Add New User form mandatory.

Print this page

You can customize the New User Account form by marking certain fields required (Accounts > Add Account). For example, if you marked the option Password expires required, that field becomes required when creating a user.

  1. Stop Faspex

    In a Terminal or Command Prompt, execute the command to stop Faspex:

    asctl faspex:stop
  2. Open Faspex.yml with a text editor

    Locate Faspex.yml in the following path:

    OS Version Path
    32-bit Windows C:\Program Files\Aspera\Faspex\config\Faspex.yml
    64-bit Windows C:\Program Files (x86)\Aspera\Faspex\config\Faspex.yml 
    /opt/aspera/faspex/config/faspex.yml

    Before editing Faspex.yml, create a backup. Open it with a text editor:

  3. Add required-field parameters

    The following fields can be marked as required:

    • Password expires: ...
    • Account expires: ...
    • Allowed IP addresses for login
    • Allowed IP addresses for download
    • Allowed IP addresses for upload

    Add the following parameters in the file. When a required field is specified, the option is checked and greyed-out; When a required field with default value is specified, a default value is presented in the option:

    Parameter Description
    RequireUserPasswordExpires: yes Make "Password expires" required. A value is required.
    RequireUserAccountExpires: yes Make "Account expires" required. A value is required.
    RequireUserDescription: yes Make "description" required.
    RequireUserDescriptionWithDefault: "Default_value" Make "description" required, and insert default value.
    RequireUserAllowedIpAddressesForLogin: yes Make "Allowed IP addresses for login" required.
    RequireUserAllowedIpAddressesForLoginWithDefault: "Default_value" Make "Allowed IP addresses for login" required, and insert default value.
    RequireUserAllowedIpAddressesForDownload: yes Make "Allowed IP addresses for download" required.
    RequireUserAllowedIpAddressesForDownloadWithDefault: "Default_value" Make "Allowed IP addresses for download" required, and insert default value.
    RequireUserAllowedIpAddressesForUpload: yes Make "Allowed IP addresses for upload" required.
    RequireUserAllowedIpAddressesForUploadWithDefault: "Default_value" Make "Allowed IP addresses for upload" required, and insert default value.

    For example, to make "Account expires" required, and "Allowed IP addresses for download" required with default value "10.0.*", add the following lines in Faspex.yml:

     ...
 RequireUserAccountExpires: yes
 RequireUserAllowedIpAddressesForDownloadWithDefault: "10.0.*"
  4. Start Faspex

    In a Terminal or Command Prompt, execute the command to start Faspex with the new setting:

    asctl faspex:start

When making fields required, log in Faspex with admin account and go to Accounts > Add Account > Faspex User. Red asterisks should appear near the fields that have been marked as required. Creating a user without specifying values for these fields should result in an error message to that effect.