Technical Documentation - Revision history

Mark: /* Wordpress Integration Requirements */

2023-04-26T17:28:35Z

Wordpress Integration Requirements

Mark: /* Wordpress Integration Requirements */

2023-04-26T17:27:54Z

Wordpress Integration Requirements

Mark: /* Wordpress Integration Requirements */

2023-04-26T17:27:08Z

Wordpress Integration Requirements

Mark: /* Wordpress Integration Requirements */

2023-04-26T17:24:15Z

Wordpress Integration Requirements

Mark at 17:23, 26 April 2023

2023-04-26T17:23:20Z

Mark: /* System Architecture Overview */

2022-02-02T18:07:22Z

System Architecture Overview

Mark: /* Main Components */

2022-01-27T20:52:47Z

Main Components

Mark: /* Main Components */

2022-01-27T20:52:17Z

Main Components

Mark: /* Client Installation Notes */

2022-01-27T20:49:18Z

Client Installation Notes

Mark: /* The Divine Mother Center */

2021-12-21T17:07:40Z

The Divine Mother Center

@@ Line 19: / Line 19: @@
 <code>require_once "web-header.php"; // 2022-08-02 Mark Houghton for HS: set cookies, form processing</code>
-Next you'll need a plug-in such as PHP Everywhere to be able to execute php code from within WP pages.
+Next you'll need a plug-in such as PHP Everywhere to be able to execute php code from within WP pages. Once the plug-in is installed and activated, you may insert a custom HS user form (such as "contact-us") by simply adding the following to your web page where you want the form to appear:
 <code><?php include "web-form.php"; ?></code>

@@ Line 15: / Line 15: @@
 == Wordpress Integration Requirements ==
-HS is designed to seamlessly integrate with Wordpress websites. The following code must be inserted into header.php file using the Appearance -> Theme File Editor from the WP dashboard:
+HS is designed to seamlessly integrate with Wordpress websites. The following code must be inserted at the top of the '''header.php''' file using the Appearance -> Theme File Editor from the WP dashboard:
 <code>require_once "web-header.php"; // 2022-08-02 Mark Houghton for HS: set cookies, form processing</code>

@@ Line 15: / Line 15: @@
 == Wordpress Integration Requirements ==
-HS is designed to seamlessly integrate with Wordpress websites. You'll need a plug-in such as PHP Everywhere to be able to execute php code from within WP pages.
+HS is designed to seamlessly integrate with Wordpress websites. The following code must be inserted into header.php file using the Appearance -> Theme File Editor from the WP dashboard:
-Once the plug-in is installed and activated, the following code must be inserted into header.php file using the Appearance -> Theme File Editor from the WP dashboard:
+<code>require_once "web-header.php"; // 2022-08-02 Mark Houghton for HS: set cookies, form processing</code>
-<code>require_once "web-header.php"; // 2022-08-02 Mark Houghton for HS: set cookies, form processing</code>
+Next you'll need a plug-in such as PHP Everywhere to be able to execute php code from within WP pages.
-This will allow a custom HS user form (such as "contact-us") by simply including the following in your web page where you want the form to appear:
+Once the plug-in is installed and activated, you may insert a custom HS user form (such as "contact-us") by simply adding the following to your web page where you want the form to appear:
 <code><?php include "web-form.php"; ?></code>

@@ Line 25: / Line 25: @@
 <code><?php include "web-form.php"; ?></code>
-This will use values from the web-header.php code (above) and the HS database table system_web_forms to both display the form, including the reCaptcha when the user is not logged in, and handle form execution on successful user form submission.
+This will use values from the web-header.php code (above) and the HS database table '''system_web_forms''' to both display the form, including the reCaptcha when the user is not logged in, and handle form execution on successful user form submission.
 == Special Auto-Responder Code Files ==

← Older revision		Revision as of 17:23, 26 April 2023
Line 12:		Line 12:

	The web server is configured to execute code files (.php) by looking first in the /houghton_local directory tree, where customized versions of HS software are kept for the particular customer installation. If the code file is not found there, it defaults to the core code file from the /houghton directory tree.		The web server is configured to execute code files (.php) by looking first in the /houghton_local directory tree, where customized versions of HS software are kept for the particular customer installation. If the code file is not found there, it defaults to the core code file from the /houghton directory tree.
		+
		+	== Wordpress Integration Requirements ==
		+
		+	HS is designed to seamlessly integrate with Wordpress websites. You'll need a plug-in such as PHP Everywhere to be able to execute php code from within WP pages.
		+
		+	Once the plug-in is installed and activated, the following code must be inserted into header.php file using the Appearance -> Theme File Editor from the WP dashboard:
		+
		+	<code>require_once "web-header.php"; // 2022-08-02 Mark Houghton for HS: set cookies, form processing</code>
		+
		+	This will allow a custom HS user form (such as "contact-us") by simply including the following in your web page where you want the form to appear:
		+
		+	<code><?php include "web-form.php"; ?></code>
		+
		+	This will use values from the web-header.php code (above) and the HS database table system_web_forms to both display the form, including the reCaptcha when the user is not logged in, and handle form execution on successful user form submission.

	== Special Auto-Responder Code Files ==		== Special Auto-Responder Code Files ==

