<?xml version="1.0"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>AutoUpdater - Quickstart Tutorial</title> <meta name="keywords" content="omnis studio, autoupdater documentation" /> <link rel="stylesheet" type="text/css" href="http://www.studiotips.net/css/codedoc.css" /> <link rel="stylesheet" type="text/css" media="print" href="http://www.studiotips.net/css/codedoc_print.css" /> </head> <body> <div id="container"> <p><a href = ../index.html > Autoupdater </a> &nbsp &gt; &nbsp <a href = index.html > About </a> &nbsp &gt; &nbsp Quickstart Tutorial</p> <a name="quickstarttutorial" /> <h2>Quickstart Tutorial</h2> For those of you who don't like reading documentation, this <span class="nav">Quickstart Tutorial</span> will get you up and running quickly with your own <span class="nav">AutoUpdater</span> library. <a name="preparingyourautoupdaterlibrary" /> <h3>Preparing your AutoUpdater Library</h3> <ol> <li>Create a new folder and name it whatever you call your Omnis Studio application. The folder name can be any name. For this tutorial we will refer to the folder as the <span class="file">APP</span> folder.</li> <li>Put a <strong>copy</strong> of the <span class="file">AutoUpdater.lbs</span> library inside your APP folder.</li> <li><strong>Rename</strong> the <span class="file">AutoUpdater.lbs</span> library to something appropriate for you application. e.g. <span class="file">MyAppName_AutoUpdater.lbs</span> (<span class="file">MyAppName</span> would be replaced with the short name for your application.)</li> <li>Make a <em>subfolder</em> inside the <span class="file">APP</span> folder, name it <span class="file">libraries</span>. </li> <li>Drag your application's library(s) and folders into the <span class="file">libraries</span> <em>subfolder</em>.<br /> <br /> <div class="image_sideline"><img src="http://www.studiotips.net/css/images/warning.gif" alt="Warning" /><p><strong>Note</strong>: If your application has large size files and many of them, just create and drag in a small test library for this quick start tutorial.</p> </div></li> <li>Open the <span class="file">MyAppName_AutoUpdater.lbs</span> library with a developer version of Omnis Studio.</li> <li>You will be asked if you want to open the main library. Click the <span class="nav">No</span> button.</li> <li>The <span class="nav">AutoUpdater</span> menu will be installed. Select the <span class="nav">Your App Name</span> menu line. This opens the <span class="nav">AutoUpdater</span> window.</li> <li>The <span class="nav">AutoUpdater</span> window will open to the <span class="nav">Preferences</span> > <span class="nav">Developer</span> tab.</li> <li>Enter the full name of your application in the <span class="nav">Application Name</span> field.</li> <li>Enter the short name of your application in the <span class="nav">Package Name</span> field. If you want to have client specific packages append the short name with a client ID. e.g. <kbd>MyAppName_Jones</kbd></li> <li>Select the <span class="nav">Preferences</span> > <span class="nav">Files Sever</span> tab. For testing purposes you can leave the current settings which will use the <span class="file">studiotips.net</span> FTP server. Later on you will want to set the files server to your own FTP server or a database on your local network.</li> <li>Select the <span class="nav">Preferences</span> > <span class="nav">Runtime User</span> tab. Take a look at the settings. You can change them if you like.</li> <li>Select the <span class="nav">Create Package</span> tab.</li> <li>Click the <span class="nav">Prepare Pacakge</span> button. All of the files inside your <span class="file">APP</span> folder should be listed, except the <span class="file">MyAppName_AutoUpdater.lbs</span> library.</li> <li>Click the <span class="nav">Upload Package and Files...</span> button. This should upload your package description file and your files to the <span class="file">studiotips.net</span> server.</li> <li><span class="nav">Quit</span> your developer version of Omnis Studio.</li> </ol>You are now ready to runtime test your <span class="file">MyAppName_AutoUpdater</span> library. <a name="testingyourautoupdaterlibrary" /> <h3>Testing Your AutoUpdater Library</h3> <ol> <li>Create a <strong>new empty</strong> folder on your <span class="file">Desktop</span>. Name it <span class="file">AutoUpdater_Test1</span></li> <li>Put a <strong>copy</strong> of your <span class="file">MyAppName_AutoUpdater</span> library into the <span class="file">AutoUpdater_Test1</span> folder.</li> <li>Using a runtime version of Omnis Studio open the <span class="file">MyAppName_AutoUpdater</span> library inside the <span class="file">AutoUpdaterTest1</span> folder.</li> <li>All going well the <span class="nav">AutoUpdater</span> library will prompt you with a window informing you that an update can be downloaded. </li> <li>Click the <span class="nav">Install</span> button to proceed.</li> <li>All going well <span class="nav">AutoUpdater</span> will download the package and files from the server, create the subfolder(s) inside the <span class="file">AutoUpdater_Test1</span> folder, install the downloaded files, and then open the library(s) directly inside the <span class="file">libraries</span> folder.</li> </ol> <p>There you have it, <span class="nav">Quickstart AutoUpdater</span>!</p> You are now ready to test uploading newer version files. <a name="uploadingnewerversionfiles" /> <h3>Uploading Newer Version Files</h3> <p>In this section of the tutorial we will use <span class="nav">AutoUpdater</span> to upload a newer version library to the files server with a <strong>developer</strong> version of Omnis Studio, then open the <span class="file">AutoUpdater_Test1</span> with a <strong>runtime</strong> version of Omnis Studio to watch how it downloads the newer version of the library to the runtime user.</p> <ol> <li>Using a <strong>developer</strong> version of Omnis Studio reopen the <span class="file">MyAppName_AutoUpdater</span> library which which you prepared in the first section of this tutorial. (<strong>Not</strong> the one inside the <span class="file">AutoUpater_Test1</span> folder.)</li> <li>When it asks if you want to open the main library, click the <span class="nav">Yes</span> button.</li> <li>Go into the <span class="code">mMainWindow</span> of your application's main library and add a comment line in text field on the window or make some other change that you will be able to see. (Drag and drop a button on the window)</li> <li>Right-click on the main library in the <span class="nav">F2 Browser</span> and select <span class="nav">Save</span> to make sure that the change is saved to the disk.</li> <li>Open the <span class="nav">AutoUpdater</span> window from the <span class="nav">AutoUpdater</span> menu.</li> <li>Click the <span class="nav">File Updates</span> tab.</li> <li>Click the <span class="nav">Add Files...</span> button. You will be prompted to select a file. Navigate to and select the main library which you just modified. (You can also drag and drop files onto the files list.)</li> <li>In the <span class="nav">Release Date</span> line of the <span class="nav">File Updates</span> tab window increment the release hour droplist to the next hour. <br /> <br /> <div class="image_sideline"><img src="http://www.studiotips.net/css/images/note.gif" alt="Note" /><p>The release hour droplist defaults to the current hour. If you do more than one release of the same library in the same hour, you need to manually increment it to the next hour.</p> </div></li> <li>Click the <span class="nav">Upload Files...</span> button. All going well your newer file will be uploaded to the server and you will see it appear in the <span class="nav">Server Files</span> list, replacing the older version in the list.<br /> <br /> <div class="image_sideline"><img src="http://www.studiotips.net/css/images/warning.gif" alt="Warning" /><p>Windows users may need to first close the library files which they wish to upload before cliciking the <span class="nav">Upload Files...</span> button.</p> </div></li> <li>Click the <span class="nav">Show All Files</span> radio button below the <span class="nav">Server Files</span> list. You will see all of the files which have been uploaded for the selected package.</li> </ol> <p>You are now ready to test updating the runtime library.</p> You can leave your developer version of Omnis Studio open. <a name="updatingtheruntimeapp" /> <h3>Updating the Runtime App</h3> <ol> <li>Using a runtime version of Omnis Studio open the <span class="file">MyAppName_AutoUpdater</span> library inside the <span class="file">AutoUpdater_Test1</span> folder.</li> <li>All going well the <span class="nav">AutoUpdater</span> library will prompt you with a window informing you that an update can be downloaded. The file which you uploaded to the files server should be list.</li> <li>Click the <span class="nav">Download</span> button to proceed.</li> <li>All going well <span class="nav">AutoUpdater</span> will download the newer version library from the server, install the downloaded file, and then open the library(s) directly inside the <span class="file">libraries</span> folder.</li> </ol> <p>That's it for the <span class="nav">Quickstart Tutorial</span>.</p> You now have the basics for using <span class="nav">AutoUpdater</span>. Scan through the <span class="nav">AutoUpdater</span> documentation to learn more features and ways to customize <span class="nav">AutoUpdater</span> to suit your requirements. <p class="footer">AutoUpdater Documentation - Copyright 2006 Vencor Software </p></div> </body> </html>