5,838
edits
Toolbox: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
Text replacement - "Cumulus.ini" to "Cumulus.ini_(Cumulus_1)"
m (Build 44 - added ability to execute local commands) |
m (Text replacement - "Cumulus.ini" to "Cumulus.ini_(Cumulus_1)") |
||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{AddOnBanner|name=Cumulus Toolbox|type=Windows software|author=David Jamieson|contact='DAJ' via the forum|updated= | {{AddOnBanner|name=Cumulus Toolbox|type=Windows software|author=David Jamieson|contact='DAJ' via the forum|updated=21 Oct 2011|version=1.0}} | ||
Cumulus Toolbox contains a variety of ‘extra’ features to enhance the power of Cumulus by providing a number of automated processes. | Cumulus Toolbox contains a variety of ‘extra’ features to enhance the power of Cumulus by providing a number of automated processes. It only runs on a Windows operating system. | ||
[[File:ToolboxScreen1.png|250px|thumb|Main Console]] | [[File:ToolboxScreen1.png|250px|thumb|Main Console]] | ||
| Line 12: | Line 10: | ||
=Current feature list= | =Current feature list= | ||
[[Category:User Contributions]] | |||
*Design your own ‘rules' based on | *Design your own ‘rules' based on any of the Cumulus [[webtags]]. When a Rule is met the system will email any number of addresses with a customized warning message. | ||
*Check to ensure Cumulus is running and also that Realtime processing is updating – again notification via email if this fails. | *Check to ensure Cumulus is running and also that Realtime processing is updating – again notification via email if this fails. | ||
| Line 20: | Line 18: | ||
*Take a copy of the realtime.txt file being produced by Cumulus and keep a running log of this valuable data. Upload it to your website for processing too! Excellent if you wish to use [http://cumulus.tnetweather.com/projects/jpgraphgraphs JpGraphs] but do not have the ability to create a 'cron' job on your server. | *Take a copy of the realtime.txt file being produced by Cumulus and keep a running log of this valuable data. Upload it to your website for processing too! Excellent if you wish to use [http://cumulus.tnetweather.com/projects/jpgraphgraphs JpGraphs] but do not have the ability to create a 'cron' job on your server. | ||
*The ability to run remote commands (either an executable/batch file on the PC or send requests via the internet). For example, if you need to run a script each day on your web server to process data you can create an Remote Command HTTP request on the Toolbox. | *The ability to run remote commands (either an executable/batch file on the PC or send requests via the internet). For example, if you need to run a script each day on your web server to process data you can create an Remote Command HTTP request on the Toolbox. | ||
| Line 28: | Line 24: | ||
*Automatically backup key Cumulus data files hourly or Daily at a specific time. Click File, Backup to do an immediate backup. Files can also be compressed. See Requirements below if you plan to Compress the backups | *Automatically backup key Cumulus data files hourly or Daily at a specific time. Click File, Backup to do an immediate backup. Files can also be compressed. See Requirements below if you plan to Compress the backups | ||
=Requirements= | =Requirements= | ||
| Line 40: | Line 35: | ||
*.NET Framework version 2.0 or above. Most up to date Windows installations will already have this. If 'Toolbox' does not run you need to download the latest .NET framework from Microsoft...[http://www.microsoft.com/downloads/details.aspx?familyid=333325FD-AE52-4E35-B531-508D977D32A6&displaylang=en here] | *.NET Framework version 2.0 or above. Most up to date Windows installations will already have this. If 'Toolbox' does not run you need to download the latest .NET framework from Microsoft...[http://www.microsoft.com/downloads/details.aspx?familyid=333325FD-AE52-4E35-B531-508D977D32A6&displaylang=en here] | ||
*If you plan to have 'Toolbox' to compress (zip) the backups then you require an additional tool for this. Download 7Zip command line tool from [http://www. | *If you plan to have 'Toolbox' to compress (zip) the backups then you require an additional tool for this. Download 7Zip command line tool from [http://www.justdaj.com/files/cumulus/7za.exe here] and place the file (7za.exe) is the same folder Cumulus runs in. 7Zip is free for personal and commercial use -- full details on the license are [http://www.justdaj.com/files/cumulus/7zalicense.txt here] | ||
=Installation= | =Installation= | ||
Firstly, you need to be processing the PHP webtag file in Cumulus, but it must be version 1.11 or later as there is a problem with earlier versions. If you are already on ver 1.11, skip to Part 2 | Firstly, you need to be processing the PHP webtag file in Cumulus, but it must be version 1.11 or later as there is a problem with earlier versions. If you are already on ver 1.11, skip to Part 2. If you are not interested in the rules bases checking you may also skip to Part 2 | ||
==Part 1== | ==Part 1== | ||
*Download from the wiki.... | *Download from the wiki....[[Php_webtags|PHP Webtags]] | ||
*Follow the instructions to set it up in Cumulus, however no need to FTP it, only process. For the remote filename you can place it anywhere on your local computer (c:\temp\...). It is not important. If you use PHP webtags on your website the remote filename is as it was before | *Follow the instructions to set it up in Cumulus, however no need to FTP it, only process. For the remote filename you can place it anywhere on your local computer (c:\temp\...). It is not important. If you use PHP webtags on your website the remote filename is as it was before | ||
*Make sure Cumulus processes the file at least once before you go any further -- quickest way is to | *Make sure Cumulus processes the file at least once before you go any further | ||
**In cumulus 1 -- quickest way is to use File menu, select Web update; this will update your website but also make Cumulus process the web tags we need | |||
**In Cumulus MX, the equivalent is to use Settings menu, select FTP now; this will do same as above. | |||
==Part 2== | ==Part 2== | ||
*Download Cumulus Toolbox .... http://www. | *Download Cumulus Toolbox .... http://www.justdaj.com/files/cumulus/ToolboxSetup.exe | ||
*Run the Setup by Double clicking on the icon | *Run the Setup by Double clicking on the icon | ||
*When complete it will add a shortcut on the desktop, and in the Programs menu, and will start. | *When complete it will add a shortcut on the desktop, and in the Programs menu, and will start. | ||
*First thing to do is File, Setup | *First thing to do is File, Setup | ||
*Select your Cumulus. | *Select your Cumulus.ini_(Cumulus_1) file location and the PHPWebtags file you are processing in Cumulus | ||
*Enter an email address of whom to notify when Rules are met | *Enter an email address of whom to notify when Rules are met | ||
*Move to the eMail server Tab | *Move to the eMail server Tab | ||
| Line 74: | Line 71: | ||
==Rules== | ==Rules== | ||
In here you can add, edit and delete rules. You basically select a webtag, a condition and a value. For example, 'temp' less than 10. Also note how often you should be told of this event. Currently you can be notified each time the event happens, hourly or once per day. You may also customise the message to be emailed to you for each Rule | In here you can add, edit and delete rules. You basically select a webtag, a condition and a value. For example, 'temp' less than 10. Also note how often you should be told of this event. Currently you can be notified each time the event happens, hourly or once per day. You may also customise the message to be emailed to you for each Rule, including using [[webtags]] in the message | ||
==System Checks== | ==System Checks== | ||
| Line 92: | Line 89: | ||
*'HTTP Requests' gives you the ability to schedule tasks on your web server by sending a standard HTTP requests. For example, you have a script on your webserver which processes your dayfile.txt each day. With 'Toolbox' you can add an entry to call the task via a normal web address. Any script you can run via a browser can be scheduled in Toolbox, and the results can be captures to a file too. | *'HTTP Requests' gives you the ability to schedule tasks on your web server by sending a standard HTTP requests. For example, you have a script on your webserver which processes your dayfile.txt each day. With 'Toolbox' you can add an entry to call the task via a normal web address. Any script you can run via a browser can be scheduled in Toolbox, and the results can be captures to a file too. | ||
*' | *The 'realtime.txt' tab allows you to take a regular, and running log of the realtime.txt file produced by Cumulus. For example, Cumulus may produce a realtime.txt file every 15 seconds. Within Toolbox you can ask it to keep a running log every minute. This log can then be uploaded to your website periodically (using the Upload Files tab) and services on your website may make use of this file. (e.g jGraphs) | ||
* | *'Backups' tab sets up regular backups of the key Cumulus data. This can be done daily or hourly and the files can be compressed into a single file if required. | ||
=Toolbox files= | =Toolbox files= | ||
| Line 123: | Line 120: | ||
=Version Control= | =Version Control= | ||
*Version 1.0 - Allow Toolbox to run even if you do not wish to use the PHP Webtags file or Rules. Support for more webtags (needed for Cumulus 1.9.2). Added month and year.ini to Editor | |||
Previous beta builds... | |||
*Build 46 - Updated to support new fields in log files for Cumulus v1.9.1 (beta); prevent two copies of Toolbox running; added support for "once 24 hour" rule; allow webtags in Rule messages | |||
*Build 45 - Added the backup of new files in 1.8.9 Build 924 of Cumulus; specifically alltime.ini and alltimelog.txt. Added alltime.ini to the list of possible files to Edit from within 'Toolbox'. Removed the Remote Email commands feature. | |||
*Build 44 - Changed HTTP Remote Request to Remote Commands tab allowing you to run local files or web commands. Fixed a bug where the Time for a back would not show in the setup screen. Increased font size on the display generally | *Build 44 - Changed HTTP Remote Request to Remote Commands tab allowing you to run local files or web commands. Fixed a bug where the Time for a back would not show in the setup screen. Increased font size on the display generally | ||
*Build 43 - added automatic backups of key Cumulus data | *Build 43 - added automatic backups of key Cumulus data | ||
