Jump to content

Can I have usernames match AD automatically?


K.Ermit
 Share

Recommended Posts

While you cannot sync with AD to create user accounts, you can use the Username creator in the MIS Importer within System Preferences to configure typical usernames on creation.

You can find more details within the Help pages, on the MIS Importer page, but in summary:

Creating username structures is an important part of the MIS Import process and it is worthwhile spending some time to ensure the formats are correct.

Username formats are made up of several components that together form the correct username for a given user.

For example:

12BloggsJ

This username format is made of 3 components, the user’s admission year - 12, their last name - Bloggs, and their first name’s initial - J.

Your username format may include the user’s last name, first name and year of admission. The user’s last name would be one component, their first name another and the year of admission a third.

Each individual component of your structure can be specified using a Component Tag within the Username Creator field.

Component Tags vary from one user type to another, the following table details the available tags for each user type:

Profile Component Tags 
Student                            
{{first_name}}                                                           
{{middle_name}}
{{last_name}}
{{year_group}}
{{house_group}}
{{dob}}
{{admission_year}}
{{roll_number}}
{{registration_group}}
Staff
{{title}}
{{first_name}}
{{middle_name}}
{{last_name}}
{{year_group}}
{{house_group}}
{{dob}}
{{roll_number}}
{{registration_group}}
Parent
{{title}}
{{first_name}}
{{middle_name}}
{{last_name}}


Writing Username Formats

To write the username format for a given user type enter the components required within the Username Creator field.

Each component tag must be enclosed within double braces {{ }}. Enter each component that is required in order as well as any free text items you need to include in your usernames.

Example 1: For the username structure:
Year of admission + First name + . + Last name.
EG: 2013Joe.Bloggs

Username Creator Component Tags:
{{admission_year}}{{first_name}}.{{last_name}}

Example 2:
For the username structure:
Reg group + _ + First name + Last name
EG: 3YH_JoeBloggs

Username Creator Component Tags:
{{registration_group}}_{{first_name}}{{last_name}}


Component Options

Components can be limited to a number of characters and some components have additional options that can be specified to alter their format. Parameters and options for component tags are specified as part of the tag. To specify a parameter enter the component tag followed by a | and then enter the parameter name and a valid choice for that parameter.

For example:

The {{first_name}} component can be limited to a number of characters. To use the limit parameter on the component specify the component and then add the limit parameter followed by the number of characters you wish to limit the component to.

First name: Jonathan
Component tag: {{first_name | limit=3}}
Result: Jon

First name: Christopher
Component tag: {{first_name | limit=5}}
Result: Chris

The following component tags have options that can be specified with them:
 

Component Tag Parameter Option
{{title}}
{{first_name}}
{{last_name}}
{{middle_name}}
limit=n
limit:
Replace n with the number of characters you wish to limit the component to.
 
EG: {{title | limit=1}}
{{year_group}}
{{house_group}}
offset=n
limit=n
offset:
Replace n with the position of the first character you wish to be displayed.
 
EG: {{year_group | offset=3}}
 
limit:
Replace n with the number of characters you wish to limit the component to.
 
EG: {{year_group | limit=2}}
 
EG: {{year_group | offset=2 | limit=2}}
{{dob}} format=FFFFFF
format:
Replace FFFFFF with your desired date format:
 
format=DD/MM/YYYY
format=DD/MM/YY
format=YYYY
format=YY
format=MM
format=DD
 
EG: {{dob | format=YYYY}}
{{admission_year}}
format=FFFF
alteration=+-n
format:
Replace FFFF with your desired date format:
 
format=YYYY
format=YY
 
EG: {{admission_year | format=YY}}
 
alteration:
Replace +-n  with the amounts of years to alter the admission year by.
 
EG: {{admission_year | alteration=+5}}
 
EG: {{admission_year | format=YY | alteration=+5}}
{{roll_number}}
removes_zeros
offset=n
remove_zeros:
Adding this option will remove the leading zeroes from a roll number.
 
offset:
Replace n with the position of the first character you wish to be displayed.
 
EG: {{year_group | offset=3}}
 
EG: {{year_group | remove_zeros | offset=5}}
{{registration_group}}
alphanumeric
just_letters
offset=n
limit=n
alphanumeric:
Adding this option will remove any non-alphanumeric characters from the registration group name.
 
EG: {{registration_group | alphanumeric}}
 
just_letters:
Adding this option will remove any numbers and non-alphanumeric characters from the registration group name.
 
EG: {{registration_group | just_letters}}
 
offset:
Replace n with the position of the first character you wish to be displayed.
 
EG: {{registration_group | offset=3}}
 
limit:
Replace n with the number of characters you wish to limit the component to.
 
EG: {{registration_group | limit=2}}

Once you have entered your username format select the Save button to commit your changes.


Autocorrect ‘Start Date’

The student user type has an additional option named Autocorrect ‘Start Date’.

This option can be used to automatically change a user’s start date. In some situations a student may join the school during the school year or after year 7. In these circumstances the Autocorrect ‘Start Date’ option will attempt to correct the start date of students so that a username is generated for them correctly.

Once the Autocorrect ‘Start Date’ option has been enabled the default admission year and month should be configured.

These items help the autocorrect function to work out the correct alteration to a student’s admission year so that the correct year is reflected in their username.

Please Note - The student’s admission year data will not be altered, the username will simply be adjusted to match the rest of the student’s year group.
Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

 Share

×
×
  • Create New...