@@ Line 1: / Line 1: @@
 == System Architecture Overview ==
 The HS CRM application system is built on the LAMP (Linux-Apache-MySQL-PHP) platform.  It is designed to operate with two main user interfaces: (1) a company staff-facing backend user interface, and (2) integration with a front-end company website, preferably built in Wordpress and running on the same web server as the backend system.
 === Main Components ===

@@ Line 9: / Line 9: @@
 * A front-end website, usually built on the Wordpress platform.
-The web server is configured to execute code files (.php) by looking first in the /houghton_local directory tree, where customized versions of HS software are kepy for the particular customer installation.  If the code file is not found there, it defaults to the core code file from the /houghton directory tree.
+The web server is configured to execute code files (.php) by looking first in the /houghton_local directory tree, where customized versions of HS software are kept for the particular customer installation.  If the code file is not found there, it defaults to the core code file from the /houghton directory tree.
 == Special Auto-Responder Code Files ==

← Older revision		Revision as of 20:49, 27 January 2022
Line 60:		Line 60:

	mail_welcome.php		mail_welcome.php
−
−	~~== Client Installation Notes ==~~
−
−	~~=== The Optimist Daily ===~~
−	~~{\| class="wikitable"~~
−	\|-
−	~~! Table !! Custom Field !! Meaning !! Value List~~
−	\|-
−	~~\| contacts \|\| custom1 \|\| Delivery Frequency \|\| Best of the Week, Week Day, M-W-F~~
−	\|-
−	~~\| \|\| \|\| \|\|~~
−	\|-
−	~~\| products \|\| custom1 \|\| Switch to Product ID \|\| toggle to this product when switching from Monthly to Annual, and vice-versa, on website checkout page~~
−	\|-
−
−	\|}
−
−	~~=== The Divine Mother Center ===~~
−	~~{\| class="wikitable"~~
−	\|-
−	~~! Table !! Custom Field !! Meaning !! Value List~~
−	\|-
−	~~\| contact_activity \|\| custom1 \|\| Requested by contact_id \|\| (Blessing Requests only) contact_id of who made this Blessing Request~~
−	\|-
−	~~\| contact_activity \|\| custom2 \|\| order_line_id \|\| (Blessing Requests only) order_line_id from which the Blessing Request was made~~
−	\|-
−	~~\| contact_activity \|\| (others) \|\| defined as needed by multiple sign-up forms\|\| See /houghton_local/includes/web-dmc-form-process.php~~
−	\|-
−	~~\| \|\| \|\| \|\|~~
−	\|-
−	~~\| contacts \|\| custom1 \|\| Birthdate \|\| yyyy-mm-dd~~
−	\|-
−	~~\| contacts \|\| custom2 \|\| Teachable.com user_id \|\| number~~
−	\|-
−	~~\| contacts \|\| custom3 \|\| Mother's Name \|\| text~~
−	\|-
−	~~\| contacts \|\| custom4 \|\| Father's Name \|\| text~~
−	\|-
−	~~\| \|\| \|\| \|\|~~
−	\|-
−	~~\| payments \|\| custom5 \|\| Quickbooks Item \|\| text (temporary field for data initialization)~~
−	\|-
−	~~\| \|\| \|\| \|\|~~
−	\|-
−	~~\| products \|\| custom1 \|\| Teachable.com course_id \|\| number~~
−	\|-
−	~~\| products \|\| custom2 \|\| Blessing Request included \|\| Y/N (default 'Y')~~
−	\|-
−	~~\| products \|\| custom3 \|\| Course author/coach \|\| text~~
−	\|-
−	~~\| products \|\| custom4 \|\| Quantity in Safe \|\| number~~
−	\|-
−	~~\| products \|\| custom5 \|\| Quickbooks Mapping \|\| text (temporary field for data initialization)~~
−	\|-
−	~~\| \|\| \|\| \|\|~~
−	\|-
−	~~\| sources \|\| custom1 \|\| Teachable.com school_id \|\| 547579=Virtual Ashram, 31644=Divine Mother School~~
−	\|}
−
−	~~=== Deer Ridge Club ===~~
−	~~{\| class="wikitable"~~
−	\|-
−	~~! Table !! Custom Field !! Meaning !! Value List~~
−	\|-
−	~~\| contacts \|\| custom1 \|\| Family Members \|\| text~~
−	\|}

@@ Line 82: / Line 82: @@
 ! Table !! Custom Field !! Meaning !! Value List
 |-
-| contact_activity || custom1 || Requested by contact_id || (BR's only) contact_id of who made this Blessing Request
+| contact_activity || custom1 || Requested by contact_id || (Blessing Requests only) contact_id of who made this Blessing Request
 |-
-| contact_activity || custom2 || order_line_id || (BR's only) order_line_id from which the Blessing Request was made
+| contact_activity || custom2 || order_line_id || (Blessing Requests only) order_line_id from which the Blessing Request was made
 |-
 | contact_activity || (others) || defined as needed by multiple sign-up forms|| See /houghton_local/includes/web-dmc-form-process.php