You have written a great Klip that has thousands of users, and now you want to upgrade everyone to a new and improved version. Klipfolio Dashboard has a built-in system that makes it easy to remotely upgrade your Klip, no matter how many users you have.
To use the remote upgrade system, add the following two parameters to your Klip before you deploy it to others:
<version>, the current version of the Klip
<kliplocation>, a URL that points to the latest version of the Klip on your web server
About once every four days, Klipfolio Dashboard checks <kliplocation> for each Klip and downloads the Klip at this location to a temporary folder. It then compares the <version> of the downloaded Klip with that of the current Klip and prompts you to upgrade the Klip if the versions are different. If you accept, the downloaded Klip replaces the current Klip.
![[Note]](/content/live/dev/guide/gfx/admonitions/note.gif) | Note |
|---|---|
The version check is done with a string comparison, not a numeric comparison. This allows you to upgrade version 1.0a to version 1.0b, for example. | |
Let's go through an example to show how the upgrades work.
Using a text editor, paste the following XML into a new document.
<klip>
<identity>
<version>
1.0a
</version>
</identity>
<locations>
<contentsource>
http://news.com.com/2547-1_3-0-5.xml
</contentsource>
<kliplocation>
http://www.klipfolio.com/static/klips/devguide/upgrade.klip
</kliplocation>
</locations>
</klip>
Save the file as upgrade.klip in your myklips folder.
Observe that Klipfolio Dashboard loads and displays the Klip.
Observe that the Klip is using a default icon.
Open the Klip's Customize window and go to the About tab.
Observe that the version of this Klip is 1.0a and that the banner is also a default one.
Open Klipfolio Dashboard's window and click the Klips tab.
Click Check Now.
Klipfolio Dashboard goes to http://www.klipfolio.com/static/klips/devguide/upgrade.klip and downloads the Klip at this location to a temporary directory. In this case, the <version> for this new Klip is 1.0b. The current Klip is version 1.0a, so Klipfolio Dashboard prompts you to upgrade.
Click Upgrade Now.
The upgraded Klip appears, and it has a Klip icon in the upper-left corner.
You can confirm that you are running the new version of the Klip by clicking the About tab in the Klip's Customize Klip window. The version now reads 1.0b:
You can also confirm the upgrade worked by checking the source. You will see updated entries for <title>, <version>, and <refresh>:
<klip>
<identity>
<title>
My First Klip (upgraded)
</title>
<version>
1.0b
</version>
</identity>
<locations>
<contentsource>
http://news.com.com/2547-1_3-0-5.xml
</contentsource>
<icon>
http://www.klipfolio.com/static/klips/klipfolio/sample_icon.png
<banner>
http://www.klipfolio.com/static/klips/klipfolio/sample_banner.png
</banner>
<kliplocation>
http://www.klipfolio.com/static/klips/devguide/upgrade.klip
</kliplocation>
</locations>
<setup>
<refresh>
60
</refresh>
</setup>
</klip>
The Klip upgrade system is both easy to use and flexible. For example, you can set things up so users download a Klip from one <kliplocation> while keeping the upgraded Klip in a different <kliplocation>.