Welcome to the Jive Apps Dev Console Early Access Program!
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!
** PLEASE NOTE **
This early access program is intended to provide early access to features and functions that Jive is currently working on. While we believe we are far enough along to both generate useful feedback and provide real value to users, there are bugs in the code, missing features, and other quirks in the application. We have cataloged known issues below, however there are surely many issues still outstanding that we have not yet discovered. Thank you in advance for your patience and your feedback! We will be updating this app regularly so check back for updates.
Using the Jive Apps Dev Console
Dev Console is delivered to your Jive instance via the production Jive Apps Market. For this early access period we will need to explicitly enable this application for your instance.
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".
Home view -- downloading the App Template
The Dev Console home view -- the "small" version you see by default on your apps dashboard -- does not contain a lot of functionality today, however there is one valuable function here: the download link for 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.
Canvas view -- registering a new Jive App
The first thing you will want to do is register a new Jive App. To do so, put the Dev Console into canvas view -- the "large" full screen version -- either by clicking "Get Started" in the home view or the "maximize" button in the upper right hand corner of the app.
Once into canvas view you will see a "New" button on the upper right hand side where you will register your Jive App with the Jive Apps Market. Once here you will need to complete two steps to register your app:
- Create 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.
- Identify your app.xml URL: The market will also need a link to your app.xml file, wherever it is you are hosting it. The app.xml and other files contained in your repository will not move. Note: The repository must be accessible to the Jive instance you are using.
Installing your application
After successfully creating your application you will return to the default canvas view where you will see your newly registered app. Your app is currently "in development" and from here you can either install your application or edit your app listing.
For most developers the next step in the process will be to install your app and start testing. Simple click "install" and the app will be installed to your app dashboard in dev-mode. You will have the ability to quickly refresh your application directly from the app chrome and to turn monitoring on or off.
Creating your Jive Apps 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
Once you are satisfied you can either save, or deploy to your community.
Publishing your app
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, hit the "Deploy to your Community" button at the top of the "edit" screen (see screenshot above). 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 "Submit". 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 hit the "deploy" button again and deselect the instances where you have deployed; hit "submit" again, 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|
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.||Q4 2011|
|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.||Q4 2011|