App

From UmsWiki
Jump to: navigation, search
UMS School App.png

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 "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 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 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. 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)
    • https://*****.dk/


My School App

My School 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', 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

Configurator -> Web setup -> App -> Setting

App levitas settings.png


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

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

  1. Open UMS Configurator
  2. Templates -> Edit -> select a template -> App
  3. Under Menu order select Manage -> Add
  4. Write a Description
  5. Drap and drop the menu you want
MeunOrderSettings.png

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.

Menu settings history.png

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.

  1. Open UMS Configurator
  2. Menu -> Web Setup -> Edit -> App
  3. Add the AD group for News Access group
App newsaccessgroup.png

Setup for RSS feed

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

App rssfeedservice.png

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

App rssfeedurl.png

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.

App services.png

Restart the service to test it and check the output in /UserManagement/RSSFeeds.Log

App rssfeedlog.png

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

  1. Get your facebook page url
  2. Copy the name. E.g. “inlogic.dk”
    • Note: this can also be a number “142642699097242”
  3. Replace “inlogic.dk” with your name in this url
    • https://graph.facebook.com/v3.0/inlogic.dk/

Your facebook page url feed should look something like this:

  • https://graph.facebook.com/v3.0/schoolname/

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 Facebook guide to enable yourself as developer on facebook.

When you have a facebook developer account and created an app go to Facebook Graph Explorer

  1. Select application
  2. Select “Get Token” and “Get App Token”
  3. Copy the Access Token
App facebookgettoken.png

Now you have the access token you need to paste into the configurator.

App rssfeedurl.png

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

App gradesview.png

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

App gradesterms.png

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

App gradescolumns.png

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

App userinfo.png

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

App userinfoselfie.png

This will enable selfie function.

Student ID And Employee ID


This content has been moved to Student / Employee ID

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"

Absence settings.png

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


Temporarily disabled

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

AppPushNotificationSettings.png

Set the description

FCM Server Api Key:

  1. Receive the key string from inLogic and paste it

Windows Phone:

  1. 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:

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

Windows Phone:

  1. Open https://developer.microsoft.com/en-us/dashboard/apps/overview
  2. Select your app
  3. Services -> Push notification -> WNS/MPNS
  4. Select "Live Services site"
  5. Copy and paste the Package SID into the configurator
  6. Generate an Application Secret if none exist
  7. 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 guide.

Homework


See UMS Homework

Parking


See Parking

Notify absence


See 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/"

App privacypolicyurl.png

To add it to the App Store login

  1. https://appstoreconnect.apple.com/
  2. My Apps
  3. Select the app
  4. Select the top menu App Store
  5. Select App Information in the left menu
  6. Add your privacy policy url to "Privacy Policy URL"
App appstore privacypolicy.png


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.

Forced language.png

The list of languages will expand over time, as UMS adds support for new languages.

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

  1. Delete the Comodo RSA Certification Authority issued by Comodo RSA Certification Authority with an expiration date of January 18, 2038.
  2. 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:

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.

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.

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.

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.

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 - https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/979/108/domain-validation-sha-2 .

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

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.

Conservation for https://support.comodo.com/index.php?/Default/Knowledgebase/Article/View/769/17/turn-off-automatic-root-certificates-updates-server-2008

To perform this procedure, you must be a member of the local Administrators group, or you must have been delegated the appropriate authority.

To turn off Automatic Root Certificates Update:

1. Click Start, and then click Run.

2. Type gpedit.msc, and then click OK.

3. If the User Account Control dialog box appears, confirm that the action it displays is what you want, and then click Continue.

4. Double-click Administrative Templates, double-click System, double-click Internet Communication Management, and then click Internet Communication settings.

5. Double-click Turn off Automatic Root Certificates Update, click Enabled, and then click OK.

6. Close the Local Group Policy Editor.

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.

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