Linking to an External App
&ios_store_url=[Appstore URL]&android_store_url=[Google Play store URL]&prompt=[Y/N]
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.
|app_name||Name of app to open.|
|ios_app_url||Define the URL of the external app to open on iOS, this depends on the 3rd party vendor supporting app deeplink.|
|android_app_url||Define the URL of the external app to open on Android, this depends on the 3rd party vendor supporting app deeplink|
|ios_store_url||(Optional) Appstore URL, in case the app is not yet installed clicking the tile directs 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 the tile directs 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.
Other external URLs include:
- The default browser - campusm://openURL?url=XX&type=external
- Opens the device's default web browser with the indicated URL pre-loaded.
- Here is an example: campusm://openURL?url=https://www.google.com/
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
- Skype for business - ms-sfb://
- Unit4/Agresso -
- iOS - https://apps.apple.com/us/app/zoom-cloud-meetings/
- Android - zoomus://
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
The above information regarding External Application prefixes should only be treated as a guide. Sometimes external application prefixes change.
Contact your Application Provider directly.
Linking to a Service or Area in the App
|App home page||campusm://home|
|App Search||Loads the home page and opens the search tab to allow the user to perform a search|
|App Feedback||campusm://feedback||Links through to the App Feedback section in the App Settings|
|App home page with the menu open the menu option selected||campusm://menu=[your 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.
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.
The link is always something like campusm://pocketguide?pg_code=123456.
|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:
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:
Note that switching profiles does not currently work with single sign-on.
Additional parameters for this URL include:
|Profile deep link (web only)||Obtain a profile code by using the Base URL followed by the profile registration authentication code listed in App Manager > App Settings > Profile Registration Authentication.|