How a customer admin will set up a Jive Connects Service

Version 1

    One of the powerful features of Jive is Jive Connects. As a developer, this allows you to quickly and easily access data from other systems that are in the enterprise and mash that up with the social context provided by Jive as well as your application's data. The details about using a Jive Connects can be found in the Accessing data via Jive Connects API document. However, what's not included in that document is what's expected from a system admin to setup a Jive Connects service. Fortunately, this is very easy and straight forward and the admin will need to know only a few pieces of information a head of time. In this document, we'll use SharePoint as the back end system that we'd like to setup. For more information on Jive Connect, please see Jive Connects API - Client Application Configuration and API Usage.

     

    In Accessing data via Jive Connects API, you learned how to declare that your application requires a Jive Connects service. This is done in the module prefs section of the application using the required feature "jive-connects-v1".

     

    <Require feature="jive-connects-v1">
      <Param name="alias:sharepoint|title:Microsoft SharePoint">jive:service://microsoft.com/sharepoint/api?version=1</Param>
    </Require>

     

    One of the most important pieces of information in the above example is the actual service tag. It's the value of the parameter, and begins with jive:service. In this case, the value is jive:service://microsoft.com/sharepoint/api?version=1. As a developer, you want your app to be as widely adopted as possible. Using a consistent, well defined service tag, will avoid requiring an admin to configure a unique Jive Connects servie for your app. The developer community maintains a list commonly used backend systems, and a correspoind tag definition. You can find the service tags in the Jive Connects Service Tags document.

     

    The following example shows the steps that the admin has to do to setup the Jive Connects service tags for SharePoint. However, for the most part, the steps are the same. The only difference comes in when the security scheme changes, e.g. from Basic Auth to OAuth 2.0.

     

    Step 1) Go to the admin console of your Jive instance.

     

    ccs1.png

     

    Step 2) Select the "Apps" tab.


    ccs2.png


    Step 3) Select "Add new service"


    ccs3.png


    Step 4) Set up the Jive Connects service

    The name of the service can be anything that makes sense for your Jive Community. For example, if you have several instances of SharePoint that are available, e.g. one for the Sales Department, one for HR, one for Finance, you may choose to create three Jive Connects services, one for each instance of the SharePoint. This can always be changes later, so for now, let's just create one that the Three Will app can use. Call it: "Microsoft Sharepoint 2010".

     

    Next, you'll select the authentication scheme.

     

    ccs4.png

     

    • Anonymous
    • API Key
    • API Key + Basic
    • Basic Auth
    • OAuth 2 (Draft 10)

     

    SharePoint uses HTTP Basic, so choose that one.

     

    ccs5.png

     

    The third thing you'll need to know is the recommended service tag. Jive is working with our developer community to define tags for the most commonly used services. You can find the in the Jive Connects Service Tags document  If the service that you use isn't there, go ahead and create one. Make sure it starts with "jive:service://". Also, start a discussion on this in our developer community so we can be sure to update the document with the service name.

     

    Finally, add the remote endpoint, a.k.a. the "Service URL", of the SharePoint instance. In the screen shot below, "http://jive.threewill.net", provided the Sharepoint instance. You'll want to make sure this is the endpoint for your service. In the case of common cloud services, e.g. Salesforce, LinkedIn, these will be the endpoints that they provide.

     

    ccs6.png

     

    The final step in configuring a Jive Connects service is determining if there's any additional access control that needs to be put in place. Jive Connects services can be restricted to a group, an specific set of users. In the example screen capture below, only ThreeWill developers and Jive Employees had access to this service. If you've got group restrictions in your organization, you can add them here to further protect the Sharepoint instance.


    ccs7.png


    That's it! You can see that setting up a Jive Connects service is straight forward and easy. The service should be all setup and your users able to access information from your SharePoint servers. If you have any questions, please post a question in the Jive Developer Community