Skip to main content
ExLibris

 

  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Events

    Introduction

    Institutions provide a wide breadth of events, activities, and ancillary opportunities to enrich the curricular and experience for their users.

    The campusM Events product integration provides users with an attractive and engaging events discovery experience. Users can browse, search, and filter their way through all the activities the institutions have to offer.

    Users can favorite and register for events and will receive reminder notifications (if configured) to drive attendance.

    The experience within the Events product integration is easily managed through App Manager, with a wide range of configuration options to customize the interface for end-users.

    The event information itself can be populated by either importing a populated Excel spreadsheet into the Product Integration Configuration screen or dynamically through configuring an RSS endpoint.

    Each customer can deploy multiple instances of the Event product integrations to support a range of user segments. Access and visibility of these instances can be managed through Profiles and Roles.

    For more information, see Events Directory Product Integration. (4:46)

    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:
    User Workflow Diagram

    Authentications

    Registering for an event requires a cmAuthToken.

    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.
    Native App Experience
    EventsPINewDoc.png
    Web App Experience
    EventsPINewDoc2.png

    Additionally:

    • Users can view all events.
    • Users can filter events by date, tags, or any additional info provided for an event.
    • Users can view their favorite events.
    • Users can view the event details.
    • Users can register for an event
    • Users can add an event to their favorites.
    • Users can get reminder notifications for registered events

     

    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

    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 Event unique identifier Yes
    B Start Date Event start date Yes
    C End Date Event end date No
    D Start Time Event start time No
    E End Time Event end time No
    F Tags Tags for the event — must be separated by a comma (,) No
    G Location Location of the event No
    H Location URL URL of the location No
    I Location Code campusM location code (Number) — this enables institutions to send users to the campusM maps for the event location No
    J Title Event name Yes
    K Description Event description No
    L Image Event image URL No
    M External Link External link for the event No
    • You can add additional columns to the Excel file after the M column. These additional headings appear for the user but are not configurable on the configuration page.
    • Do not change the order of the columns.
    • Cells' content must be defined as type Text.
    • All dates and times must be in the same format as configured in the App Manager.
    • If no end date is provided, then the end date defaults to the start date (i.e. a one-day event).
    • The event times are not mandatory.
    To import the Excel file, select Choose File, and select Import File.
    Importing events data overwrites any existing data.

    Importing Events with an RSS Feed

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

    • The RSS feed must contain the Start Date and Title.
    • A UniqueID will be automatically generated using the title and date of the event.
    • Tags must be separated by a comma (,).
    • The event times are not mandatory.

    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    
    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
    Mandatory Fields
    Title
    Code The code for the title in the RSS feed No String title  
    Start Date
    Code The code for the date in the RSS feed No String startDate  
    Date Format The format in which the start time is returned in the response No String YYYY-MM-DDTHH:mm:ss:sssZ  
    End Date
    Code The code for the date in the RSS feed No String endDate  
    Date Format The format in which the start time 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  
    Non-Mandatory Fields
    Tags
    Display Field Check this box if this field is used in the RSS feed No Boolean False  
    Code The code for the tag in the RSS feed No String tags  
    Location
    Display Field Check this box if this field is used in the RSS field No Boolean False  
    Code The code for the location in the RSS feed No String location  
    Location URL
    Display Field Check this box if this field is used in the RSS field No Boolean False  
    Code The code for the location URL in the RSS feed No String locationURL  
    Location Code
    Display Field Check this box if this field is used in the RSS field No Boolean False  
    Code The code for the location code in the RSS feed No String locationCode  
    Description
    Display Field Check this box if this field is used in the RSS field No Boolean False  
    Code The code for the description in the RSS feed No String description  
    Expect HTML Content Check this box if the description contains HTML No Boolean False  
    Image
    Display Field Check this box if this field is used in the RSS field No Boolean False  
    Code The code for the image in the RSS feed No String image  
    Additional Fields
    Fields Any extra fields other than the ones defined above
    Code The code for the field No String    
    Label The label to use for this field No String    
    Events Data
    Date Format Select the date format for events for the import file from the drop-down list.
    All dates in the Excel file must match the chosen date format exactly.
    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.
    All dates in the Excel file must match the chosen date format exactly.
    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 A timezone ID for the date and time. 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
    Show Past Events Select this box to show past events No Checkbox Unselected  
    Enable Registering to Events Select this box to enable registering to events No Checkbox Unselected  
    Date Time Display Format   No String III  
    Date Display Format   No String II  
    Event Duration Format   No String h[h] m [mins]  
    Events Home Page Image   No URL https://defaultImage.jpg  
    Notification Settings
    Event notification time Time before event (in minutes) that a reminder notification will be sent for Registered event. Yes Drop-down List 60 minutes before  
    Notification Title Notification of title text. Can contain the following parameters that are replaced by the event information {Event Name} {Start} {End} {Location}. Yes String {Event Name}  
    Notification Body Notification body text. Can contain the following parameters that are replaced by the event information {Event Name} {Start} {End} {Location}. Yes String {Start} - {End}: {Location}  
    Text/Labels Enter replacement text for the default titles and labels
    Events Home Page Title   No String Events on Campus  
    Events Home Page Subtitle   No String Recommended events just for you, anytime, any topic you want  
    Filters Title   No String Broaden your mind  
    Browse Events Title Text   No String Discover unique events at anytime  
    Showing Text   No String Showing:  
    Events Text   No String events  
    Event Text   No String event  
    Results Text   No String results  
    Result Text   No String result  
    Favorites Text   No String favorites  
    Favorite Text   No String favorite  
    All Text   No String All  
    No Text   No String No  
    Events Tab Title   No String Filter By  
    Clear Button Text    No String Clear  
    When Text   No String When  
    Tags Text   No String Tags  
    Show events button Text   No String Show events  
    No Events Found Text   No String No events found. Keep digging!  
    No Events Found Subtitle Text   No String Clear your filters and try again.  
    Event Description   No String OVERVIEW  
    When and where Heading Text   No String When & where  
    Event Start Time   No String Start Time  
    Event End Time   No String End Time  
    Duration Text   No String DURATION  
    Event Location   No String LOCATION  
    Register to Event Button Text   No String Register to event  
    Registered Text   No String Registered  
    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      
    • Was this article helpful?