Deprecated: Array and string offset access syntax with curly braces is deprecated in /home/sfoyston/public_html/TextStorm/Wiki/inc/init.php on line 560

Warning: Cannot modify header information - headers already sent by (output started at /home/sfoyston/public_html/TextStorm/Wiki/inc/init.php:560) in /home/sfoyston/public_html/TextStorm/Wiki/inc/auth.php on line 495

Warning: Cannot modify header information - headers already sent by (output started at /home/sfoyston/public_html/TextStorm/Wiki/inc/init.php:560) in /home/sfoyston/public_html/TextStorm/Wiki/inc/actions.php on line 210
schedman:main - TextStorm Wiki

The Wiki is still in development, please bare with us while we add and update content.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
schedman:main [2017/08/27 09:02]
textstorm [Installation and First Look]
schedman:main [2017/08/27 09:41] (current)
textstorm [Schedule Example]
Line 32: Line 32:
   * Optional password protection for your interface   * Optional password protection for your interface
  
-===== Installation ​and First Look =====+===== Installation =====
  
 Once you have [[http://​sfoyston.com/​SchedManV1/​download.php|Downloaded SchedMan]], upload the files to your website hosting platform. Once you have [[http://​sfoyston.com/​SchedManV1/​download.php|Downloaded SchedMan]], upload the files to your website hosting platform.
Line 72: Line 72:
  
 {{:​schedman:​created.png?​200|}} {{:​schedman:​created.png?​200|}}
 +
 +Your job will now run, the next time the Cron Job you set-up earlier runs schedman.php
 +
 +===== SchedMan Screens =====
 +
 +There are 5 screens available on SchedMan to help you monitor, manage and create your jobs.
 +
 +==== Basic ====
 +
 +The Basic screen provides, as the name suggests, a basic view of all schedules with their description and last/next run times.
 +
 +{{:​schedman:​basic.png?​100|}}
 +
 +----
 +
 +==== Advanced ====
 +
 +The Advanced screen provides more information on your jobs, such as whether the job is currently running or has returned an error. If you have configured the script to do so, it will also show you how many rows your job affected the last time it run.
 +
 +{{:​schedman:​advanced.png?​100|}}
 +
 +----
 +
 +==== Modify ====
 +
 +The Modify screen lets you change the configuration and details of your jobs.
 +
 +{{:​schedman:​modifyhighlight.png?​100|}}
 +
 +----
 +
 +=== Advanced Runtime Options ===
 +
 +The Advanced Runtime Options screen is accessible through the Modify screen, please see the red box which highlights it in the Modify screen image above.
 +
 +This page allows you to configure an advanced run matrix, where you can specify particular times and days to run the job, for example - Friday betweeen 02:00 and 03:00
 +
 +The day matrix has seven 1's defined by default, representing days of the week from Monday to Sunday, if you only wanted your job to run on a Friday the matrix would be: 0000100
 +
 +{{:​schedman:​advancedmatrix.png?​100|}}
 +
 +----
 +
 +==== Create ====
 +
 +The Create screen allows you to add a new job to SchedMan.
 +
 +{{:​schedman:​create.png?​100|}}
 +
 +----
 +
 +==== Logs ====
 +
 +The Logs screen shows you the logs generated by SchedMan and your jobs, if you have enabled logging in the installation phase and configured your jobs to do so.
 +
 +SchedMan logging:
 +
 +{{:​schedman:​logs.png?​100|}}
 +
 +SchedMan and job logging:
 +
 +{{:​schedman:​logswithjob.png?​100|}}
 +
 +SchedMan and job logging when Advanced Runtime Options are enabled:
 +
 +{{:​schedman:​logswithjobmatrix.png?​100|}}
 ===== Schedule Example ===== ===== Schedule Example =====
  
Line 80: Line 146:
 if($caller) { if($caller) {
  
-    ///you can use $id to get the SchedRef of your script, useful for logging purposes +    ///you can use $this->​schedRef ​to get the SchedRef of your script, useful for logging purposes 
-    echo $id;+    echo $this->​schedRef;
  
     ///​$this->​date is the datetimestamp last known by SchedMan, you can update this using the method below. Useful for logging.     ///​$this->​date is the datetimestamp last known by SchedMan, you can update this using the method below. Useful for logging.
Line 90: Line 156:
  
     ///generate a log you can see in the database for your script     ///generate a log you can see in the database for your script
-    $this->​GenerateLog($id, "​Script Began Running at: $this->​date",​ -1);+    $this->​GenerateLog($this->​schedRef, "​Script Began Running at: $this->​date",​ -1);
  
     ///you can reference $this->​db for your database connection if SchedMan is configured on the correct database for this script     ///you can reference $this->​db for your database connection if SchedMan is configured on the correct database for this script
Line 96: Line 162:
  
     ///need to set the job as failed if a try/catch goes wrong or validates incorrectly?​     ///need to set the job as failed if a try/catch goes wrong or validates incorrectly?​
-    $this->​setJobAsInError($id, "The job failed as we could not change x to 1");+    $this->​setJobAsInError("​The job failed as we could not change x to 1")
 +     
 +    //tell SchedMan how many rows your job affected 
 +    $this->​rowsAffected = 1;
  
 } }
 </​file>​ </​file>​

QR Code
QR Code schedman:main (generated for current page)