documentsn.com

CH A P T E R11Developing a Gadget for the Home PageNoteThis topic is intended for system and business administrators who can develop new gadgets for the Homepage.Cisco Pulse supports the development of gadgets that are comprised of an XML file with content that isspecified using HTML. The XML file and its contents must adhere to the OpenSocial Gadgets APISpecification v0.9. To access this specification, go to this .htmlThis chapter provides information on these gadget development topics: Developing a Gadget, page 11-1 Modifying a Gadget, page 11-9 Deleting a Gadget, page 11-13 Additional Gadget Development Elements, page 11-13Developing a GadgetCisco Pulse allows users with the privilege level of “system administrator” and “business administrator”to develop a gadget. The development process consists of these tasks: Creating a Gadget, page 11-2 Publishing a Gadget, page 11-7Publishing a gadget is an optional task that makes the gadget available for all Cisco Pulse users to addto their Home pages.Cisco Pulse Administrator GuideOL-20214-0211-1

Chapter 11Developing a Gadget for the Home PageDeveloping a GadgetCreating a GadgetYou can create a gadget using the Source page. In this page, you can specify the source of your gadgetcontent. Cisco Pulse supports these sources.NoteWhen leveraging gadget contents written by a third party, you must adhere to any copyright or legalrestrictions specified by the third party. External URL—You can specify a URL to an existing XML file on a website. You want to use theXML file as the source of your gadget and do not want to make any modifications to the file. Gadget Editor—By default, this editor includes sample gadget contents. You have these options tocreate your gadget contents in the Gadget Editor:– Using the sample contents as a starting point, develop the contents in the Gadget Editor and savethe updates.– Upload the contents of an XML file from a specified website to the Gadget Editor. Modify thecontents as desired, and save the modifications.– Upload the contents of an XML file from a specified hard disk location to the Gadget Editor.Modify the contents as desired, and save the modifications.When specifying the gadget contents, keep in mind that Cisco Pulse supports two gadget sizes in theHome page: Default size—By default, all gadgets in the Home page are displayed in the size shown inFigure 11-1. Canvas size—If a Cisco Pulse user maximizes the size of a gadget in their Home page, the gadgetappears as shown in Figure 11-2.Cisco Pulse Administrator Guide11-2OL-20214-02

Chapter 11Developing a Gadget for the Home PageDeveloping a GadgetFigure 11-1Sample Home Page—Default-Size GadgetsFigure 11-2Sample Home Page—Canvas-Size GadgetCisco Pulse Administrator GuideOL-20214-0211-3

Chapter 11Developing a Gadget for the Home PageDeveloping a GadgetWhen specifying the gadget content, you must specify content for both gadget sizes using theseparameters:view “home” (for the default size)view “canvas” (for the canvas size)You can specify the same content for both sizes or provide additional content for the canvas size, whichcan accommodate more content with its wider dimensions.Before You Begin Decide whether to leverage all or partial contents of an already existing gadget for your gadget. Ifyou can leverage contents, determine the location of the XML file that contains the contents. When leveraging gadget contents written by a third party, make sure that you adhere to any copyrightor legal restrictions specified by the third party. If you plan to publish your gadget so that it is available for all Cisco Pulse users to add to their Homepages, you must decide if you want to use the same content for both default and canvas sizes orprovide additional content for the canvas-size gadget.ProcedureTo create a gadget:Step 1In the Gadget Development page, click Create New Gadget as shown in Figure 11-3.Figure 11-3Sample Gadget Development PageThe Source page appears as shown in Figure 11-4.Cisco Pulse Administrator Guide11-4OL-20214-02

Chapter 11Developing a Gadget for the Home PageDeveloping a GadgetFigure 11-4Step 2Sample Source PageIn the Source page, specify the source of your gadget content using one of these substeps:a.To specify a URL to an existing XML file that you want to use as is, click the External URL radiobutton and in the field that appears, specify the URL.b.To upload the contents of an XML file from one of these sources to the Gadget Editor, make surethe Gadget Editor radio button is selected, then take one of these actions: To upload the contents from a website, from the Select Source drop-down list, choose URL. Inthe field that appears, specify the URL, then click Upload. To upload the contents from your hard disk, from the Select Source drop-down list, choose File,then click Browse. In the window that appears, locate the file on your hard disk, then clickOpen. Back in the Source page, click Upload.The system uploads the content of the specified XML file to the Gadget Editor. Modify thecontent as desired.c.Step 3Using the sample contents in the Gadget Editor as a starting point, develop the content as desired.Save your gadget contents by clicking Save.The first time that you save the contents, the system assigns a temporary gadget name that starts with“untitled ”.If desired, you can change the name by clicking the Details tab, removing the system-assigned name,specifying a new name, and clicking Save. For more information on the gadget name, see the “Publishinga Gadget” section on page 11-7.Cisco Pulse Administrator GuideOL-20214-0211-5

