Administrators Guide - Revision history

Mark: /* Example Batch Job: Import Missing PayPal Transactions */

2024-09-06T21:05:50Z

Example Batch Job: Import Missing PayPal Transactions

Mark: /* Example Batch Job: Import Missing PayPal Transactions */

2024-09-06T21:04:42Z

Example Batch Job: Import Missing PayPal Transactions

Mark: /* User Batch Jobs */

2024-09-06T20:56:53Z

User Batch Jobs

Mark: /* User Batch Jobs */

2024-09-06T20:50:59Z

User Batch Jobs

Mark: /* Example Batch Job: Import Missing PayPal Transactions */

2024-09-06T20:44:52Z

Example Batch Job: Import Missing PayPal Transactions

Mark: /* Example Batch Job: Import Missing PayPal Transactions */

2024-09-06T20:32:08Z

Example Batch Job: Import Missing PayPal Transactions

Mark: /* Example Batch Job: Import Missing PayPal Transactions */

2024-09-06T20:25:39Z

Example Batch Job: Import Missing PayPal Transactions

Mark: /* Example Batch Job: Import Missing PayPal Transactions */

2024-09-06T20:23:31Z

Example Batch Job: Import Missing PayPal Transactions

Mark: /* User Batch Jobs */

2024-09-06T20:22:57Z

User Batch Jobs

Mark: /* Example Batch Job: Import Missing PayPal Transactions */

2024-09-06T20:18:17Z

Example Batch Job: Import Missing PayPal Transactions

@@ Line 127: / Line 127: @@
 $log_filename = "paypal_import.log";
-require "batch_job_start.php";   // opens this jobs logfile, reads all input parameters from user_batch_jobs record
+require "batch_job_start.php";   // opens this job's logfile, reads all input parameters from user_batch_jobs record
 (code to import any PayPal transactions in the csv uploaded file that are missing from the HS payments table)

@@ Line 108: / Line 108: @@
 * The /admin screen process will insert the job request record into the user_batch_jobs table using the following code:
 $src="batch_paypal_import.php";
 include "batch_job_schedule.php";
 * The cronjob exec_user_batch_jobs.php will find the unprocessed job record and start the batch program in the background using the PHP exec command:
 $cmd = "nohup $PHP $src --id=$id >> ".LOG_DIR."/user_batch_jobs.log 2>&1 &";
@@ Line 118: / Line 121: @@
 exec($cmd);
 * The batch program itself, in this example /src/batch_paypal_import.php, will then execute the job and log the output with the following code:
 $log_filename = "paypal_import.log";
@@ Line 127: / Line 132: @@
 require "batch_job_finish.php";  // updates the user_batch_jobs record with success/error message, date_completed, and notifies the requesting user via email

@@ Line 92: / Line 92: @@
 The components of the system are as follows:
-* The user_batch_jobs table, which controls each job and contains the execution output;
+* The user_batch_jobs table, which controls each job and contains the execution information including job output;
 * The /admin screen to enter job parameters, upload csv files if any, and schedule the job for execution;
 * The cronjob /src/exec_user_batch_jobs.php, which polls the user_batch_jobs table each minute to kickoff any new batch job requests;
@@ Line 107: / Line 107: @@
 Once the user generates and exports the csv file from their PayPal account, uploads it here, and submits the job, the following takes place:
-* The /admin screen will insert the job request record into the user_batch_jobs table using the following code:
+* The /admin screen process will insert the job request record into the user_batch_jobs table using the following code:
 $src="batch_paypal_import.php";
 include "batch_job_schedule.php";
-* The cronjob exec_user_batch_jobs.php will find the unprocessed job record and start the batch program using the PHP exec command:
+* The cronjob exec_user_batch_jobs.php will find the unprocessed job record and start the batch program in the background using the PHP exec command:
 $cmd = "nohup $PHP $src --id=$id >> ".LOG_DIR."/user_batch_jobs.log 2>&1 &";
@@ Line 119: / Line 119: @@
 exec($cmd);
-* The batch program, in this example /src/batch_paypal_import.php, will then log and initiate the job with the following code:
+* The batch program itself, in this example /src/batch_paypal_import.php, will then execute the job and log the output with the following code:
 $log_filename = "paypal_import.log";
 require "batch_job_start.php";   // opens this jobs logfile, reads all input parameters from user_batch_jobs record
