Home
Install Ellucian Mobile Software
Install the Ellucian Mobile WAR file and perform basic configuration steps.
Customize and install the server configuration file
Set up the server configuration file.

Implementation Guide, May 2023, Release 5.6.3
This online help contains comprehensive information about how to install, set up, and maintain Ellucian Mobile.
Ellucian Mobile Overview
Ellucian Mobile, powered by Ellucian Ethos, provides faculty, prospects, students, staff, and other constituents with access to key campus information and services from their mobile devices. This section provides an overview of Ellucian Mobile.
Before You Begin
This section describes some advance preparations that you can make to help your Ellucian Mobile setup process to go as smoothly as possible.
Install Supporting Software
Before you can install the Ellucian Mobile components, there are several prerequisite software components that must be installed. Note that Grails is also required, but does not need to be installed separately because all Grails components that you need are included in the WAR file that you install later.
Install Ellucian Mobile Software
Install the Ellucian Mobile WAR file and perform basic configuration steps.
- Install the WAR file
  Install the Web Application Archive (WAR) files for Banner, PowerCampus, or Colleague.
- Customize and install the server configuration file
  Set up the server configuration file.
  - SIS database connection pool settings
    The SIS database connection pool settings for Banner and PowerCampus may limit your institution's concurrency for Ellucian GO.
- (Optional) Support for SQL Server and Oracle databases
  As delivered, Ellucian Mobile stores your configuration information in an H2 datasource on the Tomcat server.
Set up the Mobile Cloud Configuration System
Set up the Ellucian Mobile Cloud Configuration System. Description of the process for signing from the Ellucian Hub, how to create and enter the configuration settings, and how to specify the SIS credentials.
Manage Users and User Permissions for the Mobile Cloud Configuration System
You can give selected people access to modify specific elements of your mobile configurations, such as user management, configuration management, branding, or sending push notifications.
Customize the Appearance of Ellucian GO
Set up the home screen, select background and text colors, and set up the About screen.
Set Up Location-Aware Features
Set up Ellucian Mobile features that are location-aware; that is, based on proximity to a beacon.
Set Up Application Modules
Set up the application modules that are displayed in Ellucian GO.
Test and Publish a Configuration
To view your configuration on a device, you must place the configuration into test status. When you are ready to make your configuration available in the public list of institutions on Ellucian GO, you publish the configuration.
Analyze Usage
The Google Analytics Platform lets you measure user interactions across various devices and environments. You can use Google Analytics to view detailed usage statistics of your school's Ellucian Mobile implementation.
Manage Configurations
In addition to the ability to add a new configuration manually, you can create a new configuration by copying an existing one, export configuration information, import configuration information, and migrate a configuration to a different database.
Set up multiple Mobile Integration Server Web Service Apps
If you want to have multiple active configurations at the same time, you need to set up multiple Mobile Integration Server web service apps.
Set up Load Balancing and Redundancy
Multiple Mobile Integration Servers can be set up for a single configuration. This can be done to scale the solution to support more mobile users, or for redundancy. Deployment of multiple Mobile Servers requires a shared data storage using either a Microsoft SQL Server or an Oracle database.
Ellucian Mobile on Wearable Devices
Users can view push notifications on their Android Wear and Apple Watch devices. Users with Apple Watches can also view ILP assignments and maps.
Debugging
Send detailed information from Ellucian Mobile to the log file to support troubleshooting.
Appendices

Customize and install the server configuration file

Set up the server configuration file.

Procedure

Open the example-mobileserver-config.groovy file in an editor.
Find the ellucian.configuration.apiKey = "sample-API-key" line and replace sample-API-key with your own strong password.

Make a note of this password, because you will enter it in the configuration tool during server validation.

Note: If you choose to include a ‘$’ character in this password, you must enclose it in single quote marks, as shown in this sentence, to avoid validation errors. Do not include the quote marks when you enter the password in the Cloud Configuration system later.
Find the grails.serverURL parameter and replace all placeholder text (enclosed in brackets) with the actual values for your institution.
```
grails.serverURL = https://<externalMobileServer.my.edu>/<NameOfWarFile>
```
would be updated to something like
```
grails.serverURL = https://mobileserver.ellucian.edu/banner-mobileserver
```
The name of the WAR file must be the name of your SIS followed by "mobileserver" as shown in the example.

Note: This is your Mobile Server URL, which you will use again later in these installation steps.
Save the updated configuration file and rename it, replacing “example” with the name of your SIS.
banner-mobileserver-config.groovy.
Stop Tomcat.
Copy the server configuration file to the <tomcat user home>/ellucianmobile/sismobileserver directory.
The location of your <tomcat user home> directory depends on how you have configured Tomcat.

Example for a Banner school with Tomcat installed on Linux: /home/admin/ellucianmobile/banner-mobileserver
Examples for a Colleague school with Tomcat installed on Windows: C:\ellucianmobile\colleague-mobileserver or C:\Users\ellucianmobile\colleague-mobileserver
Start Tomcat.
Verify that the WAR file has been installed correctly. Use a browser and navigate to https:// <externalMobileServer.my.edu>/sis-mobileserver/api/2.0/version.
https://mobileserver.ellucian.edu/banner-mobileserver/api/2.0/version. Something like the following should be returned (please note that the version numbers will change):
```
{"application":{"name":"banner-mobileserver","version":"3.0.0.200"},"plugins":\[{"name":"msConfigurationCore","version":"3.0.0.200"} ,{"name":"msServerConfiguration","version":"3.0.0.200"} ,{"name":"msEvents
```