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

    Events

    Overview

    The Events product integration allows students, lecturers, and other users to view events and events details and to save events as favorites on the campusM app.

    Vendor

    Currently the Events product integration supports importing events with an Excel file or an RSS feed.

    User Experience

    The following section describes information relating to the user experience for the Events product integration.

    User Workflow Diagram

    The following diagram displays the user workflow:
    events_user_workflow_diagram.png
    User Workflow Diagram

    Offline Support

    Users can view cached data from previous sessions. New data will not be visible and the additional filtering functionality will not work.

    Screenshots

    The following is an overview of the Events product integration user interface for a reference when configuring it.
    Users can select an initial filter (if configured), a date (required), and a campus (if configured): Users can then view all of their events: Users can search by Description or Title from the search bar and add filters using the filter button in the right upper corner of the All Events page:
    welcome_events_planner.png
    filtered_events.png
    filter_events.png
    Users can remove filters using the eraser button in the upper-right corner in the last image above. After selecting Apply Filters, the All Events page is displayed and the additional filter button is highlighted. This indicates that the events displayed are filtered by the selected filters: Users can select an event to see more details about the event: Users can mark the event as a favorite by selecting the Add to Favorites icon in the upper-right corner. The icon is highlighted for favorite events:
    filter_events_icon.png
    events_details.png
    favorite_events.png
    Users can then see their favorites and saved events on the My Events page: Favorite events are indicated by a gray background on the All Events page: Event Live Tile
    my_events.png
    favorite_event_indication.png
    Events-live-tile.png

    Additionally:

    • Users can clear their events by selecting the trash icon on the My Events page.
    • Users can remove a specific event from their favorites by selecting the favorites icon in the event details page.
    • When opening the Events tile for the first time, users select their initial filters, which are then applied automatically when selecting the Events tile. The filters can be changed from the Home page.
    • Users can navigate between the pages of the Events interface using the Home, All Events, and My Events buttons.

    Technical Overview

    The following section describes technical information for the Events product integration.

    Prerequisites

    The following section describes the prerequisites for importing events data using an Excel file and an RSS feed.

    Importing Events with an Excel File

    Events are imported using an Excel file that must be in a specific format. For more information, see the Configuration section.

    Importing Events with an RSS Feed

    The RSS feed must contain the following fields: UniqueID, Date, Title.

    • UniqueID must not contain the character /.
    • If a start time for the event is not provided, it defaults to 00:00.
    • If an end time for the event is not provided, it defaults to 23:59.
    • If using the initial filter, provide a field to act as the filter value.
    • If using the campus filter, provide a field containing the campus.

    Configuration

    To configure the Events product integration, select Add Product Integration from the Product Integrations main menu option.
    Select Events and the configuration page appears. The following table describes the configuration options available on this page.
    Configuration Option Description Mandatory Data Type Default Example
    Enable Product Integration Select to enable the product integration on the user's campusM app. No Checkbox Unselected  
    Product Integration Description A description of the product integration for internal use Yes String    
    Screen Title The title that appears in the top header of the service No String Events My Events
    Vendor/Data Source
    Data Source Defines which vendor the integration connects to. Yes Object - RSS Feed
    URL to retrieve the information The base URL should include path parameters Yes URI https://myDomain.com  
    URL Query Parameters Any additional query parameters required by the vendor. No Array    
    Parameter Name The name of the parameter No String    
    Parameter Type Choose a parameter type that matches your needs. i.e. Select 'Username' to use the username attribute associated with the end user. No Object   Username
    Token Property Name Enter the property name to be retrieved from the token ({ USERNAME, MAIL, GIVEN_NAME, SURNAME, FULL_NAME } or as named in the integration profile) No String   USERNAME
    Constant Value The value to use if Constant is selected as the parameter type. No String    
    URL Path Parameters Any path parameters required by the vendor. Yes Object    
    Parameter Name Enter the path parameter name as specified in the base URL, for example - if the URL is: https://someHostName/serviceName/username then the parameter name will be 'username' No String    
    Parameter Type Choose a parameter type that matches your needs. i.e. Select 'Username' to use the username attribute associated with the end user. No Object   Username
    Token Property Name Enter the property name to be retrieved from the token ({ USERNAME, MAIL, GIVEN_NAME, SURNAME, FULL_NAME } or as named in the integration profile) No String   USERNAME
    Constant Value The value to use if Constant is selected as the parameter type. No String    
    General Headers Any additional headers required by the vendor. No Object    
    Header Key   No String    
    Header Value   No String    
    API Authentication Defines the authentication for this vendor. Yes Object   Basic
    Events Data
    Date Format Select the date format for events for the import file from the drop-down list.
    For information on creating formats, see Date and Time Patterns.
    The options are:
    dd/MM/yyyy
    MM/dd/yyyy
    dd MMMM yyyy
    E, dd MMM yyyy
    dd-MMM-yy
    dd-MMM-yyyy
    Yes Drop-down List   dd-MMM-yyyy
    Time Format Select the time format for events for the import file from the drop-down list.
    For information on creating formats, see Date and Time Patterns.
    The options are:
    hh:mm a
    HH:mm
    Yes Drop-down List   HH:mm
    Time Zone The time zone for events Yes Drop-down List   UTC
    Import your File Here Select Choose File to select a file to import data.   Button    
    Import File Select this button to import your file.   Button    
    Export File Select this button to export your existing data in the DB. If there is no data for the specific instance in the DB, an empty template is exported.   Button    
    General Settings        
    Enable initial general filter   No Checkbox Unselected  
    Enable initial campus filter Select to display multiple campuses on the home page No Checkbox Unselected  
    Fields
    Mandatory Fields
    Unique ID
    Code The code for the uniqueID in the RSS feed No String uniqueID  
    Date
    Code The code for the date in the RSS feed No String date  
    Date Format The format in which the date is returned in the response No String YYYY-MM-DDTHH:mm:ss:sssZ  
    Start Time
    Code The code for the start time in the RSS feed No String startTime  
    Date Format The format in which the start time is returned in the response No String HH:mm  
    End Time
    Code The code for the end time in the RSS feed No String endTime  
    Date Format The format in which the end time is returned in the response No String HH:mm  
    Title
    Code The code for the title in the RSS feed No String title  
    Non Mandatory Fields
    Initial Filter
    Code The code for the Initial filter in the RSS feed No String initialFilter  
    Campus
    Display Field Check this box to use this field in the event details No Boolean False  
    Code The code for the campus in the RSS feed No String campus  
    Location
    Display Field Check this box to use this field in the event details No Boolean False  
    Code The code for the location in the RSS feed No String location  
    Location URL
    Display Field Check this box to use this field in the event details No Boolean False  
    Code The code for the location URL in the RSS feed No String locationURL  
    Location Code
    Display Field Check this box to use this field in the event details No Boolean False  
    Code The code for the location code in the RSS feed No String locationCode  
    Description
    Display Field Check this box to use this field in the event details No Boolean False  
    Code The code for the description in the RSS feed No String description  
    External URL
    Display Field Check this box to use this field in the event details No Boolean False  
    Code The code for the external URL in the RSS feed No String externalURL  
    Additional Fields
    Fields Any extra fields other than the ones defined above No Array    
    Code The code for the field No String    
    Label The label to use for this field in the event details page No String    
    Live Tile          
    Enabled Select to display the live tile No Checkbox Unselected  
    Upcoming Event Enabled Select to display the tile title No Checkbox Selected  
    Upcoming Event Label Override the default text: Upcoming event: No String   Next Event
    Event Name - Enabled Select to display the event's name in the live tile No Checkbox Selected  
    Event date and Time - Enabled Select to display the event's date and time in the live tile No Checkbox Selected  
    Event Location - Enabled Select to display the event's location in the live tile No Checkbox Selected  
    General
    The time and date settings in this section affect the times and dates for the events that are displayed to users. For information concerning acceptable formats, see Moment.js Documentation.
    Default Locale Enter a default location No String en-gb  
    Time Format Enter the time format to be used in the service. No String LT  
    Date Format (short) Enter the short date format to be used in the service. No String ll  
    Date Format (long) Enter the long date format to be used in the service. No String LL  
    DateTime Format (short) Enter the short date/time format to be used in the service. No String llll  
    DateTime Format (long) Enter the long date/time format to be used in the service. No String LLLL  
    Look and Feel No      
    Primary Theme Color Select a color for the main elements on the page No Color Picker #444444  
    Secondary Theme Color Select a color for the secondary elements on the page No Color Picker #6f8ea4  
    Text / Labels Enter replacement text for the default titles and labels No String    
    Events Home Page Title   No String Welcome to Events Planner  
    Choose a Campus is Home Page Title   No String Choose a campus:  
    Choose an Initial Filter in Home page Title   No String Choose an initial filter:  
    Choose a Date in Home Page Title   No String Choose a date:  
    Events Browse Page Title   No String All Events  
    Navigation Menu: 'Home' Item Title   No String Home  
    Navigation Menu: 'All Events' Item Title   No String All Events  
    Navigation Menu: 'My Events' Item Title   No String My Events  
    Events Favorites Page Title   No String My Events  
    Events Filter Page Title   No String Filter Events  
    Error Message - Unexpected Error   No String Unable to reach the service at this ti,e. Please try again later  
    Error Message - Refine Search   No String Sorry, no events were found. Please refine your search  
    Error Message - No Data in Database   No String Sorry, no events were found. Please try again later.  
    Event Subject   No String Event  
    Event Initial Filter   No String Initial Filter  
    Event Date   No String Date  
    Event Start Time   No String Start Time  
    Event End Time   No String End Time  
    Event Location   No String Location  
    Event Description   No String Description  
    Event Campus   No String Campus  
    Event External URL   No String External Url  
    Load More Button Text   No String Load More  
    Import/ Export Configuration
    You can configure product integration and then export it to another campusM environment, for example, from sandbox to production or from preview to production.  
    Export Create a JSON file with all product integration configuration. No      
    Import Use this option in order to load configuration from JSON of an exported product integration. No      

    Exporting Data from the Events Service

    You can export the event data from the Events service to an Excel file. This file can then be edited and reimported. Indicate in the Date Format and Time Format fields the format in which the date and time will appear when importing and exporting event data. For information on creating formats, see Date and Time Patterns.
    To export the events data, select Export File.
    See Events Import Example Excel for an example of an events import Excel file.

    Importing Data to the Events Service

    You can import events data using an Excel file to the Events service. The first 11 columns of the Excel file can have only the following columns:
    Column Heading Name Description Mandatory
    A Unique ID The event unique identifier Yes
    B Initial Filter Any description to indicate initial filtering (e.g. Week 1,Week 2.../ Computer Science, Physics...) No
    C Date The event date Yes
    D Start Time The event start time Yes
    E End Time The event end time  Yes
    F Campus The campus where the event takes place No
    G Location The location of the event No
    H Location URL The URL of the location. The location is displayed as an external link to this URL. No
    I Location Code campusM location code (Number) 
    The location is displayed as an internal link to the position that has this code. The location code is the number at the end of the URL of the change position page in the App Manager, for example: https://appmanager.ombiel.com/app-settings/CampusM/position/123456/.
    No
    J Title The event name Yes
    K Description The description of the event No
    L External URL External webpage for the event (URL)
    This allows the institution to send users to an external page with further event information
    No
    • You can add additional columns to the Excel file after the L column. These additional headings appear to the user, but are not configurable on the configuration page.
    • Do not change the order of the columns.
    • Cells' content must defined as type Text.
    • All dates and times must be in the same format as configured in the App Manager.
    • If the Location URL and Location Code columns both have values, the Location Code column is used to create the location link.
    To import the Excel file, select Choose File, and select Import File.
    Importing events data overwrites any existing data.
    • Was this article helpful?