e-Commerce Package

The ACS 3.x based e-commerce solution ported to OpenACS. This module implements a standard business-to-consumer Web store service. A feature summary is included with the documentaion.

Warning: This package is outdated and not maintained anymore.

Package Documentation 

Procedure Files

tcl/ec-audit-trail-procs.tcl		Procedures uses to view the audit trails documented in /www/doc/audit two procs helpful for building pages that show audit history for a set of id's in a table between specific dates
tcl/ec-product-sc-procs.tcl		Procedures uses to view the audit trails documented in /www/doc/audit two procs helpful for building pages that show audit history for a set of id's in a table between specific dates
tcl/ecommerce-credit-procs.tcl		Procedures related to credit card transactions for the ecommerce module
tcl/ecommerce-customer-service-procs.tcl		Customer service procedures for the ecommerce module
tcl/ecommerce-email-procs.tcl		Email procedures for the ecommerce module Started April, 1999 by Eve Andersson (eveander@arsdigita.com) Other ecommerce procedures can be found in ecommerce-*.tcl
tcl/ecommerce-money-computations-procs.tcl		Computes the total price of an order.
tcl/ecommerce-procs.tcl		Definitions for the ecommerce module Note: Other ecommerce procedures can be found in ecommerce-*.tcl
tcl/ecommerce-scheduled-procs.tcl		Scheduled procedures for the ecommerce module.
tcl/ecommerce-ssl-procs.tcl		Definitions for the ecommerce module Note: Other ecommerce procedures can be found in ecommerce-*.tcl
tcl/ecommerce-state-changes-procs.tcl
tcl/ecommerce-user-contributions-summary-procs.tcl		Exists only to show the site owner a user's activities on the site in the ecommerce system.
tcl/ecommerce-utilities-procs.tcl		Utilities for the ecommerce module.
tcl/ecommerce-widgets-procs.tcl		Definitions for the ecommerce module
tcl/ecommerce-zip-codes-procs.tcl		Definitions for the ecommerce module
tcl/froogle-procs.tcl		Froogle (http://www.google.com/froogle) data feed procedures.
tcl/qmail-procs.tcl		qmail support procs.

Procedures

ecGetUserAgentHeader		Gets user agent header
ec_IllustraDatetoPrettyDate		date to pretty date
ec_PrettyBoolean		Returns Yes or No instead of t/f
ec_acs_admin_url
ec_add_to_cart_link		Returns cart link
ec_admin_present_user		link for admin to view user information
ec_adp_function_p		Checks for any function execution in an adp page
ec_all_cs_issues_by_one_user		creates html list of all issues by user_id or user_identification
ec_all_orders_by_one_user		returns all order for this user
ec_apply_gift_certificate_balance		This proc takes the place of the pl/sql procedure ec_apply_gift_cert_balance
ec_assert_directory		Checks that directory exists, if not creates it
ec_audit_delete_row		Inserts an entry to the audit table to log a delete.
ec_audit_generate_column_name		Returns a max-length character (max) length identifier for the table and column name, joined at the hip by an underscore.
ec_audit_process_row		internal proc for ec_audit_trail Sets audit_entry to the HTML fragement representing one line from the audit table or main table.
ec_audit_trail		Returns an HTML fragment showing changes to one row in the OLTP system between the times start_date and end_date (YYYY-MM-DD HH24:MI:SS).
ec_audit_trail_for_table		Returns the audit trail for each id from the id_column for updates and deletes from main_table_name and audit_table_name that occured between start_date and end_date.
ec_best_price		Returns the minimum price offered
ec_calculate_product_purchase_combinations		Find product purchase combinations and store those in ec_product_purchase_comb.
ec_canned_response_selector		returns a canned response selector
ec_capitalize_words		Capitalizes first letter of each word, makes rest lowercase
ec_category_subcategory_and_subsubcategory_display		Returns an HTML table of category, subcategory, and subsubcategory information
ec_category_widget		displays all categories, subcategories, and subsubcategories, default is a list of all the items you want selected
ec_choose_n_random		Get Random Choices.
ec_column_type_widget		Column type widget
ec_combocategory_widget		Category widget combining categories and subcategories
ec_continue_shopping_options		returns continue shopping options
ec_convert_path		@ return The pathname in the local filesystem of ImageMagick
ec_country_name_from_country_code		Gets country name from country code.
ec_country_widget		Just like country_widget, except it's not United States centric.
ec_creditcard_authorization		Authorizes the credit card for use with an order.
ec_creditcard_expire_1_widget		Gives the HTML for the Expiration Date Month select list.
ec_creditcard_expire_2_widget		Gives the HTML for the Expiration Date Year select list.
ec_creditcard_marking		Connect to the payment gateway to charge a previously authorized credit card for a transaction.
ec_creditcard_precheck		Prechecks credit card numbers.
ec_creditcard_return		Refunds a transaction back to the credit card used for that transaction.
ec_creditcard_summary		Returns Credit Card info
ec_creditcard_widget		Credit card selector
ec_custom_product_field_form_element		Get Custom Form Element.
ec_customer_comments		returns customer comments
ec_customer_service_email_address		returns the customer server email address
ec_customer_service_signature
ec_customer_service_simple_issue		Creates an issue, interaction, and action and closes the issue.
ec_data_directory
ec_date_text		Returns a textual representation of the date.
ec_date_widget		Generates a date widget.
ec_date_widget_validate		Validates a date widget.
ec_date_with_time_stripped		Removes the time part of the date stamp (useful when using util_AnsiDatetoPrettyDate)
ec_datetime_sql		Generates a sql datetime expression from a date widget or a date widget and a time widget.
ec_datetime_text		Generates a textual representation of the date and time.
ec_decimal_to_percent		Converts decimal to percentage.
ec_decode		This proc is modelled after the decode in sql.
ec_delayed_credit_denied		Sends "Credit Denied" email to consumers whose authorization was initially inconclusive and then failed, and then saves the order for them (so that consumer can go back to site and retry the authorization).
ec_determine_categorization_widget_defaults		given category_list, subcategory_list, and subsubcategory_list, this determines which options of the categorization widget should be selected by default (when editing a product)
ec_display_as_html		Formats text as HTML
ec_display_product_purchase_combinations		display product purchase combinations
ec_display_rating		Given a product's rating, if the star gifs exist, it will print out the appropriate # (to the nearest half); otherwise it will just say what the rating is (to the nearest half).
ec_elements_of_list_a_that_arent_in_list_b		Do a check and return list of a that are not in b
ec_email_delayed_credit_denied		Use this to send out the \"Delayed Credit Denied\" email.
ec_email_gift_certificate_order_failure		Use this to send out the \"Gift Certificate Order Failure\" email after it is determined that a previously inconclusive auth failed.
ec_email_gift_certificate_recipient		Use this to send out the \"Gift Certificate Recipient\" email after it a purchased certificate is authorized.
ec_email_new_gift_certificate_order		Use this to send out the \"New Gift Certificate Order\" email after a gift certificate order is authorized.
ec_email_new_order		Use this to send out the \"New Order\" email.
ec_email_order_shipped		Use this to send out the \"Order Shipped\" email after a shipment is made (full or partial order).
ec_email_product_notification		This proc sends notifications for any products in the order that require it.
ec_expire_old_carts		Expires old carts.
ec_export_entire_form_as_url_vars_maybe		exports form as url variables
ec_export_entire_form_except		Exports all but part of a form
ec_first_element_of_list_a_that_isnt_in_list_b		Get First Element of A not in B
ec_formatted_date		Format Ugly Date.
ec_formatted_full_date		Format Ugly Date to Pretty Date.
ec_formatted_price_shipping_gift_certificate_and_tax_in_an_order		returns formatted price
ec_full_categorization_display		given a category_id, subcategory_id, and subsubcategory_id (can be null), displays the full categorization, e.g.
ec_generate_random_string		Returns a random string
ec_generic_html_form_select_widget		This is a generalization of all the other widgets we have that create HTML select lists.
ec_get_user_session_id		Gets the user session from cookies
ec_gets_char_delimited_line		Reads and parses a line of data from a character delimited file similar to ns_getscsv.
ec_gift_certificate_expires_widget		Gives the HTML code for the select list from which customer service can change when a consumer's gift_certificate expires.
ec_gift_certificate_status		Returns the status of the gift certificate for the customer
ec_hidden_input		Returns a safe-for-browsers hidden variable, i.e.
ec_id
ec_info_used_widget		info used widget
ec_insecure_context_bar_ws_and_index		Returns a Yahoo-style hierarchical navbar, starting with a link to / and possibly the workspace or /, depending on whether or not the user is logged in.
ec_insecure_location
ec_insecurelink		Allows you to create a relative link from a secure page to an insecure page
ec_interaction_type_widget		interaction type widget
ec_issue_type_widget		issue type widget
ec_item_summary_for_admins		item summary for admins
ec_item_summary_in_confirmed_order		item summary in confirmed order
ec_items_for_fulfillment_or_return		produces an HTML form fragment for administrators to select from items that are fulfilled or received back
ec_last_second_in_the_day		Returns the last second of the given day's date.
ec_leading_nbsp		Adds leading nbsps to an integer to give it the desired number of digits
ec_leading_zeros		Adds leading zeros to an integer to give it the desired number of digits.
ec_linked_thumbnail_if_it_exists		This looks at dirname to see if the thumbnail is there and if so returns an html fragment that links to the bigger version of the picture (or to product.tcl if link_to_product_p is "t").
ec_location_based_on_zip_code		Get location
ec_log_user_as_user_id_for_this_session		logs user as user id for this session
ec_lowest_price_and_price_name_for_an_item		Returns the lowest price and price name for an item
ec_mailing_list_link_for_a_product		Returns a link for the user to add him/herself to the mailing list for whatever category/subcategory/subsubcategory a product is in.
ec_mailing_list_widget		shows mailing lists for categories, subcategories, subsub
ec_makeinsecure		If the current url is secure, will redirect the user to the insecure version of this page.
ec_makesecure		If the current page isn't secure, will ad_returnredirect the user to the https version of the page.
ec_max		Returns a if a>=b or b if b>a
ec_max_of_list		finds max value from a list of values
ec_message_if_null		Give Null Message.
ec_min		Returns b if a>=b or b if b>a
ec_multiple_state_widget		Returns a state multiple selection box
ec_na_if_null		Returns N/A if Null.
ec_navbar		Returns ec nav bar.
ec_nbsp_if_null		Return nonbreaking space.
ec_only_category_widget		category widget
ec_order_status		Returns the status of the order for the customer
ec_order_summary_for_admin		returns order summary for admins
ec_order_summary_for_customer		Shows item details to customers, as opposed to one for the admins.
ec_package_maintainer		@ return email of ecommerce package maintainer
ec_package_url_lookup
ec_pageroot
ec_percent_to_decimal		Converts percentage to decimal equiv.
ec_preferred_drivers		Determine if we implement nssock or nsunix.
ec_pretty_column_type		Get Pretty Column Type.
ec_pretty_creditcard_type		Returns the credit card type based on the one-or-two-letter code for that type.
ec_pretty_mailing_address_from_args		Get Pretty Mailing Address.
ec_pretty_mailing_address_from_ec_addresses		Gets Pretty Mailing Address.
ec_pretty_price		Returns a nicely formatted price.
ec_price_line		Returns the price line
ec_price_price_name_shipping_price_tax_shipping_tax_for_one_item		Returns price, price_name, shipping, price_tax, and shipping_tax (all in a list) for one item.
ec_price_shipping_gift_certificate_and_tax_in_an_order		Returns a list containing the total price, total shipping, gift_certificate amount and total tax for an order.
ec_product_directory
ec_product_file_directory		Returns the directory that that the product files are located under the ecommerce product data directory.
ec_product_link_if_exists		Returns product link (to ec_products url with link_label wrapped by anchor tag) of product id, or null if no url exists.
ec_product_links_if_they_exist		return product links
ec_product_name		Returns product name from product_id, memoized for efficiency
ec_product_name_internal		returns product name
ec_product_review_summary		Returns a one-line user-readable summary of a product review
ec_product_url_if_exists		Returns product url of product id, or null if none exists
ec_products__datasource
ec_products__url
ec_professional_reviews_if_they_exist		returns professional reviews
ec_prune_product_purchase_combinations		Prune expired product purchase combinations.
ec_rating_widget		ratings widget
ec_reach_widget		reach widget
ec_redirect_to_https_if_possible_and_necessary		redirects the current url to the appropriate https address
ec_remove_creditcard_data		Remove credit card number from ec_creditcards if package parameter SaveCreditCardDataP = 0.
ec_report_date_range_widget		report date range widget
ec_report_get_start_date_and_end_date		Gets the start and end date when the dates are supplied by ec_report_date_range_widget; if they're not supplied, it makes the first of this month be the start date and today be the end date.
ec_same_value		Returns true if values are essentially the same for monetary purposes, otherwise returns false.
ec_savings		Returns savings over Retail price
ec_search_widget		Creates an ecommerce search widget, using the specified category id and search text if necessary
ec_secure_location
ec_securelink		Allows you to create a relative link to a secure page
ec_send_unsent_gift_certificate_recipient_email		Finds authorized gift certificates for which email has not been sent to the recipient, sends the email, and records that it has been sent.
ec_send_unsent_new_gift_certificate_order_email		Finds authorized gift certificates for which confirmation email has not been sent, sends the email, and records that it has been sent.
ec_send_unsent_new_order_email		Finds authorized orders for which confirmation email has not been sent, sends the email, and records that it has been sent.
ec_sendmail_from_service		Use this when you're sending out customer service emails.
ec_shipment_summary_sub		Says how the items with a given product_id, color, size, style, price_charged, and price_name in a given order shipped; the reason we put in all these parameters is that item summaries group items in this manner
ec_shipping_cost_summary		returns cost summary
ec_shipping_price_for_one_item		returns the shipping price for one item
ec_shipping_prices_for_one_item_by_rate		returns the shipping prices for one item based on rate parameters, no db queries
ec_space_to_nbsp		converts space to html nbsp
ec_ssl_available_p		Returns 1 if this AOLserver has either the nsssl module or nsopenssl module installed.
ec_state_name_from_usps_abbrev		Takes a USPS abbrevation and returns the full state name, e.g., MA in yields Massachusetts out
ec_state_widget		Returns a state selection bar, based on state_widget
ec_stock_status_widget		returns stock status
ec_subcategory_widget		subcategory widget
ec_subcategory_with_subsubcategories_widget		returns subcategories with subcategories
ec_sweep_for_payment_zombie_gift_certificates		Looks for confirmed gift certificates that aren't either failed or authorized, i.e., where we didn't hear back from the payment cron job to dig up confirmed but not failed or authorized gift certificates over 15 minutes old ("zombies").
ec_sweep_for_payment_zombies		Cron job to dig up confirmed orders over 15 minutes old ("zombies") that did not fail and haven't been authorized .
ec_system_name
ec_system_owner
ec_template_widget		gives a drop-down list and, if category_id_list is specified, it will display the templates associated with those categories (if any) first
ec_thumbnail_if_it_exists		This looks at dirname to see if the thumbnail is there and if so returns an html fragment to show thumbnail Otherwise it returns the empty string.
ec_time_text		Returns a textual representation of the time.
ec_time_widget		Generates a time widget.
ec_time_widget_validate		Validates time widget input.
ec_timeentrywidget		Gives a HTML form input for a time.
ec_timeentrywidget_time_check		Checks to make sure that the time part of the timestamp is in the correct format: HH12:MI:SS.
ec_unauthorized_transactions		Ec_unauthorized_transactions searches for unauthorized transactions whose to_be_captured_date is over 1/2 hr old and authorized_date is null this is similar to ec_sweep_for_payment_zombies except that in this case these are shipments that are unauthorized.
ec_unmarked_transactions		unmarked transactions to_be_captured_p is 't' and authorized_date is not null and marked_date is null
ec_unrefunded_transactions		Unrefunded transactions.
ec_update_state_to_authorized		If a credit card authorization occurs, the following actions need to be taken: 1.
ec_update_state_to_confirmed		If an order is confirmed, the following actions need to be taken: 1.
ec_update_state_to_in_basket		If a credit card failure occurs, the following actions need to be taken: 1.
ec_url
ec_user_audit_info		Returns User ID, IP Address, and date for audit trails
ec_user_class_display		Displays a comma seperated list of the users user classes with a comment on its approval status if approval is required.
ec_user_class_select_widget		Returns a HTML multiple select list for user_class_id with an option for each user class.
ec_user_class_widget		user class select
ec_user_identification_summary		Get user Info
ec_user_session_logout
ec_zero_if_null		Returns Zero if Null.
ecommerce_user_contributions		Returns list items, one for each classified posting
froogle::upload		Upload active products to a Froogle Ftp server.
qmail		procedure for sending mail by directly injecting it into the qmail system.

SQL Files

sql/postgresql/ec-product-package-create.sql
sql/postgresql/ec-product-package-drop.sql
sql/postgresql/ec-product-sc-create.sql
sql/postgresql/ec-product-sc-drop.sql
sql/postgresql/ec-product-sws-drop.sql
sql/postgresql/ec-product-sws-setup.sql
sql/postgresql/ecommerce-create.sql
sql/postgresql/ecommerce-defaults.sql
sql/postgresql/ecommerce-drop.sql
sql/postgresql/pl-sql-utilities-drop.sql
sql/postgresql/pl-sql-utilities.sql

Content Pages