Version 5

    What is a Jive Add-on?

    A Jive Add-on is a bundled array of configuration settings that can be installed and managed by a non-technical Jive user. These add-ons can be browsed and installed directly from the Jive user interface via the Add-ons Registry, or by a direct file upload.  A Jive Add-on can configure anything that Jive can do, depending on what adapters are available to apply that configuration.

    All Jive Add-ons have a type. The type is used to filter or categorize add-ons in the Jive user interface, which helps manage add-ons. The type is also used to determine which bit of code in Jive will be used to apply the configuration data bundled in the add-on.

    Contents of the Jive Add-on Package

    Jive add-ons are ZIP files that contain some configuration files and folders. The meta.json and definition.json are the most important files in the package.

    Note: Although the Jive Add-on package is encoded as a standard ZIP file, we use the custom file extension ".jive" when naming the file.

    • meta.json - A JSON formatted file with several fields, most of which are optional, but any of which may be appropriate to any type of Jive Add-on. The most important field in here is the "type" field.
    • definition.json - A JSON formatted file with a schema specific to the add-on type. see:
      Building a Jive Extension - definition.json

    This package also contains two folders: data and i18n.

    • /data - Contains files relevant to the Jive Add-on. Most add-ons define icons in the meta.json, and those image files are here. Add-ons may also specify a EULA, and that file is also stored in this folder.
    • /i18n - Add-ons support localization through the use of resource bundles. This directory contains files like en.properties and zh_TW.properties -- Java properties formatted resource bundles.

    Developing Add-ons

    The easiest way to develop Add-ons is to use the Jive-SDK:

     

    Installing Jive-SDK

     

         Install on Mac, Linux, Unix

    1. Download Node 0.10.x (or higher) and NPM
    2. Python 2.7 (most likely preinstalled on your system), but if not
    3. Install jive-sdk globally to your system with this command:
    sudo npm install jive-sdk -g

    Install on Windows

    1. Node 0.10.x and NPM  http://nodejs.org/download
    2. Install jive-sdk globally to your system with this command:
    npm install jive-sdk –g

    Jive-SDK Basics

    To test that the Jive-SDK is installed correctly:

    1. Open a terminal(OSX/Unix) or cmd prompt (Windows) session
    2. Navigate to your add-on development folder (you choose!)
    3. Enter the following command:

    jive-sdk

     

    You should see this output:

    sdk-help.jpg

    As can be seen, there are a number of examples provided to help get you up to speed in developing solutions for your Jive Platform

     

    Deploying an Add-on

     

    To deploy your Add-on on your community, you simply need to create the zip file and use the Add-ons item that will appear in the Manage section of your drop down menu - if you have Admin permissions:

     

    manage-addons.jpg

    This will give you access to the Add-ons Management console:

     

    addon-screen.jpg

    It is here that you upload your extension.zip file:

     

    upload-screen.jpg

    As the admin, you can deploy the Add-on to be visible only to you for testing purposes, or to make it available to your entire community.

    Depending upon your Add-on, there may be further configuration necessary to make it work as expected.

     

    You can develop multiple Add-ons and deploy as one package if desired - each type of Add-on will be detected as part of the deploy process of the one .zip file