Skip to main content
Skip table of contents

SuperADMIN Settings - cfg

Global SuperADMIN Properties

Local ID Store

Description

Default settings for account locking (these settings will apply to all accounts unless specifically overridden for an individual account):

defaultLockTime
The amount of time to lock an account for once the user has exceeded the maximum failed login attempts. During this time the user will not be able to login even if they specify the correct credentials.
defaultMaxAttempts
The maximum number of failed login attempts before an account will be locked.

You can also check and set these properties using the account command.

Usage

View the current configuration:

CODE 
cfg global superadmin.localIdStore

Update the configuration:

CODE 
cfg global superadmin.localIdStore.defaultLockTime set "<time>"
cfg global superadmin.localIdStore.defaultMaxAttempts set "<attempts>"
Examples
CODE 
cfg global superadmin.localIdStore.defaultLockTime set "30 seconds"
cfg global superadmin.localIdStore.defaultLockTime set "5 minutes"
CODE 
cfg global superadmin.localIdStore.defaultMaxAttempts set "10"
More InformationUnlock a User Account

Migration

Description

These properties are set automatically by SuperADMIN when it migrates your data from the old XML files to the relational database. You should not need to make any changes to these settings.

Usage

View the current configuration:

CODE 
cfg global superadmin.migration

Update the configuration:

CODE 
cfg global superadmin.migration.displayOptionsCatalog set {true|false}
cfg global superadmin.migration.legacyFls set {true|false}
cfg global superadmin.migration.userCatalog set {true|false}
Examples
CODE 
cfg global superadmin.migration.displayOptionsCatalog set true
cfg global superadmin.migration.displayOptionsCatalog set false
cfg global superadmin.migration.legacyFls set true
cfg global superadmin.migration.legacyFls set false
cfg global superadmin.migration.userCatalog set true
cfg global superadmin.migration.userCatalog set false

User Registration

Self Reg

Description

Settings for user registration.

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg
More InformationUser Registration

Groups

Description

Settings for groups to which a new registered user is added.

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.addToGroups

Update the configuration:

CODE 
cfg global superadmin.selfreg.addToGroups set ["<value>"]
cfg global superadmin.selfreg.addToGroups set ["<value>", "<value>", ...]
cfg global superadmin.selfreg.addToGroups add "<value>"

Clear the configuration:

CODE 
cfg global superadmin.selfreg.addToGroups remove
Examples

The following example sets a single group to which new users are added. This will override any existing configured groups.

CODE 
cfg global superadmin.selfreg.addToGroups set ["Group1"]

The following example sets an array containing multiple groups to which new users are added.  You can set an array containing only one group. This will override any existing configured groups.

CODE 
cfg global superadmin.selfreg.addToGroups set ["Group1", "Group2", "Group3"]

The following example adds a group to an existing group array. You cannot add a group if an array does not already exist.

CODE 
cfg global superadmin.selfreg.addToGroups add "Group4"
More Information

Configure User Registration

Email

Description

Email settings for user registration.

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.email

Reset the configuration to default settings:

email

CODE 
cfg global superadmin.selfreg.email remove
More InformationCustomise Email Templates

Default Language

Description

Set the default language for user registration emails.

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.email.defaultLanguage

Update the configuration:

CODE 
cfg global superadmin.selfreg.email.defaultLanguage set "<lang>"

Reset the configuration to default settings:

CODE 
cfg global superadmin.selfreg.email.defaultLanguage remove
Examples

The following example sets the default language to English.
<lang> is either a two character ISO 639-1 language code or a language code followed by a hyphen and a two character ISO 3166 country code. For example, en, de or de-AT.

CODE 
cfg global superadmin.selfreg.email.defaultLanguage set "en"
More InformationCustomise Email Templates

Format

Description

Set the format of user registration emails (HTML, plain text, or both).

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.email.format

Update the configuration:

CODE 
cfg global superadmin.selfreg.email.format set "<format>"

Reset the configuration to default settings:

CODE 
cfg global superadmin.selfreg.email.format remove
Examples

The following example sets the format of email messages to HTML.
Format can be set to html, plainText or both. You need to provide templates for all the languages and formats you set.

CODE 
cfg global superadmin.selfreg.email.format set "html"
More InformationCustomise Email Templates

