Difference between revisions of "Technical Documentation"

From HS Wiki
Jump to navigationJump to search
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
 
|}
 

Revision as of 12:49, 27 January 2022

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

Assuming the web server domain directory is in a /public_html (or /www) directory,

  • The HS core software, located on the web server in the /public_html/houghton directory;
  • Customized versions of the core software code files, located in the /public_html/houghton_local directory;
  • A single MySQL database;
  • A front-end website, usually built on the Wordpress platform.

Special Auto-Responder Code Files

HS has logic to automatically send email auto-responders using the following code files:

mail_career_thank_you.php

mail_cc_declined.php

mail_cc_declined.php.2

mail_cc_declined.php.3

mail_cc_expiring.php

mail_event_guest_link.php

mail_event_registration_instructions.php

mail_event_table_host_instructions.php

mail_event_table_host_not_found.php

mail_event_table_host_notification.php

mail_event_thanks.php

mail_event_ticket.php

mail_fundraiser_payment_notification.php

mail_fundraiser_welcome.php

mail_gifter_notification.php

mail_gift_recipient_notification.php

mail_job_filled.php

mail_passwd_reset.php

mail_payment_update_confirmed.php

mail_renew_recurring.php

mail_subscription_cancel.php

mail_subscription_start.php

mail_volunteer.php

mail_welcome.php