Kapplet Beginner's Tutorial

What follows is the Kapplet Beginner's Tutorial video, along with a transcript of the video.

This is the third of four beginner tutorials which will guide you safely through your first project with Kapow Katalyst. It is advised to watch the overview video and complete the robot tutorial before following this tutorial.

You are about to learn how to use the Management Console and KappZone to run robots as Kapplets. Please feel free to follow along on your computer.

The Management Console is a web-based application for managing the operational aspects of Kapow Katalyst. First of all, the Management Console acts as a repository for robots and types. It also includes a KappZone which enables you to create and manage Kapplets. Kapplets are robots or collections of robots that have been published as apps, easy to distribute and run.

This tutorial will show you how to upload the News Magazine robot to the Management Console, and publish it as a Kapplet in the KappZone.

Open Design Studio and MyFirstRobot, the robot we created in the Beginner Tutorial on Robots. Then ensure that the robot editor is in Design Mode by clicking the Design Button at the top left corner of the robot editor.

To upload the robot to the Management Console, select Upload to Remote Management Console from the Tools menu. Everything should already be correctly configured so just press Upload. The robot, along with any types associated with it will now be uploaded to the Management Console.

Click the link that appears to the Management Console. This should open your browser in the Repository of the Management Console.

The Repository contains any robots, types and other files uploaded to the Management Console. Observe that the News Magazine robot has been listed. Similarly click the Types tab to check that the associated type has been uploaded correctly.

To create a Kapplet from the robot, go to the KappZone tab at the top of the page. This opens a page with a link to the KappZone. Click it and the KappZone will open in a new window. The KappZone is where you can add, remove and edit Kapplets.

To create a Kapplet click Add New Kapplet at the top of the repository. Call the new Kapplet “News Magazine” and click Create Kapplet. The Kapplet has now been created and we are taken to the configuration page of our new Kapplet.

The new Kapplet is so far disabled, which is indicated by the switch at the top of the page. This means that the Kapplet is only visible to administrators. We will enable the Kapplet as soon as we are done with the configuration.

There are two pages in the configuration of the Kapplet: Identity and Pages, of which Identity is selected. On the identity page it is possible to edit the name, description and icon of the Kapplet. As description I will write “Extracts the most recent news from News Magazine” and for the icon I use the News Magazine logo which I have previously saved to my computer.

Going now to the pages section of the Kapplet Configuration, we need to configure what our Kapplet actually does. Kapplet functionality is structured by pages and even the simplest Kapplet has at least two pages, namely a start page and a result history page.

From the Start Page the user will be able to either start the Kapplet right away or Schedule the Kapplet to start automatically at specific times. Whenever the Kapplet is started, it will run all robots added to the Start Page.

The Result History page archives results returned from the executed robots.

Click Add Action on the start page, then click Add New Robot, choose the robot we uploaded, click Select Robot and click OK.

This adds an action to our Start Page with a button labeled “Start Kapplet”. It also automatically adds a new page called Post to our Kapplet. Click the Post page on the left. This page will display a specific result from the Kapplet after it has been chosen by the user from the Result History page.

Right now it displays a table containing the content of the title attribute from each result. Clicking edit on the table we can add the preview attribute to our table and click OK. The Post page will now display both the title and the preview from each of the extracted stories from News Magazine.

Click to apply the changes, enable the Kapplet, and go to the menu on the right. It appears when hovering your mouse over the square in the top right corner. From the menu it is possible to go to My KappZone or just the KappZone. You can think of the KappZone as a repository which holds all the installable Kapplets. My KappZone however, contains only the Kapplets which have been installed to your account.

Click on All under KappZone. We can now see that the News Magazine Kapplet has appeared in the KappZone. Hovering over it, we see that we can either install, edit or delete the Kapplet. Go ahead and install it. Immediately we are able to open the Kapplet. Going to My KappZone through the menu bar on the right, we also see that the News Magazine Kapplet has been added to My KappZone.

Click on the icon to open the Kapplet. The Start Page and the Result History page of our Kapplet are now displayed. From the start page we can either schedule the Kapplet or just run it once by clicking Start Kapplet. Just go ahead and click Start Kapplet.

The first result now appears in the Result History page. Click it to open the Post page showing the result and scroll to the right until the entire Post page with results appears in your browser.

And so, finally our goal has been fulfilled. We have created automated process with a robot and published it as a Kapplet, easy for users to install and use.

The next tutorial will teach you how to create a type in Design Studio.