Chapter 11Developing a Gadget for the Home PageDeveloping a GadgetStep 4When you are ready, you can view a preview of your gadget by performing these steps:a.Click Preview.A preview of the default-size gadget appears to the right of the Gadget Editor as shown inFigure 11-5.Figure 11-5Sample Source Page—Displaying a Preview Gadgetb.To maximize the preview gadget so that it appears in canvas size, click the maximize icon in thegadget title bar.c.To reduce the size of the preview gadget to its default size, click the close icon in the gadget title bar.d.To close the preview gadget, click the right-arrow key next to the Select all link or the close icon inthe gadget title bar.Step 5If using the Gadget Editor, make any additional modifications to the gadget content, save themodifications, and view another preview of the gadget.Step 6When your gadget is finished, save the content by clicking Save.Step 7If you are ready to publish your gadget, go to the “Publishing a Gadget” section on page 11-7.For information on elements in the Gadget Development and Source pages that were not described inthis procedure, see the “Additional Gadget Development Elements” section on page 11-13.Related Topics Publishing a Gadget, page 11-7Cisco Pulse Administrator Guide11-6OL-20214-02

Chapter 11Developing a Gadget for the Home PageDeveloping a GadgetPublishing a GadgetAfter you create a gadget, you can optionally publish it, which means that the gadget is available to allCisco Pulse users to add to their Home pages. Cisco Pulse users who add this gadget to their Home pagesare known as subscribers.NoteKeep in mind that Cisco Pulse users can add multiple instances of a gadget to their Home page, so thenumber of gadget subscribers and the actual number of subscriptions might vary.Before publishing a gadget, the system prompts you to specify these elements for the gadget: A name and iconAt this point, your gadget probably has a temporary system-assigned name and a default icon.You must change the temporary name to a descriptive name. If you do not, the system continues toprompt you until you do.We recommend using a customized icon because both the name and icon will appear in severalplaces, the most prominent being a panel of gadgets that Cisco Pulse users can add to their Homepages. When choosing a name and icon, keep in mind that Cisco Pulse users will judge the meritsof the gadget based on the name and icon.The icon file that you specify must meet these guidelines:– Maximum size of 100 MB– JPG, GIF, or PNG format KeywordsYou can specify keywords for a gadget so that Cisco Pulse users can search upon the keywords andthereby, discover the gadget.Note The system currently accepts keywords. However, the search functionality is not yet supported.A short descriptionYou can specify a brief description of the gadget. The description is displayed, along with othergadget information, in the Gadget Development page.Before You BeginYou need these elements for your gadget: A descriptive name A customized iconProcedureTo publish a gadget:Step 1Go to the Gadget Development page as shown in Figure 11-6.Cisco Pulse Administrator GuideOL-20214-0211-7

Chapter 11Developing a Gadget for the Home PageDeveloping a GadgetFigure 11-6Step 2Sample Gadget Development Page—Publishing a GadgetIn the My Gadgets content area, find the gadget that you want to publish and click Publish.The system prompts you to verify the publishing of the gadget. To proceed with the publish, click OK.To cancel the publish, click Cancel.If you clicked the OK button, the Details page appears as shown in Figure 11-7. This page containsconfigurable elements for your gadget.Figure 11-7Step 3Sample Details PageSpecify a descriptive name for your gadget.If a system-assigned name already exists in the Name field, delete it and add your descriptive name,which can be a maximum of 64 characters and must not start with “untitled ”.Step 4Optionally, specify keywords for your gadget.The keywords can be composed of a maximum of 256 characters.NoteStep 5The system currently accepts keywords. However, the search functionality is not yet supported.Optionally, specify a description for your gadget.The description can be composed of a maximum of 256 characters. This description is displayed, alongwith other gadget information, in the Gadget Development page.Cisco Pulse Administrator Guide11-8OL-20214-02