Difference between revisions of "Student / Employee ID"

From UmsWiki
Jump to: navigation, search
(Student ID Barcode)
(Student ID Revamped)
 
Line 5: Line 5:
 
*Make sure Anonymous Authentication is enabled for the folder ‘Webservices’ in Internet Information Services (IIS) Manager for the Default Web Site
 
*Make sure Anonymous Authentication is enabled for the folder ‘Webservices’ in Internet Information Services (IIS) Manager for the Default Web Site
 
*To let the users change their student ID card profile image go to the chapter for [[My Information]].
 
*To let the users change their student ID card profile image go to the chapter for [[My Information]].
 +
*Configure a 'Student card setting' under Templates -> App -> Student card
  
 +
 +
[[File:Student card settings v2.png|border|frameless|467x467px]]<br />
 +
 +
=== Student ID Barcode ===
 +
The value 'Select column for card ID field' determines what value in the Students-table will be used to generate the barcode on the backside of the card.
 +
 +
The value 'Show Card ID label' determines whether to show or hide the label on the backside, containing a text representation of the Card ID value. This is useful in cases where a scanner cannot read the barcode, but you instead have the option to input the card ID manually.
 +
 +
''Note: It is recommended to select a specific column, as only students imported from Lectio will have the 'CardID'-column set by default.''
 +
 +
___
 +
 +
You can set a default bar code format which the students Card ID will be shown as. ''Note that not all card IDs can be displayed in all formats.''
 +
 +
Web tasks -> Web setup -> General settings (scroll to bottom)
 +
 +
Select the barcode format that your scanners support.
 +
 +
[[File:Available_barcode_formats.png|frameless|324x324px]]
 +
 +
<br />
 +
 +
=== Layout ===
 +
You now have the option to configure what fields from the Students-column you wish to show, along with what translations you want to attach to each field.
 +
 +
This is done by dragging the desired field from the left column into the right one, and add translations for each language.
 +
 +
The order is arranged as following:
 +
{| class="wikitable"
 +
|+''Name''
 +
|1
 +
|2
 +
|-
 +
|3
 +
|4
 +
|-
 +
|5
 +
|6
 +
|}
 +
You can add the <Empty> field to provide an empty field, meaning it can go '1, 2, <Empty>, 4'. Rows are autosizing to fit the content within, so know that if you make both entries in a row <Empty>, it will autosize to no height, effectively nullifying the Empty-row.
 
<br />
 
<br />
  
==Student values==
+
==== Standard layout ====
 +
Default layout, in case nothing is configured, will be 'Studienr' and 'BirthDay'.
 +
<br />
 +
==Constant values==
  
 
*Full name: An aggregation of 'FORNAVNE' and 'EFTERNAVN' columns from the Students table.
 
*Full name: An aggregation of 'FORNAVNE' and 'EFTERNAVN' columns from the Students table.
*Birthday: The 'BirthDay' column from the Students table.
 
*Last verified: A value that displays when this student card was fetched from the server. Should always show the current date.
 
 
*Expiration date: Either 'Current_Education_EndDate' column from the Students table, or if that's empty, 'SLUTDATO' column.
 
*Expiration date: Either 'Current_Education_EndDate' column from the Students table, or if that's empty, 'SLUTDATO' column.
*School community: Will say Yes or No. Yes if the current date is between SchoolCommunityHomeStartDate and SchoolCommunityHomeEndDate. No if it's outside this time span.
 
  
 
''Note that if some of these values are missing. it's usually a result of them missing in the database''.
 
''Note that if some of these values are missing. it's usually a result of them missing in the database''.
Line 24: Line 65:
 
===Ludus===
 
===Ludus===
 
The SLUTDATO-column used for 'Expiration date' is derived from the LUDUS database. First it tries to use 'DBA.ModulKursist.udmeldingsdato', and if that's null, it instead uses 'DBA.UndervisningPeriode.SLUTDATO'
 
The SLUTDATO-column used for 'Expiration date' is derived from the LUDUS database. First it tries to use 'DBA.ModulKursist.udmeldingsdato', and if that's null, it instead uses 'DBA.UndervisningPeriode.SLUTDATO'
<br />
 
==Student ID Barcode==
 
