Using links to launch or configure Connections Mobile

Help users to log in to the HCL Connections™ mobile app by using links to launch or configure the server and user information.

About this task

To start the HCL Connections™ app without any configuration:

  • Android/iOS:

    hclscp://com.hcl.connections/launch

The HCL Connections™ mobile apps for Android and iOS allow you to use a link to configure the HCL 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 HCL Connections™ user ID.
  • Create the URL. The user ID is how a user logs into HCL Connections™.
    • Android and iOS:

      hclscp://com.hcl.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:
      • hclscp://com.hcl.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 HCL 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. The accounttype is used only when a new account is created.
      • hclscp://com.hcl.connections/launch?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com&accounttype=cloud

        This URL creates an account for a user called Keiko Shin.

      • hclscp://com.hcl.connections/launch?accountserver=http(s)%3A%2F%2FyourConnectionsServer

        This URL creates a link to your HCL Connections™ server. The user can enter their account information.

  • 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 HCL 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 HCL Connections™ app.

    From a user's perspective:

    • The user installs HCL Connections™ apps for Android or iOS from the respective app store.
  • The following capabilities are available.
    Connections feature Capabilities
    General
    • To launch the HCL Connections mobile app to show the view for an item's HCL Connections desktop link, use the following URL:  
       hclscp://com.hcl.connections/launchconnectionslink?url=<encoded_desktop_url>
      For example, this URL includes a link to a file:
      hclscp://com.hcl.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 HCL Connections™:
      hclscp://com.hcl.connections/importcert?action=DeleteAll
    • Delete all certificates that have been imported for HCL Connections™ then import a new certificate:
      hclscp://com.hcl.connections/importcert?url=<encode_p12_certificate_file_url>,action=DeleteAll
    • The 5.0 apps provide the capability to import a certificate using a URL:
       hclscp://com.hcl.connections/importcert?url=<encode_p12_certificate_file_url>

      For more information about importing a client certificate, go to the Importing client certificates by using hclscp links topic in the HCL® Knowledge Center.
    Activities
    • For Activities, the following URLs can be used:
      • hclscp://com.hcl.connections/activities?uid=<uid>&action=ShowActivityEntry&entryUid=<entryUid>
      • hclscp://com.hcl.connections/activities?uid=<uid>&action=ShowActivityUpdates

      To find the UID and entryUid values, see Finding the UID and other values.

    • To launch the HCL Connections™ app and display Activities for an existing account:hclscp://com.hcl.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 HCL Connections™ server.
      • hclscp://com.hcl.connections/activities?action=MyActivities
      • hclscp://com.hcl.connections/activities?action=Updates
      • hclscp://com.hcl.connections/activities?action=MyTodos (not applicable on Android)
      • hclscp://com.hcl.connections/activities?action=Completed
    Bookmarks
    • For Bookmarks, the following URL can be used: hclscp://com.hcl.connections/bookmarks?url=http%3A%2F%2Fhcl.com&action=ViewBookmark
    • To create a public vs private bookmark, the following URL can be used:hclscp://com.hcl.connections/bookmarks?url=http%3A%2F%2Fhcl.com&title=HCL%20Corp.&public=[true|false]&action=Create
    • To launch the HCL Connections™ app and display Bookmarks for an existing account:hclscp://com.hcl.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 HCL Connections™ server.
      • hclscp://com.hcl.connections/bookmarks?action=Updates
      • hclscp://com.hcl.connections/bookmarks?action=MyBookmarks
      • hclscp://com.hcl.connections/bookmarks?action=AllBookmarks (opens Public bookmarks)
      • hclscp://com.hcl.connections/bookmarks?action=MostBookmarked
      • hclscp://com.hcl.connections/bookmarks?action=MostNotified
      • hclscp://com.hcl.connections/bookmarks?action=MostNotified
      • hclscp://com.hcl.connections/bookmarks?action=NotificationsReceived
      • hclscp://com.hcl.connections/bookmarks?action=NotificationsSent
    Blogs
    • For Blogs, the following URLs can be used:
      • hclscp://com.hcl.connections/blogs?action=BlogEntries&handle=<blogName>
      • hclscp://com.hcl.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 HCL Connections™ app and display Blogs for an existing account: hclscp://com.hcl.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 HCL Connections™ server.
      • hclscp://com.hcl.connections/blogs?action=Updates
      • hclscp://com.hcl.connections/blogs?action=MyBlogs
      • hclscp://com.hcl.connections/blogs?action=AllBlogs (opens Public blogs)
    Connections Engagement Center To launch a Connections Engagement Center page, use the general Connections desktop link launch technique.

    hclscp://com.hcl.connections/launchconnectionslink?url=<encoded_desktop_url>.

    Where <encoded_desktop_url> is the URL to the Connections Engagement Center page. For example, a Connections Cloud launch link could be:

    hclscp://com.hcl.connections/launchconnectionslink?url=https%3A%2F%2Fapps.na.collabserv.com%2Fxcc%2Fcloud%3Fpage%3Dcloud.
    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 HCL Connections™ server.
      • hclscp://com.hcl.connections/communities?action=AllCommunities (opens public communities)
      • hclscp://com.hcl.connections/communities?action=MyCommunities
      • hclscp://com.hcl.connections/communities?uid=<uid>&action=ShowCommunityUpdates
      In a specific community, the various components within the community can also be listed:
      • hclscp://com.hcl.connections/communities?uid=<uid>&action=ShowCommunityMediaGallery
      • hclscp://com.hcl.connections/communities?uid=<uid>&action=ShowCommunityFeeds
      • hclscp://com.hcl.connections/communities?uid=<uid>&action=ShowCommunityEvents
      • hclscp://com.hcl.connections/communities?uid=<uid>&action=ShowCommunityActivities
      • hclscp://com.hcl.connections/communities?uid=<uid>&action=ShowCommunityBlog
      • hclscp://com.hcl.connections/communities?uid=<uid>&action=ShowCommunityIdeationBlog
      • hclscp://com.hcl.connections/communities?uid=<uid>&action=ShowCommunityBookmarks
      • hclscp://com.hcl.connections/communities?uid=<uid>&action=ShowCommunityFiles
      • hclscp://com.hcl.connections/communities?uid=<uid>&action=ShowCommunityForums
      • hclscp://com.hcl.connections/communities?uid=<uid>&action=ShowCommunityWiki

      To find the UID value, see Finding the UID and other values.

    • To launch the HCL Connections™ app and display Communities for an existing account:hclscp://com.hcl.connections/communities?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com
    • To launch the HCL Connections™ app and display a specific community for an existing account:hclscp://com.hcl.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.
    Extensions To launch Connections Mobile and load a custom extension application, the following URL can be used:

    hclscp://com.hcl.connections/extension/<application name>

    Where <application name> is the Extension name that was defined at the Connections Mobile server. See Applying extensibility properties for more information on extensions.
    Files
    • For Files, the following URLs can be used:
      • hclscp://com.hcl.connections/files?uid=<uid>&action=Subscribe
      • hclscp://com.hcl.connections/files?uid=<uid>&action=Unsubscribe

      To find the UID value, see Finding the UID and other values.

    • To launch the HCL Connections™ app and display Files for an existing account: hclscp://com.hcl.connections/files?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com
    • To launch the HCL Connections™ app and display a specific file for an existing account: hclscp://com.hcl.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 HCL Connections™ server.
      • hclscp://com.hcl.connections/files?action=MyFiles
      • hclscp://com.hcl.connections/files?action=OrgFiles (Note: This link is valid only for Cloud customers.)
      • hclscp://com.hcl.connections/files?action=PublicFiles (Note: This link is valid only for on-premises deployments.)
      • hclscp://com.hcl.connections/files?action=SharedWithMe
      • hclscp://com.hcl.connections/files?action=SharedByMe
      • hclscp://com.hcl.connections/files?action=MyCollections
      • hclscp://com.hcl.connections/files?action=CollectionsSharedWithMe
      • hclscp://com.hcl.connections/files?action=PublicCollections (Note: This link is only valid for deployments prior to Connections 5.5.)
      • hclscp://com.hcl.connections/files?uid=<uid>&action=About
      • hclscp://com.hcl.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 HCL Connections™ server.
      • hclscp://com.hcl.connections/forums?topicId=<topicId>&action=ShowForumTopic
      • hclscp://com.hcl.connections/forums?uid=<uid>&action=Forum

      To find the UID and topicId values, see Finding the UID and other values.

    • To launch the HCL Connections™ app and display Forums for an existing account: hclscp://com.hcl.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 HCL Connections™ server: hclscp://com.hcl.connections/profiles?key=<key>&action=Show.

      To find the key value, see Finding the UID and other values.

    • To launch the HCL Connections™ app and display profiles for an existing account:hclscp://com.hcl.connections/profiles?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com
    • To launch the HCL Connections™ app and display a specific profile for an existing account:hclscp://com.hcl.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: hclscp://com.hcl.connections/updates?action=view
    • To view a single update entry, the following URL can be used: hclscp://com.hcl.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:hclscp://com.hcl.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, hclscp://com.hcl.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.

    The following links are available for use on OrientMe enabled servers:
    • hclscp://com.hcl.connections/updates?action=Top
    • hclscp://com.hcl.connections/updates?action=Latest
    • hclscp://com.hcl.connections/updates?action=Responses
    • hclscp://com.hcl.connections/updates?action=Mentions

    The following links are available for use on non-OrientMe enabled servers:

    • hclscp://com.hcl.connections/updates?action=Discover
    • hclscp://com.hcl.connections/updates?action=MyNotifications
    • hclscp://com.hcl.connections/updates?action=ActionRequired
    • hclscp://com.hcl.connections/updates?action=Mentions
    • hclscp://com.hcl.connections/updates?action=Following
    • hclscp://com.hcl.connections/updates?action=StatusUpdates
    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 HCL Connections™ server: hclscp://com.hcl.connections/wikis?action=ShowWiki.
    • For Wikis, the following URL can be used:hclscp://com.hcl.connections/wikis?action=ShowWikiPage&wiki=<wikiLabel>&page=<pageLabel>
    • To launch the HCL Connections™ app and display Wikis for an existing account:hclscp://com.hcl.connections/wikis?accountserver=http(s)%3A%2F%2FyourConnectionsServer&accountuser=keiko_shin%40greenwell.com