From Address

Description

Set the "from address" used for emails sent by the user registration system.

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.email.fromAddress

Update the configuration:

CODE 
cfg global superadmin.selfreg.email.fromAddress set "<email_address>"

Reset the configuration to default settings:

CODE 
cfg global superadmin.selfreg.email.fromAddress remove
Examples

The following example sets the from email address.

CODE 
cfg global superadmin.selfreg.email.fromAddress set "registrations@mycompany.com"
More InformationCustomise Email Templates

Localisation

Description

Settings for language and the message contents of emails.

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.email.localized

Update the configuration:

CODE 
cfg global superadmin.selfreg.email.localized.<lang>.template set "<htmltemplate>"
cfg global superadmin.selfreg.email.localized.<lang>.plainTemplate set "{message}"

Remove the configuration entry:

CODE 
cfg global superadmin.selfreg.email.localized remove
Examples

The following example defines the message content for a global HTML email template for English language messages. 
<lang> is either a two character ISO 639-1 language code or a language code followed by a hyphen and a two character ISO 3166 country code. For example, en, de or de-AT.
Any double quotes within the template are escaped with a preceding backslash: \

CODE 
cfg global superadmin.selfreg.email.localized.en.template set "<html><body style=\"font-family: Helvetica, Calibri, Verdana, sans-serif\"><p><img src=\"https://wingarc.com.au/email/str.png\" width=\"151\" height=\"65\" alt=\"Space-Time Research Logo\"/></p>{message}</body></html>"

The following example defines a global plain text email template for English language messages.

CODE 
cfg global superadmin.selfreg.email.localized.en.plainTemplate set "{message}"
More InformationCustomise Email Templates

Token Duration

Description

Settings for the duration of time that verification links sent to users by email are valid. Time period in minutes or hours. By default, links are valid for 4 hours.

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.tokenDuration

Update the configuration:

CODE 
cfg global superadmin.selfreg.tokenDuration set "<time>"

Clear the configuration:

CODE 
cfg global superadmin.selfreg.tokenDuration remove
Examples

The following example sets the duration to 10 hours.

CODE 
cfg global superadmin.selfreg.tokenDuration set "10 hours"

The following example sets the duration to 2 minutes.

CODE 
cfg global superadmin.selfreg.tokenDuration set "2 minutes"

The following example removes the set token duration and returns the value to the default of 4 hours.

CODE 
cfg global superadmin.selfreg.tokenDuration remove
More Information

Rate Limiting and Token Duration

Web Client

Description

Settings for host, path and files used for password reset, registration rejection, and registration verification in email templates.

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.webClient

Reset the configuration to default settings:

CODE 
cfg global superadmin.selfreg.webClient remove
More InformationConfigure User Registration

Password Reset Path

Description

Set the file used for the password reset path link in email templates. 

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.webClient.passwordResetPath

Update the configuration:

CODE 
cfg global superadmin.selfreg.webClient.passwordResetPath set "<filename>"

Reset the configuration to default:

CODE 
cfg global superadmin.selfreg.webClient remove
Examples

The following example sets the file used to reset a password in email templates.

CODE 
cfg global superadmin.selfreg.webClient.root set "resetPassword.xhtml"

Reject Path

Description

Set the file used for the reject path link in email templates. 

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.webClient.rejectPath

Update the configuration:

CODE 
cfg global superadmin.selfreg.webClient.rejectPath set "<filename>"

Reset the configuration to default:

CODE 
cfg global superadmin.selfreg.rejectPath remove
Examples

The following example sets the file used to reject registration in email templates.

CODE 
cfg global superadmin.selfreg.webClient.rejectPath set "reject.xhtml"

Verify Path

Description

Set the file used for the verify path link in email templates. 

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.webClient.verifyPath

Update the configuration:

CODE 
cfg global superadmin.selfreg.webClient.verifyPath set "<filename>"

Reset the configuration to default:

CODE 
cfg global superadmin.selfreg.webClient.verifyPath remove
Examples

The following example sets the file used for verification in email templates.

CODE 
cfg global superadmin.selfreg.webClient.verifyPath set "verifyPath.xhtml"

Host

Description