-(code to process the job)
+(code to import any PayPal transactions in the csv uploaded file that are missing from the HS payments table)
 require "batch_job_finish.php";  // updates the user_batch_jobs record with success/error message, date_completed, and notifies the requesting user via email

@@ Line 88: / Line 88: @@
 == User Batch Jobs ==
-The Batch Job system in HS allows users to queue log-running processes and be notified of their success or failure afterward by email.
+The Batch Job system in HS allows users to queue a potentially long-running process for execution, and be notified of their success or failure afterward by email.
 The components of the system are as follows:
-* The main source program, residing in the /src directory and accepting a set of parameters;
+* The user_batch_jobs table, which controls each job and contains the execution output;
-* The user_batch_jobs table, which controls each job and contains the output;
+* The /admin screen to enter job parameters, upload csv files if any, and schedule the job for execution;
-* The screen to enter parameters, upload csv files and initiate a batch job, located in the /admin directory;
+* The cronjob /src/exec_user_batch_jobs.php, which polls the user_batch_jobs table each minute to kickoff any new batch job requests;
-* The cronjob exec_user_batch_jobs.php, located in /src, which polls the user_batch_jobs table each minute to kickoff any new batch job requests.
+* The main batch job source program, located in the /src directory and accepting a set of parameters;
 === Example Batch Job: Import Missing PayPal Transactions ===
@@ Line 101: / Line 101: @@
 PayPal is not completely reliable with their transaction-posting webhook (Instant Payment Notifications/IPN), so HS has a tool to periodically import any missing transactions within a date range.
-The request screen is found at Home->Tools->Import Missing PayPal Transactions:
+The request screen is found at Home->Tools->Import Missing PayPal Transactions, or /admin/paypal_batch_import.php:
 [[File:AG_PayPal_Batch_Import.png|600px]]
@@ Line 109: / Line 109: @@
 * The /admin screen will insert the job request record into the user_batch_jobs table using the following code:
 $src="batch_paypal_import.php";
 include "batch_job_schedule.php";
 * The cronjob exec_user_batch_jobs.php will find the unprocessed job record and start the batch program using the PHP exec command:
 $cmd = "nohup $PHP $src --id=$id >> ".LOG_DIR."/user_batch_jobs.log 2>&1 &";
 UPDATE user_batch_jobs SET date_started=NOW() WHERE id='$id'
 exec($cmd);
 * The batch program, in this example /src/batch_paypal_import.php, will then log and initiate the job with the following code:
 $log_filename = "paypal_import.log";
 require "batch_job_start.php";   // opens this jobs logfile, reads all input parameters from user_batch_jobs record

@@ Line 107: / Line 107: @@
 Once the user generates and exports the csv file from their PayPal account, uploads it here, and submits the job, the following takes place:
-<nowiki>
+* The /admin screen will insert the job request record into the user_batch_jobs table using the following code:
 $src="batch_paypal_import.php";
 include "batch_job_schedule.php";
-</syntaxhighlight>
+* The cronjob exec_user_batch_jobs.php will find the unprocessed job record and start the batch program using the PHP exec command:
-</nowiki>
+$cmd = "nohup $PHP $src --id=$id >> ".LOG_DIR."/user_batch_jobs.log 2>&1 &";

@@ Line 107: / Line 107: @@
 Once the user generates and exports the csv file from their PayPal account, uploads it here, and submits the job, the following takes place:
-{{Codesample|$ echo "hello world!"  }}
+<syntaxhighlight lang="php">
 $src="batch_paypal_import.php";include "batch_job_schedule.php";
-{{code|lang=php|$src="batch_paypal_import.php";include "batch_job_schedule.php";}}
+</syntaxhighlight>

← Older revision		Revision as of 20:18, 6 September 2024
Line 106:		Line 106:

	Once the user generates and exports the csv file from their PayPal account, uploads it here, and submits the job, the following takes place:		Once the user generates and exports the csv file from their PayPal account, uploads it here, and submits the job, the following takes place:
		+
		+	{{Codesample \|$ echo "hello world!" \|lang=shell-session \|scheme=dark}}

	{{code\|lang=php\|$src="batch_paypal_import.php";include "batch_job_schedule.php";}}		{{code\|lang=php\|$src="batch_paypal_import.php";include "batch_job_schedule.php";}}