Welcome to the Jive Apps Dev Console app!
The Jive Apps Dev Console 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 5 instance for testing, and publish the application so it is available for install from the Apps Market by their users within their Jive 5 instance, but not to other users in other Jive 5 instances.
Today this app is not intended to enable developers to submit their application to the public Jive Apps Market for general availability. Jive will be enabling features for this workflow in the near future. We have some manual workarounds for this process, so please contact the Jive Apps Team directly with any questions!
Using the Jive Apps Dev Console app
The Dev Console app is delivered to your Jive instance via the production Jive Apps Market. To install, navigate to the Jive Apps Market (do so by clicking the "Apps" tab in the main navigation and launching the Apps Market from the Dashboard), locate the Dev Console app and click "install".
The Dev Console home view -- the "small" version you see by default on your apps dashboard -- is mainly a jumping off point for the rest of the application. There are, however, a few key things you can do here in this view:
- 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 app dashboard 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.
- Caching control: As you actively develop your app you may find it helpful to turn the caching of your app resources on or off. You can usually control this here in the home view. Additional details on this feature can be found here: Disabling App Caching During Development.
You will enter the Dev Console's canvas view -- the "large" full screen version -- either by clicking into in the home view or the "maximize" button in the upper right hand corner of the app. Here you will see the list of your registered apps or the specific app you clicked into. Again you may add a new app, download the app template, and control your caching (see above).
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 to dashboard: As in the home view you can install your app to the app dashboard for testing. If you have moved your DevConsole app from one app dashboard to another you may need to look around a bit for your app after installation.
- 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 in this view. 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, reregister 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.
- 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
- 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. Again, we will be filling in this functionality in the future; apologies for the frustration for now! 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 instance 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.
There are a host of known issues that Jive is still working on with this functionality. Below is the list of known issues; there are undoubtedly more. If you find any issues or have any questions please comment below!
|Issue||Description||Expected Resolution Date|
|Incorrect shortnames do not have useful error messaging||If for some reason you try to register with an invalid app shortname it is difficult to understand why. Please refer to the tutorial above.||9/13/11|
|Invalid app.xml does not have useful error messaging||If for some reason your app gadget is poorly defined the registration process will fail with no explanation.||9/13/11|
|App icon and screenshots must be absolute URLs, not relative URLs||In the main Jive Apps documentation the icons and screenshots in an app must be relative URLs. For a locally developed app to be properly published in the local Market they must be absolute.||9/13/11|
Unable to delete an app listing in the Dev Console
|Currently there is no function to delete an app after you create it. If you create multiple applications they will sit in your list until we introduce a delete process.||10/16/11|
Unable to change the app.xml URL value
|Once you choose your app.xml location there is no current way to change it. This means that for now you cannot move your app repository once registered.||10/16/11|
|Caching mode value alerting||Depending on setup you may or may not be able to make use of Jive's Live Dev feature. Currently there is not an easy way to tell if you can or cannot use the feature.||10/16/11|
|Dev Console does not support 2-legged OAuth||If your application requires a signed requests to your home server using OAuth there is currently no way to gather your consumer secret. Additionally any signed requests will not be passed through the Jive Apps Gateway.||11/12/11|
There is nowhere to specify OAuth-related data for 3rd party services
|If your application requires any OAuth services, even if defined within the gadget, there is currently no way to log your OAuth key or secret.||TBD|
|App install events are triggered when creating/installing new apps||Be advised that using the dev console to install a new app for development will trigger an activity event to the What Matters Activity Stream. If you happen to be developing in a production environment, other users will see this activity and may be compelled to learn more about the app you've just installed. However, since the app is in development and not in the market at large, they will not be able to see it. This could cause confusion.||TBD|