Set hostnames and IP addresses for SuperWEB2 to automatically determine the URL to use for links in registration email templates.

whitelist

A list of accepted SuperWEB2 hosts. Entries can begin with *. to allow subdomains.

default
A default host if you want to ensure that all links always use the same URL regardless of the URL that is actually used by the user initiating the registration process.
Acts as a whitelist entry, but is also used to replace the host name if it doesn't match the whitelist (or the whitelist isn't set).

cfg global superadmin.selfreg.webClient.host supercedes superadmin.selfreg.webClient.root  from SuperWEB2 V9.10.

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.webClient.host
cfg global superadmin.selfreg.webClient.host.whitelist
cfg global superadmin.selfreg.webClient.host.default

Update the configuration:

CODE 
cfg global superadmin.selfreg.webClient.host.whitelist set ["<hostname_or_ip>"]
cfg global superadmin.selfreg.webClient.host.whitelist set ["<hostname_or_ip>", "<hostname_or_ip>", ...]
cfg global superadmin.selfreg.webClient.host.whitelist add "<hostname_or_ip>"
cfg global superadmin.selfreg.webClient.host.default set "<ip_address>"

Remove the configuration setting:

CODE 
cfg global superadmin.selfreg.webClient.host.default remove
cfg global superadmin.selfreg.webClient.host.whitelist remove
Examples

The following example creates a whitelist to which an IP address is added. This will override any existing configured whitelists.

CODE 
cfg global superadmin.selfreg.webClient.host.whitelist set ["192.168.0.0"]

The following example sets an array containing multiple hostnames and IP addresses.  You can set an array containing only one hostname or IP address. This will override any existing configured whitelists.

CODE 
cfg global superadmin.selfreg.webClient.host.whitelist set ["192.168.0.0", "mydomain.com", "*.example.com", "*.192.10.3.4"]

The following example adds a hostname or address to an existing whitelist array. You cannot add a hostname or address if an array does not already exist.

CODE 
cfg global superadmin.selfreg.webClient.host.whitelist add "10.0.0.255"

The following examples sets a default IP address and host name.

CODE 
cfg global superadmin.selfreg.webClient.host.default set "172.16.0.25"
cfg global superadmin.selfreg.webClient.host.default set "mywebdomain.com"
More InformationConfigure User Registration

Root

Description

Set the base URL of the path for links in email templates.

cfg global superadmin.selfreg.webClient.host supercedes superadmin.selfreg.webClient.root from SuperWEB2 V9.10.
From V9.10, superadmin.selfreg.webClient.root is no longer set by default and will no longer reset to its default when removed. It will still be used for requests from versions of SuperWEB2 prior to this change, which don't send a URL to be validated. Using SuperWEB2 after this change with a prior version of SuperADMIN will only use this property.

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.webClient.root

Update the configuration:

CODE 
cfg global superadmin.selfreg.webClient.root set "<url>/webapi/jsf/user"

Remove the configuration entry:

CODE 
cfg global superadmin.selfreg.webClient.root remove
Examples

The following example sets the base URL of your deployment for the links used in email templates.

CODE 
cfg global superadmin.selfreg.webClient.root set "https://mydomain/webapi/jsf/user"
More InformationConfigure User Registration

Public API

Description

Set the root URL for the SuperADMIN REST endpoint.

The user registration process needs to communicate with SuperADMIN to complete the account creation process. To do this it sends messages to a SuperADMIN REST endpoint, so it needs to know where SuperADMIN is running.

The REST endpoint needs to be publicly accessible, so you must ensure that port 9001 on this machine is accessible. This is a new firewall requirement introduced with the user registration system. See Port Usage for more details.

Usage

View the current configuration:

CODE 
cfg global superadmin.selfreg.publicAPI.root

Update the configuration:

CODE 
cfg global superadmin.selfreg.publicAPI.root set "<url>:<port>"

Remove the configuration entry:

CODE 
cfg global superadmin.selfreg.publicAPI.root remove
Examples

The following example sets  https://mysuperadminserver  as the address that resolves to the machine running SuperADMIN, to the standard port number 9001.

CODE 
cfg global superadmin.selfreg.publicAPI.root set "https://mysuperadminserver:9001"
More InformationConfigure User Registration
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close