Using links to start and configure the IBM Connections mobile app
Help users to log in to the IBM Connections™ mobile app by distributing links with server and user information.
About this task
To start the IBM Connections app without any configuration:
- Android/iOS:
ibmscp://com.ibm.connections/launch
The IBM Connections mobile apps for Android and iOS allow you to use a link to configure the IBM Connections server settings in the mobile app. The link can provide the URL of the server along with a user ID that populates the app’s authentication page.
Procedure
- Decide how to provide the URL to your users: by email or in a web page:
- Email has the benefit of being able to provide extra customization. However, creating individual emails might not be a simple task.
- A web page has the benefit of simplifying the server configuration for all users, but has the drawback that users have to specify the IBM Connections user ID.
- Create the URL. The user ID is how a user logs into IBM Connections.
- Android and iOS:
ibmscp://com.ibm.connections/launch?<accountname=encoded_account_name>&<accountserver=encoded_url&accountuser=encoded_userID>
In the following examples, the user's email address is used as the user ID.- Android and iOS:
- ibmscp://com.ibm.connections/launch?accountname=Greenwell's
server&accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin@greenwell.com
- This URL creates an account for a user called Keiko Shin and names the account Greenwell's server.
- If the IBM Connections app already has an account configured with the accountserver and accountuser, the accountname is not used. The accountname is created only when a new account is created.
- ibmscp://com.ibm.connections/launch?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com
This URL creates an account for a user called Keiko Shin.
- ibmscp://com.ibm.connections/launch?accountserver=http(s)%3A%2F%2FyourConnectionsServer
This URL creates a link to your IBM Connections server. The user can enter their account information.
- ibmscp://com.ibm.connections/launch?accountname=Greenwell's
server&accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin@greenwell.com
- Android and iOS:
- Distribute the URL in one of the following ways:
- Email the URL with the preconfigured information, along with the user's names, to all applicable users. On their mobile device, each user taps the link in the email to start the IBM Connections app.
- Provide a web page which has the URL with the preconfigured information. Each user accesses the web page from their device's browser and taps the link to start the IBM Connections app.
From a user's perspective:
- The user installs IBM Connections apps for Android or iOS from the respective app store.
- The following capabilities are available.
Table 1. Additional capabilities Connections feature Capabilities General - To launch the IBM Connections mobile app to show the view for an item's IBM Connections desktop link, use the following: ibmscp://com.ibm.connections/launchconnectionslink?url=<encoded_desktop_url> Here is an example that uses a link to a file: ibmscp://com.ibm.connections/launchconnectionslink?url=http%3A%2F%2Fmycompany.com%2Ffiles%2Fapp%23%2Ffile%2Fd472893e-e0a0-44a6-988d-578e0acf32d7
- Delete all certificates that have been imported for IBM Connections:ibmscp://com.ibm.connections/importcert?action=DeleteAll
- Delete all certificates that have been imported for IBM Connections then import a new certificate:ibmscp://com.ibm.connections/importcert?url=<encode_p12_certificate_file_url>,action=DeleteAll
- The 5.0 apps provide the capability to import a certificate using a URL:
ibmscp://com.ibm.connections/importcert?url=<encode_p12_certificate_file_url>
For more information about importing a client certificate, go to the Importing client certificates by using ibmscp links topic in the IBM® Knowledge Center.
Activities - For Activities, the following URLs can be used:
- ibmscp://com.ibm.connections/activities?uid=<uid>&action=ShowActivityEntry&entryUid=<entryUid>
- ibmscp://com.ibm.connections/activities?uid=<uid>&action=ShowActivityUpdates
To find the UID and entryUid values, see Finding the UID and other values.
- To launch the IBM Connections app and display Activities for an existing account:ibmscp://com.ibm.connections/activities?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com
- For Activities, the following URLs can be used to open specific views. Not only can you use the
links provided in this row, you can enable mobile links within emails that are sent from the IBM Connections server.
- ibmscp://com.ibm.connections/activities?action=MyActivities
- ibmscp://com.ibm.connections/activities?action=Updates
- ibmscp://com.ibm.connections/activities?action=MyTodos (not applicable on Android)
- ibmscp://com.ibm.connections/activities?action=Completed
Bookmarks - For Bookmarks, the following URL can be used: ibmscp://com.ibm.connections/bookmarks?url=http%3A%2F%2Fibm.com&action=ViewBookmark
- To create a public vs private bookmark, the following URL can be used:ibmscp://com.ibm.connections/bookmarks?url=http%3A%2F%2Fibm.com&title=IBM%20Corp.&public=[true|false]&action=Create
- To launch the IBM Connections app and display Bookmarks for an existing account:ibmscp://com.ibm.connections/bookmarks?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com
- For Bookmarks, the following URLs can be used to open specific views. Not only can you use the
links provided in this row, you can enable mobile links within emails that are sent from the IBM Connections server.
- ibmscp://com.ibm.connections/bookmarks?action=Updates
- ibmscp://com.ibm.connections/bookmarks?action=MyBookmarks
- ibmscp://com.ibm.connections/bookmarks?action=AllBookmarks (opens Public bookmarks)
- ibmscp://com.ibm.connections/bookmarks?action=MostBookmarked
- ibmscp://com.ibm.connections/bookmarks?action=MostNotified
- ibmscp://com.ibm.connections/bookmarks?action=MostNotified
- ibmscp://com.ibm.connections/bookmarks?action=NotificationsReceived
- ibmscp://com.ibm.connections/bookmarks?action=NotificationsSent
Blogs - For Blogs, the following URLs can be used:
- ibmscp://com.ibm.connections/blogs?action=BlogEntries&handle=<blogName>
- ibmscp://com.ibm.connections/blogs?uid=<entryUid>&action=ShowBlogEntry&handle=<blogName>
To find the handle and UID values, see Finding the UID and other values.
- To launch the IBM Connections app and display Blogs for an existing account: ibmscp://com.ibm.connections/blogs?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com
- For Blogs, the following URLs can be used to open specific views. Not only can you use the links
provided in this row, you can enable mobile links within emails that are sent from the IBM Connections server.
- ibmscp://com.ibm.connections/blogs?action=Updates
- ibmscp://com.ibm.connections/blogs?action=MyBlogs
- ibmscp://com.ibm.connections/blogs?action=AllBlogs (opens Public blogs)
Communities - For Communities, the following URLs can be used to open specific views. Not only can you use the
links provided in this row, you can enable mobile links within emails that are sent from the IBM Connections server.
- ibmscp://com.ibm.connections/communities?action=AllCommunities (opens public communities)
- ibmscp://com.ibm.connections/communities?action=MyCommunities
- ibmscp://com.ibm.connections/communities?uid=<uid>&action=ShowCommunityUpdates
In a specific community, the various components within the community can also be listed:- ibmscp://com.ibm.connections/communities?uid=<uid>&action=ShowCommunityMediaGallery
- ibmscp://com.ibm.connections/communities?uid=<uid>&action=ShowCommunityFeeds
- ibmscp://com.ibm.connections/communities?uid=<uid>&action=ShowCommunityEvents
- ibmscp://com.ibm.connections/communities?uid=<uid>&action=ShowCommunityActivities
- ibmscp://com.ibm.connections/communities?uid=<uid>&action=ShowCommunityBlog
- ibmscp://com.ibm.connections/communities?uid=<uid>&action=ShowCommunityIdeationBlog
- ibmscp://com.ibm.connections/communities?uid=<uid>&action=ShowCommunityBookmarks
- ibmscp://com.ibm.connections/communities?uid=<uid>&action=ShowCommunityFiles
- ibmscp://com.ibm.connections/communities?uid=<uid>&action=ShowCommunityForums
- ibmscp://com.ibm.connections/communities?uid=<uid>&action=ShowCommunityWiki
To find the UID value, see Finding the UID and other values.
- To launch the IBM Connections app and display Communities for an existing account:ibmscp://com.ibm.connections/communities?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com
- To launch the IBM Connections app and
display a specific community for an existing
account:ibmscp://com.ibm.connections/communities?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com&uid=<uid>
To find the UID value, see Finding the UID and other values.
Files - For Files, the following URLs can be used:
- ibmscp://com.ibm.connections/files?uid=<uid>&action=Subscribe
- ibmscp://com.ibm.connections/files?uid=<uid>&action=Unsubscribe
- ibmscp://com.ibm.connections/files?uid=<uid>&action=UserUpdates
To find the UID value, see Finding the UID and other values.
- To launch the IBM Connections app and display Files for an existing account: ibmscp://com.ibm.connections/files?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com
- To launch the IBM Connections app and display a specific file for an existing account: ibmscp://com.ibm.connections/files?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com&uid=<uid>
- For Files, the following URLs can be used to open specific views. Not only can you use the links provided in this row, you can enable mobile links within emails that are sent from the IBM Connections server.
- ibmscp://com.ibm.connections/files?action=MyFiles
- ibmscp://com.ibm.connections/files?action=PublicFiles
- ibmscp://com.ibm.connections/files?action=SharedWithMe
- ibmscp://com.ibm.connections/files?action=SharedByMe
- ibmscp://com.ibm.connections/files?action=MyCollections
- ibmscp://com.ibm.connections/files?action=CollectionsSharedWithMe
- ibmscp://com.ibm.connections/files?action=PublicCollections
- ibmscp://com.ibm.connections/files?uid=<uid>&action=About
- ibmscp://com.ibm.connections/files?uid=<uid>&action=CollectionFiles
To find the UID value, see Finding the UID and other values.
Forums - For Forums, the following URLs can be used to open specific views. Not only can you use the
links provided in this row, you can enable mobile links within emails that are sent from the IBM Connections server.
- ibmscp://com.ibm.connections/forums?topicId=<topicId>&action=ShowForumTopic
- ibmscp://com.ibm.connections/forums?uid=<uid>&action=Forum
To find the UID and topicId values, see Finding the UID and other values.
- To launch the IBM Connections app and display Forums for an existing account: ibmscp://com.ibm.connections/forums?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com
Profiles - For Profiles, the following URL can be used. Not only can you use the link in this row, you can
enable mobile links within emails that are sent from the IBM Connections server:
ibmscp://com.ibm.connections/profiles?key=<key>&action=Show.
To find the key value, see Finding the UID and other values.
- To launch the IBM Connections app and display profiles for an existing account:ibmscp://com.ibm.connections/profiles?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com
- To launch the IBM Connections app and display a specific profile for an existing account:ibmscp://com.ibm.connections/profiles?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com&email=heather_reeds%40greenwell.com
Status updates - To display Status Updates, the following URL can be used: ibmscp://com.ibm.connections/updates?action=view
- To view a single update entry, the following URL can be used:
ibmscp://com.ibm.connections/updates?action=view&entryUuid=<entryUuid>
To find the entryUuid value, see Finding the UID and other values.
- To post status, the following URL can be
used:ibmscp://com.ibm.connections/updates?action=post
Optionally, you can specify the following additional parameters. All parameter values must be URL-encoded.
- message
- initial text to appear in the editor when launched
- target
- UID of the wall where you want to post the status
- targettype
- community or profile. When target is specified, targettype must also be specified.
For example,ibmscp://com.ibm.connections/updates?action=post&message=I%20love%20the%20Connections%20Mobile%20app%21)
To find the target value, see Finding the UID and other values and use the steps that are provided to find the key for a Profile.
Wikis - For Wikis, the following URL can be used. Not only can you use the link in this row, you can enable mobile links within emails that are sent from the IBM Connections server: ibmscp://com.ibm.connections/wikis?action=ShowWiki.
- For Wikis, the following URL can be used:ibmscp://com.ibm.connections/wikis?action=ShowWikiPage&wiki=<wikiLabel>&page=<pageLabel>
- To launch the IBM Connections app and display Wikis for an existing account:ibmscp://com.ibm.connections/wikis?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com