UmsWiki - User contributions [en]

Custom Terms and Localization

2024-01-23T12:03:50Z

Kpe:

Custom Terms and Localization is the first step in allowing you to alter the text that is displayed anywhere in the app. The edit can be made to supported languages or unsupported languages as long as phones support the culture code.

==Prerequisites==

*UMS Web
*Basic understanding of [https://www.w3schools.com/xml/xml_whatis.asp XML]

==Getting started==
You must create a file for each language you want to create your own translations for.
[[File:Translationfiles.png|left|frameless|800x800px]]

This file must be saved in your root web folder (generally located at 'C:\inetpub\wwwroot'), under the subfolder of \App\Localization\Translations.*culture*.xml

You need to create the Localization subdirectory if it does not exist. Example:
C:\inetpub\wwwroot\App\Localization\Translations.DK.xml
Note: While technically you can call the culture anything (for example Translations.arbitraryname.xml), it is recommended to call it the same culture as you use inside the XML file, for easier overview. The name simply needs to follow the pattern of 'Translations.*.xml'

A Translation file always needs a root element called 'root'. This root element needs a single attribute called 'culture', with the value of the chosen culture.

Supported cultures are

*'da-DK' (Danish)
*'en-US' (English)
*'nb' (Norwegian)
*'de-DE' (German)

Custom cultures(such as en-AU or en-GB or es-ES) are possible, but we do not support them.

The assigned culture needs to be usable by phones, ie if your phone cannot select greenlandic or other languages with a small population, you may have to override another language, say english or danish.

The root element must contain an 'entry' element for each translated key you want to override. The key attribute must match the key used in UMS App.

Inside this element you can write your desired text. Note that this text will have all leading and trailing whitespaces removed.

===Sample file===
An example where "Student" has been replaced with "Pupil" in all strings formerly using "student" and "Homework" has been replaced with "Betterments".
<root culture="en-US">
<entry key="StudentCardViewModelEmptyStateMessage">Couldn't find your Pupil ID. If the problem persists, contact your IT department</entry>
<entry key="StudentCardViewModelTitle">Pupil ID</entry>
<entry key="StudentNumberHeader">Pupil number</entry>
<entry key="StudentIdHeader">Pupil ID</entry>
<entry key="MenuStudentCard">Pupil ID</entry>
<entry key="AddNoteTapPersonTip">Tap on a Pupil to add a note to them.</entry>
<entry key="InvalidSelectedBarcodeFormat">The Pupil ID number cannot be displayed in the selected format. Use a different bar code format</entry>
<entry key="InvalidDefaultBarcodeFormat">This Pupil ID number cannot be displayed in the default barcode format. Contact your school</entry>
<entry key="IncludeFutureStudents">Include future pupils</entry>
<entry key="AbsenceRegistrationHowToMark">How do you want to mark pupils?</entry>
<entry key="HomeworkUpdateViewModelEmptyStateMessage">Couldn't find your betterments</entry>
<entry key="HomeworkViewModelEmptyStateMessage">Couldn't find your betterments</entry>
<entry key="HomeworkUpdateViewModelTitle">Betterments</entry>
<entry key="HomeworkViewModelTitle">Betterments</entry>
<entry key="MenuHomework">Betterments</entry>
<entry key="HomeworkItemViewModelTitle">Betterments</entry>
<entry key="HomeworkItemViewModelEmptyStateMessage">Couldn't find your Betterments</entry>
</root>

<root culture="da-DK">
<entry key="StudentNumberHeader">Studie nummer</entry>
<entry key="DateHeader">Sidst fornyet</entry>
<entry key="BirthdayHeader">Fødselsdato</entry>
<entry key="ExpiryDateHeader">Udløber d.</entry>
</root>
Full list as of 23/01-2024:

https://downloads.inlogic.dk/App/AppStrings.xml

For a full list of current key strings contact Inlogic support.

==FAQ==

*''The translations are not getting loaded''

Check the Event Viewer, if anything is wrong with the XML structure, it will write an error entry here.

*''The app is not using the translations''

These translations are only updated once aday, as well as on log in/out.

Please note that the app requires a minimum of version '''3.2.0'''

*''Letters like Æ, Ø and Å are shown incorrectly''

Make sure when you save the XML file, that you save it as Unicode encoding. While other types of encoding may work, Unicode has been confirmed to work with all Scandinavian letters

Custom Terms and Localization

2024-01-23T11:49:37Z

Kpe: removed faorese from supported cultures as we have no translation capabilities.

Custom Terms and Localization is the first step in allowing you to alter the text that is displayed anywhere in the app. The edit can be made to supported languages or unsupported languages as long as phones support the culture code.

==Prerequisites==

*UMS Web
*Basic understanding of [https://www.w3schools.com/xml/xml_whatis.asp XML]

==Getting started==
You must create a file for each language you want to create your own translations for.
[[File:Translationfiles.png|left|frameless|800x800px]]

This file must be saved in your root web folder (generally located at 'C:\inetpub\wwwroot'), under the subfolder of \App\Localization\Translations.*culture*.xml

You need to create the Localization subdirectory if it does not exist. Example:
C:\inetpub\wwwroot\App\Localization\Translations.DK.xml
Note: While technically you can call the culture anything (for example Translations.arbitraryname.xml), it is recommended to call it the same culture as you use inside the XML file, for easier overview. The name simply needs to follow the pattern of 'Translations.*.xml'

A Translation file always needs a root element called 'root'. This root element needs a single attribute called 'culture', with the value of the chosen culture.

Supported cultures are

*'da-DK' (Danish)
*'en-US' (English)
*'nb' (Norwegian)
*'de-DE' (German)

Custom cultures(such as en-AU or en-GB or es-ES) are possible, but we do not support them.

The root element must contain an 'entry' element for each translated key you want to override. The key attribute must match the key used in UMS App.

Inside this element you can write your desired text. Note that this text will have all leading and trailing whitespaces removed.

===Sample file===
An example where "Student" has been replaced with "Pupil" in all strings formerly using "student" and "Homework" has been replaced with "Betterments".
<root culture="en-US">
<entry key="StudentCardViewModelEmptyStateMessage">Couldn't find your Pupil ID. If the problem persists, contact your IT department</entry>
<entry key="StudentCardViewModelTitle">Pupil ID</entry>
<entry key="StudentNumberHeader">Pupil number</entry>
<entry key="StudentIdHeader">Pupil ID</entry>
<entry key="MenuStudentCard">Pupil ID</entry>
<entry key="AddNoteTapPersonTip">Tap on a Pupil to add a note to them.</entry>
<entry key="InvalidSelectedBarcodeFormat">The Pupil ID number cannot be displayed in the selected format. Use a different bar code format</entry>
<entry key="InvalidDefaultBarcodeFormat">This Pupil ID number cannot be displayed in the default barcode format. Contact your school</entry>
<entry key="IncludeFutureStudents">Include future pupils</entry>
<entry key="AbsenceRegistrationHowToMark">How do you want to mark pupils?</entry>
<entry key="HomeworkUpdateViewModelEmptyStateMessage">Couldn't find your betterments</entry>
<entry key="HomeworkViewModelEmptyStateMessage">Couldn't find your betterments</entry>
<entry key="HomeworkUpdateViewModelTitle">Betterments</entry>
<entry key="HomeworkViewModelTitle">Betterments</entry>
<entry key="MenuHomework">Betterments</entry>
<entry key="HomeworkItemViewModelTitle">Betterments</entry>
<entry key="HomeworkItemViewModelEmptyStateMessage">Couldn't find your Betterments</entry>
</root>

<root culture="da-DK">
<entry key="StudentNumberHeader">Studie nummer</entry>
<entry key="DateHeader">Sidst fornyet</entry>
<entry key="BirthdayHeader">Fødselsdato</entry>
<entry key="ExpiryDateHeader">Udløber d.</entry>
</root>
Full list as of 23/01-2024:

https://downloads.inlogic.dk/App/AppStrings.xml

For a full list of current key strings contact Inlogic support.

==FAQ==

*''The translations are not getting loaded''

Check the Event Viewer, if anything is wrong with the XML structure, it will write an error entry here.

*''The app is not using the translations''

These translations are only updated once aday, as well as on log in/out.

Please note that the app requires a minimum of version '''3.2.0'''

*''Letters like Æ, Ø and Å are shown incorrectly''

Make sure when you save the XML file, that you save it as Unicode encoding. While other types of encoding may work, Unicode has been confirmed to work with all Scandinavian letters

Custom Terms and Localization

2024-01-23T11:42:38Z

Kpe: Added updated xml of strings for localization

Custom Terms and Localization is the first step in allowing you to alter the text that is displayed anywhere in the app. The edit can be made to supported languages or unsupported languages as long as phones support the culture code.

==Prerequisites==

*UMS Web
*Basic understanding of [https://www.w3schools.com/xml/xml_whatis.asp XML]

==Getting started==
You must create a file for each language you want to create your own translations for.
[[File:Translationfiles.png|left|frameless|800x800px]]

This file must be saved in your root web folder (generally located at 'C:\inetpub\wwwroot'), under the subfolder of \App\Localization\Translations.*culture*.xml

You need to create the Localization subdirectory if it does not exist. Example:
C:\inetpub\wwwroot\App\Localization\Translations.DK.xml
Note: While technically you can call the culture anything (for example Translations.arbitraryname.xml), it is recommended to call it the same culture as you use inside the XML file, for easier overview. The name simply needs to follow the pattern of 'Translations.*.xml'

A Translation file always needs a root element called 'root'. This root element needs a single attribute called 'culture', with the value of the chosen culture.

Supported cultures are

*'da-DK' (Danish)
*'en-US' (English)
*'nb' (Norwegian)

*'fo-FO' (Faroese)
*'de-DE' (German)

Custom cultures(such as en-AU or en-GB or es-ES) are possible, but we do not support them.

The root element must contain an 'entry' element for each translated key you want to override. The key attribute must match the key used in UMS App.

Inside this element you can write your desired text. Note that this text will have all leading and trailing whitespaces removed.

===Sample file===
An example where "Student" has been replaced with "Pupil" in all strings formerly using "student" and "Homework" has been replaced with "Betterments".
<root culture="en-US">
<entry key="StudentCardViewModelEmptyStateMessage">Couldn't find your Pupil ID. If the problem persists, contact your IT department</entry>
<entry key="StudentCardViewModelTitle">Pupil ID</entry>
<entry key="StudentNumberHeader">Pupil number</entry>
<entry key="StudentIdHeader">Pupil ID</entry>
<entry key="MenuStudentCard">Pupil ID</entry>
<entry key="AddNoteTapPersonTip">Tap on a Pupil to add a note to them.</entry>
<entry key="InvalidSelectedBarcodeFormat">The Pupil ID number cannot be displayed in the selected format. Use a different bar code format</entry>
<entry key="InvalidDefaultBarcodeFormat">This Pupil ID number cannot be displayed in the default barcode format. Contact your school</entry>
<entry key="IncludeFutureStudents">Include future pupils</entry>
<entry key="AbsenceRegistrationHowToMark">How do you want to mark pupils?</entry>
<entry key="HomeworkUpdateViewModelEmptyStateMessage">Couldn't find your betterments</entry>
<entry key="HomeworkViewModelEmptyStateMessage">Couldn't find your betterments</entry>
<entry key="HomeworkUpdateViewModelTitle">Betterments</entry>
<entry key="HomeworkViewModelTitle">Betterments</entry>
<entry key="MenuHomework">Betterments</entry>
<entry key="HomeworkItemViewModelTitle">Betterments</entry>
<entry key="HomeworkItemViewModelEmptyStateMessage">Couldn't find your Betterments</entry>
</root>

<root culture="da-DK">
<entry key="StudentNumberHeader">Studie nummer</entry>
<entry key="DateHeader">Sidst fornyet</entry>
<entry key="BirthdayHeader">Fødselsdato</entry>
<entry key="ExpiryDateHeader">Udløber d.</entry>
</root>
Full list as of 23/01-2024:

https://downloads.inlogic.dk/App/AppStrings.xml

For a full list of current key strings contact Inlogic support.

==FAQ==

*''The translations are not getting loaded''

Check the Event Viewer, if anything is wrong with the XML structure, it will write an error entry here.

*''The app is not using the translations''

These translations are only updated once aday, as well as on log in/out.

Please note that the app requires a minimum of version '''3.2.0'''

*''Letters like Æ, Ø and Å are shown incorrectly''

Make sure when you save the XML file, that you save it as Unicode encoding. While other types of encoding may work, Unicode has been confirmed to work with all Scandinavian letters

Push Notifications

2023-12-05T09:02:17Z

Kpe: /* Requirements */ for phone OS

Push notification is a feature available in the UMS App, however only when using 'My Education App'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'My Education App'
*iOS must be version 10 or greater
*Android must version be 26 or greater

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

'''Only 1 hub per UMS installation supported'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "My Education App"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

'''In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub.''' 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

Before beginning testing please read the "Known issues" segment as some of these may come up.

===Inlogic support===
[[File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

==When to expect a push notification==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

#Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
#Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
#Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out(sometimes hours), cause unknown.

Users do not currently have a way to know if they are properly registered with the hub in the app, we are contemplating a way to add feedback for this. -You only get response when doing a registration/de-registration action.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions of the frontend and backend as at the time of writting(1. of april 2022) any version newer than the beta should not have this issue.

 
==FAQ==
Q: Which devices are supported?<blockquote>
A: Android 8+ and IOS.</blockquote>

Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'My Education App')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Q: Which OS are supported?<blockquote>A: Currently only android(through google and iOS are supported.</blockquote>

App

2023-08-03T12:00:09Z

Kpe: Elaborated on login background and menu background

[[File:UMS School App.png|frame]]
UMS School App is available for iPhone, Android. It will be designed with the school’s own logo, color and style. The app gives the basic functionality to see:

*News
*Timetable
*Homework
*Grades
*User information

Additional licenses gives the ability to create, edit and see more information from various modules. For an overview of module requirement see "[http://wiki.inlogic.dk/index.php?title=App&section=6&wteswitched=1#Additional_functionality Additional functionality"]

==Support==
We provide regular support for the following and newer versions:

*Android version 7.0. We support the same versions as Google provide security updates for. Find an overview [[wikipedia:Android_version_history#Code_names|here]].

*iOS version 10

*Windows 10 Mobile (version 10)

Please note that it is possible to run older versions. If support for older versions is needed, we offer support at our hourly rate.

==Prerequisites==
===Supported administrative systems===

*Userinfo: Easy-A, SIS, LUDUS and Lectio (Only mobile number).
*Grades: Easy-A, Lectio and SIS
*Homework: Easy-A and SIS.
*Timetable: Easy-A and SIS
*Attendance registration: Timetable data is retrieved from Easy-A, SIS, LUDUS, Tabulex and Lectio. Howerver, absence is only registered to Easy-A

===Module requirements===

*UMS Web (contains and run all the webservice that is required for the app to receive information and communicate with the server)

===Additional functionality===
You get more functionality in the app by having the following modules, these are all optional:

*Attendance Registration: Gives “Your attendance”, which shows student statistics, the student are able to add absence reason and see their absence status in the timetable
*Attendance Registration for UMS School App: gives employee “attendance registration” and student the ability to "report absence"
*Homework: gives the employee the ability to create homework
*Link Collection: gives links/bookmarks the school can setup
*User info: gives “Your information” the ability to edit the information. This also adds the functionality for the user to upload a new profile image (a selfie) to be used in the student id card
*Student & Employee Id: Gives the students a “student id card” and the employees an “employee id card”. To update their student id card profile image you’ll need the “User info” module
*Parking: Parkzone & APCOA Integration. Gives the option to create and edit parking permits from Parkzone and APCOA
*User information (add/edit)

Note: All Attendance functionality requires Attendance Registration.

===Testing after setup===

The app will be tested internally at inLogic before release. The test requires access to a user with relevant data. You can either create a fictional student who is associated to a real course, or alternatively use a real student's account, if the person agrees that the account is being used for a system test of the school's APP.

===What to have ready===

*'''Important''': The UMS site needs to use HTTPS and be public available. It needs a valid SSL certificate.
*Materials that can be used for designing the app. For example: Logo, brochure, design guide line, etc.

*Optional: It is possible for the school to have its own account where the app is located. An account in the App Store cost $99 per year(necessary if the school is not using "My Education App"), while an account for Google Play costs a onetime fee of $25. The school self-manage these accounts.

===Physical hardware requirements===

Having a smartphone is a necessity, either an Android, iOS or a Windows 10 Mobile.

===Should third party be contacted===

If the school is using a dedicated hosting service, they have to be informed on how you wish the news feed should be setup.

==Installation and setup==
inLogic will publish and update the app.

If you want your own AppStore and Google Play store pages, you will need your own Apple Developer Account for the iOS version, this is a requirements from Apples Guidelines. [[App Store Connect|Please follow the guide App Store Connect]].

Android and Windows Phone can be published through inLogics account or your schools own account (if you have acquired one). If you have your own account inLogic needs to be informed as well. To publish the app, inLogic needs the following information:

*[[UMS Web]] url address- This is the address that you use wen you access UMS Web. (If you are running any kind of gateway (TMG, UAG etc.) you will need to create rules for the services on UMS Web, contact us for more information)
**''<nowiki>https://*****.dk/</nowiki>''

===My Education App===
My Education App (Danish: My Education App) is the inLogic app that is hosted by inLogic, this lets your school get started using the app faster and cheaper, and also there is less maintenance for you.

======What does this mean?======
Pros:

*Lower start-up price.
*No need to set up an Apple Developer account.
*Upon contacting InLogic Support your app can be live within a few hours.
*You can change logo, images & colors after the app is deployed

Cons:

*The app will not be called your schools name on you phone and in AppStore/Google Play, but is instead called 'My Education App' (danish: My Education App), and its app icon cannot be customized.
*When students & teachers starts up the app for the first time, they will need to select their specific school before proceeding to login.

 

=====Setting up My Education App=====
<blockquote>Configurator -> Web setup -> App -> Setting</blockquote>
[[File:App levitas settings.png|none|frame]]

Here you need to configure a Primary and Secondary color, as well as a Logo. The Login background and Menu background images are optional. If you do use these we suggest using an image of a color, as the image is set to fill the entire background without considering aspect (meaning it will be squished if the aspect doesn't match the phone it is on).

The first time you set this up, you will need to contact InLogic support, and provide the following:

*A 64x64 pixels version of your logo (this logo is used in the the login dropdown, it will make it easier for users to find your school)
*UMS Web url (See [[App#Installation and setup|Installation and Setup]])

==Styling==
To style the app following is needed:

*Primary color
*Secondary color
*Logo (.png, vector file: .psd, .ai etc.)
*Icon for app logo (.png, vector file: .psd, .ai etc.)

The primary color will mostly be used as the default background color. The secondary color is the highlight color, and will be used when something is active or being activated like a button.

Optional:

*Background image for login (size 1080x1920)
*Background image for top bar of menu (size 1080x480)

===Examples of styling===

*Primary and secondary colors

[[File:App - Timetable view.png|none|thumb|Example of primary and secondary colors used in the app.
The primary color is used in the Header navigation bar, and the secondary color as border on the selected Calendar date
]]

*The schools logo - Max. 1024x576

[[File:Branding-af-app-inLogic-logo.png|none|thumb|Example of the inLogic logo used in the Demo app]]

*App logo - 1024x1024. If not supplied, inLogic will generate an App logo based on the schools logo (does not apply to My Education App)

[[File:Simulator Screen Shot - iPhone SE - 2018-05-15 at 12.57.23.png|none|thumb|Example of app logo in use]]

*Login background image - 1080x1920. If not supplied, a white background will be shown, with your logo on top

'''''NOTE: The app will place your logo on top of the background image. This means when you supply a background image, it needs to be without logo on it.'''''[[File:App - Login screen.png|none|thumb|Example of a background image used on the Demo app login screen.
The school logo will be displayed on top of the background image, as seen here
]]

*Menu top bar image - 1080x480. If not supplied, a white background will be shown

[[File:App - Sidebar menu.png|none|thumb|Example of an image used on the Demo app menu view]]

==Technical settings==

The following sections show how to configure the app. This information only applies to services that are directly connected to the app, i.e. how to set up schedule tasks in the app. The only exception is 'UMS RSS Feeds', which is a specific service for app. If a fully detailed setup guide is needed, please go to that specific module.

Some of the configurations are not set up specifically for app, i.e. ParkZone. If you cannot find the setup guide you are looking for, you can find it by searching or on the front page. Please note that some changes made in the configurator not only will affect the app but also UMS Web.

'''Important''' As many settings only loads once the website is initializing, most changes require an IIS reset on the server. The app retrieves settings from UMS once a day, which means that changes will be visible the next time you log in or the next day.

===Menu Settings===

You are able to set the order and which menu buttons should be shown per template for the users

#Open UMS Configurator
#Templates -> Edit -> select a template -> App
#Under Menu order select Manage -> Add
#Write a Description
#Drap and drop the menu you want

[[File:MeunOrderSettings.png|none|thumb|789x789px]]
Here three menubuttons will be visible to the users on that specific template.

===History===
Before version 2.0.917, you used to choose the modules displayed in the app via the Configurator -> Web Setup.

We have moved the menu order into the Configurator -> Template Editor -> App -> Menu order.
[[File:Menu settings history.png|none|thumb|1600x1600px]]
This change was made to allow a different menu items and orders on Templates.

===News===

----

This describes how to setup news for the app.

*App News created from UMS Web
*Add a RSS feed
*Add Facebook feed

It is possible to use all three setups together. Combine as you like and set difference feed for difference templates.

====Setup for App News from UMS Web====

You need to create or use an existing AD group. This group will have access to create and modify news in
App News on UMS Web.

#Open UMS Configurator
#Menu -> Web Setup -> Edit -> App
#Add the AD group for News Access group

[[File:App newsaccessgroup.png|none|thumb|767x767px]]

====Setup for RSS feed====
Add server name for the service for RSS feed in Menu -> Modules -> Settings -> RSS Feeds

[[File:App rssfeedservice.png|thumb|none|594x594px]]
To setup Rss feed you will need the url for the rss. (E.g. http://inlogic.dk/feed)

Menu -> Templates -> Edit -> select template -> Rss Feeds

Manage -> Add… -> Fill in description, feed url and access token
[[File:App rssfeedurl.png|none|thumb|920x920px]]
'''Note:''' You only need an access token if the feed is from Facebook

The RSS feed runs as a service called “UMS RSS Feeds”. Default running every 5 min.
[[File:App services.png|none|thumb|561x561px]]
Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log
[[File:App rssfeedlog.png|none|thumb|944x944px]]

====Setup for Facebook news====

If you want to use a Facebook page news feed, you need two things:

*Facebook Page Url Feed
*Access Token

=====Facebook Page Url Feed=====

To create the feed url

#Get your facebook page url
#*E.g. https://www.facebook.com/inlogic.dk
#Copy the name. E.g. “inlogic.dk”
#*Note: this can also be a number “142642699097242”
#Replace “inlogic.dk” with your name in this url
#*<nowiki>https://graph.facebook.com/v3.0/inlogic.dk/</nowiki>

Your facebook page url feed should look something like this:

*<nowiki>https://graph.facebook.com/v3.0/schoolname/</nowiki>

This is your feed URL.

=====Create a facebook access token=====
The personal Facebook account that you use to register as a developer does not need to be associated in any way with the page or group whose posts you want to display. You cannot log in to the Developer site using a Facebook Page or Business account. You must use the username and password from your personal Facebook profile. Facebook doesn’t allow businesses to register as developers, only individuals.

Please follow [https://developers.facebook.com/docs/apps/register Facebook guide] to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to [https://developers.facebook.com/tools/explorer Facebook Graph Explorer]

#Select application
#Select “Get Token” and “Get App Token”
#Copy the Access Token

[[File:App facebookgettoken.png|none|thumb|968x968px]]
Now you have the access token you need to paste into the configurator.
[[File:App rssfeedurl.png|none|thumb|920x920px]]
Reload the service UMS Rss Feed in Services and look in the RSS Feed log to validate.

===Grades===

----

You can set the default view for grades, that filters the grades accordingly. The options are Course, Day and period.

Configurator -> Web Setup -> Edit -> App -> Default grade view
[[File:App gradesview.png|none|thumb|801x801px]]
To specific the period you can set how your terms are set with start and end day for each period.

Configurator -> Modules -> Grades -> Select the Datasource -> Edit -> Terms
[[File:App gradesterms.png|none|thumb|706x706px]]
Depending on which administration system you’re exporting grades from the columns can vary. You can set which grades column should be used and in which order.

Configurator -> Web Setup -> Edit -> App -> Select grade columns
[[File:App gradescolumns.png|none|thumb|709x709px]]
The grades view in the App will change accordingly to which columns chosen, a max of 4 columns will be shown in the App. The columns will be shown for each grade in order from 1 to 4.

If no grade columns settings is made the default columns will be selected in the following order:

*EducationDescription
*CourseDescription
*EvaluationFormDescription
*GradeValue

===Your information===

----

You can select which fields in user information that should be editable.

Configurator -> Web Setup -> Edit -> Userinfo
[[File:App userinfo.png|none|thumb|800x800px]]
You need to set permission before the users are able to upload their own student photo (a selfie).

Configurator -> Web Setup -> Edit -> UMS Photo -> Enable Selfie in App
[[File:App userinfoselfie.png|none|thumb|802x802px]]
This will enable selfie function.

===Student ID And Employee ID===

----<blockquote>''This content has been moved to [[Student / Employee ID]]''</blockquote>

===My Absence===
----The students are able to write an absence reason on an already registered subject. This can be enabled in the template editor.

Select the template -> Absence -> Manage -> Create a new settings or select an existing one -> Add/Edit

Check "Allow students to register absence reason"

[[File:Absence settings.png|none|thumb|570x570px]]

'''Allow students to register absence reason''' will allow the students to set an absence reason when a teacher has set the student as absent. The student can set an absence reason in "My absence".

'''Days back''' is the number of days back the students are allowed to set an absence reason.

'''Show Course''' will show the course view (this will effect both web and app).

'''Show Activity''' will show the activity view (this will effect both web and app).

===Push Notification===
----<blockquote>'''''Temporarily disabled'''''</blockquote>UMS can send push notifications when there are news, grades, or changes in your timetable. It is possible to receive a daily notification with your timetable for the day.

In addition the app can receive [[SMS Alert]] messages.

To set up push notifications go to Web Setup -> App -> Manage -> Add
[[File:AppPushNotificationSettings.png|none|thumb|526x526px]]

Set the description

FCM Server Api Key:

#Receive the key string from inLogic and paste it

Windows Phone:

#Receive the Package SID and Client secret from inLogic and paste the strings

====School account====
In case the school has it's own account do the following to retrieve the information

FCM Server Api Key:

#Open https://play.google.com/apps/publish
#Google Play Console -> Settings -> API Access -> Create linked project and open it -> Credentials
#Create API Key
#Select the API Key and make key restriction for Android
#Type in your package name and SHA-1 certificate fingerprint
#Copy the API key and paste it inside FCM Server API Key

Windows Phone:

#Open https://developer.microsoft.com/en-us/dashboard/apps/overview
#Select your app
#Services -> Push notification -> WNS/MPNS
#Select "Live Services site"
#Copy and paste the Package SID into the configurator
#Generate an Application Secret if none exist
#Copy and paste the Application Secret into the configurator (This is the Client Secret)

===Links===
----[[UMS Links]] can be used by both UMS Web and UMS App. Check the [[UMS Links|guide]].

===Homework===
----See [[UMS Homework]]

===Parking===
----See [[Parking]]

===Notify absence===
----See [[Attendance Registration#SMS and App settings for notify absence|App settings for notify absence in attendance registration]]

===Sms Alert===
----See [[SMS Alert]]

===Privacy Policy===
----To add your own privary policy in the app go to Web Setup -> App

Insert into "Privacy Policy Url:"

If left empty privacy policy will not be shown.

InLogic has a default privacy policy "https://www.inlogic.dk/om-inlogic/privacy-policy/", you can refer to it, but we take no responsibility if you deviate from said policy.
[[File:App privacypolicyurl.png|none|thumb|792x792px]]

To add it to the App Store login

#https://appstoreconnect.apple.com/
#My Apps
#Select the app
#Select the top menu App Store
#Select App Information in the left menu
#Add your privacy policy url to "Privacy Policy URL"

[[File:App appstore privacypolicy.png|none|thumb|955x955px]] 
===Force language setting===
----Should you wish to, you have the option to force the language of the app to use a specific language, rather than the phones default language.

This is changed via the 'Forced language' feature in the Configurator.
[[File:Forced language.png|none|frame]]
The list of languages will expand over time, as UMS adds support for new languages.
 

==Custom localization resources==
see [[Custom Terms and Localization]]
 

==When changes take effect==
Changes to settings are effectuated in the app and different times, depending on what kind of change it is. The vast amount of changes will be template changes and are more or less instant, though there are exceptions.
{| class="wikitable"
|+Change Table
!Change Type
!When change takes effect
|-
|Setup changes
|IIS/Frontend Restart
|-
|Template changes
|Instant (in app needs to reload the page it is on for that to update
|-
|Changes to links
|Re-login
|}

==FAQ==

===Untrusted Certificate Error on Android===
'''''We do not recommend using Comodo certificates since they have been known to cause these issues.'''''

Can't login on some Android devices? This could be due to an untrusted Comodo SSL Certificate. We were able to reproduced it on Android version 4.1, 4.4.2, 5.0.1 and 8.1.0, but it may be present on any number of versions.

You can test your SSL certificate on https://www.ssllabs.com/ssltest/analyze.html

Do the following on the server

#Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
#Enable automatic root certificate updates on the server

Please checkout the Comodo support site: https://support.comodo.com/index.php?/Knowledgebase/Article/View/1019/38/untrusted-certificate-error-on-android

For future conservation:<blockquote>Certificate is not installed correctly; the certificate needs to be chained back to the Addtrust root certificate in order to be trusted on the Android.</blockquote><blockquote>The issue is that the Windows server is not presenting the complete certificate chain; clients which do not have the complete certificate chain will result in this error as encountered on the Android phone. In order to resolve this, on the server which this certificate is installed on, please open the MMC (Microsoft Management Console), and add the certificate snap-in for the computer account on the local computer.</blockquote><blockquote>In the Intermediate Certification Authorities folder, verify if the Comodo RSA Domain Validation Secure Server CA and Comodo RSA Certification Authority(issued to Comodo RSA Certification Authority, issued by AddTrustExternal CA Root) are installed in this certificate store.</blockquote><blockquote>In the Trusted Root Certification Authorities folder verify if the AddTrustExternal CA Root is installed. Also, if you see the Comodo RSA Certification Authority (issued to and issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038) is present, if it is please delete this certificate.</blockquote><blockquote>If any of these certificates are missing the intermediate and root certificates were provided to you in the .zip file when the certificate was issued, or are available via this support article - <nowiki>https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2</nowiki> .</blockquote><blockquote>If you had to delete the Comodo RSA Certification Authority from the Trusted Root Authorities folder, you will also need to disable automatic root certificate updates on the server - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008</blockquote><blockquote>If you have performed these steps and the certificate chain has not updated on the server, to force IIS to update the certificate chain you will need to either change the certificate binding in IIS to another certificate, and then switch the certificate bindings to the correct certificate. Alternately, you will need to restart the server.</blockquote>Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008<blockquote>To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.</blockquote><blockquote>To turn off Automatic Root Certificates Update:</blockquote><blockquote>1. Click Start, and then click Run.</blockquote><blockquote>2. Type gpedit.msc, and then click OK.</blockquote><blockquote>3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.</blockquote><blockquote>4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.</blockquote><blockquote>5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.</blockquote><blockquote>6. Close the Local Group Policy Editor.</blockquote><blockquote>Note: You can use Group Policy to set policy settings that apply across a given site, domain, or organizational unit in Active Directory Domain Services.</blockquote>

===Issues with the app===
If you're facing issues with the app, please perform the following steps before contacting support:

*Check the AppStore/GooglePlay for app updates and install any present
*Shut down the app completely, and start it back up
*Restart the phone
*Uninstall the app, and redownload it from AppStore/GooglePlay

 

=== Known issues ===
A small incomplete list of known issues and potential workarounds that may resolve them, if you do not find your issue here please contact the inlogic support on helpdesk and we will investigate and fix it / explain the issue if it is setup related.

* Unable to startup app when it has previously been able to and was logged in
** 1 of the issues that causes this is the cached login token not working or the school website being down or a combo of these. To fix this you can reinstall the app.
** Other causes are being looked into.
* "Unknown push notification, please contact your school it-department", app received a push notification of a type we do not support.
** The current theory is that virus or app/tools installed on the phone use the info to send push to the phone, it is possible a factory reset may fix it, but we have not been able to reproduce it on any of our devices. We are looking into it with what we have available.
*IOS 16 phones (usually so far reported to by iphone 14), have hangups on login that make them unable to login
**We are looking into this issue with multiple schools trying to replicate it, and planning a test to solve the issue (november 2022).
*Android doesn't clear all data/settings when uninstalling/reinstalling
**We are trying to fix this issue with patch 3.7.1 by disabling the android cloud backup for the app.

Apple Developer Account

2023-04-25T13:38:40Z

Kpe: Replace "min skole app" with "my education app"

This guide describes how to create your Apple Developer Account and give access to inLogic to administrate your app.

Three steps

#The school needs it's own Apple Developer Account
#inLogic needs accesss to Apple Developer Program to create App ID and provisioning profile
#inLogic needs access to App Store Connect to create and continues update the app

==Why?==
Due to the changes made by Apple on their Store View Guidelines on the 21st of December, 2017, we are not longer permitted to release our customers apps through our own developer account. (Section 4.2.6)

https://developer.apple.com/app-store/review/guidelines/#minimum-functionality

For this reason, all customers must create their own Apple Developer account before we can release a new version. Having an Apple Developer account costs an anual fee of 99$ USD.

Luckily, while you have to create your own developer account, when you add our development account as App Manager to your new developer account, we will still be able to handle the entire process of creating and keeping your app up-to-date with the latest releases of the UMS App.

== Alternatives ==
Instead of signing up for an Apple Developer Account, your school can choose to become a member of 'My Education App'. This is a single app being hosted by InLogic where the first step for the user is to choose which school they wish to connect to.

After they choose the school the rest of the app is identical to the UMS app.

You can read more about 'My Education App' [[App#My School App|here]].

==Create Apple Developer Account==
If you do not have an Apple ID for your organization already, you can follow this guide to create one:

https://appleid.apple.com/account

Note that you can not use the same account if you're running the VPP (Volume Purchase Programme) on it.

After creating your account, you need to enroll for Apple Developer Program. Follow the guide below:

https://developer.apple.com/programs/enroll/

Follow the instruction
[[File:Appledeveloper appleidinformation.png|none|thumb|437x437px]]
Fill in the information
[[File:Appledeveloper authority.png|none|thumb|593x593px]]
Fill in the information. Make sure that your Legal Entity Name (Company name) matches the one that is used when you received your DUNS number.
[[File:Appledevelop organizationinformation.png|none|thumb|415x415px]]
You need to provide the school DUNS number.

*Read about DUNS: https://developer.apple.com/support/D-U-N-S/
*Look up: https://developer.apple.com/enroll/duns-lookup/
*You can also request DUNS number from danish BisNode, who cooperate with Dun&Bradstreet: https://www.bisnode.dk/produkter/db-produkter/db-duns-nummer/#anchor-GetStarted
*It normally takes about 30min for the request to be completed and you'll receive an email with your DUNS number

==Add Apple Developer Program User==
inLogic will need access to create an App ID and iOS Distribution Provisioning Profiles, before an app can be build and bound to your Apple Developer Account.

Indepth information about the Apple Developer Program Team Roles: https://developer.apple.com/support/roles/

Go to: https://developer.apple.com/account/#/people/

Click 'Invite People'
[[File:AppleDeveloperProgramPeople.png|none|thumb|410x410px]]

Fill out 'Invite as Admins' and click invite
[[File:AppleDeveloperProgramAdmins.png|none|thumb|621x621px]]

Now you should see a Pending invitation.

Please inform inLogic that an invite has been sent.
[[File:AppleDeveloperProgramPendingInvite.png|none|thumb]]

==Add App Store Connect User==
inLogic will need access to be able to create and upload new updates for your app. You do so by adding our account as 'another App Store Connect User'.

Go to https://appstoreconnect.apple.com/

Select 'Users and Roles'.
[[File:Appstore usersandroles.png|none|thumb|164x164px]]
Select the plus icon.
[[File:Appstore plusicon.png|none|thumb]]
Fill out the information as seen below. Please note that you must check off 'Access to Certificates, Identifiers and Profiles'.
[[File:Invite.png|none|frame]]
You will now see that a confirmation email has been sent to inLogic.

Please inform inLogic that an invite has been sent.
[[File:AppstoreConfirmationEmail.png|none|thumb|519x519px]]

==Move app from inLogic account to your own==
You need to provide the following information to inLogic:

*Team ID (Located here: https://developer.apple.com/account/#/membership/)
*Apple ID (email and it's case sensitive)

Once the process has started both parties need to accept the transfer agreement.

From Apple: "''Once an app transfer has been requested, the recipient's Team Agent has 60 days from the day initiated to accept the request. Contracts that have not been accepted within 60 days will be canceled. App transfers can take up to two business days to complete, depending on an export compliance review."''

Log into https://appstoreconnect.apple.com/

You'll get this. The Team Agent needs to accept the agreement.
[[File:Appstore apptransferagreement.png|none|thumb|1236x1236px]]

When you accept the app you'll be asked to fill out some question. These questions is some general information.

'''New App Metadata''': Support URL should link to e.g. schools url, contact page or hosting center.

'''App Review Contact Information:''' Insert the information for the person who is responsible for the Apple account or the person who should be in control of the communication with app testers.

[[File:AppTransferReview.png|none|thumb|718x718px]]

==FAQ==

===D-U-N-S cannot be verified===
If you received the following error[[File:Appledeveloper dunsnumber.png|none|thumb|615x615px]]Look up your company on https://datacvr.virk.dk/data/

If your Company type (Virksomhedsform) is registered as 'Other legal structure' / 'Øvrige virksomhedsformer', your D&B number will not be recognized by apple.

You will need to contact Apple and prove to them that you are a company. This is done by using the 'Save to PDF'-feature on Virk. You will have to explain the situation, and ask for an email to send this information to.

<blockquote>Suggested explanation:</blockquote>
I'm writing/calling on behalf of my educational institution *'''''School name*'''''. We are trying to set up an Apple Developer account, and are encountering issues with the DUNS number. The company legal structure is registered as 'Other legal structure'.
I have been informed that this legal structure by itself is not enough for Apple to verify us as a legal entity, and that you need to see documentation that we are a registered company. I have the legal documents as PDFs, do you have an email I can send them to?

If your company type is not Other legal structure, please contact Apple Support https://developer.apple.com/contact/

Select "Membership and Account" and "D-U-N-S Number"

Select either Phone or Email to be contacted.

===Two-factor Authentication===
Make sure you have added a trusted phone number and one of your devices has two-factor authenticaiton on.
[[File:Appdeveloper appletwofactor.png|none|thumb]]
On an iOS device go to Settings -> Select account -> Password & Security. Make sure Two-Factor Authentication is On.

On Mac go to System Preferences -> iCloud -> Account Details -> Security. Then add a trusted phone number or device.
[[File:Appledeveloper twofactor.png|none|thumb|664x664px]]More info: https://support.apple.com/en-us/HT204915

===Potential Loss of Keychain Access warning===
After an app transfer you'll receive the following email from Apple:
Dear Developer,
We identified one or more issues with a recent delivery for your app, "***********". Your
delivery was successful, but you may wish to correct the following issues in your next
delivery:
Potential Loss of Keychain Access - The previous version of software has an
application-identifier value of ['**********.dk.inlogic.**********'] and the new version
of software being submitted has an application-identifier of
['**********.dk.inlogic.**********']. This will result in a loss of keychain access.
After you've corrected the issues, you can use Xcode or Application Loader to upload a new
binary to iTunes Connect.
Best regards,
The App Store Team
Apps that should expect this warning and proceed with the submission regardless are: "Those that are submitting the first update for a recently acquired app via App Transfer"

There is no further action needed if an app transfer has been made.

Source: https://developer.apple.com/library/archive/qa/qa1726/_index.html

===Can't see People menu in Developer Apple Developer Program===
If the people menu is missing from please check the account is not a type "individual". You check this under Membership "Entity Type". This should say "Company / Organization"

[[File:Appstore people.png|none|thumb]]

App

2023-04-25T13:37:42Z

Kpe: Replace "my school app" + "Min skole app" with "My Education App".

[[File:UMS School App.png|frame]]
UMS School App is available for iPhone, Android. It will be designed with the school’s own logo, color and style. The app gives the basic functionality to see:

*News
*Timetable
*Homework
*Grades
*User information

Additional licenses gives the ability to create, edit and see more information from various modules. For an overview of module requirement see "[http://wiki.inlogic.dk/index.php?title=App&section=6&wteswitched=1#Additional_functionality Additional functionality"]

==Support==
We provide regular support for the following and newer versions:

*Android version 7.0. We support the same versions as Google provide security updates for. Find an overview [[wikipedia:Android_version_history#Code_names|here]].

*iOS version 10

*Windows 10 Mobile (version 10)

Please note that it is possible to run older versions. If support for older versions is needed, we offer support at our hourly rate.

==Prerequisites==
===Supported administrative systems===

*Userinfo: Easy-A, SIS, LUDUS and Lectio (Only mobile number).
*Grades: Easy-A, Lectio and SIS
*Homework: Easy-A and SIS.
*Timetable: Easy-A and SIS
*Attendance registration: Timetable data is retrieved from Easy-A, SIS, LUDUS, Tabulex and Lectio. Howerver, absence is only registered to Easy-A

===Module requirements===

*UMS Web (contains and run all the webservice that is required for the app to receive information and communicate with the server)

===Additional functionality===
You get more functionality in the app by having the following modules, these are all optional:

*Attendance Registration: Gives “Your attendance”, which shows student statistics, the student are able to add absence reason and see their absence status in the timetable
*Attendance Registration for UMS School App: gives employee “attendance registration” and student the ability to "report absence"
*Homework: gives the employee the ability to create homework
*Link Collection: gives links/bookmarks the school can setup
*User info: gives “Your information” the ability to edit the information. This also adds the functionality for the user to upload a new profile image (a selfie) to be used in the student id card
*Student & Employee Id: Gives the students a “student id card” and the employees an “employee id card”. To update their student id card profile image you’ll need the “User info” module
*Parking: Parkzone & APCOA Integration. Gives the option to create and edit parking permits from Parkzone and APCOA
*User information (add/edit)

Note: All Attendance functionality requires Attendance Registration.

===Testing after setup===

The app will be tested internally at inLogic before release. The test requires access to a user with relevant data. You can either create a fictional student who is associated to a real course, or alternatively use a real student's account, if the person agrees that the account is being used for a system test of the school's APP.

===What to have ready===

*'''Important''': The UMS site needs to use HTTPS and be public available. It needs a valid SSL certificate.
*Materials that can be used for designing the app. For example: Logo, brochure, design guide line, etc.

*Optional: It is possible for the school to have its own account where the app is located. An account in the App Store cost $99 per year(necessary if the school is not using "My Education App"), while an account for Google Play costs a onetime fee of $25. The school self-manage these accounts.

===Physical hardware requirements===

Having a smartphone is a necessity, either an Android, iOS or a Windows 10 Mobile.

===Should third party be contacted===

If the school is using a dedicated hosting service, they have to be informed on how you wish the news feed should be setup.

==Installation and setup==
inLogic will publish and update the app.

If you want your own AppStore and Google Play store pages, you will need your own Apple Developer Account for the iOS version, this is a requirements from Apples Guidelines. [[App Store Connect|Please follow the guide App Store Connect]].

Android and Windows Phone can be published through inLogics account or your schools own account (if you have acquired one). If you have your own account inLogic needs to be informed as well. To publish the app, inLogic needs the following information:

*[[UMS Web]] url address- This is the address that you use wen you access UMS Web. (If you are running any kind of gateway (TMG, UAG etc.) you will need to create rules for the services on UMS Web, contact us for more information)
**''<nowiki>https://*****.dk/</nowiki>''

===My Education App===
My Education App (Danish: My Education App) is the inLogic app that is hosted by inLogic, this lets your school get started using the app faster and cheaper, and also there is less maintenance for you.

======What does this mean?======
Pros:

*Lower start-up price.
*No need to set up an Apple Developer account.
*Upon contacting InLogic Support your app can be live within a few hours.
*You can change logo, images & colors after the app is deployed

Cons:

*The app will not be called your schools name on you phone and in AppStore/Google Play, but is instead called 'My Education App' (danish: My Education App), and its app icon cannot be customized.
*When students & teachers starts up the app for the first time, they will need to select their specific school before proceeding to login.

 

=====Setting up My Education App=====
<blockquote>Configurator -> Web setup -> App -> Setting</blockquote>
[[File:App levitas settings.png|none|frame]]

Here you need to configure a Primary and Secondary color, as well as a Logo. The Login background and Menu background images are optional.

The first time you set this up, you will need to contact InLogic support, and provide the following:

*A 64x64 pixels version of your logo (this logo is used in the the login dropdown, it will make it easier for users to find your school)
*UMS Web url (See [[App#Installation and setup|Installation and Setup]])

==Styling==
To style the app following is needed:

*Primary color
*Secondary color
*Logo (.png, vector file: .psd, .ai etc.)
*Icon for app logo (.png, vector file: .psd, .ai etc.)

The primary color will mostly be used as the default background color. The secondary color is the highlight color, and will be used when something is active or being activated like a button.

Optional:

*Background image for login (size 1080x1920)
*Background image for top bar of menu (size 1080x480)

===Examples of styling===

*Primary and secondary colors

[[File:App - Timetable view.png|none|thumb|Example of primary and secondary colors used in the app.
The primary color is used in the Header navigation bar, and the secondary color as border on the selected Calendar date
]]

*The schools logo - Max. 1024x576

[[File:Branding-af-app-inLogic-logo.png|none|thumb|Example of the inLogic logo used in the Demo app]]

*App logo - 1024x1024. If not supplied, inLogic will generate an App logo based on the schools logo (does not apply to My Education App)

[[File:Simulator Screen Shot - iPhone SE - 2018-05-15 at 12.57.23.png|none|thumb|Example of app logo in use]]

*Login background image - 1080x1920. If not supplied, a white background will be shown, with your logo on top

'''''NOTE: The app will place your logo on top of the background image. This means when you supply a background image, it needs to be without logo on it.'''''[[File:App - Login screen.png|none|thumb|Example of a background image used on the Demo app login screen.
The school logo will be displayed on top of the background image, as seen here
]]

*Menu top bar image - 1080x480. If not supplied, a white background will be shown

[[File:App - Sidebar menu.png|none|thumb|Example of an image used on the Demo app menu view]]

==Technical settings==

The following sections show how to configure the app. This information only applies to services that are directly connected to the app, i.e. how to set up schedule tasks in the app. The only exception is 'UMS RSS Feeds', which is a specific service for app. If a fully detailed setup guide is needed, please go to that specific module.

Some of the configurations are not set up specifically for app, i.e. ParkZone. If you cannot find the setup guide you are looking for, you can find it by searching or on the front page. Please note that some changes made in the configurator not only will affect the app but also UMS Web.

'''Important''' As many settings only loads once the website is initializing, most changes require an IIS reset on the server. The app retrieves settings from UMS once a day, which means that changes will be visible the next time you log in or the next day.

===Menu Settings===

You are able to set the order and which menu buttons should be shown per template for the users

#Open UMS Configurator
#Templates -> Edit -> select a template -> App
#Under Menu order select Manage -> Add
#Write a Description
#Drap and drop the menu you want

[[File:MeunOrderSettings.png|none|thumb|789x789px]]
Here three menubuttons will be visible to the users on that specific template.

===History===
Before version 2.0.917, you used to choose the modules displayed in the app via the Configurator -> Web Setup.

We have moved the menu order into the Configurator -> Template Editor -> App -> Menu order.
[[File:Menu settings history.png|none|thumb|1600x1600px]]
This change was made to allow a different menu items and orders on Templates.

===News===

----

This describes how to setup news for the app.

*App News created from UMS Web
*Add a RSS feed
*Add Facebook feed

It is possible to use all three setups together. Combine as you like and set difference feed for difference templates.

====Setup for App News from UMS Web====

You need to create or use an existing AD group. This group will have access to create and modify news in
App News on UMS Web.

#Open UMS Configurator
#Menu -> Web Setup -> Edit -> App
#Add the AD group for News Access group

[[File:App newsaccessgroup.png|none|thumb|767x767px]]

====Setup for RSS feed====
Add server name for the service for RSS feed in Menu -> Modules -> Settings -> RSS Feeds

[[File:App rssfeedservice.png|thumb|none|594x594px]]
To setup Rss feed you will need the url for the rss. (E.g. http://inlogic.dk/feed)

Menu -> Templates -> Edit -> select template -> Rss Feeds

Manage -> Add… -> Fill in description, feed url and access token
[[File:App rssfeedurl.png|none|thumb|920x920px]]
'''Note:''' You only need an access token if the feed is from Facebook

The RSS feed runs as a service called “UMS RSS Feeds”. Default running every 5 min.
[[File:App services.png|none|thumb|561x561px]]
Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log
[[File:App rssfeedlog.png|none|thumb|944x944px]]

====Setup for Facebook news====

If you want to use a Facebook page news feed, you need two things:

*Facebook Page Url Feed
*Access Token

=====Facebook Page Url Feed=====

To create the feed url

#Get your facebook page url
#*E.g. https://www.facebook.com/inlogic.dk
#Copy the name. E.g. “inlogic.dk”
#*Note: this can also be a number “142642699097242”
#Replace “inlogic.dk” with your name in this url
#*<nowiki>https://graph.facebook.com/v3.0/inlogic.dk/</nowiki>

Your facebook page url feed should look something like this:

*<nowiki>https://graph.facebook.com/v3.0/schoolname/</nowiki>

This is your feed URL.

=====Create a facebook access token=====
The personal Facebook account that you use to register as a developer does not need to be associated in any way with the page or group whose posts you want to display. You cannot log in to the Developer site using a Facebook Page or Business account. You must use the username and password from your personal Facebook profile. Facebook doesn’t allow businesses to register as developers, only individuals.

Please follow [https://developers.facebook.com/docs/apps/register Facebook guide] to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to [https://developers.facebook.com/tools/explorer Facebook Graph Explorer]

#Select application
#Select “Get Token” and “Get App Token”
#Copy the Access Token

[[File:App facebookgettoken.png|none|thumb|968x968px]]
Now you have the access token you need to paste into the configurator.
[[File:App rssfeedurl.png|none|thumb|920x920px]]
Reload the service UMS Rss Feed in Services and look in the RSS Feed log to validate.

===Grades===

----

You can set the default view for grades, that filters the grades accordingly. The options are Course, Day and period.

Configurator -> Web Setup -> Edit -> App -> Default grade view
[[File:App gradesview.png|none|thumb|801x801px]]
To specific the period you can set how your terms are set with start and end day for each period.

Configurator -> Modules -> Grades -> Select the Datasource -> Edit -> Terms
[[File:App gradesterms.png|none|thumb|706x706px]]
Depending on which administration system you’re exporting grades from the columns can vary. You can set which grades column should be used and in which order.

Configurator -> Web Setup -> Edit -> App -> Select grade columns
[[File:App gradescolumns.png|none|thumb|709x709px]]
The grades view in the App will change accordingly to which columns chosen, a max of 4 columns will be shown in the App. The columns will be shown for each grade in order from 1 to 4.

If no grade columns settings is made the default columns will be selected in the following order:

*EducationDescription
*CourseDescription
*EvaluationFormDescription
*GradeValue

===Your information===

----

You can select which fields in user information that should be editable.

Configurator -> Web Setup -> Edit -> Userinfo
[[File:App userinfo.png|none|thumb|800x800px]]
You need to set permission before the users are able to upload their own student photo (a selfie).

Configurator -> Web Setup -> Edit -> UMS Photo -> Enable Selfie in App
[[File:App userinfoselfie.png|none|thumb|802x802px]]
This will enable selfie function.

===Student ID And Employee ID===

----<blockquote>''This content has been moved to [[Student / Employee ID]]''</blockquote>

===My Absence===
----The students are able to write an absence reason on an already registered subject. This can be enabled in the template editor.

Select the template -> Absence -> Manage -> Create a new settings or select an existing one -> Add/Edit

Check "Allow students to register absence reason"

[[File:Absence settings.png|none|thumb|570x570px]]

'''Allow students to register absence reason''' will allow the students to set an absence reason when a teacher has set the student as absent. The student can set an absence reason in "My absence".

'''Days back''' is the number of days back the students are allowed to set an absence reason.

'''Show Course''' will show the course view (this will effect both web and app).

'''Show Activity''' will show the activity view (this will effect both web and app).

===Push Notification===
----<blockquote>'''''Temporarily disabled'''''</blockquote>UMS can send push notifications when there are news, grades, or changes in your timetable. It is possible to receive a daily notification with your timetable for the day.

In addition the app can receive [[SMS Alert]] messages.

To set up push notifications go to Web Setup -> App -> Manage -> Add
[[File:AppPushNotificationSettings.png|none|thumb|526x526px]]

Set the description

FCM Server Api Key:

#Receive the key string from inLogic and paste it

Windows Phone:

#Receive the Package SID and Client secret from inLogic and paste the strings

====School account====
In case the school has it's own account do the following to retrieve the information

FCM Server Api Key:

#Open https://play.google.com/apps/publish
#Google Play Console -> Settings -> API Access -> Create linked project and open it -> Credentials
#Create API Key
#Select the API Key and make key restriction for Android
#Type in your package name and SHA-1 certificate fingerprint
#Copy the API key and paste it inside FCM Server API Key

Windows Phone:

#Open https://developer.microsoft.com/en-us/dashboard/apps/overview
#Select your app
#Services -> Push notification -> WNS/MPNS
#Select "Live Services site"
#Copy and paste the Package SID into the configurator
#Generate an Application Secret if none exist
#Copy and paste the Application Secret into the configurator (This is the Client Secret)

===Links===
----[[UMS Links]] can be used by both UMS Web and UMS App. Check the [[UMS Links|guide]].

===Homework===
----See [[UMS Homework]]

===Parking===
----See [[Parking]]

===Notify absence===
----See [[Attendance Registration#SMS and App settings for notify absence|App settings for notify absence in attendance registration]]

===Sms Alert===
----See [[SMS Alert]]

===Privacy Policy===
----To add your own privary policy in the app go to Web Setup -> App

Insert into "Privacy Policy Url:"

If left empty privacy policy will not be shown.

InLogic has a default privacy policy "https://www.inlogic.dk/om-inlogic/privacy-policy/", you can refer to it, but we take no responsibility if you deviate from said policy.
[[File:App privacypolicyurl.png|none|thumb|792x792px]]

To add it to the App Store login

#https://appstoreconnect.apple.com/
#My Apps
#Select the app
#Select the top menu App Store
#Select App Information in the left menu
#Add your privacy policy url to "Privacy Policy URL"

[[File:App appstore privacypolicy.png|none|thumb|955x955px]] 
===Force language setting===
----Should you wish to, you have the option to force the language of the app to use a specific language, rather than the phones default language.

This is changed via the 'Forced language' feature in the Configurator.
[[File:Forced language.png|none|frame]]
The list of languages will expand over time, as UMS adds support for new languages.
 

==Custom localization resources==
see [[Custom Terms and Localization]]
 

==When changes take effect==
Changes to settings are effectuated in the app and different times, depending on what kind of change it is. The vast amount of changes will be template changes and are more or less instant, though there are exceptions.
{| class="wikitable"
|+Change Table
!Change Type
!When change takes effect
|-
|Setup changes
|IIS/Frontend Restart
|-
|Template changes
|Instant (in app needs to reload the page it is on for that to update
|-
|Changes to links
|Re-login
|}

==FAQ==

===Untrusted Certificate Error on Android===
'''''We do not recommend using Comodo certificates since they have been known to cause these issues.'''''

Can't login on some Android devices? This could be due to an untrusted Comodo SSL Certificate. We were able to reproduced it on Android version 4.1, 4.4.2, 5.0.1 and 8.1.0, but it may be present on any number of versions.

You can test your SSL certificate on https://sslanalyzer.comodoca.com/

Do the following on the server

#Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
#Enable automatic root certificate updates on the server

Please checkout the Comodo support site: https://support.comodo.com/index.php?/Knowledgebase/Article/View/1019/38/untrusted-certificate-error-on-android

For future conservation:<blockquote>Certificate is not installed correctly; the certificate needs to be chained back to the Addtrust root certificate in order to be trusted on the Android.</blockquote><blockquote>The issue is that the Windows server is not presenting the complete certificate chain; clients which do not have the complete certificate chain will result in this error as encountered on the Android phone. In order to resolve this, on the server which this certificate is installed on, please open the MMC (Microsoft Management Console), and add the certificate snap-in for the computer account on the local computer.</blockquote><blockquote>In the Intermediate Certification Authorities folder, verify if the Comodo RSA Domain Validation Secure Server CA and Comodo RSA Certification Authority(issued to Comodo RSA Certification Authority, issued by AddTrustExternal CA Root) are installed in this certificate store.</blockquote><blockquote>In the Trusted Root Certification Authorities folder verify if the AddTrustExternal CA Root is installed. Also, if you see the Comodo RSA Certification Authority (issued to and issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038) is present, if it is please delete this certificate.</blockquote><blockquote>If any of these certificates are missing the intermediate and root certificates were provided to you in the .zip file when the certificate was issued, or are available via this support article - <nowiki>https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2</nowiki> .</blockquote><blockquote>If you had to delete the Comodo RSA Certification Authority from the Trusted Root Authorities folder, you will also need to disable automatic root certificate updates on the server - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008</blockquote><blockquote>If you have performed these steps and the certificate chain has not updated on the server, to force IIS to update the certificate chain you will need to either change the certificate binding in IIS to another certificate, and then switch the certificate bindings to the correct certificate. Alternately, you will need to restart the server.</blockquote>Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008<blockquote>To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.</blockquote><blockquote>To turn off Automatic Root Certificates Update:</blockquote><blockquote>1. Click Start, and then click Run.</blockquote><blockquote>2. Type gpedit.msc, and then click OK.</blockquote><blockquote>3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.</blockquote><blockquote>4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.</blockquote><blockquote>5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.</blockquote><blockquote>6. Close the Local Group Policy Editor.</blockquote><blockquote>Note: You can use Group Policy to set policy settings that apply across a given site, domain, or organizational unit in Active Directory Domain Services.</blockquote>

===Issues with the app===
If you're facing issues with the app, please perform the following steps before contacting support:

*Check the AppStore/GooglePlay for app updates and install any present
*Shut down the app completely, and start it back up
*Restart the phone
*Uninstall the app, and redownload it from AppStore/GooglePlay

 

=== Known issues ===
A small incomplete list of known issues and potential workarounds that may resolve them, if you do not find your issue here please contact the inlogic support on helpdesk and we will investigate and fix it / explain the issue if it is setup related.

* Unable to startup app when it has previously been able to and was logged in
** 1 of the issues that causes this is the cached login token not working or the school website being down or a combo of these. To fix this you can reinstall the app.
** Other causes are being looked into.
* "Unknown push notification, please contact your school it-department", app received a push notification of a type we do not support.
** The current theory is that virus or app/tools installed on the phone use the info to send push to the phone, it is possible a factory reset may fix it, but we have not been able to reproduce it on any of our devices. We are looking into it with what we have available.
*IOS 16 phones (usually so far reported to by iphone 14), have hangups on login that make them unable to login
**We are looking into this issue with multiple schools trying to replicate it, and planning a test to solve the issue (november 2022).
*Android doesn't clear all data/settings when uninstalling/reinstalling
**We are trying to fix this issue with patch 3.7.1 by disabling the android cloud backup for the app.

Push Notifications

2023-04-25T13:35:51Z

Kpe: Supported android version + change min skole app to my education app

Push notification is a feature available in the UMS App, however only when using 'My Education App'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'My Education App'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

'''Only 1 hub per UMS installation supported'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "My Education App"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

'''In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub.''' 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

Before beginning testing please read the "Known issues" segment as some of these may come up.

===Inlogic support===
[[File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

==When to expect a push notification==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

#Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
#Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
#Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out(sometimes hours), cause unknown.

Users do not currently have a way to know if they are properly registered with the hub in the app, we are contemplating a way to add feedback for this. -You only get response when doing a registration/de-registration action.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions of the frontend and backend as at the time of writting(1. of april 2022) any version newer than the beta should not have this issue.

 
==FAQ==
Q: Which devices are supported?<blockquote>
A: Android 8+ and IOS.</blockquote>

Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'My Education App')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Q: Which OS are supported?<blockquote>A: Currently only android(through google and iOS are supported.</blockquote>

App

2023-04-25T13:26:32Z

Kpe: /* Privacy Policy */

[[File:UMS School App.png|frame]]
UMS School App is available for iPhone, Android. It will be designed with the school’s own logo, color and style. The app gives the basic functionality to see:

*News
*Timetable
*Homework
*Grades
*User information

Additional licenses gives the ability to create, edit and see more information from various modules. For an overview of module requirement see "[http://wiki.inlogic.dk/index.php?title=App&section=6&wteswitched=1#Additional_functionality Additional functionality"]

==Support==
We provide regular support for the following and newer versions:

*Android version 7.0. We support the same versions as Google provide security updates for. Find an overview [[wikipedia:Android_version_history#Code_names|here]].

*iOS version 10

*Windows 10 Mobile (version 10)

Please note that it is possible to run older versions. If support for older versions is needed, we offer support at our hourly rate.

==Prerequisites==
===Supported administrative systems===

*Userinfo: Easy-A, SIS, LUDUS and Lectio (Only mobile number).
*Grades: Easy-A, Lectio and SIS
*Homework: Easy-A and SIS.
*Timetable: Easy-A and SIS
*Attendance registration: Timetable data is retrieved from Easy-A, SIS, LUDUS, Tabulex and Lectio. Howerver, absence is only registered to Easy-A

===Module requirements===

*UMS Web (contains and run all the webservice that is required for the app to receive information and communicate with the server)

===Additional functionality===
You get more functionality in the app by having the following modules, these are all optional:

*Attendance Registration: Gives “Your attendance”, which shows student statistics, the student are able to add absence reason and see their absence status in the timetable
*Attendance Registration for UMS School App: gives employee “attendance registration” and student the ability to "report absence"
*Homework: gives the employee the ability to create homework
*Link Collection: gives links/bookmarks the school can setup
*User info: gives “Your information” the ability to edit the information. This also adds the functionality for the user to upload a new profile image (a selfie) to be used in the student id card
*Student & Employee Id: Gives the students a “student id card” and the employees an “employee id card”. To update their student id card profile image you’ll need the “User info” module
*Parking: Parkzone & APCOA Integration. Gives the option to create and edit parking permits from Parkzone and APCOA
*User information (add/edit)

Note: All Attendance functionality requires Attendance Registration.

===Testing after setup===

The app will be tested internally at inLogic before release. The test requires access to a user with relevant data. You can either create a fictional student who is associated to a real course, or alternatively use a real student's account, if the person agrees that the account is being used for a system test of the school's APP.

===What to have ready===

*'''Important''': The UMS site needs to use HTTPS and be public available. It needs a valid SSL certificate.
*Materials that can be used for designing the app. For example: Logo, brochure, design guide line, etc.

*Optional: It is possible for the school to have its own account where the app is located. An account in the App Store cost $99 per year(necessary if the school is not using "My School App"), while an account for Google Play costs a onetime fee of $25. The school self-manage these accounts.

===Physical hardware requirements===

Having a smartphone is a necessity, either an Android, iOS or a Windows 10 Mobile.

===Should third party be contacted===

If the school is using a dedicated hosting service, they have to be informed on how you wish the news feed should be setup.

==Installation and setup==
inLogic will publish and update the app.

If you want your own AppStore and Google Play store pages, you will need your own Apple Developer Account for the iOS version, this is a requirements from Apples Guidelines. [[App Store Connect|Please follow the guide App Store Connect]].

Android and Windows Phone can be published through inLogics account or your schools own account (if you have acquired one). If you have your own account inLogic needs to be informed as well. To publish the app, inLogic needs the following information:

*[[UMS Web]] url address- This is the address that you use wen you access UMS Web. (If you are running any kind of gateway (TMG, UAG etc.) you will need to create rules for the services on UMS Web, contact us for more information)
**''<nowiki>https://*****.dk/</nowiki>''

===My School App===
My school app (Danish: Min skole app) is the inLogic app that is hosted by inLogic, this lets your school get started using the app faster and cheaper, and also there is less maintenance for you.

======What does this mean?======
Pros:

*Lower start-up price.
*No need to set up an Apple Developer account.
*Upon contacting InLogic Support your app can be live within a few hours.
*You can change logo, images & colors after the app is deployed

Cons:

*The app will not be called your schools name on you phone and in AppStore/Google Play, but is instead called 'My school app' (danish: Min skole app), and its app icon cannot be customized.
*When students & teachers starts up the app for the first time, they will need to select their specific school before proceeding to login.

 

=====Setting up My school app=====
<blockquote>Configurator -> Web setup -> App -> Setting</blockquote>
[[File:App levitas settings.png|none|frame]]

Here you need to configure a Primary and Secondary color, as well as a Logo. The Login background and Menu background images are optional.

The first time you set this up, you will need to contact InLogic support, and provide the following:

*A 64x64 pixels version of your logo (this logo is used in the the login dropdown, it will make it easier for users to find your school)
*UMS Web url (See [[App#Installation and setup|Installation and Setup]])

==Styling==
To style the app following is needed:

*Primary color
*Secondary color
*Logo (.png, vector file: .psd, .ai etc.)
*Icon for app logo (.png, vector file: .psd, .ai etc.)

The primary color will mostly be used as the default background color. The secondary color is the highlight color, and will be used when something is active or being activated like a button.

Optional:

*Background image for login (size 1080x1920)
*Background image for top bar of menu (size 1080x480)

===Examples of styling===

*Primary and secondary colors

[[File:App - Timetable view.png|none|thumb|Example of primary and secondary colors used in the app.
The primary color is used in the Header navigation bar, and the secondary color as border on the selected Calendar date
]]

*The schools logo - Max. 1024x576

[[File:Branding-af-app-inLogic-logo.png|none|thumb|Example of the inLogic logo used in the Demo app]]

*App logo - 1024x1024. If not supplied, inLogic will generate an App logo based on the schools logo (does not apply to My School App)

[[File:Simulator Screen Shot - iPhone SE - 2018-05-15 at 12.57.23.png|none|thumb|Example of app logo in use]]

*Login background image - 1080x1920. If not supplied, a white background will be shown, with your logo on top

'''''NOTE: The app will place your logo on top of the background image. This means when you supply a background image, it needs to be without logo on it.'''''[[File:App - Login screen.png|none|thumb|Example of a background image used on the Demo app login screen.
The school logo will be displayed on top of the background image, as seen here
]]

*Menu top bar image - 1080x480. If not supplied, a white background will be shown

[[File:App - Sidebar menu.png|none|thumb|Example of an image used on the Demo app menu view]]

==Technical settings==

The following sections show how to configure the app. This information only applies to services that are directly connected to the app, i.e. how to set up schedule tasks in the app. The only exception is 'UMS RSS Feeds', which is a specific service for app. If a fully detailed setup guide is needed, please go to that specific module.

Some of the configurations are not set up specifically for app, i.e. ParkZone. If you cannot find the setup guide you are looking for, you can find it by searching or on the front page. Please note that some changes made in the configurator not only will affect the app but also UMS Web.

'''Important''' As many settings only loads once the website is initializing, most changes require an IIS reset on the server. The app retrieves settings from UMS once a day, which means that changes will be visible the next time you log in or the next day.

===Menu Settings===

You are able to set the order and which menu buttons should be shown per template for the users

#Open UMS Configurator
#Templates -> Edit -> select a template -> App
#Under Menu order select Manage -> Add
#Write a Description
#Drap and drop the menu you want

[[File:MeunOrderSettings.png|none|thumb|789x789px]]
Here three menubuttons will be visible to the users on that specific template.

===History===
Before version 2.0.917, you used to choose the modules displayed in the app via the Configurator -> Web Setup.

We have moved the menu order into the Configurator -> Template Editor -> App -> Menu order.
[[File:Menu settings history.png|none|thumb|1600x1600px]]
This change was made to allow a different menu items and orders on Templates.

===News===

----

This describes how to setup news for the app.

*App News created from UMS Web
*Add a RSS feed
*Add Facebook feed

It is possible to use all three setups together. Combine as you like and set difference feed for difference templates.

====Setup for App News from UMS Web====

You need to create or use an existing AD group. This group will have access to create and modify news in
App News on UMS Web.

#Open UMS Configurator
#Menu -> Web Setup -> Edit -> App
#Add the AD group for News Access group

[[File:App newsaccessgroup.png|none|thumb|767x767px]]

====Setup for RSS feed====
Add server name for the service for RSS feed in Menu -> Modules -> Settings -> RSS Feeds

[[File:App rssfeedservice.png|thumb|none|594x594px]]
To setup Rss feed you will need the url for the rss. (E.g. http://inlogic.dk/feed)

Menu -> Templates -> Edit -> select template -> Rss Feeds

Manage -> Add… -> Fill in description, feed url and access token
[[File:App rssfeedurl.png|none|thumb|920x920px]]
'''Note:''' You only need an access token if the feed is from Facebook

The RSS feed runs as a service called “UMS RSS Feeds”. Default running every 5 min.
[[File:App services.png|none|thumb|561x561px]]
Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log
[[File:App rssfeedlog.png|none|thumb|944x944px]]

====Setup for Facebook news====

If you want to use a Facebook page news feed, you need two things:

*Facebook Page Url Feed
*Access Token

=====Facebook Page Url Feed=====

To create the feed url

#Get your facebook page url
#*E.g. https://www.facebook.com/inlogic.dk
#Copy the name. E.g. “inlogic.dk”
#*Note: this can also be a number “142642699097242”
#Replace “inlogic.dk” with your name in this url
#*<nowiki>https://graph.facebook.com/v3.0/inlogic.dk/</nowiki>

Your facebook page url feed should look something like this:

*<nowiki>https://graph.facebook.com/v3.0/schoolname/</nowiki>

This is your feed URL.

=====Create a facebook access token=====
The personal Facebook account that you use to register as a developer does not need to be associated in any way with the page or group whose posts you want to display. You cannot log in to the Developer site using a Facebook Page or Business account. You must use the username and password from your personal Facebook profile. Facebook doesn’t allow businesses to register as developers, only individuals.

Please follow [https://developers.facebook.com/docs/apps/register Facebook guide] to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to [https://developers.facebook.com/tools/explorer Facebook Graph Explorer]

#Select application
#Select “Get Token” and “Get App Token”
#Copy the Access Token

[[File:App facebookgettoken.png|none|thumb|968x968px]]
Now you have the access token you need to paste into the configurator.
[[File:App rssfeedurl.png|none|thumb|920x920px]]
Reload the service UMS Rss Feed in Services and look in the RSS Feed log to validate.

===Grades===

----

You can set the default view for grades, that filters the grades accordingly. The options are Course, Day and period.

Configurator -> Web Setup -> Edit -> App -> Default grade view
[[File:App gradesview.png|none|thumb|801x801px]]
To specific the period you can set how your terms are set with start and end day for each period.

Configurator -> Modules -> Grades -> Select the Datasource -> Edit -> Terms
[[File:App gradesterms.png|none|thumb|706x706px]]
Depending on which administration system you’re exporting grades from the columns can vary. You can set which grades column should be used and in which order.

Configurator -> Web Setup -> Edit -> App -> Select grade columns
[[File:App gradescolumns.png|none|thumb|709x709px]]
The grades view in the App will change accordingly to which columns chosen, a max of 4 columns will be shown in the App. The columns will be shown for each grade in order from 1 to 4.

If no grade columns settings is made the default columns will be selected in the following order:

*EducationDescription
*CourseDescription
*EvaluationFormDescription
*GradeValue

===Your information===

----

You can select which fields in user information that should be editable.

Configurator -> Web Setup -> Edit -> Userinfo
[[File:App userinfo.png|none|thumb|800x800px]]
You need to set permission before the users are able to upload their own student photo (a selfie).

Configurator -> Web Setup -> Edit -> UMS Photo -> Enable Selfie in App
[[File:App userinfoselfie.png|none|thumb|802x802px]]
This will enable selfie function.

===Student ID And Employee ID===

----<blockquote>''This content has been moved to [[Student / Employee ID]]''</blockquote>

===My Absence===
----The students are able to write an absence reason on an already registered subject. This can be enabled in the template editor.

Select the template -> Absence -> Manage -> Create a new settings or select an existing one -> Add/Edit

Check "Allow students to register absence reason"

[[File:Absence settings.png|none|thumb|570x570px]]

'''Allow students to register absence reason''' will allow the students to set an absence reason when a teacher has set the student as absent. The student can set an absence reason in "My absence".

'''Days back''' is the number of days back the students are allowed to set an absence reason.

'''Show Course''' will show the course view (this will effect both web and app).

'''Show Activity''' will show the activity view (this will effect both web and app).

===Push Notification===
----<blockquote>'''''Temporarily disabled'''''</blockquote>UMS can send push notifications when there are news, grades, or changes in your timetable. It is possible to receive a daily notification with your timetable for the day.

In addition the app can receive [[SMS Alert]] messages.

To set up push notifications go to Web Setup -> App -> Manage -> Add
[[File:AppPushNotificationSettings.png|none|thumb|526x526px]]

Set the description

FCM Server Api Key:

#Receive the key string from inLogic and paste it

Windows Phone:

#Receive the Package SID and Client secret from inLogic and paste the strings

====School account====
In case the school has it's own account do the following to retrieve the information

FCM Server Api Key:

#Open https://play.google.com/apps/publish
#Google Play Console -> Settings -> API Access -> Create linked project and open it -> Credentials
#Create API Key
#Select the API Key and make key restriction for Android
#Type in your package name and SHA-1 certificate fingerprint
#Copy the API key and paste it inside FCM Server API Key

Windows Phone:

#Open https://developer.microsoft.com/en-us/dashboard/apps/overview
#Select your app
#Services -> Push notification -> WNS/MPNS
#Select "Live Services site"
#Copy and paste the Package SID into the configurator
#Generate an Application Secret if none exist
#Copy and paste the Application Secret into the configurator (This is the Client Secret)

===Links===
----[[UMS Links]] can be used by both UMS Web and UMS App. Check the [[UMS Links|guide]].

===Homework===
----See [[UMS Homework]]

===Parking===
----See [[Parking]]

===Notify absence===
----See [[Attendance Registration#SMS and App settings for notify absence|App settings for notify absence in attendance registration]]

===Sms Alert===
----See [[SMS Alert]]

===Privacy Policy===
----To add your own privary policy in the app go to Web Setup -> App

Insert into "Privacy Policy Url:"

If left empty privacy policy will not be shown.

InLogic has a default privacy policy "https://www.inlogic.dk/om-inlogic/privacy-policy/", you can refer to it, but we take no responsibility if you deviate from said policy.
[[File:App privacypolicyurl.png|none|thumb|792x792px]]

To add it to the App Store login

#https://appstoreconnect.apple.com/
#My Apps
#Select the app
#Select the top menu App Store
#Select App Information in the left menu
#Add your privacy policy url to "Privacy Policy URL"

[[File:App appstore privacypolicy.png|none|thumb|955x955px]] 
===Force language setting===
----Should you wish to, you have the option to force the language of the app to use a specific language, rather than the phones default language.

This is changed via the 'Forced language' feature in the Configurator.
[[File:Forced language.png|none|frame]]
The list of languages will expand over time, as UMS adds support for new languages.
 

==Custom localization resources==
see [[Custom Terms and Localization]]
 

==When changes take effect==
Changes to settings are effectuated in the app and different times, depending on what kind of change it is. The vast amount of changes will be template changes and are more or less instant, though there are exceptions.
{| class="wikitable"
|+Change Table
!Change Type
!When change takes effect
|-
|Setup changes
|IIS/Frontend Restart
|-
|Template changes
|Instant (in app needs to reload the page it is on for that to update
|-
|Changes to links
|Re-login
|}

==FAQ==

===Untrusted Certificate Error on Android===
'''''We do not recommend using Comodo certificates since they have been known to cause these issues.'''''

Can't login on some Android devices? This could be due to an untrusted Comodo SSL Certificate. We were able to reproduced it on Android version 4.1, 4.4.2, 5.0.1 and 8.1.0, but it may be present on any number of versions.

You can test your SSL certificate on https://sslanalyzer.comodoca.com/

Do the following on the server

#Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
#Enable automatic root certificate updates on the server

Please checkout the Comodo support site: https://support.comodo.com/index.php?/Knowledgebase/Article/View/1019/38/untrusted-certificate-error-on-android

For future conservation:<blockquote>Certificate is not installed correctly; the certificate needs to be chained back to the Addtrust root certificate in order to be trusted on the Android.</blockquote><blockquote>The issue is that the Windows server is not presenting the complete certificate chain; clients which do not have the complete certificate chain will result in this error as encountered on the Android phone. In order to resolve this, on the server which this certificate is installed on, please open the MMC (Microsoft Management Console), and add the certificate snap-in for the computer account on the local computer.</blockquote><blockquote>In the Intermediate Certification Authorities folder, verify if the Comodo RSA Domain Validation Secure Server CA and Comodo RSA Certification Authority(issued to Comodo RSA Certification Authority, issued by AddTrustExternal CA Root) are installed in this certificate store.</blockquote><blockquote>In the Trusted Root Certification Authorities folder verify if the AddTrustExternal CA Root is installed. Also, if you see the Comodo RSA Certification Authority (issued to and issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038) is present, if it is please delete this certificate.</blockquote><blockquote>If any of these certificates are missing the intermediate and root certificates were provided to you in the .zip file when the certificate was issued, or are available via this support article - <nowiki>https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2</nowiki> .</blockquote><blockquote>If you had to delete the Comodo RSA Certification Authority from the Trusted Root Authorities folder, you will also need to disable automatic root certificate updates on the server - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008</blockquote><blockquote>If you have performed these steps and the certificate chain has not updated on the server, to force IIS to update the certificate chain you will need to either change the certificate binding in IIS to another certificate, and then switch the certificate bindings to the correct certificate. Alternately, you will need to restart the server.</blockquote>Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008<blockquote>To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.</blockquote><blockquote>To turn off Automatic Root Certificates Update:</blockquote><blockquote>1. Click Start, and then click Run.</blockquote><blockquote>2. Type gpedit.msc, and then click OK.</blockquote><blockquote>3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.</blockquote><blockquote>4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.</blockquote><blockquote>5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.</blockquote><blockquote>6. Close the Local Group Policy Editor.</blockquote><blockquote>Note: You can use Group Policy to set policy settings that apply across a given site, domain, or organizational unit in Active Directory Domain Services.</blockquote>

===Issues with the app===
If you're facing issues with the app, please perform the following steps before contacting support:

*Check the AppStore/GooglePlay for app updates and install any present
*Shut down the app completely, and start it back up
*Restart the phone
*Uninstall the app, and redownload it from AppStore/GooglePlay

 

=== Known issues ===
A small incomplete list of known issues and potential workarounds that may resolve them, if you do not find your issue here please contact the inlogic support on helpdesk and we will investigate and fix it / explain the issue if it is setup related.

* Unable to startup app when it has previously been able to and was logged in
** 1 of the issues that causes this is the cached login token not working or the school website being down or a combo of these. To fix this you can reinstall the app.
** Other causes are being looked into.
* "Unknown push notification, please contact your school it-department", app received a push notification of a type we do not support.
** The current theory is that virus or app/tools installed on the phone use the info to send push to the phone, it is possible a factory reset may fix it, but we have not been able to reproduce it on any of our devices. We are looking into it with what we have available.
*IOS 16 phones (usually so far reported to by iphone 14), have hangups on login that make them unable to login
**We are looking into this issue with multiple schools trying to replicate it, and planning a test to solve the issue (november 2022).
*Android doesn't clear all data/settings when uninstalling/reinstalling
**We are trying to fix this issue with patch 3.7.1 by disabling the android cloud backup for the app.

Student / Employee ID

2023-02-08T14:37:25Z

Kpe: Added explanation and exaple for conditional fields.

<blockquote>''This is a submodule available in [[App|UMS App]]''</blockquote>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
[[File:Updated Studentcard configurator.png|left|thumb|Studentcard setup view]]

=== 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]]

 

=== 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.
 

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

====== Conditional Fields ======
You can select a field and give it an SQL criteria, which coincides with a "Where" statement, in order to make the field conditional on the value of another field.

* example: You have a student with multiple educations at your institution and he/she has multiple rows in the database because the keep alive still maintains the old one. You want the studentcard to show the currently active education. You use the fields "StudyStart_education and StudyEnd_Education to mark when the education starts and ends.
** Convert(Date,GETDATE()) between DateAdd(DAY, -1, StudyStart_Education) and DateAdd(DAY, 1,StudyEnd_Education)
*** As long as the current date is between the start and end dates of the education that one will be selected, as long as there isn't an overlap between the former education end date and the current education start date. 
==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"'''

[[File:Studentcard backside.png|frameless]]

==FAQ==

*'''I've taken a new photo and it's showing in Your Information, but not on my Student/Employee Card'''
<blockquote>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.</blockquote><blockquote>See [[UMS Photo]] for more info on this module.</blockquote>

*'''The student card backside isn't showing'''
<blockquote>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.</blockquote>

*'''How do I get the student card backside to show?'''
<blockquote>Tap the student card to flip between front and back side.</blockquote>

File:Updated Studentcard configurator.png

2023-02-08T13:48:22Z

Kpe:

Studentcard configurator screenshot with new custom sql conditionals.

UMS Links

2023-01-12T08:26:18Z

Kpe: Clarification on when links are updated in app and web and that they have to be added in the configurator.

The Links function makes it easy for users to access the school’s most frequently used IT-systems and services, e.g. learning management systems, dictionaries, knowledge databases, the school’s social media etc. This way users save time every time they access one of the frequently used services. Time, which can be spent on teaching and learning. Links can be used for UMS School App as well as UMS Web.

==Prerequisites==

===Module requirements===
UMS

===Testing after setup===
Create a link and check it is available on either web or app.

==Installation==

===Opret link via UMS Frontend===
Åben forsiden og log ind.

Find kontrolpanelet på forsiden, den ligger altid som den sidste knap på din forside. Hvis du ikke har adgang til kontrolpanelet, skal du sætte dette op først i configuratoren – guide findes her.
[[File:Linkscontrolpanel.png|none|thumb|584x584px]]

Tryk dig ind på kontrolpanelet
[[File:Linkssamling.png|none|thumb|643x643px]]

Når du er klikket ind på kontrolpanelet vil der være en række muligheder for at sætte diverse systemer op, som bruges igennem ums. Find link samling og vælg den.
[[File:Linksoversigt.png|none|thumb|643x643px]]

Her ses en oversigt over dine links. Det er muligt at oprette, rette og slette links direkte fra oversigten. Oprettelsen af nye links og rettelse af allerede eksisterende links fungere på samme måde. Så lad os oprette vores første link.

Vælg opret link
[[File:Linkscreate.png|none|thumb|638x638px]]

Udfyld felterne

Link tekst: Er overskriften på dit link f.eks ”Fronter”

Beskrivelse: Den beskrivende tekst f.eks ”Se informationer og andet i Fronter”

URL: Er det link som den skal gå til når man trykker på knappen f.eks ”<nowiki>http://www.fronter.com”</nowiki>

Ikon: Det er det ikon som skal vises på knappen. Her er der mulighed for at oplade et direkte eller bruge et allerede eksisterende billede. Billedet skal være i formatet .png. Når et billede er blevet oploadet, vil det være at finde i dropdown menuen.

Når du har oprettet nogle links, skal vi have lagt dem på en template i configuratoren. (Så man kan lave links til de ansatte og andre links til de studerende, hvis jeres templates er sat op til det)

===Opsætning i Configuratoren===
Det hele er styret ved hjælp af templates og links settings. Så når du har oprettet dine links, skal disse samles i en gruppe også bedre kendt som en setting. Når du har lavet dine settings, vil det være muligt at tilføje en sådan setting på en template. Det vil sige at man kan oprette alle sine links og derefter bestemme hvilke grupper af bruger, som vil have disse til rådighed.
[[File:Linkstemplateeditor.png|none|thumb|643x643px]]

Her ses hvordan jeg har lagt min link setting på den template jeg har der hedder ”Elever” – Dette betyder at alle de folk som er på ”Elever”-templaten vil få vist min gruppe af links som hedder ”Test”.

Tryk på ”manage...” for at ændre dine settings. Så får du dette vindue frem.
[[File:Linkssettings.png|none|thumb|570x570px]]

Her kan du se alle dine link settings, som andre settings kendes fra configuratoren.

Når dine links er blevet oprettet enten vha configuratoren eller web, kan de tilføjes inde under link settings i configuratoren.

Lige pt kan disse kun laves i configuratoren, men det er på vej til UMS Web også.

I links dropdownen vil alle de lavede links være at finde.
[[File:Linkssettings2.png|none|thumb|611x611px]]
[[File:Linkssettings3.png|none|thumb|570x570px]]

Hvis man vælger ”Add” vil man blive vist dette vindue. Hvor man kan oprette, rette eller slette sine links.
[[File:Linksadd.png|none|thumb|454x454px]]

==Technical settings==

==FAQ==

* Hvornår træder ændringerne i kraft?
** Webben henter listen under IIS reset, eller når man trykker "genindlæs links for alle". Appen henter links fra webben næste gang man logger ind, hvilket senest er 24 timer efter sidste login.

Push Notifications

2022-12-13T09:05:18Z

Kpe: /* Setup */

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

'''Only 1 hub per UMS installation supported'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

'''In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub.''' 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

Before beginning testing please read the "Known issues" segment as some of these may come up.

===Inlogic support===
[[File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

==When to expect a push notification==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

#Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
#Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
#Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out(sometimes hours), cause unknown.

Users do not currently have a way to know if they are properly registered with the hub in the app, we are contemplating a way to add feedback for this. -You only get response when doing a registration/de-registration action.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions of the frontend and backend as at the time of writting(1. of april 2022) any version newer than the beta should not have this issue.

 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Q: Which OS are supported?<blockquote>A: Currently only android(through google and iOS are supported.</blockquote>

App

2022-11-16T13:30:09Z

Kpe: Added new known issues

[[File:UMS School App.png|frame]]
UMS School App is available for iPhone, Android. It will be designed with the school’s own logo, color and style. The app gives the basic functionality to see:

*News
*Timetable
*Homework
*Grades
*User information

Additional licenses gives the ability to create, edit and see more information from various modules. For an overview of module requirement see "[http://wiki.inlogic.dk/index.php?title=App&section=6&wteswitched=1#Additional_functionality Additional functionality"]

==Support==
We provide regular support for the following and newer versions:

*Android version 7.0. We support the same versions as Google provide security updates for. Find an overview [[wikipedia:Android_version_history#Code_names|here]].

*iOS version 10

*Windows 10 Mobile (version 10)

Please note that it is possible to run older versions. If support for older versions is needed, we offer support at our hourly rate.

==Prerequisites==
===Supported administrative systems===

*Userinfo: Easy-A, SIS, LUDUS and Lectio (Only mobile number).
*Grades: Easy-A, Lectio and SIS
*Homework: Easy-A and SIS.
*Timetable: Easy-A and SIS
*Attendance registration: Timetable data is retrieved from Easy-A, SIS, LUDUS, Tabulex and Lectio. Howerver, absence is only registered to Easy-A

===Module requirements===

*UMS Web (contains and run all the webservice that is required for the app to receive information and communicate with the server)

===Additional functionality===
You get more functionality in the app by having the following modules, these are all optional:

*Attendance Registration: Gives “Your attendance”, which shows student statistics, the student are able to add absence reason and see their absence status in the timetable
*Attendance Registration for UMS School App: gives employee “attendance registration” and student the ability to "report absence"
*Homework: gives the employee the ability to create homework
*Link Collection: gives links/bookmarks the school can setup
*User info: gives “Your information” the ability to edit the information. This also adds the functionality for the user to upload a new profile image (a selfie) to be used in the student id card
*Student & Employee Id: Gives the students a “student id card” and the employees an “employee id card”. To update their student id card profile image you’ll need the “User info” module
*Parking: Parkzone & APCOA Integration. Gives the option to create and edit parking permits from Parkzone and APCOA
*User information (add/edit)

Note: All Attendance functionality requires Attendance Registration.

===Testing after setup===

The app will be tested internally at inLogic before release. The test requires access to a user with relevant data. You can either create a fictional student who is associated to a real course, or alternatively use a real student's account, if the person agrees that the account is being used for a system test of the school's APP.

===What to have ready===

*'''Important''': The UMS site needs to use HTTPS and be public available. It needs a valid SSL certificate.
*Materials that can be used for designing the app. For example: Logo, brochure, design guide line, etc.

*Optional: It is possible for the school to have its own account where the app is located. An account in the App Store cost $99 per year(necessary if the school is not using "My School App"), while an account for Google Play costs a onetime fee of $25. The school self-manage these accounts.

===Physical hardware requirements===

Having a smartphone is a necessity, either an Android, iOS or a Windows 10 Mobile.

===Should third party be contacted===

If the school is using a dedicated hosting service, they have to be informed on how you wish the news feed should be setup.

==Installation and setup==
inLogic will publish and update the app.

If you want your own AppStore and Google Play store pages, you will need your own Apple Developer Account for the iOS version, this is a requirements from Apples Guidelines. [[App Store Connect|Please follow the guide App Store Connect]].

Android and Windows Phone can be published through inLogics account or your schools own account (if you have acquired one). If you have your own account inLogic needs to be informed as well. To publish the app, inLogic needs the following information:

*[[UMS Web]] url address- This is the address that you use wen you access UMS Web. (If you are running any kind of gateway (TMG, UAG etc.) you will need to create rules for the services on UMS Web, contact us for more information)
**''<nowiki>https://*****.dk/</nowiki>''

===My School App===
My school app (Danish: Min skole app) is the inLogic app that is hosted by inLogic, this lets your school get started using the app faster and cheaper, and also there is less maintenance for you.

======What does this mean?======
Pros:

*Lower start-up price.
*No need to set up an Apple Developer account.
*Upon contacting InLogic Support your app can be live within a few hours.
*You can change logo, images & colors after the app is deployed

Cons:

*The app will not be called your schools name on you phone and in AppStore/Google Play, but is instead called 'My school app' (danish: Min skole app), and its app icon cannot be customized.
*When students & teachers starts up the app for the first time, they will need to select their specific school before proceeding to login.

 

=====Setting up My school app=====
<blockquote>Configurator -> Web setup -> App -> Setting</blockquote>
[[File:App levitas settings.png|none|frame]]

Here you need to configure a Primary and Secondary color, as well as a Logo. The Login background and Menu background images are optional.

The first time you set this up, you will need to contact InLogic support, and provide the following:

*A 64x64 pixels version of your logo (this logo is used in the the login dropdown, it will make it easier for users to find your school)
*UMS Web url (See [[App#Installation and setup|Installation and Setup]])

==Styling==
To style the app following is needed:

*Primary color
*Secondary color
*Logo (.png, vector file: .psd, .ai etc.)
*Icon for app logo (.png, vector file: .psd, .ai etc.)

The primary color will mostly be used as the default background color. The secondary color is the highlight color, and will be used when something is active or being activated like a button.

Optional:

*Background image for login (size 1080x1920)
*Background image for top bar of menu (size 1080x480)

===Examples of styling===

*Primary and secondary colors

[[File:App - Timetable view.png|none|thumb|Example of primary and secondary colors used in the app.
The primary color is used in the Header navigation bar, and the secondary color as border on the selected Calendar date
]]

*The schools logo - Max. 1024x576

[[File:Branding-af-app-inLogic-logo.png|none|thumb|Example of the inLogic logo used in the Demo app]]

*App logo - 1024x1024. If not supplied, inLogic will generate an App logo based on the schools logo (does not apply to My School App)

[[File:Simulator Screen Shot - iPhone SE - 2018-05-15 at 12.57.23.png|none|thumb|Example of app logo in use]]

*Login background image - 1080x1920. If not supplied, a white background will be shown, with your logo on top

'''''NOTE: The app will place your logo on top of the background image. This means when you supply a background image, it needs to be without logo on it.'''''[[File:App - Login screen.png|none|thumb|Example of a background image used on the Demo app login screen.
The school logo will be displayed on top of the background image, as seen here
]]

*Menu top bar image - 1080x480. If not supplied, a white background will be shown

[[File:App - Sidebar menu.png|none|thumb|Example of an image used on the Demo app menu view]]

==Technical settings==

The following sections show how to configure the app. This information only applies to services that are directly connected to the app, i.e. how to set up schedule tasks in the app. The only exception is 'UMS RSS Feeds', which is a specific service for app. If a fully detailed setup guide is needed, please go to that specific module.

Some of the configurations are not set up specifically for app, i.e. ParkZone. If you cannot find the setup guide you are looking for, you can find it by searching or on the front page. Please note that some changes made in the configurator not only will affect the app but also UMS Web.

'''Important''' As many settings only loads once the website is initializing, most changes require an IIS reset on the server. The app retrieves settings from UMS once a day, which means that changes will be visible the next time you log in or the next day.

===Menu Settings===

You are able to set the order and which menu buttons should be shown per template for the users

#Open UMS Configurator
#Templates -> Edit -> select a template -> App
#Under Menu order select Manage -> Add
#Write a Description
#Drap and drop the menu you want

[[File:MeunOrderSettings.png|none|thumb|789x789px]]
Here three menubuttons will be visible to the users on that specific template.

===History===
Before version 2.0.917, you used to choose the modules displayed in the app via the Configurator -> Web Setup.

We have moved the menu order into the Configurator -> Template Editor -> App -> Menu order.
[[File:Menu settings history.png|none|thumb|1600x1600px]]
This change was made to allow a different menu items and orders on Templates.

===News===

----

This describes how to setup news for the app.

*App News created from UMS Web
*Add a RSS feed
*Add Facebook feed

It is possible to use all three setups together. Combine as you like and set difference feed for difference templates.

====Setup for App News from UMS Web====

You need to create or use an existing AD group. This group will have access to create and modify news in
App News on UMS Web.

#Open UMS Configurator
#Menu -> Web Setup -> Edit -> App
#Add the AD group for News Access group

[[File:App newsaccessgroup.png|none|thumb|767x767px]]

====Setup for RSS feed====
Add server name for the service for RSS feed in Menu -> Modules -> Settings -> RSS Feeds

[[File:App rssfeedservice.png|thumb|none|594x594px]]
To setup Rss feed you will need the url for the rss. (E.g. http://inlogic.dk/feed)

Menu -> Templates -> Edit -> select template -> Rss Feeds

Manage -> Add… -> Fill in description, feed url and access token
[[File:App rssfeedurl.png|none|thumb|920x920px]]
'''Note:''' You only need an access token if the feed is from Facebook

The RSS feed runs as a service called “UMS RSS Feeds”. Default running every 5 min.
[[File:App services.png|none|thumb|561x561px]]
Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log
[[File:App rssfeedlog.png|none|thumb|944x944px]]

====Setup for Facebook news====

If you want to use a Facebook page news feed, you need two things:

*Facebook Page Url Feed
*Access Token

=====Facebook Page Url Feed=====

To create the feed url

#Get your facebook page url
#*E.g. https://www.facebook.com/inlogic.dk
#Copy the name. E.g. “inlogic.dk”
#*Note: this can also be a number “142642699097242”
#Replace “inlogic.dk” with your name in this url
#*<nowiki>https://graph.facebook.com/v3.0/inlogic.dk/</nowiki>

Your facebook page url feed should look something like this:

*<nowiki>https://graph.facebook.com/v3.0/schoolname/</nowiki>

This is your feed URL.

=====Create a facebook access token=====
The personal Facebook account that you use to register as a developer does not need to be associated in any way with the page or group whose posts you want to display. You cannot log in to the Developer site using a Facebook Page or Business account. You must use the username and password from your personal Facebook profile. Facebook doesn’t allow businesses to register as developers, only individuals.

Please follow [https://developers.facebook.com/docs/apps/register Facebook guide] to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to [https://developers.facebook.com/tools/explorer Facebook Graph Explorer]

#Select application
#Select “Get Token” and “Get App Token”
#Copy the Access Token

[[File:App facebookgettoken.png|none|thumb|968x968px]]
Now you have the access token you need to paste into the configurator.
[[File:App rssfeedurl.png|none|thumb|920x920px]]
Reload the service UMS Rss Feed in Services and look in the RSS Feed log to validate.

===Grades===

----

You can set the default view for grades, that filters the grades accordingly. The options are Course, Day and period.

Configurator -> Web Setup -> Edit -> App -> Default grade view
[[File:App gradesview.png|none|thumb|801x801px]]
To specific the period you can set how your terms are set with start and end day for each period.

Configurator -> Modules -> Grades -> Select the Datasource -> Edit -> Terms
[[File:App gradesterms.png|none|thumb|706x706px]]
Depending on which administration system you’re exporting grades from the columns can vary. You can set which grades column should be used and in which order.

Configurator -> Web Setup -> Edit -> App -> Select grade columns
[[File:App gradescolumns.png|none|thumb|709x709px]]
The grades view in the App will change accordingly to which columns chosen, a max of 4 columns will be shown in the App. The columns will be shown for each grade in order from 1 to 4.

If no grade columns settings is made the default columns will be selected in the following order:

*EducationDescription
*CourseDescription
*EvaluationFormDescription
*GradeValue

===Your information===

----

You can select which fields in user information that should be editable.

Configurator -> Web Setup -> Edit -> Userinfo
[[File:App userinfo.png|none|thumb|800x800px]]
You need to set permission before the users are able to upload their own student photo (a selfie).

Configurator -> Web Setup -> Edit -> UMS Photo -> Enable Selfie in App
[[File:App userinfoselfie.png|none|thumb|802x802px]]
This will enable selfie function.

===Student ID And Employee ID===

----<blockquote>''This content has been moved to [[Student / Employee ID]]''</blockquote>

===My Absence===
----The students are able to write an absence reason on an already registered subject. This can be enabled in the template editor.

Select the template -> Absence -> Manage -> Create a new settings or select an existing one -> Add/Edit

Check "Allow students to register absence reason"

[[File:Absence settings.png|none|thumb|570x570px]]

'''Allow students to register absence reason''' will allow the students to set an absence reason when a teacher has set the student as absent. The student can set an absence reason in "My absence".

'''Days back''' is the number of days back the students are allowed to set an absence reason.

'''Show Course''' will show the course view (this will effect both web and app).

'''Show Activity''' will show the activity view (this will effect both web and app).

===Push Notification===
----<blockquote>'''''Temporarily disabled'''''</blockquote>UMS can send push notifications when there are news, grades, or changes in your timetable. It is possible to receive a daily notification with your timetable for the day.

In addition the app can receive [[SMS Alert]] messages.

To set up push notifications go to Web Setup -> App -> Manage -> Add
[[File:AppPushNotificationSettings.png|none|thumb|526x526px]]

Set the description

FCM Server Api Key:

#Receive the key string from inLogic and paste it

Windows Phone:

#Receive the Package SID and Client secret from inLogic and paste the strings

====School account====
In case the school has it's own account do the following to retrieve the information

FCM Server Api Key:

#Open https://play.google.com/apps/publish
#Google Play Console -> Settings -> API Access -> Create linked project and open it -> Credentials
#Create API Key
#Select the API Key and make key restriction for Android
#Type in your package name and SHA-1 certificate fingerprint
#Copy the API key and paste it inside FCM Server API Key

Windows Phone:

#Open https://developer.microsoft.com/en-us/dashboard/apps/overview
#Select your app
#Services -> Push notification -> WNS/MPNS
#Select "Live Services site"
#Copy and paste the Package SID into the configurator
#Generate an Application Secret if none exist
#Copy and paste the Application Secret into the configurator (This is the Client Secret)

===Links===
----[[UMS Links]] can be used by both UMS Web and UMS App. Check the [[UMS Links|guide]].

===Homework===
----See [[UMS Homework]]

===Parking===
----See [[Parking]]

===Notify absence===
----See [[Attendance Registration#SMS and App settings for notify absence|App settings for notify absence in attendance registration]]

===Sms Alert===
----See [[SMS Alert]]

===Privacy Policy===
----To add your own privary policy in the app go to Web Setup -> App

Insert into "Privacy Policy Url:"

If left empty it will default to inLogic's privacy policy "https://www.inlogic.dk/om-inlogic/privacy-policy/"
[[File:App privacypolicyurl.png|none|thumb|792x792px]]

To add it to the App Store login

#https://appstoreconnect.apple.com/
#My Apps
#Select the app
#Select the top menu App Store
#Select App Information in the left menu
#Add your privacy policy url to "Privacy Policy URL"

[[File:App appstore privacypolicy.png|none|thumb|955x955px]] 
===Force language setting===
----Should you wish to, you have the option to force the language of the app to use a specific language, rather than the phones default language.

This is changed via the 'Forced language' feature in the Configurator.
[[File:Forced language.png|none|frame]]
The list of languages will expand over time, as UMS adds support for new languages.
 

==Custom localization resources==
see [[Custom Terms and Localization]]
 

==When changes take effect==
Changes to settings are effectuated in the app and different times, depending on what kind of change it is. The vast amount of changes will be template changes and are more or less instant, though there are exceptions.
{| class="wikitable"
|+Change Table
!Change Type
!When change takes effect
|-
|Setup changes
|IIS/Frontend Restart
|-
|Template changes
|Instant (in app needs to reload the page it is on for that to update
|-
|Changes to links
|Re-login
|}

==FAQ==

===Untrusted Certificate Error on Android===
'''''We do not recommend using Comodo certificates since they have been known to cause these issues.'''''

Can't login on some Android devices? This could be due to an untrusted Comodo SSL Certificate. We were able to reproduced it on Android version 4.1, 4.4.2, 5.0.1 and 8.1.0, but it may be present on any number of versions.

You can test your SSL certificate on https://sslanalyzer.comodoca.com/

Do the following on the server

#Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
#Enable automatic root certificate updates on the server

Please checkout the Comodo support site: https://support.comodo.com/index.php?/Knowledgebase/Article/View/1019/38/untrusted-certificate-error-on-android

For future conservation:<blockquote>Certificate is not installed correctly; the certificate needs to be chained back to the Addtrust root certificate in order to be trusted on the Android.</blockquote><blockquote>The issue is that the Windows server is not presenting the complete certificate chain; clients which do not have the complete certificate chain will result in this error as encountered on the Android phone. In order to resolve this, on the server which this certificate is installed on, please open the MMC (Microsoft Management Console), and add the certificate snap-in for the computer account on the local computer.</blockquote><blockquote>In the Intermediate Certification Authorities folder, verify if the Comodo RSA Domain Validation Secure Server CA and Comodo RSA Certification Authority(issued to Comodo RSA Certification Authority, issued by AddTrustExternal CA Root) are installed in this certificate store.</blockquote><blockquote>In the Trusted Root Certification Authorities folder verify if the AddTrustExternal CA Root is installed. Also, if you see the Comodo RSA Certification Authority (issued to and issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038) is present, if it is please delete this certificate.</blockquote><blockquote>If any of these certificates are missing the intermediate and root certificates were provided to you in the .zip file when the certificate was issued, or are available via this support article - <nowiki>https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2</nowiki> .</blockquote><blockquote>If you had to delete the Comodo RSA Certification Authority from the Trusted Root Authorities folder, you will also need to disable automatic root certificate updates on the server - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008</blockquote><blockquote>If you have performed these steps and the certificate chain has not updated on the server, to force IIS to update the certificate chain you will need to either change the certificate binding in IIS to another certificate, and then switch the certificate bindings to the correct certificate. Alternately, you will need to restart the server.</blockquote>Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008<blockquote>To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.</blockquote><blockquote>To turn off Automatic Root Certificates Update:</blockquote><blockquote>1. Click Start, and then click Run.</blockquote><blockquote>2. Type gpedit.msc, and then click OK.</blockquote><blockquote>3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.</blockquote><blockquote>4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.</blockquote><blockquote>5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.</blockquote><blockquote>6. Close the Local Group Policy Editor.</blockquote><blockquote>Note: You can use Group Policy to set policy settings that apply across a given site, domain, or organizational unit in Active Directory Domain Services.</blockquote>

===Issues with the app===
If you're facing issues with the app, please perform the following steps before contacting support:

*Check the AppStore/GooglePlay for app updates and install any present
*Shut down the app completely, and start it back up
*Restart the phone
*Uninstall the app, and redownload it from AppStore/GooglePlay

 

=== Known issues ===
A small incomplete list of known issues and potential workarounds that may resolve them, if you do not find your issue here please contact the inlogic support on helpdesk and we will investigate and fix it / explain the issue if it is setup related.

* Unable to startup app when it has previously been able to and was logged in
** 1 of the issues that causes this is the cached login token not working or the school website being down or a combo of these. To fix this you can reinstall the app.
** Other causes are being looked into.
* "Unknown push notification, please contact your school it-department", app received a push notification of a type we do not support.
** The current theory is that virus or app/tools installed on the phone use the info to send push to the phone, it is possible a factory reset may fix it, but we have not been able to reproduce it on any of our devices. We are looking into it with what we have available.
*IOS 16 phones (usually so far reported to by iphone 14), have hangups on login that make them unable to login
**We are looking into this issue with multiple schools trying to replicate it, and planning a test to solve the issue (november 2022).
*Android doesn't clear all data/settings when uninstalling/reinstalling
**We are trying to fix this issue with patch 3.7.1 by disabling the android cloud backup for the app.

Push Notifications

2022-11-15T15:18:34Z

Kpe: /* Known issues */

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

'''Only 1 hub per UMS installation supported'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub. 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

Before beginning testing please read the "Known issues" segment as some of these may come up.

===Inlogic support===
[[File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

==When to expect a push notification==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

#Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
#Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
#Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out(sometimes hours), cause unknown.

Users do not currently have a way to know if they are properly registered with the hub in the app, we are contemplating a way to add feedback for this. -You only get response when doing a registration/de-registration action.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions of the frontend and backend as at the time of writting(1. of april 2022) any version newer than the beta should not have this issue.

 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Q: Which OS are supported?<blockquote>A: Currently only android(through google and iOS are supported.</blockquote>

UMS Web

2022-11-02T13:23:53Z

Kpe: Added short explanation and info on session timeout

We are currently working on the documention....
[[File:Welcomepage.png|none|thumb|954x954px]]

=== Session timeout ===
To help security, in-active users will be logged out after a while.

The default session timer is 20 minutes. But can be edited in the IIS control.

App

2022-08-23T12:40:00Z

Kpe: /* FAQ */ known issues that we know exist but currently don't have a code/permanent solution for

[[File:UMS School App.png|frame]]
UMS School App is available for iPhone, Android. It will be designed with the school’s own logo, color and style. The app gives the basic functionality to see:

*News
*Timetable
*Homework
*Grades
*User information

Additional licenses gives the ability to create, edit and see more information from various modules. For an overview of module requirement see "[http://wiki.inlogic.dk/index.php?title=App&section=6&wteswitched=1#Additional_functionality Additional functionality"]

==Support==
We provide regular support for the following and newer versions:

*Android version 7.0. We support the same versions as Google provide security updates for. Find an overview [[wikipedia:Android_version_history#Code_names|here]].

*iOS version 10

*Windows 10 Mobile (version 10)

Please note that it is possible to run older versions. If support for older versions is needed, we offer support at our hourly rate.

==Prerequisites==
===Supported administrative systems===

*Userinfo: Easy-A, SIS, LUDUS and Lectio (Only mobile number).
*Grades: Easy-A, Lectio and SIS
*Homework: Easy-A and SIS.
*Timetable: Easy-A and SIS
*Attendance registration: Timetable data is retrieved from Easy-A, SIS, LUDUS, Tabulex and Lectio. Howerver, absence is only registered to Easy-A

===Module requirements===

*UMS Web (contains and run all the webservice that is required for the app to receive information and communicate with the server)

===Additional functionality===
You get more functionality in the app by having the following modules, these are all optional:

*Attendance Registration: Gives “Your attendance”, which shows student statistics, the student are able to add absence reason and see their absence status in the timetable
*Attendance Registration for UMS School App: gives employee “attendance registration” and student the ability to "report absence"
*Homework: gives the employee the ability to create homework
*Link Collection: gives links/bookmarks the school can setup
*User info: gives “Your information” the ability to edit the information. This also adds the functionality for the user to upload a new profile image (a selfie) to be used in the student id card
*Student & Employee Id: Gives the students a “student id card” and the employees an “employee id card”. To update their student id card profile image you’ll need the “User info” module
*Parking: Parkzone & APCOA Integration. Gives the option to create and edit parking permits from Parkzone and APCOA
*User information (add/edit)

Note: All Attendance functionality requires Attendance Registration.

===Testing after setup===

The app will be tested internally at inLogic before release. The test requires access to a user with relevant data. You can either create a fictional student who is associated to a real course, or alternatively use a real student's account, if the person agrees that the account is being used for a system test of the school's APP.

===What to have ready===

*'''Important''': The UMS site needs to use HTTPS and be public available. It needs a valid SSL certificate.
*Materials that can be used for designing the app. For example: Logo, brochure, design guide line, etc.

*Optional: It is possible for the school to have its own account where the app is located. An account in the App Store cost $99 per year(necessary if the school is not using "My School App"), while an account for Google Play costs a onetime fee of $25. The school self-manage these accounts.

===Physical hardware requirements===

Having a smartphone is a necessity, either an Android, iOS or a Windows 10 Mobile.

===Should third party be contacted===

If the school is using a dedicated hosting service, they have to be informed on how you wish the news feed should be setup.

==Installation and setup==
inLogic will publish and update the app.

If you want your own AppStore and Google Play store pages, you will need your own Apple Developer Account for the iOS version, this is a requirements from Apples Guidelines. [[App Store Connect|Please follow the guide App Store Connect]].

Android and Windows Phone can be published through inLogics account or your schools own account (if you have acquired one). If you have your own account inLogic needs to be informed as well. To publish the app, inLogic needs the following information:

*[[UMS Web]] url address- This is the address that you use wen you access UMS Web. (If you are running any kind of gateway (TMG, UAG etc.) you will need to create rules for the services on UMS Web, contact us for more information)
**''<nowiki>https://*****.dk/</nowiki>''

===My School App===
My school app (Danish: Min skole app) is the inLogic app that is hosted by inLogic, this lets your school get started using the app faster and cheaper, and also there is less maintenance for you.

======What does this mean?======
Pros:

*Lower start-up price.
*No need to set up an Apple Developer account.
*Upon contacting InLogic Support your app can be live within a few hours.
*You can change logo, images & colors after the app is deployed

Cons:

*The app will not be called your schools name on you phone and in AppStore/Google Play, but is instead called 'My school app' (danish: Min skole app), and its app icon cannot be customized.
*When students & teachers starts up the app for the first time, they will need to select their specific school before proceeding to login.

 

=====Setting up My school app=====
<blockquote>Configurator -> Web setup -> App -> Setting</blockquote>
[[File:App levitas settings.png|none|frame]]

Here you need to configure a Primary and Secondary color, as well as a Logo. The Login background and Menu background images are optional.

The first time you set this up, you will need to contact InLogic support, and provide the following:

*A 64x64 pixels version of your logo (this logo is used in the the login dropdown, it will make it easier for users to find your school)
*UMS Web url (See [[App#Installation and setup|Installation and Setup]])

==Styling==
To style the app following is needed:

*Primary color
*Secondary color
*Logo (.png, vector file: .psd, .ai etc.)
*Icon for app logo (.png, vector file: .psd, .ai etc.)

The primary color will mostly be used as the default background color. The secondary color is the highlight color, and will be used when something is active or being activated like a button.

Optional:

*Background image for login (size 1080x1920)
*Background image for top bar of menu (size 1080x480)

===Examples of styling===

*Primary and secondary colors

[[File:App - Timetable view.png|none|thumb|Example of primary and secondary colors used in the app.
The primary color is used in the Header navigation bar, and the secondary color as border on the selected Calendar date
]]

*The schools logo - Max. 1024x576

[[File:Branding-af-app-inLogic-logo.png|none|thumb|Example of the inLogic logo used in the Demo app]]

*App logo - 1024x1024. If not supplied, inLogic will generate an App logo based on the schools logo (does not apply to My School App)

[[File:Simulator Screen Shot - iPhone SE - 2018-05-15 at 12.57.23.png|none|thumb|Example of app logo in use]]

*Login background image - 1080x1920. If not supplied, a white background will be shown, with your logo on top

'''''NOTE: The app will place your logo on top of the background image. This means when you supply a background image, it needs to be without logo on it.'''''[[File:App - Login screen.png|none|thumb|Example of a background image used on the Demo app login screen.
The school logo will be displayed on top of the background image, as seen here
]]

*Menu top bar image - 1080x480. If not supplied, a white background will be shown

[[File:App - Sidebar menu.png|none|thumb|Example of an image used on the Demo app menu view]]

==Technical settings==

The following sections show how to configure the app. This information only applies to services that are directly connected to the app, i.e. how to set up schedule tasks in the app. The only exception is 'UMS RSS Feeds', which is a specific service for app. If a fully detailed setup guide is needed, please go to that specific module.

Some of the configurations are not set up specifically for app, i.e. ParkZone. If you cannot find the setup guide you are looking for, you can find it by searching or on the front page. Please note that some changes made in the configurator not only will affect the app but also UMS Web.

'''Important''' As many settings only loads once the website is initializing, most changes require an IIS reset on the server. The app retrieves settings from UMS once a day, which means that changes will be visible the next time you log in or the next day.

===Menu Settings===

You are able to set the order and which menu buttons should be shown per template for the users

#Open UMS Configurator
#Templates -> Edit -> select a template -> App
#Under Menu order select Manage -> Add
#Write a Description
#Drap and drop the menu you want

[[File:MeunOrderSettings.png|none|thumb|789x789px]]
Here three menubuttons will be visible to the users on that specific template.

===History===
Before version 2.0.917, you used to choose the modules displayed in the app via the Configurator -> Web Setup.

We have moved the menu order into the Configurator -> Template Editor -> App -> Menu order.
[[File:Menu settings history.png|none|thumb|1600x1600px]]
This change was made to allow a different menu items and orders on Templates.

===News===

----

This describes how to setup news for the app.

*App News created from UMS Web
*Add a RSS feed
*Add Facebook feed

It is possible to use all three setups together. Combine as you like and set difference feed for difference templates.

====Setup for App News from UMS Web====

You need to create or use an existing AD group. This group will have access to create and modify news in
App News on UMS Web.

#Open UMS Configurator
#Menu -> Web Setup -> Edit -> App
#Add the AD group for News Access group

[[File:App newsaccessgroup.png|none|thumb|767x767px]]

====Setup for RSS feed====
Add server name for the service for RSS feed in Menu -> Modules -> Settings -> RSS Feeds

[[File:App rssfeedservice.png|thumb|none|594x594px]]
To setup Rss feed you will need the url for the rss. (E.g. http://inlogic.dk/feed)

Menu -> Templates -> Edit -> select template -> Rss Feeds

Manage -> Add… -> Fill in description, feed url and access token
[[File:App rssfeedurl.png|none|thumb|920x920px]]
'''Note:''' You only need an access token if the feed is from Facebook

The RSS feed runs as a service called “UMS RSS Feeds”. Default running every 5 min.
[[File:App services.png|none|thumb|561x561px]]
Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log
[[File:App rssfeedlog.png|none|thumb|944x944px]]

====Setup for Facebook news====

If you want to use a Facebook page news feed, you need two things:

*Facebook Page Url Feed
*Access Token

=====Facebook Page Url Feed=====

To create the feed url

#Get your facebook page url
#*E.g. https://www.facebook.com/inlogic.dk
#Copy the name. E.g. “inlogic.dk”
#*Note: this can also be a number “142642699097242”
#Replace “inlogic.dk” with your name in this url
#*<nowiki>https://graph.facebook.com/v3.0/inlogic.dk/</nowiki>

Your facebook page url feed should look something like this:

*<nowiki>https://graph.facebook.com/v3.0/schoolname/</nowiki>

This is your feed URL.

=====Create a facebook access token=====
The personal Facebook account that you use to register as a developer does not need to be associated in any way with the page or group whose posts you want to display. You cannot log in to the Developer site using a Facebook Page or Business account. You must use the username and password from your personal Facebook profile. Facebook doesn’t allow businesses to register as developers, only individuals.

Please follow [https://developers.facebook.com/docs/apps/register Facebook guide] to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to [https://developers.facebook.com/tools/explorer Facebook Graph Explorer]

#Select application
#Select “Get Token” and “Get App Token”
#Copy the Access Token

[[File:App facebookgettoken.png|none|thumb|968x968px]]
Now you have the access token you need to paste into the configurator.
[[File:App rssfeedurl.png|none|thumb|920x920px]]
Reload the service UMS Rss Feed in Services and look in the RSS Feed log to validate.

===Grades===

----

You can set the default view for grades, that filters the grades accordingly. The options are Course, Day and period.

Configurator -> Web Setup -> Edit -> App -> Default grade view
[[File:App gradesview.png|none|thumb|801x801px]]
To specific the period you can set how your terms are set with start and end day for each period.

Configurator -> Modules -> Grades -> Select the Datasource -> Edit -> Terms
[[File:App gradesterms.png|none|thumb|706x706px]]
Depending on which administration system you’re exporting grades from the columns can vary. You can set which grades column should be used and in which order.

Configurator -> Web Setup -> Edit -> App -> Select grade columns
[[File:App gradescolumns.png|none|thumb|709x709px]]
The grades view in the App will change accordingly to which columns chosen, a max of 4 columns will be shown in the App. The columns will be shown for each grade in order from 1 to 4.

If no grade columns settings is made the default columns will be selected in the following order:

*EducationDescription
*CourseDescription
*EvaluationFormDescription
*GradeValue

===Your information===

----

You can select which fields in user information that should be editable.

Configurator -> Web Setup -> Edit -> Userinfo
[[File:App userinfo.png|none|thumb|800x800px]]
You need to set permission before the users are able to upload their own student photo (a selfie).

Configurator -> Web Setup -> Edit -> UMS Photo -> Enable Selfie in App
[[File:App userinfoselfie.png|none|thumb|802x802px]]
This will enable selfie function.

===Student ID And Employee ID===

----<blockquote>''This content has been moved to [[Student / Employee ID]]''</blockquote>

===My Absence===
----The students are able to write an absence reason on an already registered subject. This can be enabled in the template editor.

Select the template -> Absence -> Manage -> Create a new settings or select an existing one -> Add/Edit

Check "Allow students to register absence reason"

[[File:Absence settings.png|none|thumb|570x570px]]

'''Allow students to register absence reason''' will allow the students to set an absence reason when a teacher has set the student as absent. The student can set an absence reason in "My absence".

'''Days back''' is the number of days back the students are allowed to set an absence reason.

'''Show Course''' will show the course view (this will effect both web and app).

'''Show Activity''' will show the activity view (this will effect both web and app).

===Push Notification===
----<blockquote>'''''Temporarily disabled'''''</blockquote>UMS can send push notifications when there are news, grades, or changes in your timetable. It is possible to receive a daily notification with your timetable for the day.

In addition the app can receive [[SMS Alert]] messages.

To set up push notifications go to Web Setup -> App -> Manage -> Add
[[File:AppPushNotificationSettings.png|none|thumb|526x526px]]

Set the description

FCM Server Api Key:

#Receive the key string from inLogic and paste it

Windows Phone:

#Receive the Package SID and Client secret from inLogic and paste the strings

====School account====
In case the school has it's own account do the following to retrieve the information

FCM Server Api Key:

#Open https://play.google.com/apps/publish
#Google Play Console -> Settings -> API Access -> Create linked project and open it -> Credentials
#Create API Key
#Select the API Key and make key restriction for Android
#Type in your package name and SHA-1 certificate fingerprint
#Copy the API key and paste it inside FCM Server API Key

Windows Phone:

#Open https://developer.microsoft.com/en-us/dashboard/apps/overview
#Select your app
#Services -> Push notification -> WNS/MPNS
#Select "Live Services site"
#Copy and paste the Package SID into the configurator
#Generate an Application Secret if none exist
#Copy and paste the Application Secret into the configurator (This is the Client Secret)

===Links===
----[[UMS Links]] can be used by both UMS Web and UMS App. Check the [[UMS Links|guide]].

===Homework===
----See [[UMS Homework]]

===Parking===
----See [[Parking]]

===Notify absence===
----See [[Attendance Registration#SMS and App settings for notify absence|App settings for notify absence in attendance registration]]

===Sms Alert===
----See [[SMS Alert]]

===Privacy Policy===
----To add your own privary policy in the app go to Web Setup -> App

Insert into "Privacy Policy Url:"

If left empty it will default to inLogic's privacy policy "https://www.inlogic.dk/om-inlogic/privacy-policy/"
[[File:App privacypolicyurl.png|none|thumb|792x792px]]

To add it to the App Store login

#https://appstoreconnect.apple.com/
#My Apps
#Select the app
#Select the top menu App Store
#Select App Information in the left menu
#Add your privacy policy url to "Privacy Policy URL"

[[File:App appstore privacypolicy.png|none|thumb|955x955px]] 
===Force language setting===
----Should you wish to, you have the option to force the language of the app to use a specific language, rather than the phones default language.

This is changed via the 'Forced language' feature in the Configurator.
[[File:Forced language.png|none|frame]]
The list of languages will expand over time, as UMS adds support for new languages.
 

==Custom localization resources==
see [[Custom Terms and Localization]]
 

==When changes take effect==
Changes to settings are effectuated in the app and different times, depending on what kind of change it is. The vast amount of changes will be template changes and are more or less instant, though there are exceptions.
{| class="wikitable"
|+Change Table
!Change Type
!When change takes effect
|-
|Setup changes
|IIS/Frontend Restart
|-
|Template changes
|Instant (in app needs to reload the page it is on for that to update
|-
|Changes to links
|Re-login
|}

==FAQ==

===Untrusted Certificate Error on Android===
'''''We do not recommend using Comodo certificates since they have been known to cause these issues.'''''

Can't login on some Android devices? This could be due to an untrusted Comodo SSL Certificate. We were able to reproduced it on Android version 4.1, 4.4.2, 5.0.1 and 8.1.0, but it may be present on any number of versions.

You can test your SSL certificate on https://sslanalyzer.comodoca.com/

Do the following on the server

#Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
#Enable automatic root certificate updates on the server

Please checkout the Comodo support site: https://support.comodo.com/index.php?/Knowledgebase/Article/View/1019/38/untrusted-certificate-error-on-android

For future conservation:<blockquote>Certificate is not installed correctly; the certificate needs to be chained back to the Addtrust root certificate in order to be trusted on the Android.</blockquote><blockquote>The issue is that the Windows server is not presenting the complete certificate chain; clients which do not have the complete certificate chain will result in this error as encountered on the Android phone. In order to resolve this, on the server which this certificate is installed on, please open the MMC (Microsoft Management Console), and add the certificate snap-in for the computer account on the local computer.</blockquote><blockquote>In the Intermediate Certification Authorities folder, verify if the Comodo RSA Domain Validation Secure Server CA and Comodo RSA Certification Authority(issued to Comodo RSA Certification Authority, issued by AddTrustExternal CA Root) are installed in this certificate store.</blockquote><blockquote>In the Trusted Root Certification Authorities folder verify if the AddTrustExternal CA Root is installed. Also, if you see the Comodo RSA Certification Authority (issued to and issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038) is present, if it is please delete this certificate.</blockquote><blockquote>If any of these certificates are missing the intermediate and root certificates were provided to you in the .zip file when the certificate was issued, or are available via this support article - <nowiki>https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2</nowiki> .</blockquote><blockquote>If you had to delete the Comodo RSA Certification Authority from the Trusted Root Authorities folder, you will also need to disable automatic root certificate updates on the server - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008</blockquote><blockquote>If you have performed these steps and the certificate chain has not updated on the server, to force IIS to update the certificate chain you will need to either change the certificate binding in IIS to another certificate, and then switch the certificate bindings to the correct certificate. Alternately, you will need to restart the server.</blockquote>Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008<blockquote>To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.</blockquote><blockquote>To turn off Automatic Root Certificates Update:</blockquote><blockquote>1. Click Start, and then click Run.</blockquote><blockquote>2. Type gpedit.msc, and then click OK.</blockquote><blockquote>3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.</blockquote><blockquote>4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.</blockquote><blockquote>5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.</blockquote><blockquote>6. Close the Local Group Policy Editor.</blockquote><blockquote>Note: You can use Group Policy to set policy settings that apply across a given site, domain, or organizational unit in Active Directory Domain Services.</blockquote>

===Issues with the app===
If you're facing issues with the app, please perform the following steps before contacting support:

*Check the AppStore/GooglePlay for app updates and install any present
*Shut down the app completely, and start it back up
*Restart the phone
*Uninstall the app, and redownload it from AppStore/GooglePlay

 

=== Known issues ===
A small incomplete list of known issues and potential workarounds that may resolve them, if you do not find your issue here please contact the inlogic support on helpdesk and we will investigate and fix it / explain the issue if it is setup related.

* Unable to startup app when it has previously been able to and was logged in
** 1 of the issues that causes this is the cached login token not working or the school website being down or a combo of these. To fix this you can reinstall the app.
** Other causes are being looked into.
* "Unknown push notification, please contact your school it-department", app received a push notification of a type we do not support.
** The current theory is that virus or app/tools installed on the phone use the info to send push to the phone, it is possible a factory reset may fix it, but we have not been able to reproduce it on any of our devices. We are looking into it with what we have available.

Username Generator

2022-07-06T10:47:29Z

Kpe: /* 2 letters of first name followed by 2 letters of last name and Autonumber. */

This is used to generate usernames for users in UMS.

==Steps==
First you need to create some options for the setting your going to create later on.

Then add the database replacements.

Then create a setting with a list of prioritized options.

Finally add a username setting to the template that needs this.

==Options==

====AddString====
This option lets you add a fixed string to the username
[[File:UsernameGenerator Options AddString.jpg|none|thumb|656x656px]]

====AutoNumber====
This option lets you add a number to the username.
[[File:UsernameGenerator Options AutoNumber.jpg|none|thumb|656x656px]]

You can define the starting number and pad left to make sure it has the correct length.

If you set the start number to 1 and set pad left to 4, the number will be 0001

This number will automatically increase when a duplicate string is found in username.

'''eg - If the username starts with AB then it will return AB0001'''

'''AB0001 (first instance autonumber)'''

'''AC0001 (first instance autonumber)'''

'''AD0001 (first instance autonumber)'''

'''AB0002 (next instance autonumber)'''

The username number is stored in the database in the table "UsernameGenerator_Numbers"

====DBField====
This option lets you take a field from the database table ImportFromDB and use as a starting string.
[[File:UsernameGenerator Options DBField.jpg|none|thumb|656x656px]]

====LowerCase====
This lowercases the username.
[[File:UsernameGenerator Options LowerCase.jpg|none|thumb|656x656px]]

====Pad====
This lets you pad the username either left or right with a character you specify and a length.
[[File:UsernameGenerator Options Pad.jpg|none|thumb|656x656px]]
If you pad 12 right and the username is AB it will return ABkkkkkkkkkk.

====Replace====
This lets you replace characters in the username with new characters or blank.
[[File:UsernameGenerator Options Replace.jpg|none|thumb|656x656px]]

If you check "Use replace from database table" it will use this feature "Database replacements".
[[File:UsernameGenerator Options DBReplace.jpg|none|thumb|656x656px]]
 

====Replace all non alphanumeric====
This will replace all characters in the username that are not within these ranges with the new string or blank

a-z

A-Z

0-9

-
[[File:UsernameGenerator Options ReplaceAllNonAlphanumeric.jpg|none|thumb|765x765px]]

====Substring====
This will replace a part of the username with a new string or blank.
[[File:UsernameGenerator Options SubString.jpg|none|thumb|656x656px]]
====Uppercase====
This uppercases the username.
[[File:UsernameGenerator Options UpperCase.jpg|none|thumb|656x656px]]

==Database replacements==
Define the strings you want to have replace with new or blank string.
[[File:UsernameGenerator Database replacements.jpg|none|thumb|492x492px]]
When it looks at a username it will run through all the rows and replace them if they are found.

 

==Example as uni-login==

===2 first letters of first name followed by 2 first letters of last name and Autonumber.===

===Create these Option:===

*First name: Create option that retrieves first name from DBfield
*Last Name : Create option that retrieves last name from DBfield
*AutoNumber : Create option autonumber. As shown below in Autonumber picture
*DB Replace: Create option DB replace, which change å, ø, å etc. As shown below in DB Replacement picture.
*First 2 characters : Create option take first 2 characters. As shown below in first 2 characters picture.
*First 4 characters : Create option take first 4 characters. As shown below in first 4 characters picture.
*Pad Right 2: Create option Pad Right 2. As shown below in Pad Right 2 picture.
*Pad Right 4: Create option Pad Right 4. As shown below in Pad Right 4 picture.
*Replace all non alphanumeric
*LowerCase ALL

Vicktor Jeppesen : VIJE0123

Tonny Thomsen : TOTH0124

Sultan Kirkegård SUKI0125

Autonumber starts at 123 and runs up. Padding character 0 and pad length 4. e.g. Sultan Kirkegård S U K I 0 1 2 3
[[File:Skærmbillede 2022-07-06 090457.png|none|thumb|489x489px]]

DB Replacement.
[[File:Replacement.png|none|thumb|491x491px]]

First 2 characters.
[[File:First2chara.png|none|thumb|491x491px]]

First 4 characters
[[File:First4.png|none|thumb|495x495px]]
Pad right 2 (J Hansen) Username = JFHA
[[File:Imagesdf.png|none|thumb|514x514px]]

Pad Right 4 (Jan H) Username = JAHF
[[File:Sds.png|none|thumb|520x520px]]

==Settings==
This is where you create a prioritized list options. This setting is then attached to a template.
[[File:UsernameGenerator Settings.jpg|none|thumb|383x383px]]

Push Notifications

2022-06-27T13:30:23Z

Kpe:

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

'''Only 1 hub per UMS installation supported'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub. 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

Before beginning testing please read the "Known issues" segment as some of these may come up.

===Inlogic support===
[[File:TestsendImage.png|link=http://wiki.inlogic.dk/index.php/File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

==When to expect a push notification==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

#Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
#Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
#Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out, cause unknown.

Users do not currently have a way to know if they are properly registered with the hub in the app, we are contemplating a way to add feedback for this.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions of the frontend and backend as at the time of writting(1. of april 2022) any version never than the beta should not have this issue.

 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Q: Which OS are supported?<blockquote>A: Currently only android(through google and iOS are supported.</blockquote>

App

2022-06-22T09:35:47Z

Kpe:

[[File:UMS School App.png|frame]]
UMS School App is available for iPhone, Android. It will be designed with the school’s own logo, color and style. The app gives the basic functionality to see:

*News
*Timetable
*Homework
*Grades
*User information

Additional licenses gives the ability to create, edit and see more information from various modules. For an overview of module requirement see "[http://wiki.inlogic.dk/index.php?title=App&section=6&wteswitched=1#Additional_functionality Additional functionality"]

==Support==
We provide regular support for the following and newer versions:

*Android version 7.0. We support the same versions as Google provide security updates for. Find an overview [[wikipedia:Android_version_history#Code_names|here]].

*iOS version 10

*Windows 10 Mobile (version 10)

Please note that it is possible to run older versions. If support for older versions is needed, we offer support at our hourly rate.

==Prerequisites==
===Supported administrative systems===

*Userinfo: Easy-A, SIS, LUDUS and Lectio (Only mobile number).
*Grades: Easy-A, Lectio and SIS
*Homework: Easy-A and SIS.
*Timetable: Easy-A and SIS
*Attendance registration: Timetable data is retrieved from Easy-A, SIS, LUDUS, Tabulex and Lectio. Howerver, absence is only registered to Easy-A

===Module requirements===

*UMS Web (contains and run all the webservice that is required for the app to receive information and communicate with the server)

===Additional functionality===
You get more functionality in the app by having the following modules, these are all optional:

*Attendance Registration: Gives “Your attendance”, which shows student statistics, the student are able to add absence reason and see their absence status in the timetable
*Attendance Registration for UMS School App: gives employee “attendance registration” and student the ability to "report absence"
*Homework: gives the employee the ability to create homework
*Link Collection: gives links/bookmarks the school can setup
*User info: gives “Your information” the ability to edit the information. This also adds the functionality for the user to upload a new profile image (a selfie) to be used in the student id card
*Student & Employee Id: Gives the students a “student id card” and the employees an “employee id card”. To update their student id card profile image you’ll need the “User info” module
*Parking: Parkzone & APCOA Integration. Gives the option to create and edit parking permits from Parkzone and APCOA
*User information (add/edit)

Note: All Attendance functionality requires Attendance Registration.

===Testing after setup===

The app will be tested internally at inLogic before release. The test requires access to a user with relevant data. You can either create a fictional student who is associated to a real course, or alternatively use a real student's account, if the person agrees that the account is being used for a system test of the school's APP.

===What to have ready===

*'''Important''': The UMS site needs to use HTTPS and be public available. It needs a valid SSL certificate.
*Materials that can be used for designing the app. For example: Logo, brochure, design guide line, etc.

*Optional: It is possible for the school to have its own account where the app is located. An account in the App Store cost $99 per year(necessary if the school is not using "My School App"), while an account for Google Play costs a onetime fee of $25. The school self-manage these accounts.

===Physical hardware requirements===

Having a smartphone is a necessity, either an Android, iOS or a Windows 10 Mobile.

===Should third party be contacted===

If the school is using a dedicated hosting service, they have to be informed on how you wish the news feed should be setup.

==Installation and setup==
inLogic will publish and update the app.

If you want your own AppStore and Google Play store pages, you will need your own Apple Developer Account for the iOS version, this is a requirements from Apples Guidelines. [[App Store Connect|Please follow the guide App Store Connect]].

Android and Windows Phone can be published through inLogics account or your schools own account (if you have acquired one). If you have your own account inLogic needs to be informed as well. To publish the app, inLogic needs the following information:

*[[UMS Web]] url address- This is the address that you use wen you access UMS Web. (If you are running any kind of gateway (TMG, UAG etc.) you will need to create rules for the services on UMS Web, contact us for more information)
**''<nowiki>https://*****.dk/</nowiki>''

===My School App===
My school app (Danish: Min skole app) is the inLogic app that is hosted by inLogic, this lets your school get started using the app faster and cheaper, and also there is less maintenance for you.

======What does this mean?======
Pros:

*Lower start-up price.
*No need to set up an Apple Developer account.
*Upon contacting InLogic Support your app can be live within a few hours.
*You can change logo, images & colors after the app is deployed

Cons:

*The app will not be called your schools name on you phone and in AppStore/Google Play, but is instead called 'My school app' (danish: Min skole app), and its app icon cannot be customized.
*When students & teachers starts up the app for the first time, they will need to select their specific school before proceeding to login.

 

=====Setting up My school app=====
<blockquote>Configurator -> Web setup -> App -> Setting</blockquote>
[[File:App levitas settings.png|none|frame]]

Here you need to configure a Primary and Secondary color, as well as a Logo. The Login background and Menu background images are optional.

The first time you set this up, you will need to contact InLogic support, and provide the following:

*A 64x64 pixels version of your logo (this logo is used in the the login dropdown, it will make it easier for users to find your school)
*UMS Web url (See [[App#Installation and setup|Installation and Setup]])

==Styling==
To style the app following is needed:

*Primary color
*Secondary color
*Logo (.png, vector file: .psd, .ai etc.)
*Icon for app logo (.png, vector file: .psd, .ai etc.)

The primary color will mostly be used as the default background color. The secondary color is the highlight color, and will be used when something is active or being activated like a button.

Optional:

*Background image for login (size 1080x1920)
*Background image for top bar of menu (size 1080x480)

===Examples of styling===

*Primary and secondary colors

[[File:App - Timetable view.png|none|thumb|Example of primary and secondary colors used in the app.
The primary color is used in the Header navigation bar, and the secondary color as border on the selected Calendar date
]]

*The schools logo - Max. 1024x576

[[File:Branding-af-app-inLogic-logo.png|none|thumb|Example of the inLogic logo used in the Demo app]]

*App logo - 1024x1024. If not supplied, inLogic will generate an App logo based on the schools logo (does not apply to My School App)

[[File:Simulator Screen Shot - iPhone SE - 2018-05-15 at 12.57.23.png|none|thumb|Example of app logo in use]]

*Login background image - 1080x1920. If not supplied, a white background will be shown, with your logo on top

'''''NOTE: The app will place your logo on top of the background image. This means when you supply a background image, it needs to be without logo on it.'''''[[File:App - Login screen.png|none|thumb|Example of a background image used on the Demo app login screen.
The school logo will be displayed on top of the background image, as seen here
]]

*Menu top bar image - 1080x480. If not supplied, a white background will be shown

[[File:App - Sidebar menu.png|none|thumb|Example of an image used on the Demo app menu view]]

==Technical settings==

The following sections show how to configure the app. This information only applies to services that are directly connected to the app, i.e. how to set up schedule tasks in the app. The only exception is 'UMS RSS Feeds', which is a specific service for app. If a fully detailed setup guide is needed, please go to that specific module.

Some of the configurations are not set up specifically for app, i.e. ParkZone. If you cannot find the setup guide you are looking for, you can find it by searching or on the front page. Please note that some changes made in the configurator not only will affect the app but also UMS Web.

'''Important''' As many settings only loads once the website is initializing, most changes require an IIS reset on the server. The app retrieves settings from UMS once a day, which means that changes will be visible the next time you log in or the next day.

===Menu Settings===

You are able to set the order and which menu buttons should be shown per template for the users

#Open UMS Configurator
#Templates -> Edit -> select a template -> App
#Under Menu order select Manage -> Add
#Write a Description
#Drap and drop the menu you want

[[File:MeunOrderSettings.png|none|thumb|789x789px]]
Here three menubuttons will be visible to the users on that specific template.

===History===
Before version 2.0.917, you used to choose the modules displayed in the app via the Configurator -> Web Setup.

We have moved the menu order into the Configurator -> Template Editor -> App -> Menu order.
[[File:Menu settings history.png|none|thumb|1600x1600px]]
This change was made to allow a different menu items and orders on Templates.

===News===

----

This describes how to setup news for the app.

*App News created from UMS Web
*Add a RSS feed
*Add Facebook feed

It is possible to use all three setups together. Combine as you like and set difference feed for difference templates.

====Setup for App News from UMS Web====

You need to create or use an existing AD group. This group will have access to create and modify news in
App News on UMS Web.

#Open UMS Configurator
#Menu -> Web Setup -> Edit -> App
#Add the AD group for News Access group

[[File:App newsaccessgroup.png|none|thumb|767x767px]]

====Setup for RSS feed====
Add server name for the service for RSS feed in Menu -> Modules -> Settings -> RSS Feeds

[[File:App rssfeedservice.png|thumb|none|594x594px]]
To setup Rss feed you will need the url for the rss. (E.g. http://inlogic.dk/feed)

Menu -> Templates -> Edit -> select template -> Rss Feeds

Manage -> Add… -> Fill in description, feed url and access token
[[File:App rssfeedurl.png|none|thumb|920x920px]]
'''Note:''' You only need an access token if the feed is from Facebook

The RSS feed runs as a service called “UMS RSS Feeds”. Default running every 5 min.
[[File:App services.png|none|thumb|561x561px]]
Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log
[[File:App rssfeedlog.png|none|thumb|944x944px]]

====Setup for Facebook news====

If you want to use a Facebook page news feed, you need two things:

*Facebook Page Url Feed
*Access Token

=====Facebook Page Url Feed=====

To create the feed url

#Get your facebook page url
#*E.g. https://www.facebook.com/inlogic.dk
#Copy the name. E.g. “inlogic.dk”
#*Note: this can also be a number “142642699097242”
#Replace “inlogic.dk” with your name in this url
#*<nowiki>https://graph.facebook.com/v3.0/inlogic.dk/</nowiki>

Your facebook page url feed should look something like this:

*<nowiki>https://graph.facebook.com/v3.0/schoolname/</nowiki>

This is your feed URL.

=====Create a facebook access token=====
The personal Facebook account that you use to register as a developer does not need to be associated in any way with the page or group whose posts you want to display. You cannot log in to the Developer site using a Facebook Page or Business account. You must use the username and password from your personal Facebook profile. Facebook doesn’t allow businesses to register as developers, only individuals.

Please follow [https://developers.facebook.com/docs/apps/register Facebook guide] to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to [https://developers.facebook.com/tools/explorer Facebook Graph Explorer]

#Select application
#Select “Get Token” and “Get App Token”
#Copy the Access Token

[[File:App facebookgettoken.png|none|thumb|968x968px]]
Now you have the access token you need to paste into the configurator.
[[File:App rssfeedurl.png|none|thumb|920x920px]]
Reload the service UMS Rss Feed in Services and look in the RSS Feed log to validate.

===Grades===

----

You can set the default view for grades, that filters the grades accordingly. The options are Course, Day and period.

Configurator -> Web Setup -> Edit -> App -> Default grade view
[[File:App gradesview.png|none|thumb|801x801px]]
To specific the period you can set how your terms are set with start and end day for each period.

Configurator -> Modules -> Grades -> Select the Datasource -> Edit -> Terms
[[File:App gradesterms.png|none|thumb|706x706px]]
Depending on which administration system you’re exporting grades from the columns can vary. You can set which grades column should be used and in which order.

Configurator -> Web Setup -> Edit -> App -> Select grade columns
[[File:App gradescolumns.png|none|thumb|709x709px]]
The grades view in the App will change accordingly to which columns chosen, a max of 4 columns will be shown in the App. The columns will be shown for each grade in order from 1 to 4.

If no grade columns settings is made the default columns will be selected in the following order:

*EducationDescription
*CourseDescription
*EvaluationFormDescription
*GradeValue

===Your information===

----

You can select which fields in user information that should be editable.

Configurator -> Web Setup -> Edit -> Userinfo
[[File:App userinfo.png|none|thumb|800x800px]]
You need to set permission before the users are able to upload their own student photo (a selfie).

Configurator -> Web Setup -> Edit -> UMS Photo -> Enable Selfie in App
[[File:App userinfoselfie.png|none|thumb|802x802px]]
This will enable selfie function.

===Student ID And Employee ID===

----<blockquote>''This content has been moved to [[Student / Employee ID]]''</blockquote>

===My Absence===
----The students are able to write an absence reason on an already registered subject. This can be enabled in the template editor.

Select the template -> Absence -> Manage -> Create a new settings or select an existing one -> Add/Edit

Check "Allow students to register absence reason"

[[File:Absence settings.png|none|thumb|570x570px]]

'''Allow students to register absence reason''' will allow the students to set an absence reason when a teacher has set the student as absent. The student can set an absence reason in "My absence".

'''Days back''' is the number of days back the students are allowed to set an absence reason.

'''Show Course''' will show the course view (this will effect both web and app).

'''Show Activity''' will show the activity view (this will effect both web and app).

===Push Notification===
----<blockquote>'''''Temporarily disabled'''''</blockquote>UMS can send push notifications when there are news, grades, or changes in your timetable. It is possible to receive a daily notification with your timetable for the day.

In addition the app can receive [[SMS Alert]] messages.

To set up push notifications go to Web Setup -> App -> Manage -> Add
[[File:AppPushNotificationSettings.png|none|thumb|526x526px]]

Set the description

FCM Server Api Key:

#Receive the key string from inLogic and paste it

Windows Phone:

#Receive the Package SID and Client secret from inLogic and paste the strings

====School account====
In case the school has it's own account do the following to retrieve the information

FCM Server Api Key:

#Open https://play.google.com/apps/publish
#Google Play Console -> Settings -> API Access -> Create linked project and open it -> Credentials
#Create API Key
#Select the API Key and make key restriction for Android
#Type in your package name and SHA-1 certificate fingerprint
#Copy the API key and paste it inside FCM Server API Key

Windows Phone:

#Open https://developer.microsoft.com/en-us/dashboard/apps/overview
#Select your app
#Services -> Push notification -> WNS/MPNS
#Select "Live Services site"
#Copy and paste the Package SID into the configurator
#Generate an Application Secret if none exist
#Copy and paste the Application Secret into the configurator (This is the Client Secret)

===Links===
----[[UMS Links]] can be used by both UMS Web and UMS App. Check the [[UMS Links|guide]].

===Homework===
----See [[UMS Homework]]

===Parking===
----See [[Parking]]

===Notify absence===
----See [[Attendance Registration#SMS and App settings for notify absence|App settings for notify absence in attendance registration]]

===Sms Alert===
----See [[SMS Alert]]

===Privacy Policy===
----To add your own privary policy in the app go to Web Setup -> App

Insert into "Privacy Policy Url:"

If left empty it will default to inLogic's privacy policy "https://www.inlogic.dk/om-inlogic/privacy-policy/"
[[File:App privacypolicyurl.png|none|thumb|792x792px]]

To add it to the App Store login

#https://appstoreconnect.apple.com/
#My Apps
#Select the app
#Select the top menu App Store
#Select App Information in the left menu
#Add your privacy policy url to "Privacy Policy URL"

[[File:App appstore privacypolicy.png|none|thumb|955x955px]] 
===Force language setting===
----Should you wish to, you have the option to force the language of the app to use a specific language, rather than the phones default language.

This is changed via the 'Forced language' feature in the Configurator.
[[File:Forced language.png|none|frame]]
The list of languages will expand over time, as UMS adds support for new languages.
 

==Custom localization resources==
see [[Custom Terms and Localization]]
 

==When changes take effect==
Changes to settings are effectuated in the app and different times, depending on what kind of change it is. The vast amount of changes will be template changes and are more or less instant, though there are exceptions.
{| class="wikitable"
|+Change Table
!Change Type
!When change takes effect
|-
|Setup changes
|IIS/Frontend Restart
|-
|Template changes
|Instant (in app needs to reload the page it is on for that to update
|-
|Changes to links
|Re-login
|}

==FAQ==

===Untrusted Certificate Error on Android===
'''''We do not recommend using Comodo certificates since they have been known to cause these issues.'''''

Can't login on some Android devices? This could be due to an untrusted Comodo SSL Certificate. We were able to reproduced it on Android version 4.1, 4.4.2, 5.0.1 and 8.1.0, but it may be present on any number of versions.

You can test your SSL certificate on https://sslanalyzer.comodoca.com/

Do the following on the server

#Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
#Enable automatic root certificate updates on the server

Please checkout the Comodo support site: https://support.comodo.com/index.php?/Knowledgebase/Article/View/1019/38/untrusted-certificate-error-on-android

For future conservation:<blockquote>Certificate is not installed correctly; the certificate needs to be chained back to the Addtrust root certificate in order to be trusted on the Android.</blockquote><blockquote>The issue is that the Windows server is not presenting the complete certificate chain; clients which do not have the complete certificate chain will result in this error as encountered on the Android phone. In order to resolve this, on the server which this certificate is installed on, please open the MMC (Microsoft Management Console), and add the certificate snap-in for the computer account on the local computer.</blockquote><blockquote>In the Intermediate Certification Authorities folder, verify if the Comodo RSA Domain Validation Secure Server CA and Comodo RSA Certification Authority(issued to Comodo RSA Certification Authority, issued by AddTrustExternal CA Root) are installed in this certificate store.</blockquote><blockquote>In the Trusted Root Certification Authorities folder verify if the AddTrustExternal CA Root is installed. Also, if you see the Comodo RSA Certification Authority (issued to and issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038) is present, if it is please delete this certificate.</blockquote><blockquote>If any of these certificates are missing the intermediate and root certificates were provided to you in the .zip file when the certificate was issued, or are available via this support article - <nowiki>https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2</nowiki> .</blockquote><blockquote>If you had to delete the Comodo RSA Certification Authority from the Trusted Root Authorities folder, you will also need to disable automatic root certificate updates on the server - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008</blockquote><blockquote>If you have performed these steps and the certificate chain has not updated on the server, to force IIS to update the certificate chain you will need to either change the certificate binding in IIS to another certificate, and then switch the certificate bindings to the correct certificate. Alternately, you will need to restart the server.</blockquote>Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008<blockquote>To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.</blockquote><blockquote>To turn off Automatic Root Certificates Update:</blockquote><blockquote>1. Click Start, and then click Run.</blockquote><blockquote>2. Type gpedit.msc, and then click OK.</blockquote><blockquote>3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.</blockquote><blockquote>4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.</blockquote><blockquote>5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.</blockquote><blockquote>6. Close the Local Group Policy Editor.</blockquote><blockquote>Note: You can use Group Policy to set policy settings that apply across a given site, domain, or organizational unit in Active Directory Domain Services.</blockquote>

===Issues with the app===
If you're facing issues with the app, please perform the following steps before contacting support:

*Check the AppStore/GooglePlay for app updates and install any present
*Shut down the app completely, and start it back up
*Restart the phone
*Uninstall the app, and redownload it from AppStore/GooglePlay

App

2022-06-22T09:29:27Z

Kpe:

[[File:UMS School App.png|frame]]
UMS School App is available for iPhone, Android. It will be designed with the school’s own logo, color and style. The app gives the basic functionality to see:

*News
*Timetable
*Homework
*Grades
*User information

Additional licenses gives the ability to create, edit and see more information from various modules. For an overview of module requirement see "[http://wiki.inlogic.dk/index.php?title=App&section=6&wteswitched=1#Additional_functionality Additional functionality"]

==Support==
We provide regular support for the following and newer versions:

*Android version 7.0. We support the same versions as Google provide security updates for. Find an overview [[wikipedia:Android_version_history#Code_names|here]].

*iOS version 10

*Windows 10 Mobile (version 10)

Please note that it is possible to run older versions. If support for older versions is needed, we offer support at our hourly rate.

==Prerequisites==
===Supported administrative systems===

*Userinfo: Easy-A, SIS, LUDUS and Lectio (Only mobile number).
*Grades: Easy-A, Lectio and SIS
*Homework: Easy-A and SIS.
*Timetable: Easy-A and SIS
*Attendance registration: Timetable data is retrieved from Easy-A, SIS, LUDUS, Tabulex and Lectio. Howerver, absence is only registered to Easy-A

===Module requirements===

*UMS Web (contains and run all the webservice that is required for the app to receive information and communicate with the server)

===Additional functionality===
You get more functionality in the app by having the following modules, these are all optional:

*Attendance Registration: Gives “Your attendance”, which shows student statistics, the student are able to add absence reason and see their absence status in the timetable
*Attendance Registration for UMS School App: gives employee “attendance registration” and student the ability to "report absence"
*Homework: gives the employee the ability to create homework
*Link Collection: gives links/bookmarks the school can setup
*User info: gives “Your information” the ability to edit the information. This also adds the functionality for the user to upload a new profile image (a selfie) to be used in the student id card
*Student & Employee Id: Gives the students a “student id card” and the employees an “employee id card”. To update their student id card profile image you’ll need the “User info” module
*Parking: Parkzone & APCOA Integration. Gives the option to create and edit parking permits from Parkzone and APCOA
*User information (add/edit)

Note: All Attendance functionality requires Attendance Registration.

===Testing after setup===

The app will be tested internally at inLogic before release. The test requires access to a user with relevant data. You can either create a fictional student who is associated to a real course, or alternatively use a real student's account, if the person agrees that the account is being used for a system test of the school's APP.

===What to have ready===

*'''Important''': The UMS site needs to use HTTPS and be public available. It needs a valid SSL certificate.
*Materials that can be used for designing the app. For example: Logo, brochure, design guide line, etc.

*Optional: It is possible for the school to have its own account where the app is located. An account in the App Store cost $99 per year, while an account for Google Play costs a onetime fee of $25. The school self-manage these accounts.

===Physical hardware requirements===

Having a smartphone is a necessity, either an Android, iOS or a Windows 10 Mobile.

===Should third party be contacted===

If the school is using a dedicated hosting service, they have to be informed on how you wish the news feed should be setup.

==Installation and setup==
inLogic will publish and update the app.

If you want your own AppStore and Google Play store pages, you will need your own Apple Developer Account for the iOS version, this is a requirements from Apples Guidelines. [[App Store Connect|Please follow the guide App Store Connect]].

Android and Windows Phone can be published through inLogics account or your schools own account (if you have acquired one). If you have your own account inLogic needs to be informed as well. To publish the app, inLogic needs the following information:

*[[UMS Web]] url address- This is the address that you use wen you access UMS Web. (If you are running any kind of gateway (TMG, UAG etc.) you will need to create rules for the services on UMS Web, contact us for more information)
**''<nowiki>https://*****.dk/</nowiki>''

===My School App===
My school app (Danish: Min skole app) is the inLogic app that is hosted by inLogic, this lets your school get started using the app faster and cheaper, and also there is less maintenance for you.

======What does this mean?======
Pros:

*Lower start-up price.
*No need to set up an Apple Developer account.
*Upon contacting InLogic Support your app can be live within a few hours.
*You can change logo, images & colors after the app is deployed

Cons:

*The app will not be called your schools name on you phone and in AppStore/Google Play, but is instead called 'My school app' (danish: Min skole app), and its app icon cannot be customized.
*When students & teachers starts up the app for the first time, they will need to select their specific school before proceeding to login.

 

=====Setting up My school app=====
<blockquote>Configurator -> Web setup -> App -> Setting</blockquote>
[[File:App levitas settings.png|none|frame]]

Here you need to configure a Primary and Secondary color, as well as a Logo. The Login background and Menu background images are optional.

The first time you set this up, you will need to contact InLogic support, and provide the following:

*A 64x64 pixels version of your logo (this logo is used in the the login dropdown, it will make it easier for users to find your school)
*UMS Web url (See [[App#Installation and setup|Installation and Setup]])

==Styling==
To style the app following is needed:

*Primary color
*Secondary color
*Logo (.png, vector file: .psd, .ai etc.)
*Icon for app logo (.png, vector file: .psd, .ai etc.)

The primary color will mostly be used as the default background color. The secondary color is the highlight color, and will be used when something is active or being activated like a button.

Optional:

*Background image for login (size 1080x1920)
*Background image for top bar of menu (size 1080x480)

===Examples of styling===

*Primary and secondary colors

[[File:App - Timetable view.png|none|thumb|Example of primary and secondary colors used in the app.
The primary color is used in the Header navigation bar, and the secondary color as border on the selected Calendar date
]]

*The schools logo - Max. 1024x576

[[File:Branding-af-app-inLogic-logo.png|none|thumb|Example of the inLogic logo used in the Demo app]]

*App logo - 1024x1024. If not supplied, inLogic will generate an App logo based on the schools logo (does not apply to My School App)

[[File:Simulator Screen Shot - iPhone SE - 2018-05-15 at 12.57.23.png|none|thumb|Example of app logo in use]]

*Login background image - 1080x1920. If not supplied, a white background will be shown, with your logo on top

'''''NOTE: The app will place your logo on top of the background image. This means when you supply a background image, it needs to be without logo on it.'''''[[File:App - Login screen.png|none|thumb|Example of a background image used on the Demo app login screen.
The school logo will be displayed on top of the background image, as seen here
]]

*Menu top bar image - 1080x480. If not supplied, a white background will be shown

[[File:App - Sidebar menu.png|none|thumb|Example of an image used on the Demo app menu view]]

==Technical settings==

The following sections show how to configure the app. This information only applies to services that are directly connected to the app, i.e. how to set up schedule tasks in the app. The only exception is 'UMS RSS Feeds', which is a specific service for app. If a fully detailed setup guide is needed, please go to that specific module.

Some of the configurations are not set up specifically for app, i.e. ParkZone. If you cannot find the setup guide you are looking for, you can find it by searching or on the front page. Please note that some changes made in the configurator not only will affect the app but also UMS Web.

'''Important''' As many settings only loads once the website is initializing, most changes require an IIS reset on the server. The app retrieves settings from UMS once a day, which means that changes will be visible the next time you log in or the next day.

===Menu Settings===

You are able to set the order and which menu buttons should be shown per template for the users

#Open UMS Configurator
#Templates -> Edit -> select a template -> App
#Under Menu order select Manage -> Add
#Write a Description
#Drap and drop the menu you want

[[File:MeunOrderSettings.png|none|thumb|789x789px]]
Here three menubuttons will be visible to the users on that specific template.

===History===
Before version 2.0.917, you used to choose the modules displayed in the app via the Configurator -> Web Setup.

We have moved the menu order into the Configurator -> Template Editor -> App -> Menu order.
[[File:Menu settings history.png|none|thumb|1600x1600px]]
This change was made to allow a different menu items and orders on Templates.

===News===

----

This describes how to setup news for the app.

*App News created from UMS Web
*Add a RSS feed
*Add Facebook feed

It is possible to use all three setups together. Combine as you like and set difference feed for difference templates.

====Setup for App News from UMS Web====

You need to create or use an existing AD group. This group will have access to create and modify news in
App News on UMS Web.

#Open UMS Configurator
#Menu -> Web Setup -> Edit -> App
#Add the AD group for News Access group

[[File:App newsaccessgroup.png|none|thumb|767x767px]]

====Setup for RSS feed====
Add server name for the service for RSS feed in Menu -> Modules -> Settings -> RSS Feeds

[[File:App rssfeedservice.png|thumb|none|594x594px]]
To setup Rss feed you will need the url for the rss. (E.g. http://inlogic.dk/feed)

Menu -> Templates -> Edit -> select template -> Rss Feeds

Manage -> Add… -> Fill in description, feed url and access token
[[File:App rssfeedurl.png|none|thumb|920x920px]]
'''Note:''' You only need an access token if the feed is from Facebook

The RSS feed runs as a service called “UMS RSS Feeds”. Default running every 5 min.
[[File:App services.png|none|thumb|561x561px]]
Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log
[[File:App rssfeedlog.png|none|thumb|944x944px]]

====Setup for Facebook news====

If you want to use a Facebook page news feed, you need two things:

*Facebook Page Url Feed
*Access Token

=====Facebook Page Url Feed=====

To create the feed url

#Get your facebook page url
#*E.g. https://www.facebook.com/inlogic.dk
#Copy the name. E.g. “inlogic.dk”
#*Note: this can also be a number “142642699097242”
#Replace “inlogic.dk” with your name in this url
#*<nowiki>https://graph.facebook.com/v3.0/inlogic.dk/</nowiki>

Your facebook page url feed should look something like this:

*<nowiki>https://graph.facebook.com/v3.0/schoolname/</nowiki>

This is your feed URL.

=====Create a facebook access token=====
The personal Facebook account that you use to register as a developer does not need to be associated in any way with the page or group whose posts you want to display. You cannot log in to the Developer site using a Facebook Page or Business account. You must use the username and password from your personal Facebook profile. Facebook doesn’t allow businesses to register as developers, only individuals.

Please follow [https://developers.facebook.com/docs/apps/register Facebook guide] to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to [https://developers.facebook.com/tools/explorer Facebook Graph Explorer]

#Select application
#Select “Get Token” and “Get App Token”
#Copy the Access Token

[[File:App facebookgettoken.png|none|thumb|968x968px]]
Now you have the access token you need to paste into the configurator.
[[File:App rssfeedurl.png|none|thumb|920x920px]]
Reload the service UMS Rss Feed in Services and look in the RSS Feed log to validate.

===Grades===

----

You can set the default view for grades, that filters the grades accordingly. The options are Course, Day and period.

Configurator -> Web Setup -> Edit -> App -> Default grade view
[[File:App gradesview.png|none|thumb|801x801px]]
To specific the period you can set how your terms are set with start and end day for each period.

Configurator -> Modules -> Grades -> Select the Datasource -> Edit -> Terms
[[File:App gradesterms.png|none|thumb|706x706px]]
Depending on which administration system you’re exporting grades from the columns can vary. You can set which grades column should be used and in which order.

Configurator -> Web Setup -> Edit -> App -> Select grade columns
[[File:App gradescolumns.png|none|thumb|709x709px]]
The grades view in the App will change accordingly to which columns chosen, a max of 4 columns will be shown in the App. The columns will be shown for each grade in order from 1 to 4.

If no grade columns settings is made the default columns will be selected in the following order:

*EducationDescription
*CourseDescription
*EvaluationFormDescription
*GradeValue

===Your information===

----

You can select which fields in user information that should be editable.

Configurator -> Web Setup -> Edit -> Userinfo
[[File:App userinfo.png|none|thumb|800x800px]]
You need to set permission before the users are able to upload their own student photo (a selfie).

Configurator -> Web Setup -> Edit -> UMS Photo -> Enable Selfie in App
[[File:App userinfoselfie.png|none|thumb|802x802px]]
This will enable selfie function.

===Student ID And Employee ID===

----<blockquote>''This content has been moved to [[Student / Employee ID]]''</blockquote>

===My Absence===
----The students are able to write an absence reason on an already registered subject. This can be enabled in the template editor.

Select the template -> Absence -> Manage -> Create a new settings or select an existing one -> Add/Edit

Check "Allow students to register absence reason"

[[File:Absence settings.png|none|thumb|570x570px]]

'''Allow students to register absence reason''' will allow the students to set an absence reason when a teacher has set the student as absent. The student can set an absence reason in "My absence".

'''Days back''' is the number of days back the students are allowed to set an absence reason.

'''Show Course''' will show the course view (this will effect both web and app).

'''Show Activity''' will show the activity view (this will effect both web and app).

===Push Notification===
----<blockquote>'''''Temporarily disabled'''''</blockquote>UMS can send push notifications when there are news, grades, or changes in your timetable. It is possible to receive a daily notification with your timetable for the day.

In addition the app can receive [[SMS Alert]] messages.

To set up push notifications go to Web Setup -> App -> Manage -> Add
[[File:AppPushNotificationSettings.png|none|thumb|526x526px]]

Set the description

FCM Server Api Key:

#Receive the key string from inLogic and paste it

Windows Phone:

#Receive the Package SID and Client secret from inLogic and paste the strings

====School account====
In case the school has it's own account do the following to retrieve the information

FCM Server Api Key:

#Open https://play.google.com/apps/publish
#Google Play Console -> Settings -> API Access -> Create linked project and open it -> Credentials
#Create API Key
#Select the API Key and make key restriction for Android
#Type in your package name and SHA-1 certificate fingerprint
#Copy the API key and paste it inside FCM Server API Key

Windows Phone:

#Open https://developer.microsoft.com/en-us/dashboard/apps/overview
#Select your app
#Services -> Push notification -> WNS/MPNS
#Select "Live Services site"
#Copy and paste the Package SID into the configurator
#Generate an Application Secret if none exist
#Copy and paste the Application Secret into the configurator (This is the Client Secret)

===Links===
----[[UMS Links]] can be used by both UMS Web and UMS App. Check the [[UMS Links|guide]].

===Homework===
----See [[UMS Homework]]

===Parking===
----See [[Parking]]

===Notify absence===
----See [[Attendance Registration#SMS and App settings for notify absence|App settings for notify absence in attendance registration]]

===Sms Alert===
----See [[SMS Alert]]

===Privacy Policy===
----To add your own privary policy in the app go to Web Setup -> App

Insert into "Privacy Policy Url:"

If left empty it will default to inLogic's privacy policy "https://www.inlogic.dk/om-inlogic/privacy-policy/"
[[File:App privacypolicyurl.png|none|thumb|792x792px]]

To add it to the App Store login

#https://appstoreconnect.apple.com/
#My Apps
#Select the app
#Select the top menu App Store
#Select App Information in the left menu
#Add your privacy policy url to "Privacy Policy URL"

[[File:App appstore privacypolicy.png|none|thumb|955x955px]] 
===Force language setting===
----Should you wish to, you have the option to force the language of the app to use a specific language, rather than the phones default language.

This is changed via the 'Forced language' feature in the Configurator.
[[File:Forced language.png|none|frame]]
The list of languages will expand over time, as UMS adds support for new languages.
 

==Custom localization resources==
see [[Custom Terms and Localization]]
 

==When changes take effect==
Changes to settings are effectuated in the app and different times, depending on what kind of change it is. The vast amount of changes will be template changes and are more or less instant, though there are exceptions.
{| class="wikitable"
|+Change Table
!Change Type
!When change takes effect
|-
|Setup changes
|IIS/Frontend Restart
|-
|Template changes
|Instant (in app needs to reload the page it is on for that to update
|-
|Changes to links
|Re-login
|}

==FAQ==

===Untrusted Certificate Error on Android===
'''''We do not recommend using Comodo certificates since they have been known to cause these issues.'''''

Can't login on some Android devices? This could be due to an untrusted Comodo SSL Certificate. We were able to reproduced it on Android version 4.1, 4.4.2, 5.0.1 and 8.1.0, but it may be present on any number of versions.

You can test your SSL certificate on https://sslanalyzer.comodoca.com/

Do the following on the server

#Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
#Enable automatic root certificate updates on the server

Please checkout the Comodo support site: https://support.comodo.com/index.php?/Knowledgebase/Article/View/1019/38/untrusted-certificate-error-on-android

For future conservation:<blockquote>Certificate is not installed correctly; the certificate needs to be chained back to the Addtrust root certificate in order to be trusted on the Android.</blockquote><blockquote>The issue is that the Windows server is not presenting the complete certificate chain; clients which do not have the complete certificate chain will result in this error as encountered on the Android phone. In order to resolve this, on the server which this certificate is installed on, please open the MMC (Microsoft Management Console), and add the certificate snap-in for the computer account on the local computer.</blockquote><blockquote>In the Intermediate Certification Authorities folder, verify if the Comodo RSA Domain Validation Secure Server CA and Comodo RSA Certification Authority(issued to Comodo RSA Certification Authority, issued by AddTrustExternal CA Root) are installed in this certificate store.</blockquote><blockquote>In the Trusted Root Certification Authorities folder verify if the AddTrustExternal CA Root is installed. Also, if you see the Comodo RSA Certification Authority (issued to and issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038) is present, if it is please delete this certificate.</blockquote><blockquote>If any of these certificates are missing the intermediate and root certificates were provided to you in the .zip file when the certificate was issued, or are available via this support article - <nowiki>https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2</nowiki> .</blockquote><blockquote>If you had to delete the Comodo RSA Certification Authority from the Trusted Root Authorities folder, you will also need to disable automatic root certificate updates on the server - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008</blockquote><blockquote>If you have performed these steps and the certificate chain has not updated on the server, to force IIS to update the certificate chain you will need to either change the certificate binding in IIS to another certificate, and then switch the certificate bindings to the correct certificate. Alternately, you will need to restart the server.</blockquote>Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008<blockquote>To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.</blockquote><blockquote>To turn off Automatic Root Certificates Update:</blockquote><blockquote>1. Click Start, and then click Run.</blockquote><blockquote>2. Type gpedit.msc, and then click OK.</blockquote><blockquote>3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.</blockquote><blockquote>4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.</blockquote><blockquote>5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.</blockquote><blockquote>6. Close the Local Group Policy Editor.</blockquote><blockquote>Note: You can use Group Policy to set policy settings that apply across a given site, domain, or organizational unit in Active Directory Domain Services.</blockquote>

===Issues with the app===
If you're facing issues with the app, please perform the following steps before contacting support:

*Check the AppStore/GooglePlay for app updates and install any present
*Shut down the app completely, and start it back up
*Restart the phone
*Uninstall the app, and redownload it from AppStore/GooglePlay

MSGraphPermissions

2022-06-21T14:28:23Z

Kpe: /* Open Powershell 5 on the server running the program */

'''MS graph permissions are required by these UMS modules'''

*'''LiveAtEdu'''
*'''OneNote'''
*'''SharePoint'''
*'''Office 365 Time blocks'''
*'''MS Teams'''

==Creating App Registration==
Go to [http://portal.azure.com Azure Portal] and login with you admin account( '''the same UMS uses''').

'''!!! ATTENTION !!! use service account that UMS uses'''

When logged in go to Azure Active Directory:
[[File:Graph1.jpg|left|thumb|832x832px]]

Go to App registrations
[[File:Graph2.jpg|none|thumb|831x831px]]

Click on New application registration
[[File:Graph3.jpg|none|thumb|909x909px]]

Give the new App a name ex. "UMSGraph", Choose "Web app / API" in Application type, set "Sign-on URL" to "http://localhost". After setting Application Permission values click "Create"
[[File:Graph43.jpg|none|thumb|913x913px]]

You will return to previous screen, here click "your new app"
[[File:Grahp5.jpg|none|thumb|905x905px]]

Click "Certificates & secrets"

Click "New Client Secret"

Enter a "Description" and set "Expires" to the interval that suits your needs.

Click "Add"
[[File:Graph6.jpg|none|thumb|908x908px]]

Copy "Value ID" We will use this later

'''!!! ATTENTION !!! the key value will never be visible again so ensure to copy it.''' [[File:Graph7.png|none|thumb|790x790px]]

Copy the "VALUE Key into "UMS Configurator" field Client Secret

[[File:Tewxddf.png|frameless|566x566px]]

Copy the "Directory Tenant ID " into "UMS Configurator" Field Tenant ID

Copy the "Appplication Client ID " into "UMS Configurator" Field Client ID
[[File:Id.jpg|none|thumb|1120x1120px]]

Click "Api permissions"

Click "Add a permission"
[[File:Graph8.png|none|thumb|780x780px]]

==Setup SharePoint, OneNote Class Notebook or Onedrive provisioning==
'''You do not need to fill out the settings in UMS (This was done in the above text) when using OneDrive provisioning.''' Only the "Setup SharePoint permissions" chapter.

In the UMS Configurator go to Modules->Office 365 and click "SharePoint organization settings"
[[File:UMSConfiguratorSharepointOrganizationSettings.png|none|thumb|600x600px]]
Choose your SharePoint organization setting and click "Edit..."
[[File:UMSConfiguratorSharepointOrganizationSettingsEdit.png|none|thumb|600x600px]]
Input your "Tenant Name" ex. "cortenso'''.onmicrosoft.com'''", insert Application ID into "Client ID" field, insert "Client secret" and "Tenant ID" and click "Ok"
[[File:SharepointOrganization SettingsEdit.jpg|none|thumb|585x585px]]

===Add SharePoint App permissions===

*Go to https://<tenant>-admin.sharepoint.com/_layouts/15/appinv.aspx
*Enter app Id (AKA Client Id) and press lookup.
*Copy paste the below text in Permission Request XML and save

<AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" />
<AppPermissionRequest Scope="http://sharepoint/social/tenant" Right="FullControl" />
</AppPermissionRequests>

[[File:SharePoint Organization Settings App permission.jpg|none|thumb|389x389px|Enter anything you like into Title]]

====Open Powershell 5 on the server running the program====
'''This only works in Powershell 5'''
Install-Module -Name Microsoft.Online.SharePoint.PowerShell
Import-Module Microsoft.Online.SharePoint.PowerShell
Connect-SPOService -Url https://<tenantname>-admin.sharepoint.com -Credential administrator@<tenantname>.onmicrosoft.com
Set-SPOTenant -DisableCustomAppAuthentication $false
===Remove SharePoint App permissions===
if the App is already registered use this link to delete it
https://<tenant>-admin.sharepoint.com/_layouts/15/TA_AllAppPrincipals.aspx
==Permissions overview==

===Microsoft Graph===
{| class="wikitable sortable"
|+Default permissions
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|User.ReadWrite.All
|Application
|Microsoft Graph
|Setting attributes on the user in Office 365
|Live_at_edu.exe
|-
|Group.ReadWrite.All
|Application
|Microsoft Graph
|Setting group attributes on Office 365 groups
|Live_at_edu.exe
|-
|GroupMember.ReadWrite.All
|Application
|Microsoft Graph
|Manage GroupMembers in Office 365
|Live_at_edu.exe
|-
|Directory.ReadWrite.All
|Application
|Microsoft Graph
|Setting attributes on the user in Azure Active Directory
|Live_at_edu.exe
|-
|MailboxSettings.ReadWrite
|Application
|Microsoft Graph
|Used to set mailbox settings in Office 365.
Used to get/create categories
|Live_at_edu.exe
Skemabrikker.exe
|-
|Calendars.ReadWrite
|Application
|Microsoft Graph
|Used to allow UMS to sync calendar events to Office 365
|Skemabrikker.exe
|-
|Files.ReadWrite.All
|Application
|Microsoft Graph
|Used to provision OneDrive for users
|Live_at_edu.exe
|}

===Teams sync permissions===
{| class="wikitable sortable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|EduRoster.ReadWrite.All
|Application
|Microsoft Graph
|Allows the UMS to handle users on roster
|Live_at_edu.exe
|-
|Member.Read.Hidden
|Application
|Microsoft Graph
|Allows the UMS to handle users on roster
|Live_at_edu.exe
|-
|TeamMember.ReadWrite.All
|Application
|Microsoft Graph
|Used to add or remove users from Team
|Live_at_edu.exe
|-
|TeamsTab.ReadWrite.All
|Application
|Microsoft Graph
|Used to create tabs in teams
|Live_at_edu.exe
|-
|TeamsAppInstallation.ReadForTeam.All
|Application
|Microsoft Graph
|Used to install app in teams
|Live_at_edu.exe
|-
|Team.Create
|Application
|Microsoft Graph
|Used to create Teams
|Live_at_edu.exe
|-
|Team.ReadBasic.All
|Application
|Microsoft Graph
|Used to read teams
|Live_at_edu.exe
|}

===Change Password when using Azure AD as login===
{| class="wikitable sortable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|Directory.AccessAsUser.All
|Delegated
|Microsoft Graph
|
|UMS Web
|-
|User.Read
|Delegated
|Microsoft Graph
|
|UMS Web
|}

===Password Sync===
{| class="wikitable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|Roles and Administrators
|Application
|Microsoft Graph
|Reset password for Users
|Password_Sync
|}

===SharePoint===
{| class="wikitable sortable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|Sites.FullControl.All
|Application
|Microsoft Graph
|Have full control of all site collections
|Office365_SP_OneNote.exe
|-
|Sites.Manage.All
|Application
|Microsoft Graph
|Read and write items and lists in all site collections
|Office365_SP_OneNote.exe
|-
|Sites.ReadWrite.All
|Application
|Microsoft Graph
|Read and write items in all site collections
|Office365_SP_OneNote.exe
|-
|User.ReadWrite.All
|Application
|Microsoft Graph
|Read and write user profiles
|Office365_SP_OneNote.exe
|}

===OneNote===
{| class="wikitable sortable"
|+
!Permission name
!Permission type
!API
!Used for
!Used by
|-
|Notes.ReadWrite.All
|Application
|Microsoft Graph
|
|Office365_SP_OneNote.exe
|} 
===Password Administrator===

To Add Password administrator roles. Click '''Roles and administrator'''
[[File:Passwordd.png|thumb|1167x1167px|none]]

*Click Add Assignments and Search for App Registrations name and Click Add.

[[File:Password1.png|1167x1167px|thumb|none]]
 

==FAQ :==
If you get this message when trying to reset password in Office365 using MS Graph Api. This is because user is global Admin and therefore MS graph can not Reset password
[[File:Passwordsync.png|none|thumb|1245x1245px]]

Push Notifications

2022-05-03T10:53:04Z

Kpe: /* Testing */

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub. 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

Before beginning testing please read the "Known issues" segment as some of these may come up.

===Inlogic support===
[[File:TestsendImage.png|link=http://wiki.inlogic.dk/index.php/File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

==When to expect a push notification==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

#Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
#Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
#Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out, cause unknown.

Users do not currently have a way to know if they are properly registered with the hub in the app, we are contemplating a way to add feedback for this.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions of the frontend and backend as at the time of writting(1. of april 2022) any version never than the beta should not have this issue.

 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Q: Which OS are supported?<blockquote>A: Currently only android(through google and iOS are supported.</blockquote>

Push Notifications

2022-05-03T10:50:33Z

Kpe: /* FAQ */

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub. 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

===Inlogic support===
[[File:TestsendImage.png|link=http://wiki.inlogic.dk/index.php/File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

==When to expect a push notification==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

#Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
#Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
#Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out, cause unknown.

Users do not currently have a way to know if they are properly registered with the hub in the app, we are contemplating a way to add feedback for this.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions of the frontend and backend as at the time of writting(1. of april 2022) any version never than the beta should not have this issue.

 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Q: Which OS are supported?<blockquote>A: Currently only android(through google and iOS are supported.</blockquote>

Push Notifications

2022-05-03T10:48:34Z

Kpe: /* FAQ */

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub. 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

===Inlogic support===
[[File:TestsendImage.png|link=http://wiki.inlogic.dk/index.php/File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

==When to expect a push notification==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

#Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
#Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
#Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out, cause unknown.

Users do not currently have a way to know if they are properly registered with the hub in the app, we are contemplating a way to add feedback for this.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions of the frontend and backend as at the time of writting(1. of april 2022) any version never than the beta should not have this issue.

 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>Q: Which OS are supported?

A:Currently only android(through google and iOS are supported

App

2022-04-11T12:44:26Z

Kpe: /* When changes take effect */

[[File:UMS School App.png|frame]]
UMS School App is available for iPhone, Android and Windows Phone. It will be designed with the school’s own logo, color and style. The app gives the basic functionality to see:

*News
*Timetable
*Homework
*Grades
*User information

Additional licenses gives the ability to create, edit and see more information from various modules. For an overview of module requirement see "[http://wiki.inlogic.dk/index.php?title=App&section=6&wteswitched=1#Additional_functionality Additional functionality"]

==Support==
We provide regular support for the following and newer versions:

*Android version 7.0. We support the same versions as Google provide security updates for. Find an overview [[wikipedia:Android_version_history#Code_names|here]].

*iOS version 10

*Windows 10 Mobile (version 10)

Please note that it is possible to run older versions. If support for older versions is needed, we offer support at our hourly rate.

==Prerequisites==
===Supported administrative systems===

*Userinfo: Easy-A, SIS, LUDUS and Lectio (Only mobile number).
*Grades: Easy-A, Lectio and SIS
*Homework: Easy-A and SIS.
*Timetable: Easy-A and SIS
*Attendance registration: Timetable data is retrieved from Easy-A, SIS, LUDUS, Tabulex and Lectio. Howerver, absence is only registered to Easy-A

===Module requirements===

*UMS Web (contains and run all the webservice that is required for the app to receive information and communicate with the server)

===Additional functionality===
You get more functionality in the app by having the following modules, these are all optional:

*Attendance Registration: Gives “Your attendance”, which shows student statistics, the student are able to add absence reason and see their absence status in the timetable
*Attendance Registration for UMS School App: gives employee “attendance registration” and student the ability to "report absence"
*Homework: gives the employee the ability to create homework
*Link Collection: gives links/bookmarks the school can setup
*User info: gives “Your information” the ability to edit the information. This also adds the functionality for the user to upload a new profile image (a selfie) to be used in the student id card
*Student & Employee Id: Gives the students a “student id card” and the employees an “employee id card”. To update their student id card profile image you’ll need the “User info” module
*Parking: Parkzone & APCOA Integration. Gives the option to create and edit parking permits from Parkzone and APCOA
*User information (add/edit)

Note: All Attendance functionality requires Attendance Registration.

===Testing after setup===

The app will be tested internally at inLogic before release. The test requires access to a user with relevant data. You can either create a fictional student who is associated to a real course, or alternatively use a real student's account, if the person agrees that the account is being used for a system test of the school's APP.

===What to have ready===

*'''Important''': The UMS site needs to use HTTPS and be public available. It needs a valid SSL certificate.
*Materials that can be used for designing the app. For example: Logo, brochure, design guide line, etc.

*Optional: It is possible for the school to have its own account where the app is located. An account in the App Store cost $99 per year, while an account for Google Play costs a onetime fee of $25. The school self-manage these accounts.

===Physical hardware requirements===

Having a smartphone is a necessity, either an Android, iOS or a Windows 10 Mobile.

===Should third party be contacted===

If the school is using a dedicated hosting service, they have to be informed on how you wish the news feed should be setup.

==Installation and setup==
inLogic will publish and update the app.

If you want your own AppStore and Google Play store pages, you will need your own Apple Developer Account for the iOS version, this is a requirements from Apples Guidelines. [[App Store Connect|Please follow the guide App Store Connect]].

Android and Windows Phone can be published through inLogics account or your schools own account (if you have acquired one). If you have your own account inLogic needs to be informed as well. To publish the app, inLogic needs the following information:

*[[UMS Web]] url address- This is the address that you use wen you access UMS Web. (If you are running any kind of gateway (TMG, UAG etc.) you will need to create rules for the services on UMS Web, contact us for more information)
**''<nowiki>https://*****.dk/</nowiki>''

===My School App===
My school app (Danish: Min skole app) is the inLogic app that is hosted by inLogic, this lets your school get started using the app faster and cheaper, and also there is less maintenance for you.

======What does this mean?======
Pros:

*Lower start-up price.
*No need to set up an Apple Developer account.
*Upon contacting InLogic Support your app can be live within a few hours.
*You can change logo, images & colors after the app is deployed

Cons:

*The app will not be called your schools name on you phone and in AppStore/Google Play, but is instead called 'My school app' (danish: Min skole app), and its app icon cannot be customized.
*When students & teachers starts up the app for the first time, they will need to select their specific school before proceeding to login.

 

=====Setting up My school app=====
<blockquote>Configurator -> Web setup -> App -> Setting</blockquote>
[[File:App levitas settings.png|none|frame]]

Here you need to configure a Primary and Secondary color, as well as a Logo. The Login background and Menu background images are optional.

The first time you set this up, you will need to contact InLogic support, and provide the following:

*A 64x64 pixels version of your logo (this logo is used in the the login dropdown, it will make it easier for users to find your school)
*UMS Web url (See [[App#Installation and setup|Installation and Setup]])

==Styling==
To style the app following is needed:

*Primary color
*Secondary color
*Logo (.png, vector file: .psd, .ai etc.)
*Icon for app logo (.png, vector file: .psd, .ai etc.)

The primary color will mostly be used as the default background color. The secondary color is the highlight color, and will be used when something is active or being activated like a button.

Optional:

*Background image for login (size 1080x1920)
*Background image for top bar of menu (size 1080x480)

===Examples of styling===

*Primary and secondary colors

[[File:App - Timetable view.png|none|thumb|Example of primary and secondary colors used in the app.
The primary color is used in the Header navigation bar, and the secondary color as border on the selected Calendar date
]]

*The schools logo - Max. 1024x576

[[File:Branding-af-app-inLogic-logo.png|none|thumb|Example of the inLogic logo used in the Demo app]]

*App logo - 1024x1024. If not supplied, inLogic will generate an App logo based on the schools logo (does not apply to My School App)

[[File:Simulator Screen Shot - iPhone SE - 2018-05-15 at 12.57.23.png|none|thumb|Example of app logo in use]]

*Login background image - 1080x1920. If not supplied, a white background will be shown, with your logo on top

'''''NOTE: The app will place your logo on top of the background image. This means when you supply a background image, it needs to be without logo on it.'''''[[File:App - Login screen.png|none|thumb|Example of a background image used on the Demo app login screen.
The school logo will be displayed on top of the background image, as seen here
]]

*Menu top bar image - 1080x480. If not supplied, a white background will be shown

[[File:App - Sidebar menu.png|none|thumb|Example of an image used on the Demo app menu view]]

==Technical settings==

The following sections show how to configure the app. This information only applies to services that are directly connected to the app, i.e. how to set up schedule tasks in the app. The only exception is 'UMS RSS Feeds', which is a specific service for app. If a fully detailed setup guide is needed, please go to that specific module.

Some of the configurations are not set up specifically for app, i.e. ParkZone. If you cannot find the setup guide you are looking for, you can find it by searching or on the front page. Please note that some changes made in the configurator not only will affect the app but also UMS Web.

'''Important''' As many settings only loads once the website is initializing, most changes require an IIS reset on the server. The app retrieves settings from UMS once a day, which means that changes will be visible the next time you log in or the next day.

===Menu Settings===

You are able to set the order and which menu buttons should be shown per template for the users

#Open UMS Configurator
#Templates -> Edit -> select a template -> App
#Under Menu order select Manage -> Add
#Write a Description
#Drap and drop the menu you want

[[File:MeunOrderSettings.png|none|thumb|789x789px]]
Here three menubuttons will be visible to the users on that specific template.

===History===
Before version 2.0.917, you used to choose the modules displayed in the app via the Configurator -> Web Setup.

We have moved the menu order into the Configurator -> Template Editor -> App -> Menu order.
[[File:Menu settings history.png|none|thumb|1600x1600px]]
This change was made to allow a different menu items and orders on Templates.

===News===

----

This describes how to setup news for the app.

*App News created from UMS Web
*Add a RSS feed
*Add Facebook feed

It is possible to use all three setups together. Combine as you like and set difference feed for difference templates.

====Setup for App News from UMS Web====

You need to create or use an existing AD group. This group will have access to create and modify news in
App News on UMS Web.

#Open UMS Configurator
#Menu -> Web Setup -> Edit -> App
#Add the AD group for News Access group

[[File:App newsaccessgroup.png|none|thumb|767x767px]]

====Setup for RSS feed====
Add server name for the service for RSS feed in Menu -> Modules -> Settings -> RSS Feeds

[[File:App rssfeedservice.png|thumb|none|594x594px]]
To setup Rss feed you will need the url for the rss. (E.g. http://inlogic.dk/feed)

Menu -> Templates -> Edit -> select template -> Rss Feeds

Manage -> Add… -> Fill in description, feed url and access token
[[File:App rssfeedurl.png|none|thumb|920x920px]]
'''Note:''' You only need an access token if the feed is from Facebook

The RSS feed runs as a service called “UMS RSS Feeds”. Default running every 5 min.
[[File:App services.png|none|thumb|561x561px]]
Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log
[[File:App rssfeedlog.png|none|thumb|944x944px]]

====Setup for Facebook news====

If you want to use a Facebook page news feed, you need two things:

*Facebook Page Url Feed
*Access Token

=====Facebook Page Url Feed=====

To create the feed url

#Get your facebook page url
#*E.g. https://www.facebook.com/inlogic.dk
#Copy the name. E.g. “inlogic.dk”
#*Note: this can also be a number “142642699097242”
#Replace “inlogic.dk” with your name in this url
#*<nowiki>https://graph.facebook.com/v3.0/inlogic.dk/</nowiki>

Your facebook page url feed should look something like this:

*<nowiki>https://graph.facebook.com/v3.0/schoolname/</nowiki>

This is your feed URL.

=====Create a facebook access token=====
The personal Facebook account that you use to register as a developer does not need to be associated in any way with the page or group whose posts you want to display. You cannot log in to the Developer site using a Facebook Page or Business account. You must use the username and password from your personal Facebook profile. Facebook doesn’t allow businesses to register as developers, only individuals.

Please follow [https://developers.facebook.com/docs/apps/register Facebook guide] to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to [https://developers.facebook.com/tools/explorer Facebook Graph Explorer]

#Select application
#Select “Get Token” and “Get App Token”
#Copy the Access Token

[[File:App facebookgettoken.png|none|thumb|968x968px]]
Now you have the access token you need to paste into the configurator.
[[File:App rssfeedurl.png|none|thumb|920x920px]]
Reload the service UMS Rss Feed in Services and look in the RSS Feed log to validate.

===Grades===

----

You can set the default view for grades, that filters the grades accordingly. The options are Course, Day and period.

Configurator -> Web Setup -> Edit -> App -> Default grade view
[[File:App gradesview.png|none|thumb|801x801px]]
To specific the period you can set how your terms are set with start and end day for each period.

Configurator -> Modules -> Grades -> Select the Datasource -> Edit -> Terms
[[File:App gradesterms.png|none|thumb|706x706px]]
Depending on which administration system you’re exporting grades from the columns can vary. You can set which grades column should be used and in which order.

Configurator -> Web Setup -> Edit -> App -> Select grade columns
[[File:App gradescolumns.png|none|thumb|709x709px]]
The grades view in the App will change accordingly to which columns chosen, a max of 4 columns will be shown in the App. The columns will be shown for each grade in order from 1 to 4.

If no grade columns settings is made the default columns will be selected in the following order:

*EducationDescription
*CourseDescription
*EvaluationFormDescription
*GradeValue

===Your information===

----

You can select which fields in user information that should be editable.

Configurator -> Web Setup -> Edit -> Userinfo
[[File:App userinfo.png|none|thumb|800x800px]]
You need to set permission before the users are able to upload their own student photo (a selfie).

Configurator -> Web Setup -> Edit -> UMS Photo -> Enable Selfie in App
[[File:App userinfoselfie.png|none|thumb|802x802px]]
This will enable selfie function.

===Student ID And Employee ID===

----<blockquote>''This content has been moved to [[Student / Employee ID]]''</blockquote>

===My Absence===
----The students are able to write an absence reason on an already registered subject. This can be enabled in the template editor.

Select the template -> Absence -> Manage -> Create a new settings or select an existing one -> Add/Edit

Check "Allow students to register absence reason"

[[File:Absence settings.png|none|thumb|570x570px]]

'''Allow students to register absence reason''' will allow the students to set an absence reason when a teacher has set the student as absent. The student can set an absence reason in "My absence".

'''Days back''' is the number of days back the students are allowed to set an absence reason.

'''Show Course''' will show the course view (this will effect both web and app).

'''Show Activity''' will show the activity view (this will effect both web and app).

===Push Notification===
----<blockquote>'''''Temporarily disabled'''''</blockquote>UMS can send push notifications when there are news, grades, or changes in your timetable. It is possible to receive a daily notification with your timetable for the day.

In addition the app can receive [[SMS Alert]] messages.

To set up push notifications go to Web Setup -> App -> Manage -> Add
[[File:AppPushNotificationSettings.png|none|thumb|526x526px]]

Set the description

FCM Server Api Key:

#Receive the key string from inLogic and paste it

Windows Phone:

#Receive the Package SID and Client secret from inLogic and paste the strings

====School account====
In case the school has it's own account do the following to retrieve the information

FCM Server Api Key:

#Open https://play.google.com/apps/publish
#Google Play Console -> Settings -> API Access -> Create linked project and open it -> Credentials
#Create API Key
#Select the API Key and make key restriction for Android
#Type in your package name and SHA-1 certificate fingerprint
#Copy the API key and paste it inside FCM Server API Key

Windows Phone:

#Open https://developer.microsoft.com/en-us/dashboard/apps/overview
#Select your app
#Services -> Push notification -> WNS/MPNS
#Select "Live Services site"
#Copy and paste the Package SID into the configurator
#Generate an Application Secret if none exist
#Copy and paste the Application Secret into the configurator (This is the Client Secret)

===Links===
----[[UMS Links]] can be used by both UMS Web and UMS App. Check the [[UMS Links|guide]].

===Homework===
----See [[UMS Homework]]

===Parking===
----See [[Parking]]

===Notify absence===
----See [[Attendance Registration#SMS and App settings for notify absence|App settings for notify absence in attendance registration]]

===Sms Alert===
----See [[SMS Alert]]

===Privacy Policy===
----To add your own privary policy in the app go to Web Setup -> App

Insert into "Privacy Policy Url:"

If left empty it will default to inLogic's privacy policy "https://www.inlogic.dk/om-inlogic/privacy-policy/"
[[File:App privacypolicyurl.png|none|thumb|792x792px]]

To add it to the App Store login

#https://appstoreconnect.apple.com/
#My Apps
#Select the app
#Select the top menu App Store
#Select App Information in the left menu
#Add your privacy policy url to "Privacy Policy URL"

[[File:App appstore privacypolicy.png|none|thumb|955x955px]] 
===Force language setting===
----Should you wish to, you have the option to force the language of the app to use a specific language, rather than the phones default language.

This is changed via the 'Forced language' feature in the Configurator.
[[File:Forced language.png|none|frame]]
The list of languages will expand over time, as UMS adds support for new languages.
 

==Custom localization resources==
see [[Custom Terms and Localization]]
 

==When changes take effect==
Changes to settings are effectuated in the app and different times, depending on what kind of change it is. The vast amount of changes will be template changes and are more or less instant, though there are exceptions.
{| class="wikitable"
|+Change Table
!Change Type
!When change takes effect
|-
|Setup changes
|IIS/Frontend Restart
|-
|Template changes
|Instant (in app needs to reload the page it is on for that to update
|-
|Changes to links
|Re-login
|}

==FAQ==

===Untrusted Certificate Error on Android===
'''''We do not recommend using Comodo certificates since they have been known to cause these issues.'''''

Can't login on some Android devices? This could be due to an untrusted Comodo SSL Certificate. We were able to reproduced it on Android version 4.1, 4.4.2, 5.0.1 and 8.1.0, but it may be present on any number of versions.

You can test your SSL certificate on https://sslanalyzer.comodoca.com/

Do the following on the server

#Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
#Enable automatic root certificate updates on the server

Please checkout the Comodo support site: https://support.comodo.com/index.php?/Knowledgebase/Article/View/1019/38/untrusted-certificate-error-on-android

For future conservation:<blockquote>Certificate is not installed correctly; the certificate needs to be chained back to the Addtrust root certificate in order to be trusted on the Android.</blockquote><blockquote>The issue is that the Windows server is not presenting the complete certificate chain; clients which do not have the complete certificate chain will result in this error as encountered on the Android phone. In order to resolve this, on the server which this certificate is installed on, please open the MMC (Microsoft Management Console), and add the certificate snap-in for the computer account on the local computer.</blockquote><blockquote>In the Intermediate Certification Authorities folder, verify if the Comodo RSA Domain Validation Secure Server CA and Comodo RSA Certification Authority(issued to Comodo RSA Certification Authority, issued by AddTrustExternal CA Root) are installed in this certificate store.</blockquote><blockquote>In the Trusted Root Certification Authorities folder verify if the AddTrustExternal CA Root is installed. Also, if you see the Comodo RSA Certification Authority (issued to and issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038) is present, if it is please delete this certificate.</blockquote><blockquote>If any of these certificates are missing the intermediate and root certificates were provided to you in the .zip file when the certificate was issued, or are available via this support article - <nowiki>https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2</nowiki> .</blockquote><blockquote>If you had to delete the Comodo RSA Certification Authority from the Trusted Root Authorities folder, you will also need to disable automatic root certificate updates on the server - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008</blockquote><blockquote>If you have performed these steps and the certificate chain has not updated on the server, to force IIS to update the certificate chain you will need to either change the certificate binding in IIS to another certificate, and then switch the certificate bindings to the correct certificate. Alternately, you will need to restart the server.</blockquote>Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008<blockquote>To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.</blockquote><blockquote>To turn off Automatic Root Certificates Update:</blockquote><blockquote>1. Click Start, and then click Run.</blockquote><blockquote>2. Type gpedit.msc, and then click OK.</blockquote><blockquote>3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.</blockquote><blockquote>4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.</blockquote><blockquote>5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.</blockquote><blockquote>6. Close the Local Group Policy Editor.</blockquote><blockquote>Note: You can use Group Policy to set policy settings that apply across a given site, domain, or organizational unit in Active Directory Domain Services.</blockquote>

===Issues with the app===
If you're facing issues with the app, please perform the following steps before contacting support:

*Check the AppStore/GooglePlay for app updates and install any present
*Shut down the app completely, and start it back up
*Restart the phone
*Uninstall the app, and redownload it from AppStore/GooglePlay

App

2022-04-11T10:56:01Z

Kpe: /* When changes take effect */

[[File:UMS School App.png|frame]]
UMS School App is available for iPhone, Android and Windows Phone. It will be designed with the school’s own logo, color and style. The app gives the basic functionality to see:

*News
*Timetable
*Homework
*Grades
*User information

Additional licenses gives the ability to create, edit and see more information from various modules. For an overview of module requirement see "[http://wiki.inlogic.dk/index.php?title=App&section=6&wteswitched=1#Additional_functionality Additional functionality"]

==Support==
We provide regular support for the following and newer versions:

*Android version 7.0. We support the same versions as Google provide security updates for. Find an overview [[wikipedia:Android_version_history#Code_names|here]].

*iOS version 10

*Windows 10 Mobile (version 10)

Please note that it is possible to run older versions. If support for older versions is needed, we offer support at our hourly rate.

==Prerequisites==
===Supported administrative systems===

*Userinfo: Easy-A, SIS, LUDUS and Lectio (Only mobile number).
*Grades: Easy-A, Lectio and SIS
*Homework: Easy-A and SIS.
*Timetable: Easy-A and SIS
*Attendance registration: Timetable data is retrieved from Easy-A, SIS, LUDUS, Tabulex and Lectio. Howerver, absence is only registered to Easy-A

===Module requirements===

*UMS Web (contains and run all the webservice that is required for the app to receive information and communicate with the server)

===Additional functionality===
You get more functionality in the app by having the following modules, these are all optional:

*Attendance Registration: Gives “Your attendance”, which shows student statistics, the student are able to add absence reason and see their absence status in the timetable
*Attendance Registration for UMS School App: gives employee “attendance registration” and student the ability to "report absence"
*Homework: gives the employee the ability to create homework
*Link Collection: gives links/bookmarks the school can setup
*User info: gives “Your information” the ability to edit the information. This also adds the functionality for the user to upload a new profile image (a selfie) to be used in the student id card
*Student & Employee Id: Gives the students a “student id card” and the employees an “employee id card”. To update their student id card profile image you’ll need the “User info” module
*Parking: Parkzone & APCOA Integration. Gives the option to create and edit parking permits from Parkzone and APCOA
*User information (add/edit)

Note: All Attendance functionality requires Attendance Registration.

===Testing after setup===

The app will be tested internally at inLogic before release. The test requires access to a user with relevant data. You can either create a fictional student who is associated to a real course, or alternatively use a real student's account, if the person agrees that the account is being used for a system test of the school's APP.

===What to have ready===

*'''Important''': The UMS site needs to use HTTPS and be public available. It needs a valid SSL certificate.
*Materials that can be used for designing the app. For example: Logo, brochure, design guide line, etc.

*Optional: It is possible for the school to have its own account where the app is located. An account in the App Store cost $99 per year, while an account for Google Play costs a onetime fee of $25. The school self-manage these accounts.

===Physical hardware requirements===

Having a smartphone is a necessity, either an Android, iOS or a Windows 10 Mobile.

===Should third party be contacted===

If the school is using a dedicated hosting service, they have to be informed on how you wish the news feed should be setup.

==Installation and setup==
inLogic will publish and update the app.

If you want your own AppStore and Google Play store pages, you will need your own Apple Developer Account for the iOS version, this is a requirements from Apples Guidelines. [[App Store Connect|Please follow the guide App Store Connect]].

Android and Windows Phone can be published through inLogics account or your schools own account (if you have acquired one). If you have your own account inLogic needs to be informed as well. To publish the app, inLogic needs the following information:

*[[UMS Web]] url address- This is the address that you use wen you access UMS Web. (If you are running any kind of gateway (TMG, UAG etc.) you will need to create rules for the services on UMS Web, contact us for more information)
**''<nowiki>https://*****.dk/</nowiki>''

===My School App===
My school app (Danish: Min skole app) is the inLogic app that is hosted by inLogic, this lets your school get started using the app faster and cheaper, and also there is less maintenance for you.

======What does this mean?======
Pros:

*Lower start-up price.
*No need to set up an Apple Developer account.
*Upon contacting InLogic Support your app can be live within a few hours.
*You can change logo, images & colors after the app is deployed

Cons:

*The app will not be called your schools name on you phone and in AppStore/Google Play, but is instead called 'My school app' (danish: Min skole app), and its app icon cannot be customized.
*When students & teachers starts up the app for the first time, they will need to select their specific school before proceeding to login.

 

=====Setting up My school app=====
<blockquote>Configurator -> Web setup -> App -> Setting</blockquote>
[[File:App levitas settings.png|none|frame]]

Here you need to configure a Primary and Secondary color, as well as a Logo. The Login background and Menu background images are optional.

The first time you set this up, you will need to contact InLogic support, and provide the following:

*A 64x64 pixels version of your logo (this logo is used in the the login dropdown, it will make it easier for users to find your school)
*UMS Web url (See [[App#Installation and setup|Installation and Setup]])

==Styling==
To style the app following is needed:

*Primary color
*Secondary color
*Logo (.png, vector file: .psd, .ai etc.)
*Icon for app logo (.png, vector file: .psd, .ai etc.)

The primary color will mostly be used as the default background color. The secondary color is the highlight color, and will be used when something is active or being activated like a button.

Optional:

*Background image for login (size 1080x1920)
*Background image for top bar of menu (size 1080x480)

===Examples of styling===

*Primary and secondary colors

[[File:App - Timetable view.png|none|thumb|Example of primary and secondary colors used in the app.
The primary color is used in the Header navigation bar, and the secondary color as border on the selected Calendar date
]]

*The schools logo - Max. 1024x576

[[File:Branding-af-app-inLogic-logo.png|none|thumb|Example of the inLogic logo used in the Demo app]]

*App logo - 1024x1024. If not supplied, inLogic will generate an App logo based on the schools logo (does not apply to My School App)

[[File:Simulator Screen Shot - iPhone SE - 2018-05-15 at 12.57.23.png|none|thumb|Example of app logo in use]]

*Login background image - 1080x1920. If not supplied, a white background will be shown, with your logo on top

'''''NOTE: The app will place your logo on top of the background image. This means when you supply a background image, it needs to be without logo on it.'''''[[File:App - Login screen.png|none|thumb|Example of a background image used on the Demo app login screen.
The school logo will be displayed on top of the background image, as seen here
]]

*Menu top bar image - 1080x480. If not supplied, a white background will be shown

[[File:App - Sidebar menu.png|none|thumb|Example of an image used on the Demo app menu view]]

==Technical settings==

The following sections show how to configure the app. This information only applies to services that are directly connected to the app, i.e. how to set up schedule tasks in the app. The only exception is 'UMS RSS Feeds', which is a specific service for app. If a fully detailed setup guide is needed, please go to that specific module.

Some of the configurations are not set up specifically for app, i.e. ParkZone. If you cannot find the setup guide you are looking for, you can find it by searching or on the front page. Please note that some changes made in the configurator not only will affect the app but also UMS Web.

'''Important''' As many settings only loads once the website is initializing, most changes require an IIS reset on the server. The app retrieves settings from UMS once a day, which means that changes will be visible the next time you log in or the next day.

===Menu Settings===

You are able to set the order and which menu buttons should be shown per template for the users

#Open UMS Configurator
#Templates -> Edit -> select a template -> App
#Under Menu order select Manage -> Add
#Write a Description
#Drap and drop the menu you want

[[File:MeunOrderSettings.png|none|thumb|789x789px]]
Here three menubuttons will be visible to the users on that specific template.

===History===
Before version 2.0.917, you used to choose the modules displayed in the app via the Configurator -> Web Setup.

We have moved the menu order into the Configurator -> Template Editor -> App -> Menu order.
[[File:Menu settings history.png|none|thumb|1600x1600px]]
This change was made to allow a different menu items and orders on Templates.

===News===

----

This describes how to setup news for the app.

*App News created from UMS Web
*Add a RSS feed
*Add Facebook feed

It is possible to use all three setups together. Combine as you like and set difference feed for difference templates.

====Setup for App News from UMS Web====

You need to create or use an existing AD group. This group will have access to create and modify news in
App News on UMS Web.

#Open UMS Configurator
#Menu -> Web Setup -> Edit -> App
#Add the AD group for News Access group

[[File:App newsaccessgroup.png|none|thumb|767x767px]]

====Setup for RSS feed====
Add server name for the service for RSS feed in Menu -> Modules -> Settings -> RSS Feeds

[[File:App rssfeedservice.png|thumb|none|594x594px]]
To setup Rss feed you will need the url for the rss. (E.g. http://inlogic.dk/feed)

Menu -> Templates -> Edit -> select template -> Rss Feeds

Manage -> Add… -> Fill in description, feed url and access token
[[File:App rssfeedurl.png|none|thumb|920x920px]]
'''Note:''' You only need an access token if the feed is from Facebook

The RSS feed runs as a service called “UMS RSS Feeds”. Default running every 5 min.
[[File:App services.png|none|thumb|561x561px]]
Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log
[[File:App rssfeedlog.png|none|thumb|944x944px]]

====Setup for Facebook news====

If you want to use a Facebook page news feed, you need two things:

*Facebook Page Url Feed
*Access Token

=====Facebook Page Url Feed=====

To create the feed url

#Get your facebook page url
#*E.g. https://www.facebook.com/inlogic.dk
#Copy the name. E.g. “inlogic.dk”
#*Note: this can also be a number “142642699097242”
#Replace “inlogic.dk” with your name in this url
#*<nowiki>https://graph.facebook.com/v3.0/inlogic.dk/</nowiki>

Your facebook page url feed should look something like this:

*<nowiki>https://graph.facebook.com/v3.0/schoolname/</nowiki>

This is your feed URL.

=====Create a facebook access token=====
The personal Facebook account that you use to register as a developer does not need to be associated in any way with the page or group whose posts you want to display. You cannot log in to the Developer site using a Facebook Page or Business account. You must use the username and password from your personal Facebook profile. Facebook doesn’t allow businesses to register as developers, only individuals.

Please follow [https://developers.facebook.com/docs/apps/register Facebook guide] to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to [https://developers.facebook.com/tools/explorer Facebook Graph Explorer]

#Select application
#Select “Get Token” and “Get App Token”
#Copy the Access Token

[[File:App facebookgettoken.png|none|thumb|968x968px]]
Now you have the access token you need to paste into the configurator.
[[File:App rssfeedurl.png|none|thumb|920x920px]]
Reload the service UMS Rss Feed in Services and look in the RSS Feed log to validate.

===Grades===

----

You can set the default view for grades, that filters the grades accordingly. The options are Course, Day and period.

Configurator -> Web Setup -> Edit -> App -> Default grade view
[[File:App gradesview.png|none|thumb|801x801px]]
To specific the period you can set how your terms are set with start and end day for each period.

Configurator -> Modules -> Grades -> Select the Datasource -> Edit -> Terms
[[File:App gradesterms.png|none|thumb|706x706px]]
Depending on which administration system you’re exporting grades from the columns can vary. You can set which grades column should be used and in which order.

Configurator -> Web Setup -> Edit -> App -> Select grade columns
[[File:App gradescolumns.png|none|thumb|709x709px]]
The grades view in the App will change accordingly to which columns chosen, a max of 4 columns will be shown in the App. The columns will be shown for each grade in order from 1 to 4.

If no grade columns settings is made the default columns will be selected in the following order:

*EducationDescription
*CourseDescription
*EvaluationFormDescription
*GradeValue

===Your information===

----

You can select which fields in user information that should be editable.

Configurator -> Web Setup -> Edit -> Userinfo
[[File:App userinfo.png|none|thumb|800x800px]]
You need to set permission before the users are able to upload their own student photo (a selfie).

Configurator -> Web Setup -> Edit -> UMS Photo -> Enable Selfie in App
[[File:App userinfoselfie.png|none|thumb|802x802px]]
This will enable selfie function.

===Student ID And Employee ID===

----<blockquote>''This content has been moved to [[Student / Employee ID]]''</blockquote>

===My Absence===
----The students are able to write an absence reason on an already registered subject. This can be enabled in the template editor.

Select the template -> Absence -> Manage -> Create a new settings or select an existing one -> Add/Edit

Check "Allow students to register absence reason"

[[File:Absence settings.png|none|thumb|570x570px]]

'''Allow students to register absence reason''' will allow the students to set an absence reason when a teacher has set the student as absent. The student can set an absence reason in "My absence".

'''Days back''' is the number of days back the students are allowed to set an absence reason.

'''Show Course''' will show the course view (this will effect both web and app).

'''Show Activity''' will show the activity view (this will effect both web and app).

===Push Notification===
----<blockquote>'''''Temporarily disabled'''''</blockquote>UMS can send push notifications when there are news, grades, or changes in your timetable. It is possible to receive a daily notification with your timetable for the day.

In addition the app can receive [[SMS Alert]] messages.

To set up push notifications go to Web Setup -> App -> Manage -> Add
[[File:AppPushNotificationSettings.png|none|thumb|526x526px]]

Set the description

FCM Server Api Key:

#Receive the key string from inLogic and paste it

Windows Phone:

#Receive the Package SID and Client secret from inLogic and paste the strings

====School account====
In case the school has it's own account do the following to retrieve the information

FCM Server Api Key:

#Open https://play.google.com/apps/publish
#Google Play Console -> Settings -> API Access -> Create linked project and open it -> Credentials
#Create API Key
#Select the API Key and make key restriction for Android
#Type in your package name and SHA-1 certificate fingerprint
#Copy the API key and paste it inside FCM Server API Key

Windows Phone:

#Open https://developer.microsoft.com/en-us/dashboard/apps/overview
#Select your app
#Services -> Push notification -> WNS/MPNS
#Select "Live Services site"
#Copy and paste the Package SID into the configurator
#Generate an Application Secret if none exist
#Copy and paste the Application Secret into the configurator (This is the Client Secret)

===Links===
----[[UMS Links]] can be used by both UMS Web and UMS App. Check the [[UMS Links|guide]].

===Homework===
----See [[UMS Homework]]

===Parking===
----See [[Parking]]

===Notify absence===
----See [[Attendance Registration#SMS and App settings for notify absence|App settings for notify absence in attendance registration]]

===Sms Alert===
----See [[SMS Alert]]

===Privacy Policy===
----To add your own privary policy in the app go to Web Setup -> App

Insert into "Privacy Policy Url:"

If left empty it will default to inLogic's privacy policy "https://www.inlogic.dk/om-inlogic/privacy-policy/"
[[File:App privacypolicyurl.png|none|thumb|792x792px]]

To add it to the App Store login

#https://appstoreconnect.apple.com/
#My Apps
#Select the app
#Select the top menu App Store
#Select App Information in the left menu
#Add your privacy policy url to "Privacy Policy URL"

[[File:App appstore privacypolicy.png|none|thumb|955x955px]] 
===Force language setting===
----Should you wish to, you have the option to force the language of the app to use a specific language, rather than the phones default language.

This is changed via the 'Forced language' feature in the Configurator.
[[File:Forced language.png|none|frame]]
The list of languages will expand over time, as UMS adds support for new languages.
 

==Custom localization resources==
see [[Custom Terms and Localization]]
 

==When changes take effect==
{| class="wikitable"
|+Change Table
!Change Type
!When change takes effect
|-
|Setup changes
|IIS/Frontend Restart
|-
|Template changes
|Instant (in app needs to reload the page it is on for that to update
|-
|Links
|Re-login
|}

==FAQ==

===Untrusted Certificate Error on Android===
'''''We do not recommend using Comodo certificates since they have been known to cause these issues.'''''

Can't login on some Android devices? This could be due to an untrusted Comodo SSL Certificate. We were able to reproduced it on Android version 4.1, 4.4.2, 5.0.1 and 8.1.0, but it may be present on any number of versions.

You can test your SSL certificate on https://sslanalyzer.comodoca.com/

Do the following on the server

#Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
#Enable automatic root certificate updates on the server

Please checkout the Comodo support site: https://support.comodo.com/index.php?/Knowledgebase/Article/View/1019/38/untrusted-certificate-error-on-android

For future conservation:<blockquote>Certificate is not installed correctly; the certificate needs to be chained back to the Addtrust root certificate in order to be trusted on the Android.</blockquote><blockquote>The issue is that the Windows server is not presenting the complete certificate chain; clients which do not have the complete certificate chain will result in this error as encountered on the Android phone. In order to resolve this, on the server which this certificate is installed on, please open the MMC (Microsoft Management Console), and add the certificate snap-in for the computer account on the local computer.</blockquote><blockquote>In the Intermediate Certification Authorities folder, verify if the Comodo RSA Domain Validation Secure Server CA and Comodo RSA Certification Authority(issued to Comodo RSA Certification Authority, issued by AddTrustExternal CA Root) are installed in this certificate store.</blockquote><blockquote>In the Trusted Root Certification Authorities folder verify if the AddTrustExternal CA Root is installed. Also, if you see the Comodo RSA Certification Authority (issued to and issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038) is present, if it is please delete this certificate.</blockquote><blockquote>If any of these certificates are missing the intermediate and root certificates were provided to you in the .zip file when the certificate was issued, or are available via this support article - <nowiki>https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2</nowiki> .</blockquote><blockquote>If you had to delete the Comodo RSA Certification Authority from the Trusted Root Authorities folder, you will also need to disable automatic root certificate updates on the server - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008</blockquote><blockquote>If you have performed these steps and the certificate chain has not updated on the server, to force IIS to update the certificate chain you will need to either change the certificate binding in IIS to another certificate, and then switch the certificate bindings to the correct certificate. Alternately, you will need to restart the server.</blockquote>Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008<blockquote>To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.</blockquote><blockquote>To turn off Automatic Root Certificates Update:</blockquote><blockquote>1. Click Start, and then click Run.</blockquote><blockquote>2. Type gpedit.msc, and then click OK.</blockquote><blockquote>3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.</blockquote><blockquote>4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.</blockquote><blockquote>5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.</blockquote><blockquote>6. Close the Local Group Policy Editor.</blockquote><blockquote>Note: You can use Group Policy to set policy settings that apply across a given site, domain, or organizational unit in Active Directory Domain Services.</blockquote>

===Issues with the app===
If you're facing issues with the app, please perform the following steps before contacting support:

*Check the AppStore/GooglePlay for app updates and install any present
*Shut down the app completely, and start it back up
*Restart the phone
*Uninstall the app, and redownload it from AppStore/GooglePlay

App

2022-04-11T10:55:45Z

Kpe: Added a small table of when changes take effect

[[File:UMS School App.png|frame]]
UMS School App is available for iPhone, Android and Windows Phone. It will be designed with the school’s own logo, color and style. The app gives the basic functionality to see:

*News
*Timetable
*Homework
*Grades
*User information

Additional licenses gives the ability to create, edit and see more information from various modules. For an overview of module requirement see "[http://wiki.inlogic.dk/index.php?title=App&section=6&wteswitched=1#Additional_functionality Additional functionality"]

==Support==
We provide regular support for the following and newer versions:

*Android version 7.0. We support the same versions as Google provide security updates for. Find an overview [[wikipedia:Android_version_history#Code_names|here]].

*iOS version 10

*Windows 10 Mobile (version 10)

Please note that it is possible to run older versions. If support for older versions is needed, we offer support at our hourly rate.

==Prerequisites==
===Supported administrative systems===

*Userinfo: Easy-A, SIS, LUDUS and Lectio (Only mobile number).
*Grades: Easy-A, Lectio and SIS
*Homework: Easy-A and SIS.
*Timetable: Easy-A and SIS
*Attendance registration: Timetable data is retrieved from Easy-A, SIS, LUDUS, Tabulex and Lectio. Howerver, absence is only registered to Easy-A

===Module requirements===

*UMS Web (contains and run all the webservice that is required for the app to receive information and communicate with the server)

===Additional functionality===
You get more functionality in the app by having the following modules, these are all optional:

*Attendance Registration: Gives “Your attendance”, which shows student statistics, the student are able to add absence reason and see their absence status in the timetable
*Attendance Registration for UMS School App: gives employee “attendance registration” and student the ability to "report absence"
*Homework: gives the employee the ability to create homework
*Link Collection: gives links/bookmarks the school can setup
*User info: gives “Your information” the ability to edit the information. This also adds the functionality for the user to upload a new profile image (a selfie) to be used in the student id card
*Student & Employee Id: Gives the students a “student id card” and the employees an “employee id card”. To update their student id card profile image you’ll need the “User info” module
*Parking: Parkzone & APCOA Integration. Gives the option to create and edit parking permits from Parkzone and APCOA
*User information (add/edit)

Note: All Attendance functionality requires Attendance Registration.

===Testing after setup===

The app will be tested internally at inLogic before release. The test requires access to a user with relevant data. You can either create a fictional student who is associated to a real course, or alternatively use a real student's account, if the person agrees that the account is being used for a system test of the school's APP.

===What to have ready===

*'''Important''': The UMS site needs to use HTTPS and be public available. It needs a valid SSL certificate.
*Materials that can be used for designing the app. For example: Logo, brochure, design guide line, etc.

*Optional: It is possible for the school to have its own account where the app is located. An account in the App Store cost $99 per year, while an account for Google Play costs a onetime fee of $25. The school self-manage these accounts.

===Physical hardware requirements===

Having a smartphone is a necessity, either an Android, iOS or a Windows 10 Mobile.

===Should third party be contacted===

If the school is using a dedicated hosting service, they have to be informed on how you wish the news feed should be setup.

==Installation and setup==
inLogic will publish and update the app.

If you want your own AppStore and Google Play store pages, you will need your own Apple Developer Account for the iOS version, this is a requirements from Apples Guidelines. [[App Store Connect|Please follow the guide App Store Connect]].

Android and Windows Phone can be published through inLogics account or your schools own account (if you have acquired one). If you have your own account inLogic needs to be informed as well. To publish the app, inLogic needs the following information:

*[[UMS Web]] url address- This is the address that you use wen you access UMS Web. (If you are running any kind of gateway (TMG, UAG etc.) you will need to create rules for the services on UMS Web, contact us for more information)
**''<nowiki>https://*****.dk/</nowiki>''

===My School App===
My school app (Danish: Min skole app) is the inLogic app that is hosted by inLogic, this lets your school get started using the app faster and cheaper, and also there is less maintenance for you.

======What does this mean?======
Pros:

*Lower start-up price.
*No need to set up an Apple Developer account.
*Upon contacting InLogic Support your app can be live within a few hours.
*You can change logo, images & colors after the app is deployed

Cons:

*The app will not be called your schools name on you phone and in AppStore/Google Play, but is instead called 'My school app' (danish: Min skole app), and its app icon cannot be customized.
*When students & teachers starts up the app for the first time, they will need to select their specific school before proceeding to login.

 

=====Setting up My school app=====
<blockquote>Configurator -> Web setup -> App -> Setting</blockquote>
[[File:App levitas settings.png|none|frame]]

Here you need to configure a Primary and Secondary color, as well as a Logo. The Login background and Menu background images are optional.

The first time you set this up, you will need to contact InLogic support, and provide the following:

*A 64x64 pixels version of your logo (this logo is used in the the login dropdown, it will make it easier for users to find your school)
*UMS Web url (See [[App#Installation and setup|Installation and Setup]])

==Styling==
To style the app following is needed:

*Primary color
*Secondary color
*Logo (.png, vector file: .psd, .ai etc.)
*Icon for app logo (.png, vector file: .psd, .ai etc.)

The primary color will mostly be used as the default background color. The secondary color is the highlight color, and will be used when something is active or being activated like a button.

Optional:

*Background image for login (size 1080x1920)
*Background image for top bar of menu (size 1080x480)

===Examples of styling===

*Primary and secondary colors

[[File:App - Timetable view.png|none|thumb|Example of primary and secondary colors used in the app.
The primary color is used in the Header navigation bar, and the secondary color as border on the selected Calendar date
]]

*The schools logo - Max. 1024x576

[[File:Branding-af-app-inLogic-logo.png|none|thumb|Example of the inLogic logo used in the Demo app]]

*App logo - 1024x1024. If not supplied, inLogic will generate an App logo based on the schools logo (does not apply to My School App)

[[File:Simulator Screen Shot - iPhone SE - 2018-05-15 at 12.57.23.png|none|thumb|Example of app logo in use]]

*Login background image - 1080x1920. If not supplied, a white background will be shown, with your logo on top

'''''NOTE: The app will place your logo on top of the background image. This means when you supply a background image, it needs to be without logo on it.'''''[[File:App - Login screen.png|none|thumb|Example of a background image used on the Demo app login screen.
The school logo will be displayed on top of the background image, as seen here
]]

*Menu top bar image - 1080x480. If not supplied, a white background will be shown

[[File:App - Sidebar menu.png|none|thumb|Example of an image used on the Demo app menu view]]

==Technical settings==

The following sections show how to configure the app. This information only applies to services that are directly connected to the app, i.e. how to set up schedule tasks in the app. The only exception is 'UMS RSS Feeds', which is a specific service for app. If a fully detailed setup guide is needed, please go to that specific module.

Some of the configurations are not set up specifically for app, i.e. ParkZone. If you cannot find the setup guide you are looking for, you can find it by searching or on the front page. Please note that some changes made in the configurator not only will affect the app but also UMS Web.

'''Important''' As many settings only loads once the website is initializing, most changes require an IIS reset on the server. The app retrieves settings from UMS once a day, which means that changes will be visible the next time you log in or the next day.

===Menu Settings===

You are able to set the order and which menu buttons should be shown per template for the users

#Open UMS Configurator
#Templates -> Edit -> select a template -> App
#Under Menu order select Manage -> Add
#Write a Description
#Drap and drop the menu you want

[[File:MeunOrderSettings.png|none|thumb|789x789px]]
Here three menubuttons will be visible to the users on that specific template.

===History===
Before version 2.0.917, you used to choose the modules displayed in the app via the Configurator -> Web Setup.

We have moved the menu order into the Configurator -> Template Editor -> App -> Menu order.
[[File:Menu settings history.png|none|thumb|1600x1600px]]
This change was made to allow a different menu items and orders on Templates.

===News===

----

This describes how to setup news for the app.

*App News created from UMS Web
*Add a RSS feed
*Add Facebook feed

It is possible to use all three setups together. Combine as you like and set difference feed for difference templates.

====Setup for App News from UMS Web====

You need to create or use an existing AD group. This group will have access to create and modify news in
App News on UMS Web.

#Open UMS Configurator
#Menu -> Web Setup -> Edit -> App
#Add the AD group for News Access group

[[File:App newsaccessgroup.png|none|thumb|767x767px]]

====Setup for RSS feed====
Add server name for the service for RSS feed in Menu -> Modules -> Settings -> RSS Feeds

[[File:App rssfeedservice.png|thumb|none|594x594px]]
To setup Rss feed you will need the url for the rss. (E.g. http://inlogic.dk/feed)

Menu -> Templates -> Edit -> select template -> Rss Feeds

Manage -> Add… -> Fill in description, feed url and access token
[[File:App rssfeedurl.png|none|thumb|920x920px]]
'''Note:''' You only need an access token if the feed is from Facebook

The RSS feed runs as a service called “UMS RSS Feeds”. Default running every 5 min.
[[File:App services.png|none|thumb|561x561px]]
Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log
[[File:App rssfeedlog.png|none|thumb|944x944px]]

====Setup for Facebook news====

If you want to use a Facebook page news feed, you need two things:

*Facebook Page Url Feed
*Access Token

=====Facebook Page Url Feed=====

To create the feed url

#Get your facebook page url
#*E.g. https://www.facebook.com/inlogic.dk
#Copy the name. E.g. “inlogic.dk”
#*Note: this can also be a number “142642699097242”
#Replace “inlogic.dk” with your name in this url
#*<nowiki>https://graph.facebook.com/v3.0/inlogic.dk/</nowiki>

Your facebook page url feed should look something like this:

*<nowiki>https://graph.facebook.com/v3.0/schoolname/</nowiki>

This is your feed URL.

=====Create a facebook access token=====
The personal Facebook account that you use to register as a developer does not need to be associated in any way with the page or group whose posts you want to display. You cannot log in to the Developer site using a Facebook Page or Business account. You must use the username and password from your personal Facebook profile. Facebook doesn’t allow businesses to register as developers, only individuals.

Please follow [https://developers.facebook.com/docs/apps/register Facebook guide] to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to [https://developers.facebook.com/tools/explorer Facebook Graph Explorer]

#Select application
#Select “Get Token” and “Get App Token”
#Copy the Access Token

[[File:App facebookgettoken.png|none|thumb|968x968px]]
Now you have the access token you need to paste into the configurator.
[[File:App rssfeedurl.png|none|thumb|920x920px]]
Reload the service UMS Rss Feed in Services and look in the RSS Feed log to validate.

===Grades===

----

You can set the default view for grades, that filters the grades accordingly. The options are Course, Day and period.

Configurator -> Web Setup -> Edit -> App -> Default grade view
[[File:App gradesview.png|none|thumb|801x801px]]
To specific the period you can set how your terms are set with start and end day for each period.

Configurator -> Modules -> Grades -> Select the Datasource -> Edit -> Terms
[[File:App gradesterms.png|none|thumb|706x706px]]
Depending on which administration system you’re exporting grades from the columns can vary. You can set which grades column should be used and in which order.

Configurator -> Web Setup -> Edit -> App -> Select grade columns
[[File:App gradescolumns.png|none|thumb|709x709px]]
The grades view in the App will change accordingly to which columns chosen, a max of 4 columns will be shown in the App. The columns will be shown for each grade in order from 1 to 4.

If no grade columns settings is made the default columns will be selected in the following order:

*EducationDescription
*CourseDescription
*EvaluationFormDescription
*GradeValue

===Your information===

----

You can select which fields in user information that should be editable.

Configurator -> Web Setup -> Edit -> Userinfo
[[File:App userinfo.png|none|thumb|800x800px]]
You need to set permission before the users are able to upload their own student photo (a selfie).

Configurator -> Web Setup -> Edit -> UMS Photo -> Enable Selfie in App
[[File:App userinfoselfie.png|none|thumb|802x802px]]
This will enable selfie function.

===Student ID And Employee ID===

----<blockquote>''This content has been moved to [[Student / Employee ID]]''</blockquote>

===My Absence===
----The students are able to write an absence reason on an already registered subject. This can be enabled in the template editor.

Select the template -> Absence -> Manage -> Create a new settings or select an existing one -> Add/Edit

Check "Allow students to register absence reason"

[[File:Absence settings.png|none|thumb|570x570px]]

'''Allow students to register absence reason''' will allow the students to set an absence reason when a teacher has set the student as absent. The student can set an absence reason in "My absence".

'''Days back''' is the number of days back the students are allowed to set an absence reason.

'''Show Course''' will show the course view (this will effect both web and app).

'''Show Activity''' will show the activity view (this will effect both web and app).

===Push Notification===
----<blockquote>'''''Temporarily disabled'''''</blockquote>UMS can send push notifications when there are news, grades, or changes in your timetable. It is possible to receive a daily notification with your timetable for the day.

In addition the app can receive [[SMS Alert]] messages.

To set up push notifications go to Web Setup -> App -> Manage -> Add
[[File:AppPushNotificationSettings.png|none|thumb|526x526px]]

Set the description

FCM Server Api Key:

#Receive the key string from inLogic and paste it

Windows Phone:

#Receive the Package SID and Client secret from inLogic and paste the strings

====School account====
In case the school has it's own account do the following to retrieve the information

FCM Server Api Key:

#Open https://play.google.com/apps/publish
#Google Play Console -> Settings -> API Access -> Create linked project and open it -> Credentials
#Create API Key
#Select the API Key and make key restriction for Android
#Type in your package name and SHA-1 certificate fingerprint
#Copy the API key and paste it inside FCM Server API Key

Windows Phone:

#Open https://developer.microsoft.com/en-us/dashboard/apps/overview
#Select your app
#Services -> Push notification -> WNS/MPNS
#Select "Live Services site"
#Copy and paste the Package SID into the configurator
#Generate an Application Secret if none exist
#Copy and paste the Application Secret into the configurator (This is the Client Secret)

===Links===
----[[UMS Links]] can be used by both UMS Web and UMS App. Check the [[UMS Links|guide]].

===Homework===
----See [[UMS Homework]]

===Parking===
----See [[Parking]]

===Notify absence===
----See [[Attendance Registration#SMS and App settings for notify absence|App settings for notify absence in attendance registration]]

===Sms Alert===
----See [[SMS Alert]]

===Privacy Policy===
----To add your own privary policy in the app go to Web Setup -> App

Insert into "Privacy Policy Url:"

If left empty it will default to inLogic's privacy policy "https://www.inlogic.dk/om-inlogic/privacy-policy/"
[[File:App privacypolicyurl.png|none|thumb|792x792px]]

To add it to the App Store login

#https://appstoreconnect.apple.com/
#My Apps
#Select the app
#Select the top menu App Store
#Select App Information in the left menu
#Add your privacy policy url to "Privacy Policy URL"

[[File:App appstore privacypolicy.png|none|thumb|955x955px]] 
===Force language setting===
----Should you wish to, you have the option to force the language of the app to use a specific language, rather than the phones default language.

This is changed via the 'Forced language' feature in the Configurator.
[[File:Forced language.png|none|frame]]
The list of languages will expand over time, as UMS adds support for new languages.
 

==Custom localization resources==
see [[Custom Terms and Localization]]
 

== When changes take effect ==
 
{| class="wikitable"
|+Change Table
!Change Type
!When change takes effect
|-
|Setup changes
|IIS/Frontend Restart
|-
|Template changes
|Instant (in app needs to reload the page it is on for that to update
|-
|Links
|Re-login
|}

==FAQ==

===Untrusted Certificate Error on Android===
'''''We do not recommend using Comodo certificates since they have been known to cause these issues.'''''

Can't login on some Android devices? This could be due to an untrusted Comodo SSL Certificate. We were able to reproduced it on Android version 4.1, 4.4.2, 5.0.1 and 8.1.0, but it may be present on any number of versions.

You can test your SSL certificate on https://sslanalyzer.comodoca.com/

Do the following on the server

#Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
#Enable automatic root certificate updates on the server

Please checkout the Comodo support site: https://support.comodo.com/index.php?/Knowledgebase/Article/View/1019/38/untrusted-certificate-error-on-android

For future conservation:<blockquote>Certificate is not installed correctly; the certificate needs to be chained back to the Addtrust root certificate in order to be trusted on the Android.</blockquote><blockquote>The issue is that the Windows server is not presenting the complete certificate chain; clients which do not have the complete certificate chain will result in this error as encountered on the Android phone. In order to resolve this, on the server which this certificate is installed on, please open the MMC (Microsoft Management Console), and add the certificate snap-in for the computer account on the local computer.</blockquote><blockquote>In the Intermediate Certification Authorities folder, verify if the Comodo RSA Domain Validation Secure Server CA and Comodo RSA Certification Authority(issued to Comodo RSA Certification Authority, issued by AddTrustExternal CA Root) are installed in this certificate store.</blockquote><blockquote>In the Trusted Root Certification Authorities folder verify if the AddTrustExternal CA Root is installed. Also, if you see the Comodo RSA Certification Authority (issued to and issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038) is present, if it is please delete this certificate.</blockquote><blockquote>If any of these certificates are missing the intermediate and root certificates were provided to you in the .zip file when the certificate was issued, or are available via this support article - <nowiki>https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2</nowiki> .</blockquote><blockquote>If you had to delete the Comodo RSA Certification Authority from the Trusted Root Authorities folder, you will also need to disable automatic root certificate updates on the server - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008</blockquote><blockquote>If you have performed these steps and the certificate chain has not updated on the server, to force IIS to update the certificate chain you will need to either change the certificate binding in IIS to another certificate, and then switch the certificate bindings to the correct certificate. Alternately, you will need to restart the server.</blockquote>Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008<blockquote>To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.</blockquote><blockquote>To turn off Automatic Root Certificates Update:</blockquote><blockquote>1. Click Start, and then click Run.</blockquote><blockquote>2. Type gpedit.msc, and then click OK.</blockquote><blockquote>3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.</blockquote><blockquote>4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.</blockquote><blockquote>5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.</blockquote><blockquote>6. Close the Local Group Policy Editor.</blockquote><blockquote>Note: You can use Group Policy to set policy settings that apply across a given site, domain, or organizational unit in Active Directory Domain Services.</blockquote>

===Issues with the app===
If you're facing issues with the app, please perform the following steps before contacting support:

*Check the AppStore/GooglePlay for app updates and install any present
*Shut down the app completely, and start it back up
*Restart the phone
*Uninstall the app, and redownload it from AppStore/GooglePlay

Push Notifications

2022-04-08T12:47:23Z

Kpe: /* Known issues */ Clarification on 1 issue

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub. 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

===Inlogic support===
[[File:TestsendImage.png|link=http://wiki.inlogic.dk/index.php/File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

==When to expect a push notification==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

#Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
#Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
#Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out, cause unknown.

Users do not currently have a way to know if they are properly registered with the hub in the app, we are contemplating a way to add feedback for this.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions of the frontend and backend as at the time of writting(1. of april 2022) any version never than the beta should not have this issue.

 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Push Notifications

2022-04-01T08:53:33Z

Kpe: Edited Known issues

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub. 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

===Inlogic support===
[[File:TestsendImage.png|link=http://wiki.inlogic.dk/index.php/File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

==When to expect a push notification==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

#Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
#Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
#Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out, cause unknown.

Users do not currently have a way to know if they are properly registered with the hub in the app, we are contemplating a way to add feedback for this.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions as at the time of writting(1. of april 2022) any version never than the beta should not have this issue.

 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Push Notifications

2022-04-01T08:51:07Z

Kpe: /* When push events are sent */

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub. 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

===Inlogic support===
[[File:TestsendImage.png|link=http://wiki.inlogic.dk/index.php/File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

==When to expect a push notification==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

#Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
#Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
#Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out, cause unknown.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions as at the time of writting(1. of april 2022) any version never than the beta should not have this issue. 

 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Push Notifications

2022-04-01T08:50:41Z

Kpe: Added to known issues and added "When push events are sent" topic

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub. 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

===Inlogic support===
[[File:TestsendImage.png|link=http://wiki.inlogic.dk/index.php/File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

== When push events are sent ==
The app service is set to run every 5 minutes, which means after you complete the following actions there may be a timelag of 5 minutes before the service contacts the hub to send messages.

 

# Create a News item: If send push is marked this is immediately added to the push queue, this is the fastest one you can test with.
# Make changes to timetable Items, requires you to run "GetSkemaBrikker" to completion, before a push notification is added to the queue.
# Adding a grade requires you to run "GetGrades" to completion, before a push notification is added to the queue.

Add to this that issues on the azure hub may delay a push for whatever reason. The app service will keep trying to contact the hub until the hub receives the request to send a push, but the hub may be unable to send it instantly, We know of 1 situation where the push took just above one hour since the time the push was sent from the app service.

 

==Known issues==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

Azure hub may have push messages saved in buffer for a while before sending it out, cause unknown.

The app service may not be able to send on the currently released version as it has checks on the wrong licenses. Fixed in beta versions as at the time of writting(1. of april 2022) any version never than the beta should not have this issue. 

 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Push Notifications

2022-03-14T09:18:55Z

Kpe: Added known issues and a detail about wait time for the sent push.

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

In the configurator, under Settings>Services, it is important that the field "App Service" has been filled in, as the app service is in charge of sending the notifications to the hub. 

==Testing==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

===Inlogic support===
[[File:TestsendImage.png|link=http://wiki.inlogic.dk/index.php/File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

======Accepted tags are:======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

======Our default payloads for Android is:======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

======Our default payloads for Apple is:======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

======After sending======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

===Institutions===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications.

Sending messages can take up to 5 minutes as that is the interval the app service runs on. 

== Known issues ==
For whatever reason some devices may have issues registering with the notification hub, so far we do not know what causes it, but suggest making sure the push settings for the institution are properly setup before jumping to conclusions as it may be fixable.

Rapidly registering and deregistering can cause issues with the notification hub on a device basis. As such we heavily suggest you don't do so. you can reset this by doing a reinstall of the app as that will be the most clear "deregistration" the app can do.

A database table needed to set settings for push in-app is missing, but will be generated if missing as of version 3.6.7.
 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

Push Notifications

2022-03-03T11:07:28Z

Kpe: Added Testing section divided into what inlogic support can do and what institutions can do.

Push notification is a feature available in the UMS App, however only when using 'Min skole app'. This allows the schools teachers and students to receive notifications on their phone about things such as news, timetable changes , grades and receive [[SMS Alert]] as notifications.
==Requirements==

*The school must be using 'Min skole app'

 

==Setup==

===Institution===
'''Contact InLogic to have Hub name provided, along with generated server-keys endpoints.'''

===Inlogic Support===
Go to https://portal.azure.com/

Create a new hub under the "umsapp-inlogic" Notification Hub Namespace, with the name matching the institution of the customer.

After creating the hub for the institution, open the hub and copy the connection settings for "Apple (APNS)" and Google(GCM/FCM) from the other hubs. These settings are the same for all "min skole app"/"UMS App"s installations.

Then under the "Manage" section, select "Access Policies" to get the auto generated Endpoints.
[[File:HubPic1Edited.png|left|thumb|473x473px]]

Give the Hubname, DefaultListenSharedAccessSignature endpoint (listen permission) as well as the DefaultFullSharedAccessSignature endpoint (manage, listen and send permissions) to the customers(to be entered into their configurator).

Once the Customer has entered the lines in the right fields, saved and added the template, users will be able to login to the app(re login if they don't want to wait a day) to register for push notifications. Inlogic support can then use the Test Send function(highlighted in blue), to send a test message, more on that in the "Testing" section.
 

===Institution===
The hubname and the Endpoints have to be entered into the matching fields below in the configurator > edit template > app > Push notification.

[[File:Push notifications editor 2.png|border|frameless|789x789px]]

Description can be whatever you wish to denote it as, but Hub name and the Endpoints have to match the correct information or the module won't work.

After this, press OK and ensure that all templates has this setting selected.

 

== Testing ==
After the endpoints have been entered into the configurator, a user that has logged in will be prompted for whether they want to receive push messages, once a user has been chosen, test notifications can be sent from the Inlogic azure platform by inlogic og normal notifications can be sent from the web.

=== Inlogic support ===
[[File:TestsendImage.png|link=http://wiki.inlogic.dk/index.php/File:TestsendImage.png|left|thumb|842x842px]]
In "Platforms" select the desired platform, either Apple or Android(currently only supported services).

In "Send to Tag Expression" either enter an accepted tag to specify a target or leave empty to send to all 10 random registered devices.

====== Accepted tags are: ======
"CustomerId#broadcast" : Broadcasts to members of an institution with the specific customer id.

"CustomerId#user#username" : Sends to a specific user belonging to a specific customer id, which makes this the most useful option for testing.

"deviceID" : Sends to a specific device that is registered on the hub, impossible to know unless you have access to the database in the "AppTokens" table.

Payload is the structure of the message including data on how the device should show the notification.

====== Our default payloads for Android is: ======
{"notification":{},

<nowiki>"data":{"NewsId":Number,"Type":number,"Title":"Text","Message":"Text","Payload":json object}}</nowiki>

Where Title and message are used for the Title and body of the Notification when showing on the phone.

NewsId is used for news notifications to open a specific news item, if you write the wrong number it will give you an error when you tap it on the phone.

Type is the type of the notification, which decides how the app reacts when the notification is tapped. Currently supported types are: 1: News, 2: Timetable, 3: TimetableChanged, 4: Grades, 5: Alerts, and 0 Unknown type which unsupported types default to and will give you an error when tapped.

Payload is currently unused but open for extra data once we expand the use of push messages.

====== Our default payloads for Apple is: ======
{"aps":{"alert":{"title":"Text","body":"Text"},"sound":"iOS Setting"},

<nowiki>"data":{"NewsId":Number,"Type":Number,"Title":"Text","Message":"Text","Payload":Json object}}</nowiki>

Where everything in APS controls the design of the notification, Title and Body is the same as Title and Message in Android, while in iOS the data fields for text and and message of the same name aren't used, they need to be there to fit the data object. Sound is an iOS setting on what sound to play when the notification is received by the phone, which we usually set to "default".

The data part is the same for both Android and iOS, it is the object used to manage notifications in the app.

====== After sending ======
Once you have filled in the fields above, you can click send and the hub will tell you the result of devices that have been sent to or if the payload isn't in an accepted format.

This can be used to check if your registrations/deregistrations have been updated and also if the message sent is received and works as intended/expected on targeted phones.

=== Institutions ===
If you don't have access to your database, what you can do on your own is to send push messages to specific users or teams when creating news, though it excludes alerts, grades and timetable notifications.

Otherwise if you do have access to your database, you can manipulate the "AppPushNotificationQueue" table, which allows to you send it to specific users and different types of notifications. 
==FAQ==
Q: Why can't I receive push notifications?<blockquote>A: If you made changes in the Configurator, you will either need to wait a day, or log out and back in, in the app, for the settings to pass through. Additionally ensure the phone has permitted push notifications.</blockquote>

Q: Can I use Push Notifications with the traditional app (not 'Min skole app')?<blockquote>A: As it stands right now, this is not something we support.</blockquote>

File:TestsendImage.png

2022-03-03T09:56:00Z

Kpe:

Example of test send function on hub

Push Notifications

2022-03-01T15:33:24Z

Kpe:

Push Notifications

2022-03-01T15:32:33Z

Kpe:

Push Notifications

2022-03-01T15:32:12Z

Kpe:

Push Notifications

2022-03-01T15:31:49Z

Kpe: /* Setup */

File:HubPic1Edited.png

2022-03-01T15:14:00Z

Kpe:

KeyItems for setup and testing

Custom Terms and Localization

2021-11-10T10:59:56Z

Kpe: Updated for 2021

Custom Terms and Localization is the first step in allowing you to alter the text that is displayed anywhere in the app. The edit can be made to supported languages or unsupported languages as long as phones support the culture code.

==Prerequisites==

*UMS Web
*Basic understanding of [https://www.w3schools.com/xml/xml_whatis.asp XML]

==Getting started==
You must create a file for each language you want to create your own translations for.
[[File:Translationfiles.png|left|frameless|800x800px]]

This file must be saved in your root web folder (generally located at 'C:\inetpub\wwwroot'), under the subfolder of \App\Localization\Translations.*culture*.xml

You need to create the Localization subdirectory if it does not exist. Example:
C:\inetpub\wwwroot\App\Localization\Translations.DK.xml
Note: While technically you can call the culture anything (for example Translations.arbitraryname.xml), it is recommended to call it the same culture as you use inside the XML file, for easier overview. The name simply needs to follow the pattern of 'Translations.*.xml'

A Translation file always needs a root element called 'root'. This root element needs a single attribute called 'culture', with the value of the chosen culture.

Supported cultures are

*'da-DK' (Danish)
*'en-US' (English)
*'nb' (Norwegian)

*'fo-FO' (Faroese)
*'de-DE' (German)

Custom cultures(such as en-AU or en-GB or es-ES) are possible, but we do not support them.

The root element must contain an 'entry' element for each translated key you want to override. The key attribute must match the key used in UMS App.

Inside this element you can write your desired text. Note that this text will have all leading and trailing whitespaces removed.

===Sample file===
An example where "Student" has been replaced with "Pupil" in all strings formerly using "student" and "Homework" has been replaced with "Betterments".
<root culture="en-US">
<entry key="StudentCardViewModelEmptyStateMessage">Couldn't find your Pupil ID. If the problem persists, contact your IT department</entry>
<entry key="StudentCardViewModelTitle">Pupil ID</entry>
<entry key="StudentNumberHeader">Pupil number</entry>
<entry key="StudentIdHeader">Pupil ID</entry>
<entry key="MenuStudentCard">Pupil ID</entry>
<entry key="AddNoteTapPersonTip">Tap on a Pupil to add a note to them.</entry>
<entry key="InvalidSelectedBarcodeFormat">The Pupil ID number cannot be displayed in the selected format. Use a different bar code format</entry>
<entry key="InvalidDefaultBarcodeFormat">This Pupil ID number cannot be displayed in the default barcode format. Contact your school</entry>
<entry key="IncludeFutureStudents">Include future pupils</entry>
<entry key="AbsenceRegistrationHowToMark">How do you want to mark pupils?</entry>
<entry key="HomeworkUpdateViewModelEmptyStateMessage">Couldn't find your betterments</entry>
<entry key="HomeworkViewModelEmptyStateMessage">Couldn't find your betterments</entry>
<entry key="HomeworkUpdateViewModelTitle">Betterments</entry>
<entry key="HomeworkViewModelTitle">Betterments</entry>
<entry key="MenuHomework">Betterments</entry>
<entry key="HomeworkItemViewModelTitle">Betterments</entry>
<entry key="HomeworkItemViewModelEmptyStateMessage">Couldn't find your Betterments</entry>
</root>

<root culture="da-DK">
<entry key="StudentNumberHeader">Studie nummer</entry>
<entry key="DateHeader">Sidst fornyet</entry>
<entry key="BirthdayHeader">Fødselsdato</entry>
<entry key="ExpiryDateHeader">Udløber d.</entry>
</root>
For a full list of current key strings contact Inlogic support.

==FAQ==

*''The translations are not getting loaded''

Check the Event Viewer, if anything is wrong with the XML structure, it will write an error entry here.

*''The app is not using the translations''

These translations are only updated once aday, as well as on log in/out.

Please note that the app requires a minimum of version '''3.2.0'''

*''Letters like Æ, Ø and Å are shown incorrectly''

Make sure when you save the XML file, that you save it as Unicode encoding. While other types of encoding may work, Unicode has been confirmed to work with all Scandinavian letters

File:Translationfiles.png

2021-11-10T10:49:58Z

Kpe:

Example of multiple translations in folder

Custom Terms and Localization

2021-11-10T10:44:55Z

Kpe:

Custom Terms and Localization is the first step in allowing you to alter the text that is displayed anywhere in the app.

==Prerequisites==

*UMS Web
*Basic understanding of [https://www.w3schools.com/xml/xml_whatis.asp XML]

==Getting started==
You must create a file for each language you want to create your own translations for.

This file must be saved in your root web folder (generally located at 'C:\inetpub\wwwroot'), under the subfolder of \App\Localization\Translations.*culture*.xml

You need to create the Localization subdirectory if it does not exist. Example:
C:\inetpub\wwwroot\App\Localization\Translations.DK.xml
Note: While technically you can call the culture anything (for example Translations.arbitraryname.xml), it is recommended to call it the same culture as you use inside the XML file, for easier overview. The name simply needs to follow the pattern of 'Translations.*.xml'

A Translation file always needs a root element called 'root'. This root element needs a single attribute called 'culture', with the value of the chosen culture.

Supported cultures are

*'da-DK' (Danish)
*'en-US' (English)
*'nb' (Norwegian)

*'fo-FO' (Faroese)

The root element must contain an 'entry' element for each translated key you want to override. The key attribute must match the key used in UMS App.

Inside this element you can write your desired text. Note that this text will have all leading and trailing whitespaces removed.

===Sample file===
<root culture="en-US">

<entry key="StudentCardViewModelEmptyStateMessage">Couldn't find your Pupil ID. If the problem persists, contact your IT department</entry>
<entry key="StudentCardViewModelTitle">Pupil ID</entry>
<entry key="StudentNumberHeader">Pupil number</entry>
<entry key="StudentIdHeader">Pupil ID</entry>
<entry key="MenuStudentCard">Pupil ID</entry>
<entry key="AddNoteTapPersonTip">Tap on a Pupil to add a note to them.</entry>
<entry key="InvalidSelectedBarcodeFormat">The Pupil ID number cannot be displayed in the selected format. Use a different bar code format</entry>
<entry key="InvalidDefaultBarcodeFormat">This Pupil ID number cannot be displayed in the default barcode format. Contact your school</entry>
<entry key="IncludeFutureStudents">Include future pupils</entry>
<entry key="AbsenceRegistrationHowToMark">How do you want to mark pupils?</entry>

<entry key="HomeworkUpdateViewModelEmptyStateMessage">Couldn't find your betterments</entry>
<entry key="HomeworkViewModelEmptyStateMessage">Couldn't find your betterments</entry>
<entry key="HomeworkUpdateViewModelTitle">Betterments</entry>
<entry key="HomeworkViewModelTitle">Betterments</entry>
<entry key="MenuHomework">Betterments</entry>
<entry key="HomeworkItemViewModelTitle">Betterments</entry>
<entry key="HomeworkItemViewModelEmptyStateMessage">Couldn't find your Betterments</entry>
</root>

<root culture="da-DK">
<entry key="StudentNumberHeader">Studie nummer</entry>
<entry key="DateHeader">Sidst fornyet</entry>
<entry key="BirthdayHeader">Fødselsdato</entry>
<entry key="ExpiryDateHeader">Udløber d.</entry>
</root>

==FAQ==

*''The translations are not getting loaded''

Check the Event Viewer, if anything is wrong with the XML structure, it will write an error entry here.

*''The app is not using the translations''

These translations are only updated once aday, as well as on log in/out.

Please note that the app requires a minimum of version '''3.2.0'''

*''Letters like Æ, Ø and Å are shown incorrectly''

Make sure when you save the XML file, that you save it as Unicode encoding. While other types of encoding may work, Unicode has been confirmed to work with all Scandinavian letters

Custom Terms and Localization

2021-11-10T10:30:31Z

Kpe: Samplefile update

Custom Terms and Localization is the first step in allowing you to alter the text that is displayed anywhere in the app.

==Prerequisites==

*UMS Web
*Basic understanding of [https://www.w3schools.com/xml/xml_whatis.asp XML]

==Getting started==
You must create a file for each language you want to create your own translations for.

This file must be saved in your root web folder (generally located at 'C:\inetpub\wwwroot'), under the subfolder of \App\Localization\Translations.*culture*.xml

You need to create the Localization subdirectory if it does not exist. Example:
C:\inetpub\wwwroot\App\Localization\Translations.DK.xml
Note: While technically you can call the culture anything (for example Translations.arbitraryname.xml), it is recommended to call it the same culture as you use inside the XML file, for easier overview. The name simply needs to follow the pattern of 'Translations.*.xml'

A Translation file always needs a root element called 'root'. This root element needs a single attribute called 'culture', with the value of the chosen culture.

Supported cultures are

*'da-DK' (Danish)
*'en-US' (English)
*'nb' (Norwegian)

*'fo-FO' (Faroese)

The root element must contain an 'entry' element for each translated key you want to override. The key attribute must match the key used in UMS App.

Inside this element you can write your desired text. Note that this text will have all leading and trailing whitespaces removed.

===Sample file===
<code><nowiki><div style="text-align: right; direction: ltr; margin-left: 1em;"></nowiki></code>

<code><root culture="en-US"></code>

<code></code>

<code><entry key="StudentCardViewModelEmptyStateMessage">Couldn't find your Pupil ID. If the problem persists, contact your IT department</entry></code>

<code><entry key="StudentCardViewModelTitle">Pupil ID</entry></code>

<code><entry key="StudentNumberHeader">Pupil number</entry></code>

<code><entry key="StudentIdHeader">Pupil ID</entry></code>

<code><entry key="MenuStudentCard">Pupil ID</entry></code>

<code><entry key="AddNoteTapPersonTip">Tap on a Pupil to add a note to them.</entry></code>

<code><entry key="InvalidSelectedBarcodeFormat">The Pupil ID number cannot be displayed in the selected format. Use a different bar code format</entry></code>

<code><entry key="InvalidDefaultBarcodeFormat">This Pupil ID number cannot be displayed in the default barcode format. Contact your school</entry></code>

<code><entry key="SmsSendSelectedStudentsMessage">You have selected {count, plural, =1 {1 pupil} other {# pupils} }</entry></code>

<code><entry key="IncludeFutureStudents">Include future pupils</entry></code>

<code><entry key="SmsSendAsSms">Will be sent as text to {pupils, plural, =1 {1 pupil} other {# pupils} }.</entry></code>

<code><entry key="SmsSendAsMail">Will be sent as e-mail to {pupils, plural, =1 {1 pupil} other {# pupils} }.</entry></code>

<code><entry key="SmsCannotSend">Cannot be sent to {pupils, plural, =1 {1 pupil} other {# pupils} }.</entry></code>

<code><entry key="AbsenceRegistrationHowToMark">How do you want to mark pupils?</entry></code>

<code><entry key="TimeDetailNoteStudent">pupil: {0}</entry></code>

<code></code>

<code><entry key="HomeworkUpdateViewModelEmptyStateMessage">Couldn't find your betterments</entry></code>

<code><entry key="HomeworkViewModelEmptyStateMessage">Couldn't find your betterments</entry></code>

<code><entry key="HomeworkUpdateViewModelTitle">Betterments</entry></code>

<code><entry key="HomeworkViewModelTitle">Betterments</entry></code>

<code><entry key="MenuHomework">Betterments</entry></code>

<code><entry key="HomeworkItemViewModelTitle">Betterments</entry></code>

<code><entry key="HomeworkItemViewModelEmptyStateMessage">Couldn't find your Betterments</entry></code>

<code></root></code>

<code><nowiki></div></nowiki></code>

<root culture="da-DK">
<entry key="StudentNumberHeader">Studie nummer</entry>
<entry key="DateHeader">Sidst fornyet</entry>
<entry key="BirthdayHeader">Fødselsdato</entry>
<entry key="ExpiryDateHeader">Udløber d.</entry>
</root>

==FAQ==

*''The translations are not getting loaded''

Check the Event Viewer, if anything is wrong with the XML structure, it will write an error entry here.

*''The app is not using the translations''

These translations are only updated once aday, as well as on log in/out.

Please note that the app requires a minimum of version '''3.2.0'''

*''Letters like Æ, Ø and Å are shown incorrectly''

Make sure when you save the XML file, that you save it as Unicode encoding. While other types of encoding may work, Unicode has been confirmed to work with all Scandinavian letters

App

2021-11-10T10:22:06Z

Kpe: App link to custom terms and localization

[[File:UMS School App.png|frame]]
UMS School App is available for iPhone, Android and Windows Phone. It will be designed with the school’s own logo, color and style. The app gives the basic functionality to see:

*News
*Timetable
*Homework
*Grades
*User information

Additional licenses gives the ability to create, edit and see more information from various modules. For an overview of module requirement see "[http://wiki.inlogic.dk/index.php?title=App&section=6&wteswitched=1#Additional_functionality Additional functionality"]

==Support==
We provide regular support for the following and newer versions:

*Android version 7.0. We support the same versions as Google provide security updates for. Find an overview [[wikipedia:Android_version_history#Code_names|here]].

*iOS version 10

*Windows 10 Mobile (version 10)

Please note that it is possible to run older versions. If support for older versions is needed, we offer support at our hourly rate.

==Prerequisites==
===Supported administrative systems===

*Userinfo: Easy-A, SIS, LUDUS and Lectio (Only mobile number).
*Grades: Easy-A, Lectio and SIS
*Homework: Easy-A and SIS.
*Timetable: Easy-A and SIS
*Attendance registration: Timetable data is retrieved from Easy-A, SIS, LUDUS, Tabulex and Lectio. Howerver, absence is only registered to Easy-A

===Module requirements===

*UMS Web (contains and run all the webservice that is required for the app to receive information and communicate with the server)

===Additional functionality===
You get more functionality in the app by having the following modules, these are all optional:

*Attendance Registration: Gives “Your attendance”, which shows student statistics, the student are able to add absence reason and see their absence status in the timetable
*Attendance Registration for UMS School App: gives employee “attendance registration” and student the ability to "report absence"
*Homework: gives the employee the ability to create homework
*Link Collection: gives links/bookmarks the school can setup
*User info: gives “Your information” the ability to edit the information. This also adds the functionality for the user to upload a new profile image (a selfie) to be used in the student id card
*Student & Employee Id: Gives the students a “student id card” and the employees an “employee id card”. To update their student id card profile image you’ll need the “User info” module
*Parking: Parkzone & APCOA Integration. Gives the option to create and edit parking permits from Parkzone and APCOA
*User information (add/edit)

Note: All Attendance functionality requires Attendance Registration.

===Testing after setup===

The app will be tested internally at inLogic before release. The test requires access to a user with relevant data. You can either create a fictional student who is associated to a real course, or alternatively use a real student's account, if the person agrees that the account is being used for a system test of the school's APP.

===What to have ready===

*'''Important''': The UMS site needs to use HTTPS and be public available. It needs a valid SSL certificate.
*Materials that can be used for designing the app. For example: Logo, brochure, design guide line, etc.

*Optional: It is possible for the school to have its own account where the app is located. An account in the App Store cost $99 per year, while an account for Google Play costs a onetime fee of $25. The school self-manage these accounts.

===Physical hardware requirements===

Having a smartphone is a necessity, either an Android, iOS or a Windows 10 Mobile.

===Should third party be contacted===

If the school is using a dedicated hosting service, they have to be informed on how you wish the news feed should be setup.

==Installation and setup==
inLogic will publish and update the app.

If you want your own AppStore and Google Play store pages, you will need your own Apple Developer Account for the iOS version, this is a requirements from Apples Guidelines. [[App Store Connect|Please follow the guide App Store Connect]].

Android and Windows Phone can be published through inLogics account or your schools own account (if you have acquired one). If you have your own account inLogic needs to be informed as well. To publish the app, inLogic needs the following information:

*[[UMS Web]] url address- This is the address that you use wen you access UMS Web. (If you are running any kind of gateway (TMG, UAG etc.) you will need to create rules for the services on UMS Web, contact us for more information)
**''<nowiki>https://*****.dk/</nowiki>''

===My School App===
My school app (Danish: Min skole app) is the inLogic app that is hosted by inLogic, this lets your school get started using the app faster and cheaper, and also there is less maintenance for you.

======What does this mean?======
Pros:

*Lower start-up price.
*No need to set up an Apple Developer account.
*Upon contacting InLogic Support your app can be live within a few hours.
*You can change logo, images & colors after the app is deployed

Cons:

*The app will not be called your schools name on you phone and in AppStore/Google Play, but is instead called 'My school app' (danish: Min skole app), and its app icon cannot be customized.
*When students & teachers starts up the app for the first time, they will need to select their specific school before proceeding to login.

 

=====Setting up My school app=====
<blockquote>Configurator -> Web setup -> App -> Setting</blockquote>
[[File:App levitas settings.png|none|frame]]

Here you need to configure a Primary and Secondary color, as well as a Logo. The Login background and Menu background images are optional.

The first time you set this up, you will need to contact InLogic support, and provide the following:

*A 64x64 pixels version of your logo (this logo is used in the the login dropdown, it will make it easier for users to find your school)
*UMS Web url (See [[App#Installation and setup|Installation and Setup]])

==Styling==
To style the app following is needed:

*Primary color
*Secondary color
*Logo (.png, vector file: .psd, .ai etc.)
*Icon for app logo (.png, vector file: .psd, .ai etc.)

The primary color will mostly be used as the default background color. The secondary color is the highlight color, and will be used when something is active or being activated like a button.

Optional:

*Background image for login (size 1080x1920)
*Background image for top bar of menu (size 1080x480)

===Examples of styling===

*Primary and secondary colors

[[File:App - Timetable view.png|none|thumb|Example of primary and secondary colors used in the app.
The primary color is used in the Header navigation bar, and the secondary color as border on the selected Calendar date
]]

*The schools logo - Max. 1024x576

[[File:Branding-af-app-inLogic-logo.png|none|thumb|Example of the inLogic logo used in the Demo app]]

*App logo - 1024x1024. If not supplied, inLogic will generate an App logo based on the schools logo (does not apply to My School App)

[[File:Simulator Screen Shot - iPhone SE - 2018-05-15 at 12.57.23.png|none|thumb|Example of app logo in use]]

*Login background image - 1080x1920. If not supplied, a white background will be shown, with your logo on top

'''''NOTE: The app will place your logo on top of the background image. This means when you supply a background image, it needs to be without logo on it.'''''[[File:App - Login screen.png|none|thumb|Example of a background image used on the Demo app login screen.
The school logo will be displayed on top of the background image, as seen here
]]

*Menu top bar image - 1080x480. If not supplied, a white background will be shown

[[File:App - Sidebar menu.png|none|thumb|Example of an image used on the Demo app menu view]]

==Technical settings==

The following sections show how to configure the app. This information only applies to services that are directly connected to the app, i.e. how to set up schedule tasks in the app. The only exception is 'UMS RSS Feeds', which is a specific service for app. If a fully detailed setup guide is needed, please go to that specific module.

Some of the configurations are not set up specifically for app, i.e. ParkZone. If you cannot find the setup guide you are looking for, you can find it by searching or on the front page. Please note that some changes made in the configurator not only will affect the app but also UMS Web.

'''Important''' As many settings only loads once the website is initializing, most changes require an IIS reset on the server. The app retrieves settings from UMS once a day, which means that changes will be visible the next time you log in or the next day.

===Menu Settings===

You are able to set the order and which menu buttons should be shown per template for the users

#Open UMS Configurator
#Templates -> Edit -> select a template -> App
#Under Menu order select Manage -> Add
#Write a Description
#Drap and drop the menu you want

[[File:MeunOrderSettings.png|none|thumb|789x789px]]
Here three menubuttons will be visible to the users on that specific template.

===History===
Before version 2.0.917, you used to choose the modules displayed in the app via the Configurator -> Web Setup.

We have moved the menu order into the Configurator -> Template Editor -> App -> Menu order.
[[File:Menu settings history.png|none|thumb|1600x1600px]]
This change was made to allow a different menu items and orders on Templates.

===News===

----

This describes how to setup news for the app.

*App News created from UMS Web
*Add a RSS feed
*Add Facebook feed

It is possible to use all three setups together. Combine as you like and set difference feed for difference templates.

====Setup for App News from UMS Web====

You need to create or use an existing AD group. This group will have access to create and modify news in
App News on UMS Web.

#Open UMS Configurator
#Menu -> Web Setup -> Edit -> App
#Add the AD group for News Access group

[[File:App newsaccessgroup.png|none|thumb|767x767px]]

====Setup for RSS feed====
Add server name for the service for RSS feed in Menu -> Modules -> Settings -> RSS Feeds

[[File:App rssfeedservice.png|thumb|none|594x594px]]
To setup Rss feed you will need the url for the rss. (E.g. http://inlogic.dk/feed)

Menu -> Templates -> Edit -> select template -> Rss Feeds

Manage -> Add… -> Fill in description, feed url and access token
[[File:App rssfeedurl.png|none|thumb|920x920px]]
'''Note:''' You only need an access token if the feed is from Facebook

The RSS feed runs as a service called “UMS RSS Feeds”. Default running every 5 min.
[[File:App services.png|none|thumb|561x561px]]
Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log
[[File:App rssfeedlog.png|none|thumb|944x944px]]

====Setup for Facebook news====

If you want to use a Facebook page news feed, you need two things:

*Facebook Page Url Feed
*Access Token

=====Facebook Page Url Feed=====

To create the feed url

#Get your facebook page url
#*E.g. https://www.facebook.com/inlogic.dk
#Copy the name. E.g. “inlogic.dk”
#*Note: this can also be a number “142642699097242”
#Replace “inlogic.dk” with your name in this url
#*<nowiki>https://graph.facebook.com/v3.0/inlogic.dk/</nowiki>

Your facebook page url feed should look something like this:

*<nowiki>https://graph.facebook.com/v3.0/schoolname/</nowiki>

This is your feed URL.

=====Create a facebook access token=====
The personal Facebook account that you use to register as a developer does not need to be associated in any way with the page or group whose posts you want to display. You cannot log in to the Developer site using a Facebook Page or Business account. You must use the username and password from your personal Facebook profile. Facebook doesn’t allow businesses to register as developers, only individuals.

Please follow [https://developers.facebook.com/docs/apps/register Facebook guide] to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to [https://developers.facebook.com/tools/explorer Facebook Graph Explorer]

#Select application
#Select “Get Token” and “Get App Token”
#Copy the Access Token

[[File:App facebookgettoken.png|none|thumb|968x968px]]
Now you have the access token you need to paste into the configurator.
[[File:App rssfeedurl.png|none|thumb|920x920px]]
Reload the service UMS Rss Feed in Services and look in the RSS Feed log to validate.

===Grades===

----

You can set the default view for grades, that filters the grades accordingly. The options are Course, Day and period.

Configurator -> Web Setup -> Edit -> App -> Default grade view
[[File:App gradesview.png|none|thumb|801x801px]]
To specific the period you can set how your terms are set with start and end day for each period.

Configurator -> Modules -> Grades -> Select the Datasource -> Edit -> Terms
[[File:App gradesterms.png|none|thumb|706x706px]]
Depending on which administration system you’re exporting grades from the columns can vary. You can set which grades column should be used and in which order.

Configurator -> Web Setup -> Edit -> App -> Select grade columns
[[File:App gradescolumns.png|none|thumb|709x709px]]
The grades view in the App will change accordingly to which columns chosen, a max of 4 columns will be shown in the App. The columns will be shown for each grade in order from 1 to 4.

If no grade columns settings is made the default columns will be selected in the following order:

*EducationDescription
*CourseDescription
*EvaluationFormDescription
*GradeValue

===Your information===

----

You can select which fields in user information that should be editable.

Configurator -> Web Setup -> Edit -> Userinfo
[[File:App userinfo.png|none|thumb|800x800px]]
You need to set permission before the users are able to upload their own student photo (a selfie).

Configurator -> Web Setup -> Edit -> UMS Photo -> Enable Selfie in App
[[File:App userinfoselfie.png|none|thumb|802x802px]]
This will enable selfie function.

===Student ID And Employee ID===

----<blockquote>''This content has been moved to [[Student / Employee ID]]''</blockquote>

===My Absence===
----The students are able to write an absence reason on an already registered subject. This can be enabled in the template editor.

Select the template -> Absence -> Manage -> Create a new settings or select an existing one -> Add/Edit

Check "Allow students to register absence reason"

[[File:Absence settings.png|none|thumb|570x570px]]

'''Allow students to register absence reason''' will allow the students to set an absence reason when a teacher has set the student as absent. The student can set an absence reason in "My absence".

'''Days back''' is the number of days back the students are allowed to set an absence reason.

'''Show Course''' will show the course view (this will effect both web and app).

'''Show Activity''' will show the activity view (this will effect both web and app).

===Push Notification===
----<blockquote>'''''Temporarily disabled'''''</blockquote>UMS can send push notifications when there are news, grades, or changes in your timetable. It is possible to receive a daily notification with your timetable for the day.

In addition the app can receive [[SMS Alert]] messages.

To set up push notifications go to Web Setup -> App -> Manage -> Add
[[File:AppPushNotificationSettings.png|none|thumb|526x526px]]

Set the description

FCM Server Api Key:

#Receive the key string from inLogic and paste it

Windows Phone:

#Receive the Package SID and Client secret from inLogic and paste the strings

====School account====
In case the school has it's own account do the following to retrieve the information

FCM Server Api Key:

#Open https://play.google.com/apps/publish
#Google Play Console -> Settings -> API Access -> Create linked project and open it -> Credentials
#Create API Key
#Select the API Key and make key restriction for Android
#Type in your package name and SHA-1 certificate fingerprint
#Copy the API key and paste it inside FCM Server API Key

Windows Phone:

#Open https://developer.microsoft.com/en-us/dashboard/apps/overview
#Select your app
#Services -> Push notification -> WNS/MPNS
#Select "Live Services site"
#Copy and paste the Package SID into the configurator
#Generate an Application Secret if none exist
#Copy and paste the Application Secret into the configurator (This is the Client Secret)

===Links===
----[[UMS Links]] can be used by both UMS Web and UMS App. Check the [[UMS Links|guide]].

===Homework===
----See [[UMS Homework]]

===Parking===
----See [[Parking]]

===Notify absence===
----See [[Attendance Registration#SMS and App settings for notify absence|App settings for notify absence in attendance registration]]

===Sms Alert===
----See [[SMS Alert]]

===Privacy Policy===
----To add your own privary policy in the app go to Web Setup -> App

Insert into "Privacy Policy Url:"

If left empty it will default to inLogic's privacy policy "https://www.inlogic.dk/om-inlogic/privacy-policy/"
[[File:App privacypolicyurl.png|none|thumb|792x792px]]

To add it to the App Store login

#https://appstoreconnect.apple.com/
#My Apps
#Select the app
#Select the top menu App Store
#Select App Information in the left menu
#Add your privacy policy url to "Privacy Policy URL"

[[File:App appstore privacypolicy.png|none|thumb|955x955px]] 
===Force language setting===
----Should you wish to, you have the option to force the language of the app to use a specific language, rather than the phones default language.

This is changed via the 'Forced language' feature in the Configurator.
[[File:Forced language.png|none|frame]]
The list of languages will expand over time, as UMS adds support for new languages.
 

== Custom localization resources ==
see [[Custom Terms and Localization]]
 
==FAQ==

===Untrusted Certificate Error on Android===
'''''We do not recommend using Comodo certificates since they have been known to cause these issues.'''''

Can't login on some Android devices? This could be due to an untrusted Comodo SSL Certificate. We were able to reproduced it on Android version 4.1, 4.4.2, 5.0.1 and 8.1.0, but it may be present on any number of versions.

You can test your SSL certificate on https://sslanalyzer.comodoca.com/

Do the following on the server

#Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
#Enable automatic root certificate updates on the server

Please checkout the Comodo support site: https://support.comodo.com/index.php?/Knowledgebase/Article/View/1019/38/untrusted-certificate-error-on-android

For future conservation:<blockquote>Certificate is not installed correctly; the certificate needs to be chained back to the Addtrust root certificate in order to be trusted on the Android.</blockquote><blockquote>The issue is that the Windows server is not presenting the complete certificate chain; clients which do not have the complete certificate chain will result in this error as encountered on the Android phone. In order to resolve this, on the server which this certificate is installed on, please open the MMC (Microsoft Management Console), and add the certificate snap-in for the computer account on the local computer.</blockquote><blockquote>In the Intermediate Certification Authorities folder, verify if the Comodo RSA Domain Validation Secure Server CA and Comodo RSA Certification Authority(issued to Comodo RSA Certification Authority, issued by AddTrustExternal CA Root) are installed in this certificate store.</blockquote><blockquote>In the Trusted Root Certification Authorities folder verify if the AddTrustExternal CA Root is installed. Also, if you see the Comodo RSA Certification Authority (issued to and issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038) is present, if it is please delete this certificate.</blockquote><blockquote>If any of these certificates are missing the intermediate and root certificates were provided to you in the .zip file when the certificate was issued, or are available via this support article - <nowiki>https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2</nowiki> .</blockquote><blockquote>If you had to delete the Comodo RSA Certification Authority from the Trusted Root Authorities folder, you will also need to disable automatic root certificate updates on the server - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008</blockquote><blockquote>If you have performed these steps and the certificate chain has not updated on the server, to force IIS to update the certificate chain you will need to either change the certificate binding in IIS to another certificate, and then switch the certificate bindings to the correct certificate. Alternately, you will need to restart the server.</blockquote>Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008<blockquote>To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.</blockquote><blockquote>To turn off Automatic Root Certificates Update:</blockquote><blockquote>1. Click Start, and then click Run.</blockquote><blockquote>2. Type gpedit.msc, and then click OK.</blockquote><blockquote>3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.</blockquote><blockquote>4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.</blockquote><blockquote>5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.</blockquote><blockquote>6. Close the Local Group Policy Editor.</blockquote><blockquote>Note: You can use Group Policy to set policy settings that apply across a given site, domain, or organizational unit in Active Directory Domain Services.</blockquote>

===Issues with the app===
If you're facing issues with the app, please perform the following steps before contacting support:

*Check the AppStore/GooglePlay for app updates and install any present
*Shut down the app completely, and start it back up
*Restart the phone
*Uninstall the app, and redownload it from AppStore/GooglePlay