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

    Working with App URLs

    You enter URLs in various places in the App Manager, in particular when creating a redirect for the end-user to select. You can use a standard URL; however, in addition you can use special URLs to redirect to other services in the app, or to other apps on the device.
    App URLs cannot currently be linked from content list menus, alternatively you can create a content page containing App URL links via the content editor.

    Linking to an External App

    To link to an external app, use the following URL.
    campusm://launchapp?app_name=[app name]&ios_app_url=[iOS URL]&android_app_url=[Android URL]
    &ios_store_url=[Appstore URL]&android_store_url=[Google Play store URL]&prompt=[Y/N]
    Where:

    As of iOS 10, Apple requires that the launch URL prefix for the external app is added to the whitelist during the app build. Please open a Salesforce ticket to campusM Support to whitelist the external apps.

    campusM External App URL Elements
    Parameter Value
    app_name Name of app to open.
    ios_app_url Define the URL of the external app  to open on iOS, this is depends on the 3rd party vendor supporting app deeplink.
    android_app_url Define the URL of the external app  to open on Android, this is depends on the 3rd party vendor supporting app deeplink
    ios_store_url (Optional) Appstore URL, in case the app is not yet installed clicking on the tile will take the user to the app store to download the app.
    android_store_url (Optional) Google Play Store URL, in case the app is not yet installed clicking on the tile will take the user to the app store to download the app.
    prompt (Optional) When not included in the URL, or when set to Y, the end-user is prompted if the app is not yet installed.
    noandroidtoolbar (not shown) (Optional) When set to Y, the navigation overlay toolbar (pictured below) will be hidden from the end-user.

    AndroidInterface.png

    The URL must be ASCII encoded (unsupported characters replaced by % followed by two hexadecimal values).
    The following example links to Twitter.
    campusM External URL Example for Twitter
    Parameter Unencoded Encoded
    app_name Twitter Twitter
    ios_app_url =twitter://user?screen_name=_campusM_ ios_app_url=twitter%3A%2F%2Fuser%3Fscreen_name%3D_campusM_
    android_app_url android_app_url=http://twitter.com/_campusM_ android_app_url=http%3A%2F%2Ftwitter.com%2F_campusM_
    ios_store_url ios_store_url=https://itunes.apple.com/gb/app/twitter/id333903271?mt=8 ios_store_url=https%3A%2F%2Fitunes.apple.com%2Fgb%2Fapp%2Ftwitter%2Fid333903271%3Fmt%3D8
    android_store_url &android_store_url=https://play.google.com/store/apps/details?id=com.twitter.android android_store_url=https%3A%2F%2Fplay.google.com%2Fstore%2Fapps%2Fdetails%3Fid%3Dcom.twitter.android
    prompt prompt=Y prompt=Y
    As a URL:
    campusm://launchapp?app_name=Twitter&ios_app_url=twitter%3A%2F%2Fuser%3Fscreen_name%3D_campusM_&android_app_url=http%3A%2F%2Ftwitter.com%2F_campusM_&ios_store_url=https%3A%2F%2Fitunes.apple.com%2Fgb%2Fapp%2Ftwitter%2Fid333903271%3Fmt%3D8&android_store_url=https%3A%2F%2Fplay.google.com%2Fstore%2Fapps%2Fdetails%3Fid%3Dcom.twitter.android&prompt=Y
    To add this to HTML directly into service code, use:
    <p><a href="campusm://launchapp?app_name=Twitter&ios_app_url=twitter%3A%2F%2Fuser%3Fscreen_name%3D_campusM_&android_app_url=http%3A%2F%2Ftwitter.com%2F_campusM_&ios_store_url=https%3A%2F%2Fitunes.apple.com%2Fgb%2Fapp%2Ftwitter%2Fid333903271%3Fmt%3D8&android_store_url=https%3A%2F%2Fplay.google.com%2Fstore%2Fapps%2Fdetails%3Fid%3Dcom.twitter.android&prompt=Y"</a></p>

    Other external URLs include:

    External native apps URL Scheme examples:

    • Cisco Jabber - ciscojabber://
    • DoubleMap - doublemap://
    • Flickr - flickr://
    • Maze Maps - mazemap://
    • One Drive - ms-onedrive://
    • Outlook -
      • iOS - ms-outlook://
      • Android - msoutlook://

    URL example - U  campusm://launchapp?app_name=Outlook&ios_app_url=ms-outlook%3A%2F%2F&android_app_url=msoutlook%3A%2F%2F%0A&ios_store_url=https%3A%2F%2Fapps.apple.com%2Fgb%2Fapp%2Fmicrosoft-outlook%2Fid951937596&android_store_url=https%3A%2F%2Fplay.google.com%2Fstore%2Fapps%2Fdetails%3Fid%3Dcom.microsoft.office.outlook%26hl%3Den_GB&prompt=Y

    URL example  -   campusm://launchapp?app_name=Zoom&io...en_GB&prompt=Y

    URL example  -   campusm://launchapp?app_name=canvas-teacher&ios_app_url=canvas-teacher%3A%2F%2F&android_app_url=canvas-teacher%3A%2F%2F%0A&ios_store_url=https%3A%2F%2Fapps.apple.com%2Fus%2Fapp%2Fcanvas-teacher%2Fid1257834464&android_store_url=https%3A%2F%2Fplay.google.com%2Fstore%2Fapps%2Fdetails%3Fid%3Dcom.instructure.teacher%26hl%3Den&prompt=Y

     

    Note: Above information regarding External Application prefixes should be treated as a guidance only. From time to time external application prefixes are changing.

    It is always advisable to contact Application Provider directly.

    Linking to a Service or Area in the campusM App

    To link to a service or other area of the campusM app, use the following URL format:
     
    Area URL Notes
    App home page campusm://home  
    App home page with the menu open the menu option selected campusm://menu=[menu option ID] You can see a menu option ID when adding a link to the menu option in the App Builder as an Action URL, in the static content simple WYSIWYG HTML editor, or as a location action. In any of these cases, when you select the field to enter the link, the link selector appears. Enter the name, or part of the name, of the menu option and you will see the link in the selector. The ID is the last part of the link.
    link_selector_with_link_highlighted.png
    The link is always something like campusm://menu?menucode=12345.
    Static content service campusm://pocketguide?pg_code=[static content service ID] You can see a static content service ID when adding a link to the service in the App Builder as an Action URL, in the static content simple WYSIWYG HTML editor, or as a location action. In any of these cases, when you select the field to enter the link, the link selector appears. Enter the name, or part of the name, of the service and you will see the link in the selector. The ID is the last part of the link.
    link_selector_with_link_highlighted.png
    The link is always something like campusm://pocketguide?pg_code=123456.
    AEK service

    campusm://loadaek?toolbar=XX&sid=YY&otherparameter1=ZZ&otherparameter2=AA

    To get the menu option ref code, open the service for editing (AEK > App Extension Kit > AEK Menu Options) and copy the value in Component type. The value will look something like AEK12345.
    Alternately, in the App Builder, select the service, select Code, and copy the value of menuRefCode. For example: "menuRefCode": "AEK16368",
    The optional "sid" parameter is the service id when an AEK component needs to send the user’s credentials. You can find the ID required for this by opening the record for the credentials used by the AEK screen under “App Settings” > “Authentication Access”, and once you’ve got the details page open its URL should be in the form https://appmanager.ombiel.com/app-se...iceaccess/[sid here]/.
     
    The "otherparameter" values can be called anything, and set to anything (i.e. "firstname=John" and will be passed to the AEK page. You don't have to set any of these.
    Map location campusm://uniloc?posCode=[location code] To get the location code, open the location for editing (App Settings > Maps/Locations > Positions) and copy the location code from the URL. For example:
    https://.../app-settings/CampusM/position/44227/
    Alternately, if you have defined a value for Customer Location Reference for the location, you can use that as the location code.
    App home page with the indicated profile selected campusm://switchprofile?profile_id=[profile ID] To get the profile ID, open the profile for editing (App Settings > Enterprise Roles > App Profiles) and copy the profile ID from the URL. For example:
    https://.../app-settings/CampusM/userappprofile/3282/
    Note that switching profiles does not currently work with single sign-on.
    Additional parameters for this URL include:
    • prompt_confirm=[Y/N] - Whether to prompt the user to confirm switching profile. Default: N.
    • prompt_confirm_message=<msg> - The message to display when confirming before switching profile. Default: Are you sure you watch to switch profile?
    • show_profile_switch_error_message=[Y/N] - Whether to display an error message if cannot switch profile. Default: N.
    • prompt_switch_error_message=<msg> - The message to display if cannot switch profile. Default: Cannot switch profile.
    • Was this article helpful?