Developing Jive Apps for your own community - using the Dev Console app

Version 2

    Welcome to the Jive Apps Dev Console app!

    The Dev Console app is intended to manage the local Jive Apps development experience, whereby a user may register a new app with Jive, deploy it to a local Jive instance for testing, and publish the application so it is available for install from the Apps Market by their users within their Jive instance, but not to other users in other Jive communities.

     

    This app is not intended to enable developers to submit their application to the public Jive Apps Market for general availability. If you'd like to make your app generally available, please check out the Jive Apps Market FAQ as a starting point. You'll also need to get an account on the Jive Developer Services, so check out Getting started with Developer Services. Of course, you can always post a question in the Developer Community as well.

     

    Using the Jive Apps Dev Console app

    Installation

    The Dev Console app is delivered to your Jive instance via the Jive Apps Market. To install the app, navigate to the Jive Apps Market via the Apps tab in the main navigation, locate the Dev Console app and click “Install”. This will place the Dev Console app into the Apps Quick Launch menu.

     

    Using the app

    Launching the app will list out any Jive Apps that you currently have registered for development. If this is your first time launching, there are a few key things you can otherwise do here:

    • Download the App Template: This .zip file is an example app and file repository and the best place to start developing an app if you do not have a repository set up already. The Jive Apps Market will be looking for apps to be setup in this format, so our recommendation is to rename the folder, copy to your app server, and start working! Included here is a "hello.html" page with some basic information for you as well.
    • Register a new app: Once you have your app repository setup you simply need to copy the URL for the gadget.xml file and hit the "Add App" button. You have the option at this time to also install to your Apps Quick Launcher if you want to see what your app looks like in your Jive instance. Note: The repository must be accessible to the Jive instance you are using without further authentication.
    • Caching control: As you actively develop your app you may find it helpful to turn the caching of your app resources on or off. Additional details on this feature can be found

    here: Disabling App Caching During Development.

     

    ss1.png

     

    Once you have selected one of your apps you will have some additional options available to you:

     

    • App Overview: In this basic view you will see the quick overview of your app, including the status of your app (In Development, or Active), your app shortname, your repository URL, your app UUID/Consumer Key, the status of your app listing, and any communities where your app may be actively published.
      • Changing your app shortname: This 4-128 character field will be the human readable name for your app -- think of it like your app's URL. Shortnames must be unique for your instance. For more information check out Step 1 of our Creating a Basic "Hello World" App tutorial.
      • Changing your app repository: Through the course of development and publication of your app you may need to move your repository. You can do so here (even after the app has been pushed live) by hitting the "pencil" control at the end of the "Located at" field.
      • Install in Quick Launcher: To test your app within your local Jive instance, without making it available to other users within the community, you can use the Dev Console to place your app into the Quick Launcher during the development process.
      • Delete your app: If you feel the app you have registered is no longer of value and you would like to delete it you may do so here. Once you delete your app it will no longer be available to anyone else who may have been using the app and cannot be recovered. You can, of course, re-register the app gadget again, however it will be treated as a new application with a new consumer key and secret and will require reinstallation by any users.

     

    ss2.png

     

    • Market Listing: Once you are comfortable with the performance of your app the next step is to fill out the app listing information. To do so, hit the "edit" button in the canvas view of the Dev Console. Here you will have the ability to fill out the details about your app we will present in the Market, preview your gadget.xml information, and preview the entire listing. For more information check out steps 4, 5, and 6 from this tutorial: Submitting And Updating Your App

     

    ss3.png

     

    ss4.png

     

    ss5.png

     

    • Publishing your app -- Communities: The final step for now is to publish your app. This is where anyone using the Dev Console for developing public apps -- those available for all Jive customers -- will need to jump over to our standard 3rd party developer experience. For those developing for your own users, you will be presented with a list of all production Jive instances associated with your Jive license. Choose all instances you would like to deploy to and hit "Publish". Your app is now live for all users of those instances! Users just need to navigate to the Jive Apps Market where your app is now listed and available for installation. If, for some reason, you would like to remove your app from any or all of these instances just deselect the instances where you have deployed; hit "update", and the app will be removed.

     

    ss6.png

     

    ss7.png