Only students imported from Lectio will have a Card ID set by default. Note that not all card IDs can be displayed in all formats. You can set a default bar code format which the students Card ID will be shown as.
 
 
Web tasks -> Web setup -> General settings (scroll to bottom)
 
 
Select the barcode format that your scanners support.
 
[[File:Available barcode formats.png|none|frame]]Additionally you have the option to toggle whether the label that shows the Barcode as cleartext, should be visible.
 
 
With formats such as QR code, you may want to hide this label, as it would otherwise overlap with parts of the QR code, making it unreadable.
 
 
[[File:Student card settings.png|frameless|508x508px]]
 
<br />
 
==Student ID Username==
 
You have the option to specify a different field to user for Username, on a template-basis.
 
 
This can be any column from the Students database.
 
[[File:Student card username.jpg|none|frame]]At the same time you may wish to change the header for the specified entry. To change the Username header, edit the [[Custom Terms and Localization|key in the Translation file]] named '''"StudentNumberHeader"'''
 
[[File:Screenshot 2018-11-30-13-19-05.png|none|thumb]]
 
 
<br />
 
<br />
 
==Student backside==
 
==Student backside==

Latest revision as of 14:07, 26 March 2020

This is a submodule available in UMS App

Student and Employee ID is a module that is automatically available in the App. These ID's uses user information and UMS Photo and has no configuration specific to the app.

Setup

  • Make sure Anonymous Authentication is enabled for the folder ‘Webservices’ in Internet Information Services (IIS) Manager for the Default Web Site
  • To let the users change their student ID card profile image go to the chapter for My Information.
  • Configure a 'Student card setting' under Templates -> App -> Student card


Student card settings v2.png

Student ID Barcode

The value 'Select column for card ID field' determines what value in the Students-table will be used to generate the barcode on the backside of the card.

The value 'Show Card ID label' determines whether to show or hide the label on the backside, containing a text representation of the Card ID value. This is useful in cases where a scanner cannot read the barcode, but you instead have the option to input the card ID manually.

Note: It is recommended to select a specific column, as only students imported from Lectio will have the 'CardID'-column set by default.

___

You can set a default bar code format which the students Card ID will be shown as. Note that not all card IDs can be displayed in all formats.

Web tasks -> Web setup -> General settings (scroll to bottom)

Select the barcode format that your scanners support.

Available barcode formats.png


Layout

You now have the option to configure what fields from the Students-column you wish to show, along with what translations you want to attach to each field.

This is done by dragging the desired field from the left column into the right one, and add translations for each language.

The order is arranged as following:

Name
1 2
3 4
5 6

You can add the <Empty> field to provide an empty field, meaning it can go '1, 2, <Empty>, 4'. Rows are autosizing to fit the content within, so know that if you make both entries in a row <Empty>, it will autosize to no height, effectively nullifying the Empty-row.

Standard layout

Default layout, in case nothing is configured, will be 'Studienr' and 'BirthDay'.

Constant values

  • Full name: An aggregation of 'FORNAVNE' and 'EFTERNAVN' columns from the Students table.
  • Expiration date: Either 'Current_Education_EndDate' column from the Students table, or if that's empty, 'SLUTDATO' column.

Note that if some of these values are missing. it's usually a result of them missing in the database.


Integrations

Ludus

The SLUTDATO-column used for 'Expiration date' is derived from the LUDUS database. First it tries to use 'DBA.ModulKursist.udmeldingsdato', and if that's null, it instead uses 'DBA.UndervisningPeriode.SLUTDATO'

Student backside

By using our Custom Terms and Localization module, we've added a backside to the Student Card

By adding a translation entry in your localization file with the following key, you can add whatever custom text you want to show on the backside of the Student card:

  • Key: "StudentCardBacksideText"

Studentcard backside.png

FAQ

  • I've taken a new photo and it's showing in Your Information, but not on my Student/Employee Card

When you take a new photo with Your Information, it's stored with a 'Pending'-tag. To ensure only valid photos are used for user IDs, the student and employee cards only uses photos that has been marked as Approved.

See UMS Photo for more info on this module.

  • The student card backside isn't showing

By default the translated entry is empty, and as a result the student card backside is disabled. It will only become enabled once you have added a translated entry for the specified key.

  • How do I get the student card backside to show?

Tap the student card to flip between front and back side.