Skip to main content
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    campusM Implementation Guide

    The purpose of this document is to provide background knowledge regarding the campusM implementation process and to explain the requirements necessary to implement campusM. 


    Introduction to campusM

    For an overview of the campusM app, including product features and benefits of the campusM structure and workflow, click the following link:

    campusM Implementation Methodology

    Click the following link for the campusM Implementation Methodology document, which provides an overview of the typical Ex Libris campusM project. This includes the implementation strategy, roles and methodology of the various phases of the campusM project and is invaluable in helping your organization prepare for the project.


    Getting Started

    Environments and Integrating systems

    campusM Cloud Environments

    The campusM Production and Sandbox cloud environments are provisioned and provided by Ex Libris early in the project to facilitate early customer training on app manager and the Production environment is ultimately the environment from which your users will be served content and services, and where your static content should be added during implementation. Additionally, each customer is entitled to a Preview cloud environment - which is a clone of your campusM production environment, which is refreshed automatically once / month with the next monthly release of campusM (see additional details here).

    The main initial focus of campusM implementation is around the key areas which will allow a valuable app available to your students and users, including Branding, App Store licenses, Content creation (Creative Studio) and Maps/Location information.

    In some implementations, authentication and 3rd party integration will also be part of scope and, when included, will be deployed first on Sandbox for testing, then on Production.

    App Store Accounts

    To allow releasing apps on your behalf to the iOS app store and Google Play store, there is a requirement that your Apple Developer program, iTunes Connect account, and your Google Play Developer Account are made accessible to Ex Libris. Click the following links for instructions.

    Acquiring access to these accounts can take some time. Since this information is required for the kick off, gathering this information should start from the beginning of the project.


    Required Resources on the Customer Side

    Project Team

    In order to have effective communication between you and Ex Libris, one single point of contact should be designated on your side for project management issues and one for technical issues (In some cases, this may be the same person).

    During the time period between kick-off and go live you should plan to make the following resources available at the relevant points of the project where their involvement is needed to ensure the on-time completion of the project:



    Project Sponsor

    • Interact with the project team, stakeholders (executive and senior management), and employees during the project phase. In charge of change management and sponsorship of the project. Acquires the necessary project resources
    • Build management support and sponsorship
    • Create awareness with employees of the business drivers and need for change​​​​​​

    Project Manager – Primary project contact:

    • Oversees the project tasks, ensures the project adheres to budget and time frame guidelines
    • Manages the implementation process steps, which include setting goals, planning, and monitoring progress to completion
    • Manages customer project communications
    • Executive decision maker

    App Administrator  Initial and ongoing responsibility for the configuration and maintenance of the apps and their content

    Source Systems Specialists Customer systems expert(s) who understand the institution data structures and functional requirements to the integration points to be delivered by the app

    IT Infrastructure Team  Ensuring 3rd party systems and infrastructure meet load needs and 3rd party & University system APIs are available to the campusM environment (either publicly or via IP whitelisting). 

    IT Security  Ensuring all security concerns are met early in the project lifecycle

    Marketing  Involvement in the app branding process, internal communication regarding the deployment and promotion of the app, content management

    Developer (if applicable)  Optionally develop new screens and app functionality based on campusM Application Extension Kit (AEK) - requires the relevant campusM subscription level


    The campusM kickoff is a key component in the design stage. During this interactive workshop (which may be done remotely or on-site at Ex Libris' discretion), Ex Libris will work with the customer to review the project's integration scope and pre-requisites and review the timeframes and tasks for the implementation in detail. When done on-site, the following information is important for the customer to follow and prepare.

    On-Site Technical Required Resources
    Microsoft Teams or Cisco WebEx

    Ex Libris uses Microsoft Teams or Cisco Web Ex for all of its online meetings and training offerings. Additionally, it is recommended that customers have the following equipment available:

    • A monitor for individual viewing and the ability to project on a large screen for group viewing
    • Speakers and a microphone or telephone with conference call or hands-free capability for audio participation
    Room Requirements for on-site Kickoffs
    The following are the technology requirements for rooms where an on-site kickoff takes place:
    • Presenter’s workstation:
      • The ability for the Ex Libris presenter to connect a laptop to the Internet (wired or wireless)
      • Allow connecting to an LCD projector via standard VGA cable to demonstrate to an audience (overhead installation preferred)
      • Situated at the front of the room, ideally to one side and facing the participants 

    The room should be a quiet place where disturbances are minimal. The ability to control temperature, light, and organization of the space will allow participants to be as comfortable as possible. The Ex Libris presenter and participants need access to the room prior to the day’s start as well as during lunch and breaks.


    The Define phase is the largest part of the implementation project.

    During this phase (typically up to 10 weeks or more than half of an average project), the scope and timeline of the project is communicated and agreed and the required prerequisites are gathered.

    The effective execution of the Define phase allows the Build phase to proceed in a streamlined and on-schedule manner.

    The APF Point

    The final step of the Define section is the APF point ('All Pre-requisites Fulfilled' milestone, see the detailed implementation flow chart).
    At this point, all the prerequisites for the different parts of the implementation should have been provided to Ex Libris for verification. To avoid potential delays, prerequisites should be provided to Ex Libris as they are ready rather than waiting until the APF point to provide all at once.

    Ex Libris then reviews the provided information to make sure that all the needed information to setup all relevant scope and build

    the app according to the project's Project plan was received and valid.

    This stamp throughout the document represents the elements that are required to be delivered by the APF point.  


    The following is a list of the inputs required for the APF stage completion. Click each item for more information:

    Using a Custom Domain Name for campusM

    By default, your web app domain is in the following convention: <cust_code>

    However, it is possible to request a custom domain name to be used for your campusM hosted server.

    For more information regarding working with custom domain names on hosted Ex Libris, click the following:

    if you are obtaining an SSL certificate signed by QuoVadis (JISC obtain their certificate from QuoVadis), you will be required to ensure that you request the certificate to be signed by QuoVadis Root CA2, if the certificate is signed by the G3 root it will not be trusted by Android 4.x (i.e it would not be supported) 



    Each campusM app is separate and unique.

    Ex Libris provides a dedicated design team that uses the branding guidelines provided by the customer to design the app home page. 

    The minimum requirements for branding are:

    • App name (Appears on the device. Has to be unique. 12 Characters)
    • App Long name (Appears in the app store. Has to be unique. 30 Characters)
    • App icon png files (The app icon has to be unique. Two apps cannot have the same icon in the store. it is recommended to provide two different icons; one for the live production app and one for the sandbox app in order to easily distinguish between the two)
    • Header icon png files
    • University branding guidelines
    • Fonts
    • Color Palette

    Also needed is a list of the tiles names for the designer to create. for example:

    Common standard tiles (besides 3rd party integrations):

    • Maps
    • Alerts
    • News and Events 
    • Pocket Guide  
    • Emergency contact
    • Banner
    • Welcome To the University 

    Ex Libris will create a document with several branding mockups of the homepage for your review. See below an example for such document. this document will be sent over for your review and approval. Upon approval, the assets will be loaded into the app.


    For more information, click the following for the campusM Branding Guidelines document:

    The branding guidelines should be provided along with the rest of the required prerequisites by the APF point, at the latest.

    The branding process coordinated between you and Ex Libris is done once during the implementation process


    Determining and familiarizing administrative staff with campusM's batch notification capabilities is a key point of the implementation process. More information on the notification capabilities for campusM can be found here.

    Maps and Locations Information

    Maps and locations within the app enable the end user to search for buildings and other services by name, pinpoint them, and navigate campus maps using real GPS coordinates.

    Ex Libris project team will provide you with an Excel worksheet which you'll completed and send back in order to do a full initial setup of all the relevant maps and locations in your app. More information here.

    Adjustments and updates may be performed via the App Manager at any time.

    In addition to defining positions in the Excel sheet, campus map images may also be provided (this can be one per campus) with the following requirements:

    • png format image 
    • Facing north
    • To scale, so we can overlay onto Google Maps
    • No larger than 1500px on the longest side
    • Less than 1MB in size
    • Map top left latitude, GPS top left longitude.
    • Map bottom right latitude, GPS bottom right longitude

    Static Content

    The App Manager offers administrative abilities around Content Management using Creative Studio, allowing the administrator to add static content and publish the changes directly to the app independently.

    Following the on-line App Manager training and the kickoff, the customer may begin adding and arranging the static content into the campusM app. This should be performed on the Production environment. This includes adding pocket guides, about / information, and all content-based tiles. 

    Since static content is crucial for submitting the app to the app stores for acceptance, it is required to complete this task before the app test period.

    See the relevant milestone Static Content Completed in the detailed implementation flow chart at the end of the Build phase.

    For more information regarding the addition and management of static content, click the following link:


    Authentication is a primary component of many campusM profiles and integrations and as such, will typically be the first component setup prior to any integration deliveries. campusM supports several external authentication methods:

    • SSO Authentication (SSOGROUP) 

    The supported SAML 2.0 authentication systems:

    • Shibboleth
    • ADFS
    • OAuth
    • Authentication against secure LDAP (AUTHGROUP) – this method can be implemented for a native app and web interface. 

    The following is the list of the available internal authentication methods that can be configured from the App Manager and do not require any integration:

    • Standard Authentication (GROUP) - used for guest authentication.
    • No Authentication (ANON) - usually for guest users where the user clicks on the Guest profile and is logged in immediately. 

    Since authentication is a prerequisite for many other integrations with back-office systems, it will typically be the first element set up when setting up your campusM system.


    When campusM will integrate with your institution's 3rd party systems, it is strongly recommended to supply access to the data of those systems according to the documented and defined pre-requisites (as defined here) and via online Web-accessible public credential-based APIs. For more information on integrations, see below.

    In case your institution cannot supply secure credentialed APIs publicly, Ex Libris supports white listing of IPs to the relevant IPs required to run the service and allow the relevant Ex Libris services to communicate freely with your services, according to the required general and regional IPs, as described in the Whitelisting IPs for campusM (Note: in case your institution cannot supply APIs at all - this will involve additional maintenance and efforts - see the next section on the Connect Layer)

    Connect Layer Installation and Ex Libris Access

    In case your campusM implementation includes integration with other systems that cannot be supplied via API, Apache Tomcat on-premises Linux-based servers are required to be provisioned by the customer (one Production and one Sandbox). These servers are called the Connect Layer and have to be publicly accessible via HTTPS from outside the university. Best practice for campusM is to provide access to your 3rd party systems via APIs and to avoid the need for your institution to procure, provision and maintain additional servers and services and allow campusM to deliver its service as a pure SaaS service.

    When needed, the Connect Layer is a prerequisite that must be set up before any on-premise system integration work can start. It is crucial to have the Connect Layer server in place and accessible before the kick off.

    The Connect Layer, if needed, must be accessible publicly via secure HTTPS from the Ex Libris cloud servers and must also be accessible for campusM technical staff via SSH (via VPN) to manage the web service code deployed on the servers. Additionally, these servers should have access to the appropriate back-end university systems which were not available via API. The back-office systems should also be accessible via VPN IP range of the University outside of the Connect Layer servers to allow appropriate back-office end-point troubleshooting.

    The campusM cloud Production environment will be associated with the customer's analogous local Production connect layer and back-office systems, while the campusM cloud Sandbox will be associated with the customer's analogous Sandbox connect layer and back-office systems.

    The document available below details the activities required to be completed by the university's technical team before the kick off. Information on recommended load balancing and testing is also covered in this document.

    platform updated2.PNG

    Product Integrations - Requirements and Prerequisites

    In addition to the key app features configured such as branding, maps and content, campusM may provide access to one or more of the standard University services, for example: Learning Management System (VLE / LMS) resources, Library Information System (LIS) classroom and library availability hours, Student Information System (SIS) events calendar, and student records, including course enrollment and grades. The specific systems to integrate with are contracted for and denoted in your contract and Project plan.

    There are also other relevant services that can be incorporated into the apps for the benefit of students.

    These services are presented as tiles in the campusM app. The source of the displayed data is accessed via 3rd party systems via API or via the institutions network.

    To initiate the integrations for these services, Ex Libris may require API information, system details, sample data, connection information, and test credentials, in addition to other requirements for the completion of the requested integrations. Your Ex Libris project team will solicit the relevant pre-requisites needed for each integration in the early part of the define phase.

    For specific information on supported product integrations, including pre-requisites can be found here.

    Prerequisites defined for each integration in the Project Plan must be provided during the define phase, no later than the agreed APF date.

    App Configuration Checklist

    The objective of this checklist is to verify that the essential configuration and setup needed for launching the app has been completed. 


    Integration Checks

    As each integration is ready for testing during this phase, it will be delivered for customer testing on the Sandbox environment. As each integration is confirmed, it will be moved to the Production environment.

    General testing guidelines are included with each standard integration's documentation in the integration directory, as noted above.

    General App Checks

    This is a list of suggested checks to run on your campusM app to verify configuration and availability. As each integration is ready (setup, configured and checked by Ex Libris) it will be delivered back for your testing later in the Build phase.

    Load Tests

    It is recommend that you perform load testing on the intended interfaces of your integrated systems (for example, the timetable integration may invoke a web service or pull the data via a database view from your University). It is your responsibility to ensure your backend system/s are capable of handling the estimated peak load based on the expected usage. As noted above, Load test recommendations are covered in the Tomcat Install Guide, for sites with Connect Layer installations. 


    App Center

    campusM development builds for both iOS and Android apps are accessible to app testers via the App Center system.

    App Center can be installed from the Google and Apple app stores. It is a tool for distributing pre-release builds of apps before they go to the stores publicly.

    All testers must be invited to be a beta tester for the apps they desire to test.

    See the following guide for information regarding the use of App Center:

    hockey app.PNG

    While Android users can be sent builds immediately after registering, iOS users must register their device specifically before they can be sent builds, and registration may take a day or two to be approved. Users of iOS devices should be encouraged to register their devices shortly after receiving their invitation. (From App Center support page - How to install iOS beta apps). Alternately, you can provide your campusM staff with the devices' UDIDs in order to bulk provision them instead of one-by-one.

    App Submission

    The app store document is used when the app is submitted to Apple and Google stores for approval.

    This MS Excel sheet contains all the formal information needed in order to submit the app. We use the provided information in this document, along with screenshots of the app and the app icon (which will be finalized during the branding phase) to submit the app for approval.

    Note that it can take a several weeks for the app to be approved, so it is crucial to submit it on time in order to meet the project schedule and go-live date.

    The app store document should be provided by the APF point.


    Additional Product Information


    Ex Libris delivers training for the campusM administration interface, App Manager, and provides several related introductory and more advanced training recordings.

    In addition to the training recordings, Ex Libris provides a robust set of reference and How To documentation that allows the customer to discover more about the campusM product and its capabilities, all available on the Ex Libris Knowledge Center.

    Ex Libris also supports a growing campusM community that engages its members through an array of channels. These include the Developer network, useful knowledge articles, regional user conferences and the online customer Slack channel where other campusM users can share experiences and best practices and where Ex Libris can provide important product-related updates.

    campusM as a platform

    campusM's robust platform allows customers with the relevant technical skills to extend and add to the standard functionalities campusM offers. This can be done via wide framework of developer tools, including the Application Extenstion Kit (AEK) used by customers to create custom user interface tiles and functionalities, the Connect Layer Extension Kit (CLEK), if relevant, to extend the ability of the customer's AEK screens to access University data which may not be available directly via API.

    Additionally, each campusM customer will be provided a secure API key unique to their institution which allows invoking various key campusM functions programmatically, including Push notifications, Analytics and User/Role sync updates.

    Relevant training, recordings, documentation and useful examples are available for developers on the Ex Libris developers network.


    Important Links