Whirlwind eCommerce Wiki - User contributions [en]

Talk:Pages templates:forum

2009-04-28T18:41:43Z

71.163.185.8: Removing all content from page

Talk:Whirlwind eCommerce Engine Wiki

2009-04-28T18:41:20Z

71.163.185.8: Removing all content from page

Page Templates:Functions

2009-04-28T18:40:35Z

71.163.185.8:

{{Page Template Functions Shortcuts}}
A series of custom functions are created to allow content management to easily access content they require to build the copy in templates:

;Quick Output of Options Tags for common select boxes
*[[functions:addressStateOptions|addressStateOptions]] - returns string of option tags for states
*[[functions:addressCountryOptions|addressCountryOptions]] - returns string of option tags for countries
*[[functions:orderExpDateOptions|orderExpDateOptions]] - returns string of option tags for expiration dates of a credit card
*[[functions:orderPayTypeOptions|orderPayTypeOptions]] - returns string of option tags for pay types

;Set Variables that Content Managers can use in the WYSIWYG copy editor
*[[functions:pageContentAttribSet|pageContentAttribSet]] - sets a single variable that can be used by content managers in the page manager form (including the WYSIWYG editor)
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribStart/pageContentAttribEnd]] - wrapper that the contents of which is set as a single variable that can be used by content managers in the page manager form

;Retrieve Page Content to Build Pages
*[[functions:pageMenuGet|pageMenuGet]] - returns menu item data
*[[functions:pageChildrenGet|pageChildrenGet]] - returns page data for children of a specific page
*[[functions:pageSearchGet|pageSearchGet]] - returns page data for pages qualifying for a keyword search
*[[functions:pageZoneGet|pageZoneGet]] - returns code to display an banner ad zone
*[[functions:pageForumPostsGet|pageForumPostsGet]] - returns forum post data for posts submitted to a particular forum page
*[[functions:pageGet|pageGet]] - return specific information about a specific page
*[[functions:pagePollQuestionsGet|pagePollQuestionsGet]] - returns question and answer data for building a poll
*[[functions:pagePollResultsGet|pagePollResultsGet]] - returns poll submission data for building a report of poll results
*[[functions:pageBreadcrumbsFamilyGet|pageBreadcrumbsFamilyGet(]] - returns breadcrumb data by traversing parent pages
*[[functions:pageBreadcrumbsHistoryGet|pageBreadcrumbsHistoryGet]] - returns breadcrumb data by traversing linear browsing history
*[[functions:pageProductsGet|pageProductsGet]] - returns product data for products related to a specific page
*[[functions:catalogProductsGet|catalogProductsGet]] - returns product data by catalog number
*[[functions:recentlyViewedGet|recentlyViewedGet]] - returns data for recently viewed pages
*[[functions:continueShoppingGet|continueShoppingGet]] - returns data for recently viewed pages
*[[functions:pageCustomSearchGroup|pageCustomSearchGroup]] - returns Custom Search Group data used to build a custom search widget
*[[functions:prodArrayToJS|prodArrayToJS]] - creates a string of pricing data that can be assigned to a javascript object to calculate pricing on the fly (ajax)

;Manage Copy
*[[functions:fullyQualifyAllURLs|fullyQualifyAllURLs]] - converts any relative/absolute URL in the passed copy to fully qualified URLs - useful when sending copy as an email

;Manage Large Lists of Data
*[[functions:pagination|pagination]] - easy to use tool to paginate large sets of data. Use for managing page children, search results and more

;Retrieve Order information for perpetual and full shopping carts, checkout stages, order history
*[[functions:orderGetSummary|orderGetSummary]] - returns summerized order information. Useful for perpetual carts.
*[[functions:orderGetPayTypes|orderGetPayTypes]] - returns data relating to active paytypes in the system
*[[functions:userGetAddresses|userGetAddresses]] - returns data for all addresses belonging to a specific user
*[[functions:orderGetShipArray|orderGetShipArray]] - returns array of shipping options and costs
*[[functions:orderGetCompleteArray|orderGetCompleteArray]] - returns full order information including payment, item, address, etc. Use for shopping carts, order summaries and receipts of orders.
*[[functions:ordersGetList|ordersGetList]] - returns listing of orders for a particular user (useful for building order history pages)

;Integrate With 3rd Party Web Tools
*[[functions:googleTrack|googleTrack]] - Google Analytics Integration
*[[functions:googleTrackTrans|googleTrackTrans]] - Google eCommerce Conversion Tracking
*[[functions:TEMConversionTag|TEMConversionTag]] - Trigger Email Marketing Conversion Tracking
*[[functions:jellyfishOutput|jellyfishOutput]] - Jellyfish Order Conversion Tracking

;Retrieve User Content to Build Community (Web 2.0) Pages
*[[functions:usersGet|usersGet]] - retrieve user data from a list of user ids
*[[functions:userBlogEntriesGet|userBlogEntriesGet]] - retrieve blog entry data belonging to a specific user
*[[functions:userFriendsGet|userFriendsGet]] - retrieves data for users in a specific user's 'friend list'
*[[functions:userWishListGet|userWishListGet]] - retrieves product data for products in a specific user's wish list
*[[functions:usersAmbassadorGet|usersAmbassadorGet]] - retrieves user data for users that are classified as 'ambassadors'

;Set Tracking Functions
*[[functions:recentlyViewedAdd|recentlyViewedAdd]] - registers a page to the recently viewed history when viewed

;User Management Functions
*[[functions:userAccountEdit|userAccountEdit]] - manages user account information
*[[functions:userAccountAndAddressCreate|userAccountAndAddressCreate]] - create a user account (or both a user account and address)
*[[functions:userAddressAddEdit|userAddressAddEdit]] - manages user addresses
*[[functions:userBlogEntryAddEdit|userBlogEntryAddEdit]] - managers user blog entries
*[[functions:userBlogSetup|userBlogSetup]] - sets up a user with a blog
*[[functions:authorizeIsLoggedOut|authorizeIsLoggedOut]] - to check if a user is logged out
*[[functions:authorizeIsLoggedIn|authorizeIsLoggedIn]] - to check if a user is logged in

;Retrieve additional information from address data
*[[functions:addressCountryNameGet|addressCountryNameGet]] - returns full country name from ISO 2 digit format
*[[functions:addressZipDetailsGet|addressZipDetailsGet]] - returns data about zip including: city,state,areaCode,county,timeZone,latitude,longitude,dayLightSavings

;Security functions
*[[functions:captchaCheck|captchaCheck]] - validate a captcha image to ensure we don't have automated form submissions
*[[functions:ipBlockCheck|ipBlockCheck]] - checks if an IP is registered to the block list

;Shortcut Functions that just plain make your job easier
*[[functions:redirect|redirect]] - redirects visitors to another page
*[[functions:valueArrayFromQuery|valueArrayFromQuery]] - returns a single dimension array of values based on the contents of a specific column in all records of a query
*[[functions:dollarFormat|dollarFormat]] - converts a decimal to a dollar value with preceding $ sign.
*[[functions:validateEmail|validateEmail]] - checks to make sure an email address is well formatted.

Page Templates:Functions

2009-04-28T18:40:13Z

71.163.185.8:

{{Page Template Functions Shortcuts}}
A series of custom functions are created to allow content management to easily access content they require to build the copy in templates:

;Quick Output of Options Tags for common select boxes
*[[functions:addressStateOptions|addressStateOptions]] - returns string of option tags for states
*[[functions:addressCountryOptions|addressCountryOptions]] - returns string of option tags for countries
*[[functions:orderExpDateOptions|orderExpDateOptions]] - returns string of option tags for expiration dates of a credit card
*[[functions:orderPayTypeOptions|orderPayTypeOptions]] - returns string of option tags for pay types

;Set Variables that Content Managers can use in the WYSIWYG copy editor
*[[functions:pageContentAttribSet|pageContentAttribSet]] - sets a single variable that can be used by content managers in the page manager form (including the WYSIWYG editor)
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribStart/pageContentAttribEnd]] - wrapper that the contents of which is set as a single variable that can be used by content managers in the page manager form

;Retrieve Page Content to Build Pages
*[[functions:pageMenuGet|pageMenuGet]] - returns menu item data
*[[functions:pageChildrenGet|pageChildrenGet]] - returns page data for children of a specific page
*[[functions:pageSearchGet|pageSearchGet]] - returns page data for pages qualifying for a keyword search
*[[functions:pageZoneGet|pageZoneGet]] - returns code to display an banner ad zone
*[[functions:pageForumPostsGet|pageForumPostsGet]] - returns forum post data for posts submitted to a particular forum page
*[[functions:pageGet|pageGet]] - return specific information about a specific page
*[[functions:pagePollQuestionsGet|pagePollQuestionsGet]] - returns question and answer data for building a poll
*[[functions:pagePollResultsGet|pagePollResultsGet]] - returns poll submission data for building a report of poll results
*[[functions:pageBreadcrumbsFamilyGet|pageBreadcrumbsFamilyGet(]] - returns breadcrumb data by traversing parent pages
*[[functions:pageBreadcrumbsHistoryGet|pageBreadcrumbsHistoryGet]] - returns breadcrumb data by traversing linear browsing history
*[[functions:pageProductsGet|pageProductsGet]] - returns product data for products related to a specific page
*[[functions:catalogProductsGet|catalogProductsGet]] - returns product data by catalog number
*[[functions:recentlyViewedGet|recentlyViewedGet]] - returns data for recently viewed pages
*[[functions:continueShoppingGet|continueShoppingGet]] - returns data for recently viewed pages
*[[functions:pageCustomSearchGroup|pageCustomSearchGroup]] - returns Custom Search Group data used to build a custom search widget
*[[functions:prodArrayToJS|prodArrayToJS]] - creates a string of pricing data that can be assigned to a javascript object to calculate pricing on the fly (ajax)

;Manage Copy
*[[functions:fullyQualifyAllURLs|fullyQualifyAllURLs]] - converts any relative/absolute URL in the passed copy to fully qualified URLs - useful when sending copy as an email

;Manage Large Lists of Data
*[[functions:pagination|pagination]] - easy to use tool to paginate large sets of data. Use for managing page children, search results and more

;Retrieve Order information for perpetual and full shopping carts, checkout stages, order history
*[[functions:orderGetSummary|orderGetSummary]] - returns summerized order information. Useful for perpetual carts.
*[[functions:orderGetPayTypes|orderGetPayTypes]] - returns data relating to active paytypes in the system
*[[functions:userGetAddresses|userGetAddresses]] - returns data for all addresses belonging to a specific user
*[[functions:orderGetShipArray|orderGetShipArray]] - returns array of shipping options and costs
*[[functions:orderGetCompleteArray|orderGetCompleteArray]] - returns full order information including payment, item, address, etc. Use for shopping carts, order summaries and receipts of orders.
*[[functions:ordersGetList|ordersGetList]] - returns listing of orders for a particular user (useful for building order history pages)

;Integrate With 3rd Party Web Tools
*[[functions:googleTrack|googleTrack]] - Google Analytics Integration
*[[functions:googleTrackTrans|googleTrackTrans]] - Google eCommerce Conversion Tracking
*[[functions:TEMConversionTag]TEMConversionTag]] - Trigger Email Marketing Conversion Tracking
*[[functions:jellyfishOutput|jellyfishOutput]] - Jellyfish Order Conversion Tracking

;Retrieve User Content to Build Community (Web 2.0) Pages
*[[functions:usersGet|usersGet]] - retrieve user data from a list of user ids
*[[functions:userBlogEntriesGet|userBlogEntriesGet]] - retrieve blog entry data belonging to a specific user
*[[functions:userFriendsGet|userFriendsGet]] - retrieves data for users in a specific user's 'friend list'
*[[functions:userWishListGet|userWishListGet]] - retrieves product data for products in a specific user's wish list
*[[functions:usersAmbassadorGet|usersAmbassadorGet]] - retrieves user data for users that are classified as 'ambassadors'

;Set Tracking Functions
*[[functions:recentlyViewedAdd|recentlyViewedAdd]] - registers a page to the recently viewed history when viewed

;User Management Functions
*[[functions:userAccountEdit|userAccountEdit]] - manages user account information
*[[functions:userAccountAndAddressCreate|userAccountAndAddressCreate]] - create a user account (or both a user account and address)
*[[functions:userAddressAddEdit|userAddressAddEdit]] - manages user addresses
*[[functions:userBlogEntryAddEdit|userBlogEntryAddEdit]] - managers user blog entries
*[[functions:userBlogSetup|userBlogSetup]] - sets up a user with a blog
*[[functions:authorizeIsLoggedOut|authorizeIsLoggedOut]] - to check if a user is logged out
*[[functions:authorizeIsLoggedIn|authorizeIsLoggedIn]] - to check if a user is logged in

;Retrieve additional information from address data
*[[functions:addressCountryNameGet|addressCountryNameGet]] - returns full country name from ISO 2 digit format
*[[functions:addressZipDetailsGet|addressZipDetailsGet]] - returns data about zip including: city,state,areaCode,county,timeZone,latitude,longitude,dayLightSavings

;Security functions
*[[functions:captchaCheck|captchaCheck]] - validate a captcha image to ensure we don't have automated form submissions
*[[functions:ipBlockCheck|ipBlockCheck]] - checks if an IP is registered to the block list

;Shortcut Functions that just plain make your job easier
*[[functions:redirect|redirect]] - redirects visitors to another page
*[[functions:valueArrayFromQuery|valueArrayFromQuery]] - returns a single dimension array of values based on the contents of a specific column in all records of a query
*[[functions:dollarFormat|dollarFormat]] - converts a decimal to a dollar value with preceding $ sign.
*[[functions:validateEmail|validateEmail]] - checks to make sure an email address is well formatted.

Template:Page Template Functions Shortcuts

2009-04-28T18:39:43Z

71.163.185.8:

<table align=right style="background-color: #DDDDDD;" cellpadding=0 cellspacing=0 border=0>
<tr>
<td valign=top>
{{Page Template Managers Shortcuts}}
</td>
</tr>
<tr>
<td valign=top>
[[Page Templates:Functions|Page Template Functions]]
*[[functions:addressCountryOptions|addressCountryOptions]]
*[[functions:addressCountryNameGet|addressCountryNameGet]]
*[[functions:addressStateOptions|addressStateOptions]]
*[[functions:addressZipDetailsGet|addressZipDetailsGet]]
*[[functions:authorizeIsLoggedIn|authorizeIsLoggedIn]]
*[[functions:authorizeIsLoggedOut|authorizeIsLoggedOut]]
*[[functions:captchaCheck|captchaCheck]]
*[[functions:catalogProductsGet|catalogProductsGet]]
*[[functions:continueShoppingGet|continueShoppingGet]]
*[[functions:continueShoppingSet|continueShopppingSet]]
*[[functions:dollarFormat|dollarFormat]]
*[[functions:fullyQualifyAllURLs|fullyQualifyAllURLs]]
*[[functions:googleTrack|googleTrack]]
*[[functions:googleTrackTrans|googleTrackTrans]]
*[[functions:ipBlockCheck|ipBlockCheck]]
*[[functions:itemLayout_dataString2Array|itemLayout_dataString2Array]]
*[[functions:jellyfishOutput|jellyfishOutput]]
*[[functions:mysqlquery2array|mysqlquery2array]]
*[[functions:orderExpDateOptions|orderExpDateOptions]]
*[[functions:orderGetCompleteArray|orderGetCompleteArray]]
*[[functions:orderGetEmail|orderGetEmail]]
*[[functions:orderGetFirstName|orderGetFirstName]]
*[[functions:orderGetIdFromNumber|orderGetIdFromNumber]]
*[[functions:orderGetPayTypes|orderGetPayTypes]]
*[[functions:orderGetShipArray|orderGetShipArray]]
*[[functions:orderGetSummary|orderGetSummary]]
*[[functions:ordersGetList|ordersGetList]]
*[[functions:orderPayTypeOptions|orderPayTypeOptions]]
*[[functions:orderShipFedexRate|orderShipFedexRate]]
*[[functions:orderShipAdjustRate|orderShipAdjustRate]]
*[[functions:pageBreadcrumbsFamilyGet|pageBreadcrumbsFamilyGet]]
*[[functions:pageBreadcrumbsHistoryGet|pageBreadcrumbsHistoryGet]]
*[[functions:pageChildrenGet|pageChildrenGet]]
*[[functions:pageContentAttribSet|pageContentAttribSet]]
*[[functions:pageContentAttribsSet|pageContentAttribsSet]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribStart]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribEnd]]
*[[functions:pageCustomSearchGroup|pageCustomSearchGroup]]
*[[functions:pageForumPostsGet|pageForumPostsGet]]
*[[functions:pageGet|pageGet]]
*[[functions:pageGetHomeId|pageGetHomeId]]
*[[functions:pageMenuGet|pageMenuGet]]
*[[functions:pagePollQuestionsGet|pagePollQuestionsGet]]
*[[functions:pagePollResultsGet|pagePollResultsGet]]
*[[functions:pageProductsGet|pageProductsGet]]
*[[functions:pageSearchGet|pageSearchGet]]
*[[functions:pageZoneGet|pageZoneGet]]
*[[functions:pagination|pagination]]
*[[functions:phpObjToJS|phpObjToJS]]
*[[functions:prodArrayToJS|prodArrayToJS]]
*[[functions:prodOptionString2Array|prodOptionString2Array]]
*[[functions:recentlyViewedAdd|recentlyViewedAdd]]
*[[functions:recentlyViewedGet|recentlyViewedGet]]
*[[functions:redirect|redirect]]
*[[functions:TEMConversionTag|TEMConversionTag]]
*[[functions:userAccountAndAddressCreate|userAccountAndAddressCreate]]
*[[functions:userAccountEdit|userAccountEdit]]
*[[functions:userAddressAddEdit|userAddressAddEdit]]
*[[functions:userBlogEntriesGet|userBlogEntriesGet]]
*[[functions:userBlogEntryAddEdit|userBlogEntryAddEdit]]
*[[functions:userBlogSetup|userBlogSetup]]
*[[functions:userFriendsGet|userFriendsGet]]
*[[functions:userGetAddresses|userGetAddresses]]
*[[functions:userWishListGet|userWishListGet]]
*[[functions:usersAmbassadorGet|usersAmbassadorGet]]
*[[functions:usersGet|usersGet]]
*[[functions:valueArrayFromQuery|valueArrayFromQuery]]
*[[functions:verifyEmail|verifyEmail]]
</td>
</tr>
</table>

Template:Page Template Functions Shortcuts

2009-04-28T18:39:13Z

71.163.185.8:

<table align=right style="background-color: #DDDDDD;" cellpadding=0 cellspacing=0 border=0>
<tr>
<td valign=top>
{{Page Template Managers Shortcuts}}
</td>
</tr>
<tr>
<td valign=top>
[[Page Templates:Functions|Page Template Functions]]
*[[functions:addressCountryOptions|addressCountryOptions]]
*[[functions:addressCountryNameGet|addressCountryNameGet]]
*[[functions:addressStateOptions|addressStateOptions]]
*[[functions:addressZipDetailsGet|addressZipDetailsGet]]
*[[functions:authorizeIsLoggedIn|authorizeIsLoggedIn]]
*[[functions:authorizeIsLoggedOut|authorizeIsLoggedOut]]
*[[functions:captchaCheck|captchaCheck]]
*[[functions:catalogProductsGet|catalogProductsGet]]
*[[functions:continueShoppingGet|continueShoppingGet]]
*[[functions:continueShoppingSet|continueShopppingSet]]
*[[functions:dollarFormat|dollarFormat]]
*[[functions:fullyQualifyAllURLs|fullyQualifyAllURLs]]
*[[functions:googleTrack]googleTrack]]
*[[functions:googleTrack]googleTrackTrans]]
*[[functions:ipBlockCheck|ipBlockCheck]]
*[[functions:itemLayout_dataString2Array|itemLayout_dataString2Array]]
*[[functions:jellyfishOutput|jellyfishOutput]]
*[[functions:mysqlquery2array|mysqlquery2array]]
*[[functions:orderExpDateOptions|orderExpDateOptions]]
*[[functions:orderGetCompleteArray|orderGetCompleteArray]]
*[[functions:orderGetEmail|orderGetEmail]]
*[[functions:orderGetFirstName|orderGetFirstName]]
*[[functions:orderGetIdFromNumber|orderGetIdFromNumber]]
*[[functions:orderGetPayTypes|orderGetPayTypes]]
*[[functions:orderGetShipArray|orderGetShipArray]]
*[[functions:orderGetSummary|orderGetSummary]]
*[[functions:ordersGetList|ordersGetList]]
*[[functions:orderPayTypeOptions|orderPayTypeOptions]]
*[[functions:orderShipFedexRate|orderShipFedexRate]]
*[[functions:orderShipAdjustRate|orderShipAdjustRate]]
*[[functions:pageBreadcrumbsFamilyGet|pageBreadcrumbsFamilyGet]]
*[[functions:pageBreadcrumbsHistoryGet|pageBreadcrumbsHistoryGet]]
*[[functions:pageChildrenGet|pageChildrenGet]]
*[[functions:pageContentAttribSet|pageContentAttribSet]]
*[[functions:pageContentAttribsSet|pageContentAttribsSet]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribStart]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribEnd]]
*[[functions:pageCustomSearchGroup|pageCustomSearchGroup]]
*[[functions:pageForumPostsGet|pageForumPostsGet]]
*[[functions:pageGet|pageGet]]
*[[functions:pageGetHomeId|pageGetHomeId]]
*[[functions:pageMenuGet|pageMenuGet]]
*[[functions:pagePollQuestionsGet|pagePollQuestionsGet]]
*[[functions:pagePollResultsGet|pagePollResultsGet]]
*[[functions:pageProductsGet|pageProductsGet]]
*[[functions:pageSearchGet|pageSearchGet]]
*[[functions:pageZoneGet|pageZoneGet]]
*[[functions:pagination|pagination]]
*[[functions:phpObjToJS|phpObjToJS]]
*[[functions:prodArrayToJS|prodArrayToJS]]
*[[functions:prodOptionString2Array|prodOptionString2Array]]
*[[functions:recentlyViewedAdd|recentlyViewedAdd]]
*[[functions:recentlyViewedGet|recentlyViewedGet]]
*[[functions:redirect|redirect]]
*[[functions:TEMConversionTag|TEMConversionTag]]
*[[functions:userAccountAndAddressCreate|userAccountAndAddressCreate]]
*[[functions:userAccountEdit|userAccountEdit]]
*[[functions:userAddressAddEdit|userAddressAddEdit]]
*[[functions:userBlogEntriesGet|userBlogEntriesGet]]
*[[functions:userBlogEntryAddEdit|userBlogEntryAddEdit]]
*[[functions:userBlogSetup|userBlogSetup]]
*[[functions:userFriendsGet|userFriendsGet]]
*[[functions:userGetAddresses|userGetAddresses]]
*[[functions:userWishListGet|userWishListGet]]
*[[functions:usersAmbassadorGet|usersAmbassadorGet]]
*[[functions:usersGet|usersGet]]
*[[functions:valueArrayFromQuery|valueArrayFromQuery]]
*[[functions:verifyEmail|verifyEmail]]
</td>
</tr>
</table>

Template:Page Template Functions Shortcuts

2009-04-28T18:38:51Z

71.163.185.8: added google and jellyfish tracking functions

<table align=right style="background-color: #DDDDDD;" cellpadding=0 cellspacing=0 border=0>
<tr>
<td valign=top>
{{Page Template Managers Shortcuts}}
</td>
</tr>
<tr>
<td valign=top>
[[Page Templates:Functions|Page Template Functions]]
*[[functions:addressCountryOptions|addressCountryOptions]]
*[[functions:addressCountryNameGet|addressCountryNameGet]]
*[[functions:addressStateOptions|addressStateOptions]]
*[[functions:addressZipDetailsGet|addressZipDetailsGet]]
*[[functions:authorizeIsLoggedIn|authorizeIsLoggedIn]]
*[[functions:authorizeIsLoggedOut|authorizeIsLoggedOut]]
*[[functions:captchaCheck|captchaCheck]]
*[[functions:catalogProductsGet|catalogProductsGet]]
*[[functions:continueShoppingGet|continueShoppingGet]]
*[[functions:continueShoppingSet|continueShopppingSet]]
*[[functions:dollarFormat|dollarFormat]]
*[[functions:fullyQualifyAllURLs|fullyQualifyAllURLs]]
*[[functions:googleTrack]googleTrack]
*[[functions:googleTrack]googleTrackTrans]
*[[functions:ipBlockCheck|ipBlockCheck]]
*[[functions:itemLayout_dataString2Array|itemLayout_dataString2Array]]
*[[functions:jellyfishOutput|jellyfishOutput]
*[[functions:mysqlquery2array|mysqlquery2array]]
*[[functions:orderExpDateOptions|orderExpDateOptions]]
*[[functions:orderGetCompleteArray|orderGetCompleteArray]]
*[[functions:orderGetEmail|orderGetEmail]]
*[[functions:orderGetFirstName|orderGetFirstName]]
*[[functions:orderGetIdFromNumber|orderGetIdFromNumber]]
*[[functions:orderGetPayTypes|orderGetPayTypes]]
*[[functions:orderGetShipArray|orderGetShipArray]]
*[[functions:orderGetSummary|orderGetSummary]]
*[[functions:ordersGetList|ordersGetList]]
*[[functions:orderPayTypeOptions|orderPayTypeOptions]]
*[[functions:orderShipFedexRate|orderShipFedexRate]]
*[[functions:orderShipAdjustRate|orderShipAdjustRate]]
*[[functions:pageBreadcrumbsFamilyGet|pageBreadcrumbsFamilyGet]]
*[[functions:pageBreadcrumbsHistoryGet|pageBreadcrumbsHistoryGet]]
*[[functions:pageChildrenGet|pageChildrenGet]]
*[[functions:pageContentAttribSet|pageContentAttribSet]]
*[[functions:pageContentAttribsSet|pageContentAttribsSet]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribStart]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribEnd]]
*[[functions:pageCustomSearchGroup|pageCustomSearchGroup]]
*[[functions:pageForumPostsGet|pageForumPostsGet]]
*[[functions:pageGet|pageGet]]
*[[functions:pageGetHomeId|pageGetHomeId]]
*[[functions:pageMenuGet|pageMenuGet]]
*[[functions:pagePollQuestionsGet|pagePollQuestionsGet]]
*[[functions:pagePollResultsGet|pagePollResultsGet]]
*[[functions:pageProductsGet|pageProductsGet]]
*[[functions:pageSearchGet|pageSearchGet]]
*[[functions:pageZoneGet|pageZoneGet]]
*[[functions:pagination|pagination]]
*[[functions:phpObjToJS|phpObjToJS]]
*[[functions:prodArrayToJS|prodArrayToJS]]
*[[functions:prodOptionString2Array|prodOptionString2Array]]
*[[functions:recentlyViewedAdd|recentlyViewedAdd]]
*[[functions:recentlyViewedGet|recentlyViewedGet]]
*[[functions:redirect|redirect]]
*[[functions:TEMConversionTag|TEMConversionTag]]
*[[functions:userAccountAndAddressCreate|userAccountAndAddressCreate]]
*[[functions:userAccountEdit|userAccountEdit]]
*[[functions:userAddressAddEdit|userAddressAddEdit]]
*[[functions:userBlogEntriesGet|userBlogEntriesGet]]
*[[functions:userBlogEntryAddEdit|userBlogEntryAddEdit]]
*[[functions:userBlogSetup|userBlogSetup]]
*[[functions:userFriendsGet|userFriendsGet]]
*[[functions:userGetAddresses|userGetAddresses]]
*[[functions:userWishListGet|userWishListGet]]
*[[functions:usersAmbassadorGet|usersAmbassadorGet]]
*[[functions:usersGet|usersGet]]
*[[functions:valueArrayFromQuery|valueArrayFromQuery]]
*[[functions:verifyEmail|verifyEmail]]
</td>
</tr>
</table>

Page Templates:Functions

2009-04-28T18:37:18Z

71.163.185.8: added google, tem and jellyfish tracking tags

{{Page Template Functions Shortcuts}}
A series of custom functions are created to allow content management to easily access content they require to build the copy in templates:

;Quick Output of Options Tags for common select boxes
*[[functions:addressStateOptions|addressStateOptions]] - returns string of option tags for states
*[[functions:addressCountryOptions|addressCountryOptions]] - returns string of option tags for countries
*[[functions:orderExpDateOptions|orderExpDateOptions]] - returns string of option tags for expiration dates of a credit card
*[[functions:orderPayTypeOptions|orderPayTypeOptions]] - returns string of option tags for pay types

;Set Variables that Content Managers can use in the WYSIWYG copy editor
*[[functions:pageContentAttribSet|pageContentAttribSet]] - sets a single variable that can be used by content managers in the page manager form (including the WYSIWYG editor)
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribStart/pageContentAttribEnd]] - wrapper that the contents of which is set as a single variable that can be used by content managers in the page manager form

;Retrieve Page Content to Build Pages
*[[functions:pageMenuGet|pageMenuGet]] - returns menu item data
*[[functions:pageChildrenGet|pageChildrenGet]] - returns page data for children of a specific page
*[[functions:pageSearchGet|pageSearchGet]] - returns page data for pages qualifying for a keyword search
*[[functions:pageZoneGet|pageZoneGet]] - returns code to display an banner ad zone
*[[functions:pageForumPostsGet|pageForumPostsGet]] - returns forum post data for posts submitted to a particular forum page
*[[functions:pageGet|pageGet]] - return specific information about a specific page
*[[functions:pagePollQuestionsGet|pagePollQuestionsGet]] - returns question and answer data for building a poll
*[[functions:pagePollResultsGet|pagePollResultsGet]] - returns poll submission data for building a report of poll results
*[[functions:pageBreadcrumbsFamilyGet|pageBreadcrumbsFamilyGet(]] - returns breadcrumb data by traversing parent pages
*[[functions:pageBreadcrumbsHistoryGet|pageBreadcrumbsHistoryGet]] - returns breadcrumb data by traversing linear browsing history
*[[functions:pageProductsGet|pageProductsGet]] - returns product data for products related to a specific page
*[[functions:catalogProductsGet|catalogProductsGet]] - returns product data by catalog number
*[[functions:recentlyViewedGet|recentlyViewedGet]] - returns data for recently viewed pages
*[[functions:continueShoppingGet|continueShoppingGet]] - returns data for recently viewed pages
*[[functions:pageCustomSearchGroup|pageCustomSearchGroup]] - returns Custom Search Group data used to build a custom search widget
*[[functions:prodArrayToJS|prodArrayToJS]] - creates a string of pricing data that can be assigned to a javascript object to calculate pricing on the fly (ajax)

;Manage Copy
*[[functions:fullyQualifyAllURLs|fullyQualifyAllURLs]] - converts any relative/absolute URL in the passed copy to fully qualified URLs - useful when sending copy as an email

;Manage Large Lists of Data
*[[functions:pagination|pagination]] - easy to use tool to paginate large sets of data. Use for managing page children, search results and more

;Retrieve Order information for perpetual and full shopping carts, checkout stages, order history
*[[functions:orderGetSummary|orderGetSummary]] - returns summerized order information. Useful for perpetual carts.
*[[functions:orderGetPayTypes|orderGetPayTypes]] - returns data relating to active paytypes in the system
*[[functions:userGetAddresses|userGetAddresses]] - returns data for all addresses belonging to a specific user
*[[functions:orderGetShipArray|orderGetShipArray]] - returns array of shipping options and costs
*[[functions:orderGetCompleteArray|orderGetCompleteArray]] - returns full order information including payment, item, address, etc. Use for shopping carts, order summaries and receipts of orders.
*[[functions:ordersGetList|ordersGetList]] - returns listing of orders for a particular user (useful for building order history pages)

;Integrate With 3rd Party Web Tools
*[[functions:googleTrack]googleTrack] - Google Analytics Integration
*[[functions:googleTrack]googleTrackTrans] - Google eCommerce Conversion Tracking
*[[functions:TEMConversionTag]TEMConversionTag] - Trigger Email Marketing Conversion Tracking
*[[functions:jellyfishOutput|jellyfishOutput] - Jellyfish Order Conversion Tracking

;Retrieve User Content to Build Community (Web 2.0) Pages
*[[functions:usersGet|usersGet]] - retrieve user data from a list of user ids
*[[functions:userBlogEntriesGet|userBlogEntriesGet]] - retrieve blog entry data belonging to a specific user
*[[functions:userFriendsGet|userFriendsGet]] - retrieves data for users in a specific user's 'friend list'
*[[functions:userWishListGet|userWishListGet]] - retrieves product data for products in a specific user's wish list
*[[functions:usersAmbassadorGet|usersAmbassadorGet]] - retrieves user data for users that are classified as 'ambassadors'

;Set Tracking Functions
*[[functions:recentlyViewedAdd|recentlyViewedAdd]] - registers a page to the recently viewed history when viewed

;User Management Functions
*[[functions:userAccountEdit|userAccountEdit]] - manages user account information
*[[functions:userAccountAndAddressCreate|userAccountAndAddressCreate]] - create a user account (or both a user account and address)
*[[functions:userAddressAddEdit|userAddressAddEdit]] - manages user addresses
*[[functions:userBlogEntryAddEdit|userBlogEntryAddEdit]] - managers user blog entries
*[[functions:userBlogSetup|userBlogSetup]] - sets up a user with a blog
*[[functions:authorizeIsLoggedOut|authorizeIsLoggedOut]] - to check if a user is logged out
*[[functions:authorizeIsLoggedIn|authorizeIsLoggedIn]] - to check if a user is logged in

;Retrieve additional information from address data
*[[functions:addressCountryNameGet|addressCountryNameGet]] - returns full country name from ISO 2 digit format
*[[functions:addressZipDetailsGet|addressZipDetailsGet]] - returns data about zip including: city,state,areaCode,county,timeZone,latitude,longitude,dayLightSavings

;Security functions
*[[functions:captchaCheck|captchaCheck]] - validate a captcha image to ensure we don't have automated form submissions
*[[functions:ipBlockCheck|ipBlockCheck]] - checks if an IP is registered to the block list

;Shortcut Functions that just plain make your job easier
*[[functions:redirect|redirect]] - redirects visitors to another page
*[[functions:valueArrayFromQuery|valueArrayFromQuery]] - returns a single dimension array of values based on the contents of a specific column in all records of a query
*[[functions:dollarFormat|dollarFormat]] - converts a decimal to a dollar value with preceding $ sign.
*[[functions:validateEmail|validateEmail]] - checks to make sure an email address is well formatted.

Pages:Custom Forms

2009-04-28T14:53:16Z

71.163.185.8:

Custom forms allow page content managers to create forms on the fly in the WYSIWYG editor. A knowledge of HTML form coding is required to do this. When a custom form is submitted by a website visitor, it is emailed to specified recipients (using the emailTo field below) AND it is placed into the database accessible via [[Form Submissions]] in system administration.

Each form has required hidden fields, core fields and custom fields:

===REQUIRED HIDDEN FIELDS===
Required hidden fields send data to the system that tells it how to process the form. The required hidden fields are as follows:
;fa: This field should ALWAYS have a value of "USER.formSubmit" - which tells the system this is a custom form that needs to be processed.
;formType: This field's value is used to classify and organize the form submissions made through this form. For instance, enter "newsletter" as the value if this form is being used to register for the newsletter; or enter "catalog request" as the value if this is a catalog request form. This value can later be used when looking up the form in [[Form Submissions]] so you can filter only certain forms.
;emailTo: A comma delimited list of email addresses that will receive this form's contents upon submission. Use to send yourself and others notifications of these forms as they are submitted. Leave empty if there are no recipients.
;redirect: The URL where the visitor should be directed to following submission of the form. For each custom form it is recommended you create an accompanying page that will display a thank you or confirmation message. This page should be where the visitor is directed to using the 'redirect' field following form submission.
;otherFields: A comma delimited list of custom field names. Leave empty if no custom fields are being used.

===OPTIONAL HIDDEN FIELDS===
;fieldValidations: Use to require certain fields. Comma delimited list of required fields, commands and messages. Example: "firstName/min:1:Must enter first name,zipCode/min:5:You must enter a 5 digit zip code,emailAddress/email:Must enter a valid email address" sets firstName to require min length 1 character, zipCode to require min length of 5 characters and emailAddress to be a valid email address.

===CORE FIELDS===
Core fields are visitor-populated fields that can be used to organize and classify form submissions. The emailAddress field in particular is required if you wish to include the subscribe option (which allows visitors to subscribe to the newsletter when this form is submitted).
;firstName: A text field with a maxlength of 50
;lastName: A text field with a maxlength of 50
;emailAddress: A text field with a maxlength of 255
;subscribe: A checkbox with a value of 1 (if checked, this will pass and trigger the newsletter registration process for the entered emailAddress)

===CUSTOM FIELDS===
Custom fields allow the content manager creating the form to add any number of additional form fields that will be stored upon submission. Note that form submissions cannot be searched or filtered by the contents of these fields, but they are present when looking up submitted forms and are listed in exports of form submissions (which are then sortable by the custom fields in Excel). Custom fields can have any name EXCEPT the reserved CORE and REQUIRED HIDDEN field names (fa,formType,emailTo,redirect,firstName,lastName,emailAddress,subscribe,otherFields). All custom field names MUST be entered into the hidden field "otherFields" (see REQUIRED HIDDEN FIELDS above)

===EXAMPLES===
Generic Example, with detailed explainations:
<source lang="HTML4strict">


<form action="index.php" method="POST">






<input type="hidden" name="formType" value="this form">


<input type="hidden" name="emailTo" value="email@website.com,anotheremail@website.com">


<input type="hidden" name="fa" value="USER.formSubmit">


<input type="hidden" name="redirect" value="index.php?pageId=123&message=Thank you for filling our our form">


<input type="hidden" name="otherFields" value="source,color,likeItalian" />






<br>First Name: <input type="text" name="firstName" size=25 maxlength=50>
<br>Last Name: <input type="text" name="lastName" size=25 maxlength=50>
<br>Email Address: <input type="text" name="emailAddress" size=50 maxlength=255>


<br>Check here to subscribe to our newsletter: <input type="checkbox" name="subscribe" value="1">





<br />How did you find out about us? <input type="text" name="source" size=50 maxlength=100 />
<br />What is your favorite color?
<select name="color">
<option>Red</option>
<option>Blue</option>
<option>Green</option>
</select>
<br />Do you like italian food?
YES<input type="radio" name="likeItalian" value="1" />
NO<input type="radio" name="likeItalian" value="0" />





<br /><input type="submit" value="SUBMIT" />


</form>
</source>

Newsletter Sign Up Form Example:
<source lang="HTML4strict">

<form action="index.php" method="POST">

<input type="hidden" name="formType" value="newsletter">
<input type="hidden" name="emailTo" value="newsletters@mywebsite.com">
<input type="hidden" name="fa" value="USER.formSubmit">
<input type="hidden" name="redirect" value="index.php?pageId=123&message=Thank you for registering for our newsletter">

<input type="hidden" name="otherFields" value="" />

<h1>Register for our newsletter!</h1>

<br>First Name: <input type="text" name="firstName" size=25 maxlength=50>
<br>Last Name: <input type="text" name="lastName" size=25 maxlength=50>
<br>Email Address: <input type="text" name="emailAddress" size=50 maxlength=255>


<input type="hidden" name="subscribe" value="1">

<br /><input type="submit" value="SUBSCRIBE!" />

</form>
</source>

Catalog Request Example:
<source lang="HTML4strict">

<form action="index.php" method="POST">

<input type="hidden" name="formType" value="catalog request">
<input type="hidden" name="emailTo" value="catalogrequests@mywebsite.com">
<input type="hidden" name="fa" value="USER.formSubmit">
<input type="hidden" name="redirect" value="index.php?pageId=456&message=You will receive a copy of our catalog shortly">


<input type="hidden" name="otherFields" value="street1,street2,city,state,zipCode" />

<h1>Order a Catalog</h1>

<br>First Name: <input type="text" name="firstName" size=25 maxlength=50>
<br>Last Name: <input type="text" name="lastName" size=25 maxlength=50>
<br>Email Address: <input type="text" name="emailAddress" size=50 maxlength=255>
<br>I would like to receive occassional emails about specials and what-not: <input type="checkbox" name="subscribe" value="1">
<br>


<br>Address: <input type="text" name="street1" size=50>
<br>Address Line 2: <input type="text" name="street2" size=50>
<br>City: <input type="text" name="city" size=50>
<br>State: <select name="state">
<option>AK</option>
<option>AL</option>
<option>... more states here ...</option>
</select>
<br>Zip: <input type="text" name="zipCode" size=10>

<br /><input type="submit" value="ORDER!" />

</form>
</source>

Pages:Custom Forms

2009-04-28T14:52:34Z

71.163.185.8: addded fieldValidations

Custom forms allow page content managers to create forms on the fly in the WYSIWYG editor. A knowledge of HTML form coding is required to do this. When a custom form is submitted by a website visitor, it is emailed to specified recipients (using the emailTo field below) AND it is placed into the database accessible via [[Form Submissions]] in system administration.

Each form has required hidden fields, core fields and custom fields:

===REQUIRED HIDDEN FIELDS===
Required hidden fields send data to the system that tells it how to process the form. The required hidden fields are as follows:
;fa: This field should ALWAYS have a value of "USER.formSubmit" - which tells the system this is a custom form that needs to be processed.
;formType: This field's value is used to classify and organize the form submissions made through this form. For instance, enter "newsletter" as the value if this form is being used to register for the newsletter; or enter "catalog request" as the value if this is a catalog request form. This value can later be used when looking up the form in [[Form Submissions]] so you can filter only certain forms.
;emailTo: A comma delimited list of email addresses that will receive this form's contents upon submission. Use to send yourself and others notifications of these forms as they are submitted. Leave empty if there are no recipients.
;redirect: The URL where the visitor should be directed to following submission of the form. For each custom form it is recommended you create an accompanying page that will display a thank you or confirmation message. This page should be where the visitor is directed to using the 'redirect' field following form submission.
;otherFields: A comma delimited list of custom field names. Leave empty if no custom fields are being used.
;fieldValidations: Use to require certain fields. Comma delimited list of required fields, commands and messages. Example: "firstName/min:1:Must enter first name,zipCode/min:5:You must enter a 5 digit zip code,emailAddress/email:Must enter a valid email address" sets firstName to require min length 1 character, zipCode to require min length of 5 characters and emailAddress to be a valid email address.

===CORE FIELDS===
Core fields are visitor-populated fields that can be used to organize and classify form submissions. The emailAddress field in particular is required if you wish to include the subscribe option (which allows visitors to subscribe to the newsletter when this form is submitted).
;firstName: A text field with a maxlength of 50
;lastName: A text field with a maxlength of 50
;emailAddress: A text field with a maxlength of 255
;subscribe: A checkbox with a value of 1 (if checked, this will pass and trigger the newsletter registration process for the entered emailAddress)

===CUSTOM FIELDS===
Custom fields allow the content manager creating the form to add any number of additional form fields that will be stored upon submission. Note that form submissions cannot be searched or filtered by the contents of these fields, but they are present when looking up submitted forms and are listed in exports of form submissions (which are then sortable by the custom fields in Excel). Custom fields can have any name EXCEPT the reserved CORE and REQUIRED HIDDEN field names (fa,formType,emailTo,redirect,firstName,lastName,emailAddress,subscribe,otherFields). All custom field names MUST be entered into the hidden field "otherFields" (see REQUIRED HIDDEN FIELDS above)

===EXAMPLES===
Generic Example, with detailed explainations:
<source lang="HTML4strict">


<form action="index.php" method="POST">






<input type="hidden" name="formType" value="this form">


<input type="hidden" name="emailTo" value="email@website.com,anotheremail@website.com">


<input type="hidden" name="fa" value="USER.formSubmit">


<input type="hidden" name="redirect" value="index.php?pageId=123&message=Thank you for filling our our form">


<input type="hidden" name="otherFields" value="source,color,likeItalian" />






<br>First Name: <input type="text" name="firstName" size=25 maxlength=50>
<br>Last Name: <input type="text" name="lastName" size=25 maxlength=50>
<br>Email Address: <input type="text" name="emailAddress" size=50 maxlength=255>


<br>Check here to subscribe to our newsletter: <input type="checkbox" name="subscribe" value="1">





<br />How did you find out about us? <input type="text" name="source" size=50 maxlength=100 />
<br />What is your favorite color?
<select name="color">
<option>Red</option>
<option>Blue</option>
<option>Green</option>
</select>
<br />Do you like italian food?
YES<input type="radio" name="likeItalian" value="1" />
NO<input type="radio" name="likeItalian" value="0" />





<br /><input type="submit" value="SUBMIT" />


</form>
</source>

Newsletter Sign Up Form Example:
<source lang="HTML4strict">

<form action="index.php" method="POST">

<input type="hidden" name="formType" value="newsletter">
<input type="hidden" name="emailTo" value="newsletters@mywebsite.com">
<input type="hidden" name="fa" value="USER.formSubmit">
<input type="hidden" name="redirect" value="index.php?pageId=123&message=Thank you for registering for our newsletter">

<input type="hidden" name="otherFields" value="" />

<h1>Register for our newsletter!</h1>

<br>First Name: <input type="text" name="firstName" size=25 maxlength=50>
<br>Last Name: <input type="text" name="lastName" size=25 maxlength=50>
<br>Email Address: <input type="text" name="emailAddress" size=50 maxlength=255>


<input type="hidden" name="subscribe" value="1">

<br /><input type="submit" value="SUBSCRIBE!" />

</form>
</source>

Catalog Request Example:
<source lang="HTML4strict">

<form action="index.php" method="POST">

<input type="hidden" name="formType" value="catalog request">
<input type="hidden" name="emailTo" value="catalogrequests@mywebsite.com">
<input type="hidden" name="fa" value="USER.formSubmit">
<input type="hidden" name="redirect" value="index.php?pageId=456&message=You will receive a copy of our catalog shortly">


<input type="hidden" name="otherFields" value="street1,street2,city,state,zipCode" />

<h1>Order a Catalog</h1>

<br>First Name: <input type="text" name="firstName" size=25 maxlength=50>
<br>Last Name: <input type="text" name="lastName" size=25 maxlength=50>
<br>Email Address: <input type="text" name="emailAddress" size=50 maxlength=255>
<br>I would like to receive occassional emails about specials and what-not: <input type="checkbox" name="subscribe" value="1">
<br>


<br>Address: <input type="text" name="street1" size=50>
<br>Address Line 2: <input type="text" name="street2" size=50>
<br>City: <input type="text" name="city" size=50>
<br>State: <select name="state">
<option>AK</option>
<option>AL</option>
<option>... more states here ...</option>
</select>
<br>Zip: <input type="text" name="zipCode" size=10>

<br /><input type="submit" value="ORDER!" />

</form>
</source>

Upgrade Requests / Bugs

2009-04-22T16:54:33Z

71.163.185.8:

*Additional field to shared option groups - so it can have a name that is not the same as it's displayed title.
*Increments for products (visitor must buy in allotted increment)
*Coupon Memory - have the system remember coupon codes entered that where not qualified for, automatically apply coupon as soon as cart qualifies.
*Checkbox to discounts that allow an item to ignore the ‘only 1 discount per cart’ command.
*Text field in discounts for non-qualifying codes that will go into queue, when application is attempted.
*Banner Zones controlled by url data passed (tell a zone to display a specific banner), command expires after order is complete
*Banner repository queue to hold attempted, but unqualified, discount codes, attempt to re-apply with each cart modification.
*Tiered discounts for BOTH % and $ off.
*Checkout modifications to support non-pay accounts, po numbers.
*Cart check function, checks all items, shipping, discounts in cart to make sure they all still qualify, if any do not, remove and display message to visitor.
*Order management to allow product option changes.
*Auto deletion of expired data including: incomplete carts, searches, send2friend, banner tracking, campaign tracking, page views, user sessions.
*Export/Import templates (to duplicate BETWEEN sites)
*Audit all queries to confirm 'best practices' used with strings - see referencePHP
*Add items to cart right on product page (AJAX solution)
*Persistent right column cart throughout checkout
*Confirmation "Thank You" page should have cross-sell that can be "added to your order automatically" and possibly allow the items to be added without any additional shipping charges.
*Banner management should be reworked. Chris Ziter writing up details.
*Print all option for groups of invoices in order management
*Duplicate function in discounts
*Search ability in discounts
*Category application to discounts
*Delete campaigns in banner management
*dBug wrapper to ALL functions.
*All site email to use scheduled queue mechanism. Set up email to be send via smtp server designated in Settings.
*Zero return keyword searches
*Keyword search funnel report
*Page view (product ,category, product line) funnel report by template

;Completed:
*2/5/2009: Free item alterations, store items as $0, pass controls that allow design changes for these items when presented in cart, etc.
*2/9/2009: When a visitor enters an email/name to register for the newsletter, and the billing/shipping addresses are blank, attach the email/name to the billing/shipping addresses in the order.
*2/13/2008: Reliable exit pop up
*2/16/2008: TEM channelId control for the order process (abandoned cart) manageable through admin console.
*2/18/2008: TEM custom image generation field set up

;In Progress:
*Catalog quick order

Attn: Template Integrators

2009-04-21T12:55:31Z

71.163.185.8: added lost password process check

=Before Site Development=

==Site Configuration==
Set up for proper shipping method. Adjust cart accordingly (don't need zip code entry if using level shipping, don't need shipping selection if only one shipping method is available).

==Testing Criteria==
Generate testing criteria with the client, these will be your measurements of success. Testing criteria will start with the new site checklist below - augment this list with custom functions and templates built for the client. Create at least one testing scenario for each custom function / template possible conditions. If the function / template is to effect other site areas (cart, checkout, orders, importing / exporting) be sure to include a process flow test to ensure those other functions are impacted correctly.

==During Site Development==
===For ANY deviations made from the designs===
*Email the client, verify response
*Note in the code when / how the client was notified of the change.

=After Site Completion=

==New Site Checklist==

===Templates Adjusted to Match Config Settings===
*Shopping cart shipping only shows zip code if using Fedex shipping
*Shopping cart shipping only has option box if more than one shipping method is available

===Address Collection Form Homogeneity===
''Address forms should all have same fields AND validation rules, also that all pages that display addresses include all these fields''
*Create account (if address is included)
*Address book
*Checkout Billing
*Checkout Shipping
*Order Confirmation
*Viewable / Printable Invoice
*Emailed Invoice

===Page Accessibility Conditions are Enforced===
;cannot view while logged OUT:
:*Your Account
:*Edit Account
:*Address Book
:*Order History
;cannot view while logged IN:
:*Welcome (checkout registration)
:*Create Account
:*Lost Password

===Settings Completed===
;All Email Content Entered:
:*Page Management > Send 2 Friend Email Subject and Body
:*Campaign > Registration Email, Subject and Body (OR a page is built in page management and the "Registration Email Page ID" is pointing to that page)
:*Ecommerce > Invoice Header, Footer, Subject and Emails (OR a page is built in page management and the "Checkout (Confirmation) Email Page ID" is pointing to that page)
:*Users > Lost password header, footer, email, subject
;All Forwards Are Completed (and Pages for which are created):
:*Page Management > Search Page Id; 404 (not found) Page Id
:*Campaigns > Opt In / Out Success / Failure Urls
:*Ecommerce > Cart and Checkout Process Page Ids (all a required except "Checkout (Confirmation) Email Page ID")
:*Users > Fail Access Authorization URL; Login Successfully URL; Fail Attempted Login URL; Logout URL; Password Expired Link; Create Account Link; Edit Account Link

===Template Links Tested===
''Click ALL links for a page for every template and verify they link to their target. If links appear / disappear or change based on different conditions (logged in, logged out, appear in a loop such as children, appear when cart has items or meets certain conditions, etc) be sure to test under each condition to ensure link operates correctly''

===Process Flow Tested===
;Navigation Flow:
:*Start at a CNAV category > Category page > Product line page > product page
:*Enter Search Keywords > Search > Select a product
;Email Registration Flow:
:*Enter email into newsletter field > Newsletter registration page > registration complete page > check the email received
;Purchase Flow (after completing all orders, log into administration to check if order is displayed correct and complete):
:*WHILE LOGGED OUT: Add one product utilizing each product template built to the shopping cart > checkout registration (continue as guest) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED OUT: Add one product to the shopping cart > checkout registration (create account) > create account page > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED OUT: Add one product to the shopping cart > checkout registration (log in) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED IN: Add one product to the shopping cart > (should skip checkout registration) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
;Account Management:
:*WHILE LOGGED OUT: Select ALL "Your Account" links/buttons, verify they go to login form.
:*WHILE LOGGED OUT: Your Account > Create Account > Your Account Page
:*WHILE LOGGED OUT: Your Account > Log in > Your Account Page
:*WHILE LOGGED OUT: Your Account > Forgotten Password > Submit Incorrect Email > Verify Error Message
:*WHILE LOGGED OUT: Your Account > Forgotten Password > Submit Correct Email > Verify Following Page and Receipt of email with correct content
:*WHILE LOGGED IN: Select ALL "Your Account" links/buttons. Verify they all go to "Your Account Page"
:*Add one address, edit one address and delete one address from the address book
:*View an order through order history
:*Change your name and password in the edit account form
===Custom Forms Tested===
:*Enter samples into ALL custom forms built for the web site.
:*Verify each form has the 'form type' set to a unique value that will be easy for the client to use when looking up forms in the 'form submissions' area of administration.
:*Look up the submissions in the 'form submissions' area of administration, verify all the fields entered passed correctly.
:*Verify all email recipients specified in the custom form received the emails with the fields correctly filled out.
:*For each form, if newsletter subscription is used, submit the form TWICE (once subscribing, once not) and verify the subscription took by looking them up in the 'subscriptions' area of administration. Follow the newsletter registration process to completion, verify the process works as intended and all content during the course of :*the process is as the client wishes.
===Custom Development Tested===
Test all CUSTOM processes / templates / functions created for client as per the contract. Use testing criteria for evaluation.

Attn: Template Integrators

2009-04-21T12:49:33Z

71.163.185.8: added all your account links/buttons procs

=Before Site Development=

==Site Configuration==
Set up for proper shipping method. Adjust cart accordingly (don't need zip code entry if using level shipping, don't need shipping selection if only one shipping method is available).

==Testing Criteria==
Generate testing criteria with the client, these will be your measurements of success. Testing criteria will start with the new site checklist below - augment this list with custom functions and templates built for the client. Create at least one testing scenario for each custom function / template possible conditions. If the function / template is to effect other site areas (cart, checkout, orders, importing / exporting) be sure to include a process flow test to ensure those other functions are impacted correctly.

==During Site Development==
===For ANY deviations made from the designs===
*Email the client, verify response
*Note in the code when / how the client was notified of the change.

=After Site Completion=

==New Site Checklist==

===Templates Adjusted to Match Config Settings===
*Shopping cart shipping only shows zip code if using Fedex shipping
*Shopping cart shipping only has option box if more than one shipping method is available

===Address Collection Form Homogeneity===
''Address forms should all have same fields AND validation rules, also that all pages that display addresses include all these fields''
*Create account (if address is included)
*Address book
*Checkout Billing
*Checkout Shipping
*Order Confirmation
*Viewable / Printable Invoice
*Emailed Invoice

===Page Accessibility Conditions are Enforced===
;cannot view while logged OUT:
:*Your Account
:*Edit Account
:*Address Book
:*Order History
;cannot view while logged IN:
:*Welcome (checkout registration)
:*Create Account
:*Lost Password

===Settings Completed===
;All Email Content Entered:
:*Page Management > Send 2 Friend Email Subject and Body
:*Campaign > Registration Email, Subject and Body (OR a page is built in page management and the "Registration Email Page ID" is pointing to that page)
:*Ecommerce > Invoice Header, Footer, Subject and Emails (OR a page is built in page management and the "Checkout (Confirmation) Email Page ID" is pointing to that page)
:*Users > Lost password header, footer, email, subject
;All Forwards Are Completed (and Pages for which are created):
:*Page Management > Search Page Id; 404 (not found) Page Id
:*Campaigns > Opt In / Out Success / Failure Urls
:*Ecommerce > Cart and Checkout Process Page Ids (all a required except "Checkout (Confirmation) Email Page ID")
:*Users > Fail Access Authorization URL; Login Successfully URL; Fail Attempted Login URL; Logout URL; Password Expired Link; Create Account Link; Edit Account Link

===Template Links Tested===
''Click ALL links for a page for every template and verify they link to their target. If links appear / disappear or change based on different conditions (logged in, logged out, appear in a loop such as children, appear when cart has items or meets certain conditions, etc) be sure to test under each condition to ensure link operates correctly''

===Process Flow Tested===
;Navigation Flow:
:*Start at a CNAV category > Category page > Product line page > product page
:*Enter Search Keywords > Search > Select a product
;Email Registration Flow:
:*Enter email into newsletter field > Newsletter registration page > registration complete page > check the email received
;Purchase Flow (after completing all orders, log into administration to check if order is displayed correct and complete):
:*WHILE LOGGED OUT: Add one product utilizing each product template built to the shopping cart > checkout registration (continue as guest) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED OUT: Add one product to the shopping cart > checkout registration (create account) > create account page > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED OUT: Add one product to the shopping cart > checkout registration (log in) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED IN: Add one product to the shopping cart > (should skip checkout registration) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
;Account Management:
:*WHILE LOGGED OUT: Select ALL "Your Account" links/buttons, verify they go to login form.
:*WHILE LOGGED OUT: Your Account > Create Account > Your Account Page
:*WHILE LOGGED OUT: Your Account > Log in > Your Account Page
:*WHILE LOGGED IN: Select ALL "Your Account" links/buttons. Verify they all go to "Your Account Page"
:*Add one address, edit one address and delete one address from the address book
:*View an order through order history
:*Change your name and password in the edit account form
===Custom Forms Tested===
:*Enter samples into ALL custom forms built for the web site.
:*Verify each form has the 'form type' set to a unique value that will be easy for the client to use when looking up forms in the 'form submissions' area of administration.
:*Look up the submissions in the 'form submissions' area of administration, verify all the fields entered passed correctly.
:*Verify all email recipients specified in the custom form received the emails with the fields correctly filled out.
:*For each form, if newsletter subscription is used, submit the form TWICE (once subscribing, once not) and verify the subscription took by looking them up in the 'subscriptions' area of administration. Follow the newsletter registration process to completion, verify the process works as intended and all content during the course of :*the process is as the client wishes.
===Custom Development Tested===
Test all CUSTOM processes / templates / functions created for client as per the contract. Use testing criteria for evaluation.

Page Templates:Examples

2009-04-15T17:37:49Z

71.163.185.8: added conversion tracking, analytics extras

==Some Template Examples==
{{Page Template Managers Shortcuts}}
:*[[Page Templates:Creating Your First Template]]

*Content
:*[[Page Templates:Creating a Basic Template]]
:*[[Page Templates:Creating a Category Template]]
:*[[Page Templates:Creating a Product Template]]

*Checkout Process:
:*[[Page Templates:Creating Shopping Cart Template]]
:*[[Page Templates:Creating a Registration Template]]
:*[[Page Templates:Creating a Billing Address Template]]
:*[[Page Templates:Creating a Shipping Address Template]]
:*[[Page Templates:Creating a Payment Template]]
:*[[Page Templates:Creating a Confirmation Template]]
:*[[Page Templates:Creating an Order Complete Template]]

*Account Management:
:*[[Functions:userAccountAndAddressCreate|Page Templates:Creating a "Create Account" Template]]
:*[[Page Templates:Login Form|Page Templates:Log In Form]]
:*[[Page Templates: Your Account]]
:*[[Functions:userAccountEdit|Page Templates:Creating a "Edit Account" Template]]
:*[[Page Templates:Creating a Address Book Management Template]]
:*[[Page Templates:Creating a Order History Template]]
:*[[Page Templates:Creating a Wishlist Template]]
:*[[Pages:Lost Password Page]]

*Web 2.0
:*[[Pages:Custom Forms|Creating a Custom Form]]
:*[[Pages Templates:Forum|Creating a Forum / Comments Template]]

*Extra Features
:*[[Page Templates:Exit Pop-ups]]
:*[[Page Templates:Bookmarking]]
:*[[Page Templates:Ajax (layer) Pop-ups]]
:*[[Page Templates:Ajax (live) Product Pricing]]
:*[[Page Templates:TEM Conversion Tracking]]
:*[[Page Templates:Google Analytics]]
:*[[Page Templates:Google eCommerce Conversion Tracking]]

Page Templates:Examples

2009-04-15T17:36:27Z

71.163.185.8: added order complete template

Upgrade Requests / Bugs

2009-04-15T17:34:16Z

71.163.185.8: added dBugwrapper to all functions

*Additional field to shared option groups - so it can have a name that is not the same as it's displayed title.
*Increments for products (visitor must buy in allotted increment)
*Coupon Memory - have the system remember coupon codes entered that where not qualified for, automatically apply coupon as soon as cart qualifies.
*Checkbox to discounts that allow an item to ignore the ‘only 1 discount per cart’ command.
*Text field in discounts for non-qualifying codes that will go into queue, when application is attempted.
*Banner Zones controlled by url data passed (tell a zone to display a specific banner), command expires after order is complete
*Banner repository queue to hold attempted, but unqualified, discount codes, attempt to re-apply with each cart modification.
*Tiered discounts for BOTH % and $ off.
*Checkout modifications to support non-pay accounts, po numbers.
*Cart check function, checks all items, shipping, discounts in cart to make sure they all still qualify, if any do not, remove and display message to visitor.
*Order management to allow product option changes.
*Auto deletion of expired data including: incomplete carts, searches, send2friend, banner tracking, campaign tracking, page views, user sessions.
*Export/Import templates (to duplicate BETWEEN sites)
*Audit all queries to confirm 'best practices' used with strings - see referencePHP
*Add items to cart right on product page (AJAX solution)
*Persistent right column cart throughout checkout
*Confirmation "Thank You" page should have cross-sell that can be "added to your order automatically" and possibly allow the items to be added without any additional shipping charges.
*Banner management should be reworked. Chris Ziter writing up details.
*Print all option for groups of invoices in order management
*Duplicate function in discounts
*Search ability in discounts
*Category application to discounts
*Delete campaigns in banner management
*dBug wrapper to ALL functions.

;Completed:
*2/5/2009: Free item alterations, store items as $0, pass controls that allow design changes for these items when presented in cart, etc.
*2/9/2009: When a visitor enters an email/name to register for the newsletter, and the billing/shipping addresses are blank, attach the email/name to the billing/shipping addresses in the order.
*2/13/2008: Reliable exit pop up
*2/16/2008: TEM channelId control for the order process (abandoned cart) manageable through admin console.
*2/18/2008: TEM custom image generation field set up

;In Progress:
*Catalog quick order

Page Templates:Creating a Confirmation Template

2009-04-15T17:17:44Z

71.163.185.8: added some missing $securedSiteUrl links

{{Page Template Managers Shortcuts}}
The confirmation / review template shows the visitor all the order information and provided a link to process the order / payment.

After creating the template, setup a page for it. Place the pageId of this new page in Settings > eCommerce tab: "Confirmation Page Id"

Sample content is below:

<source lang="php">

// get order data
$orderArray = eV::orderGetCompleteArray();

// shortcut order info
$orderArr = $orderArray['order'];
// short cut payment info
$payArr = $orderArray['payments'][0];
// short cut the item info
$itemArr = $orderArray['items'];
// short cut shipping address info
$shipArr = $itemArr[0];
// shortcut discount data
$discArr = $orderArray['discounts'];

// output shipping address
echo "<br>Shipping to: ";
// link to change shipping address
// prepend URLs with $securedSiteUrl to ensure the link uses the SSL site link
echo "<br><a href=\"$securedSiteUrl/index.php?fa=ORDER.checkoutShipping\">EDIT</a>";
// shipping address data
echo "<br>" . $shipArr['firstName'] . " " . $shipArr['lastName'] . "
<br>" . $shipArr['street1'] . "
<br>" . $shipArr['street2'] . "
<br>" . $shipArr['city'] . ", " . $shipArr['state'] . " " . $shipArr['zipCode'] . "
<br>" . $shipArr['country'];

// shipping instructions
echo "<br>Instructions: ";
echo "<br>" . $shipArr['instructions'];

// output billing address
echo "<br>Billing Method: ";
// link to change billing address
// prepend URLs with $securedSiteUrl to ensure the link uses the SSL site link
echo "<br><a href=\"$securedSiteUrl/index.php?fa=ORDER.checkoutBilling\">EDIT</a>";
// billing adddress data
echo "<br>" . $payArr['firstName'] . " " . $payArr['lastName'] . "
<br>" . $payArr['street1'] . "
<br>" . $payArr['street2'] . "
<br>" . $payArr['city'] . ", " . $payArr['state'] . " " . $payArr['zipCode'] . "
<br>" . $payArr['country'];

// output items in shopping cart
echo "<br>Items: ";
// link to go back to cart
// prepend URLs with $securedSiteUrl to ensure the link uses the SSL site link
echo "<br><a href=\"$securedSiteUrl/index.php?ORDER.cartView\">EDIT</a>";
// loop thru items
foreach($itemArr as $item){
// link back to product page
// note we can pass the productId in the URL and it will find the first page with that product in it
// prepend link with $siteUrl to direct back to product page, but out of SSL
echo "<br><a href=\"$siteUrl/index.php?productId=" . $item['productId'] . "\">" . $item['productName'] . "</a>";
echo " Item #: " . $item['sku'];
if($item['isDiscontinued']) echo " Discontinued ";
echo $item['quantity'] . " x " . eV::dollarFormat($item['pricePer']) . " = " . eV::dollarFormat($item['quantity'] * $item['pricePer']);
echo "<br>" . $item['cartDescription'];
};

// output item total
// this is the merchandise total for all the items in the cart added up
echo "<br>Merchandise Total: " . eV::dollarFormat($orderArr['itemTotal']);

// output shipping method
echo "<br>Shipping Method: " . $shipArr['shipTypeCode'] . ": " . $shipArr['shipType'];
// shipping cost
echo "<br>Shipping Cost: " . eV::dollarFormat($orderArr['shippingTotal']);

// discount form to submit discount
// start discount form
// prepend URLs with $securedSiteUrl to ensure the link uses the SSL site link
echo " <form action=\"$securedSiteUrl/index.php\" method=\"post\" name=\"discountForm\">";
echo "<br>Enter Promo Code: <input name=\"discountCode\" type=\"text\" size=\"7\" />";
echo "<input type=\"submit\" value=\"Apply Code\">";

// output codes already applied
foreach($discArr as $disc) echo "<br>" . $disc['discountCode'] . ": " . $disc['description'] . " :" . eV::dollarFormat($disc['amount']);

// tax and total
echo "<br>Tax: " . eV::dollarFormat($orderArr['taxTotal']);
echo "<br>Order Total: " . eV::dollarFormat($orderArr['grandTotal']); // use 'totalDue' if accepting partial payments, this will show how much it oustanding instead of total amount

// payment method info
echo "<br>Payment Method: ";
// payment edit link
// prepend URLs with $securedSiteUrl to ensure the link uses the SSL site link
echo "<br><a href=\"$securedSiteUrl/index.php?fa=ORDER.checkoutPayment\">EDIT</a>";
// payment data
echo "<br>**** **** **** " . substr($payArr['accountNumber'],(strlen($payArr['accountNumber'])-4),4);
echo "<br>Expires: " . date('m/Y',strtotime($payArr['expDate']));

// process order link
echo "<br><a href=\"$securedSiteUrl/index.php?fa=ORDER.process\">PROCESS ORDER</a>";

</source>

Template:Page Template Functions Shortcuts

2009-04-15T16:56:56Z

71.163.185.8: added orderGetIdFromNumber

<table align=right style="background-color: #DDDDDD;" cellpadding=0 cellspacing=0 border=0>
<tr>
<td valign=top>
{{Page Template Managers Shortcuts}}
</td>
</tr>
<tr>
<td valign=top>
[[Page Templates:Functions|Page Template Functions]]
*[[functions:addressCountryOptions|addressCountryOptions]]
*[[functions:addressCountryNameGet|addressCountryNameGet]]
*[[functions:addressStateOptions|addressStateOptions]]
*[[functions:addressZipDetailsGet|addressZipDetailsGet]]
*[[functions:authorizeIsLoggedIn|authorizeIsLoggedIn]]
*[[functions:authorizeIsLoggedOut|authorizeIsLoggedOut]]
*[[functions:captchaCheck|captchaCheck]]
*[[functions:catalogProductsGet|catalogProductsGet]]
*[[functions:continueShoppingGet|continueShoppingGet]]
*[[functions:continueShoppingSet|continueShopppingSet]]
*[[functions:dollarFormat|dollarFormat]]
*[[functions:fullyQualifyAllURLs|fullyQualifyAllURLs]]
*[[functions:ipBlockCheck|ipBlockCheck]]
*[[functions:itemLayout_dataString2Array|itemLayout_dataString2Array]]
*[[functions:mysqlquery2array|mysqlquery2array]]
*[[functions:orderExpDateOptions|orderExpDateOptions]]
*[[functions:orderGetCompleteArray|orderGetCompleteArray]]
*[[functions:orderGetEmail|orderGetEmail]]
*[[functions:orderGetFirstName|orderGetFirstName]]
*[[functions:orderGetIdFromNumber|orderGetIdFromNumber]]
*[[functions:orderGetPayTypes|orderGetPayTypes]]
*[[functions:orderGetShipArray|orderGetShipArray]]
*[[functions:orderGetSummary|orderGetSummary]]
*[[functions:ordersGetList|ordersGetList]]
*[[functions:orderPayTypeOptions|orderPayTypeOptions]]
*[[functions:orderShipFedexRate|orderShipFedexRate]]
*[[functions:orderShipAdjustRate|orderShipAdjustRate]]
*[[functions:pageBreadcrumbsFamilyGet|pageBreadcrumbsFamilyGet]]
*[[functions:pageBreadcrumbsHistoryGet|pageBreadcrumbsHistoryGet]]
*[[functions:pageChildrenGet|pageChildrenGet]]
*[[functions:pageContentAttribSet|pageContentAttribSet]]
*[[functions:pageContentAttribsSet|pageContentAttribsSet]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribStart]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribEnd]]
*[[functions:pageCustomSearchGroup|pageCustomSearchGroup]]
*[[functions:pageForumPostsGet|pageForumPostsGet]]
*[[functions:pageGet|pageGet]]
*[[functions:pageGetHomeId|pageGetHomeId]]
*[[functions:pageMenuGet|pageMenuGet]]
*[[functions:pagePollQuestionsGet|pagePollQuestionsGet]]
*[[functions:pagePollResultsGet|pagePollResultsGet]]
*[[functions:pageProductsGet|pageProductsGet]]
*[[functions:pageSearchGet|pageSearchGet]]
*[[functions:pageZoneGet|pageZoneGet]]
*[[functions:pagination|pagination]]
*[[functions:phpObjToJS|phpObjToJS]]
*[[functions:prodArrayToJS|prodArrayToJS]]
*[[functions:prodOptionString2Array|prodOptionString2Array]]
*[[functions:recentlyViewedAdd|recentlyViewedAdd]]
*[[functions:recentlyViewedGet|recentlyViewedGet]]
*[[functions:redirect|redirect]]
*[[functions:TEMConversionTag|TEMConversionTag]]
*[[functions:userAccountAndAddressCreate|userAccountAndAddressCreate]]
*[[functions:userAccountEdit|userAccountEdit]]
*[[functions:userAddressAddEdit|userAddressAddEdit]]
*[[functions:userBlogEntriesGet|userBlogEntriesGet]]
*[[functions:userBlogEntryAddEdit|userBlogEntryAddEdit]]
*[[functions:userBlogSetup|userBlogSetup]]
*[[functions:userFriendsGet|userFriendsGet]]
*[[functions:userGetAddresses|userGetAddresses]]
*[[functions:userWishListGet|userWishListGet]]
*[[functions:usersAmbassadorGet|usersAmbassadorGet]]
*[[functions:usersGet|usersGet]]
*[[functions:valueArrayFromQuery|valueArrayFromQuery]]
*[[functions:verifyEmail|verifyEmail]]
</td>
</tr>
</table>

Upgrade Requests / Bugs

2009-04-14T12:53:00Z

71.163.185.8:

*Additional field to shared option groups - so it can have a name that is not the same as it's displayed title.
*Increments for products (visitor must buy in allotted increment)
*Coupon Memory - have the system remember coupon codes entered that where not qualified for, automatically apply coupon as soon as cart qualifies.
*Checkbox to discounts that allow an item to ignore the ‘only 1 discount per cart’ command.
*Text field in discounts for non-qualifying codes that will go into queue, when application is attempted.
*Banner Zones controlled by url data passed (tell a zone to display a specific banner), command expires after order is complete
*Banner repository queue to hold attempted, but unqualified, discount codes, attempt to re-apply with each cart modification.
*Tiered discounts for BOTH % and $ off.
*Checkout modifications to support non-pay accounts, po numbers.
*Cart check function, checks all items, shipping, discounts in cart to make sure they all still qualify, if any do not, remove and display message to visitor.
*Order management to allow product option changes.
*Auto deletion of expired data including: incomplete carts, searches, send2friend, banner tracking, campaign tracking, page views, user sessions.
*Export/Import templates (to duplicate BETWEEN sites)
*Audit all queries to confirm 'best practices' used with strings - see referencePHP
*Add items to cart right on product page (AJAX solution)
*Persistent right column cart throughout checkout
*Confirmation "Thank You" page should have cross-sell that can be "added to your order automatically" and possibly allow the items to be added without any additional shipping charges.
*Banner management should be reworked. Chris Ziter writing up details.
*Print all option for groups of invoices in order management
*Duplicate function in discounts
*Search ability in discounts
*Category application to discounts
*Delete campaigns in banner management

;Completed:
*2/5/2009: Free item alterations, store items as $0, pass controls that allow design changes for these items when presented in cart, etc.
*2/9/2009: When a visitor enters an email/name to register for the newsletter, and the billing/shipping addresses are blank, attach the email/name to the billing/shipping addresses in the order.
*2/13/2008: Reliable exit pop up
*2/16/2008: TEM channelId control for the order process (abandoned cart) manageable through admin console.
*2/18/2008: TEM custom image generation field set up

;In Progress:
*Catalog quick order

Upgrade Requests / Bugs

2009-04-14T12:48:19Z

71.163.185.8:

*Additional field to shared option groups - so it can have a name that is not the same as it's displayed title.
*Increments for products (visitor must buy in allotted increment)
*Coupon Memory - have the system remember coupon codes entered that where not qualified for, automatically apply coupon as soon as cart qualifies.
*Checkbox to discounts that allow an item to ignore the ‘only 1 discount per cart’ command.
*Text field in discounts for non-qualifying codes that will go into queue, when application is attempted.
*Banner Zones controlled by url data passed (tell a zone to display a specific banner), command expires after order is complete
*Banner repository queue to hold attempted, but unqualified, discount codes, attempt to re-apply with each cart modification.
*Tiered discounts for BOTH % and $ off.
*Checkout modifications to support non-pay accounts, po numbers.
*Cart check function, checks all items, shipping, discounts in cart to make sure they all still qualify, if any do not, remove and display message to visitor.
*Order management to allow product option changes.
*Auto deletion of expired data including: incomplete carts, searches, send2friend, banner tracking, campaign tracking, page views, user sessions.
*Export/Import templates (to duplicate BETWEEN sites)
*Audit all queries to confirm 'best practices' used with strings - see referencePHP
*Add items to cart right on product page (AJAX solution)
*Persistent right column cart throughout checkout
*Confirmation "Thank You" page should have cross-sell that can be "added to your order automatically" and possibly allow the items to be added without any additional shipping charges.
*Banner management should be reworked. Chris Ziter writing up details.
*Print all option for groups of invoices in order management

;Completed:
*2/5/2009: Free item alterations, store items as $0, pass controls that allow design changes for these items when presented in cart, etc.
*2/9/2009: When a visitor enters an email/name to register for the newsletter, and the billing/shipping addresses are blank, attach the email/name to the billing/shipping addresses in the order.
*2/13/2008: Reliable exit pop up
*2/16/2008: TEM channelId control for the order process (abandoned cart) manageable through admin console.
*2/18/2008: TEM custom image generation field set up

;In Progress:
*Catalog quick order

Page Templates:Creating a Registration Template

2009-04-13T12:58:02Z

71.163.185.8:

{{Page Template Managers Shortcuts}}
The registration template is very basic. It requires a login form and links to the forgotten password and create account pages. It is recommended a check is done to see if the user is logged in and forward them to the next step in the checkout if they are.

After creating the template, setup a page for it. Place the pageId of this new page in Settings > eCommerce tab: "Registration Page Id"

Sample content is below:

<source lang="php">
// check if user is logged in
// using the core variable isLoggedIn
// and the redirect function
// sending to the shipping checkout page
// sometiems clients want billing address before shipping, simply change to ORDER.checkoutBilling if that is the case
if($isLoggedIn) eV::redirect($iProducts['securedSiteUrl'] . 'index.php?fa=ORDER.checkoutShipping');

// display message (this will contain login errors, etc, if the forms point failures back to this page)
if(!empty($message)) echo "<p><font color=\"red\">$message</font></p>";

// output form and links
// sometiems clients want billing address before shipping, simply change to ORDER.checkoutBilling if that is the case
// note the $securedSiteURL attribute in the anchor tag - this will retrieve the value in settings for the Secure Site URL
echo "
<a href=\"" . $iProducts['securedSiteUrl']. "/index.php?fa=ORDER.checkoutShipping\">Checkout Without Logging In</a>

<hr>

Log In:
// note the $securedSiteURL attribute in the form action - this will retrieve the value in settings for the Secure Site URL
<form action=\"" . $iProducts['securedSiteUrl']. "/index.php\" method=\"post\" name=\"registeredLoginForm\">

<br>Email Address:
<input name=\"emailAddress\" size=\"20\" type=\"text\" />

<br>Password:
<input name=\"password\" size=\"20\" type=\"password\" />


<br><a href=\"index.php?pageId=1223\">Forgot your password</a>

<br><input type=\"submit\" value=\"Log In\">


<input name=\"fa\" type=\"hidden\" value=\"USER.login\" />



<input name=\"redirect\" type=\"hidden\" value=\"" . $iProducts['securedSiteUrl']. "/index.php?fa=ORDER.checkoutShipping&message=You have successfully logged in\" />


<input name=\"redirectOnFailure\" type=\"hidden\" value=\"" . $iProducts['securedSiteUrl']. "/index.php?fa=ORDER.register&message=Login Failure\" />

</form>

<hr>
Don't have an account?




<br><a href=\"" . $iProducts['securedSiteUrl']. "/index.php?pageId=2&redirect=index.php%3Ffa%3DORDER.checkoutShipping\">CLICK HERE</a> to create one



<form action=\"" . $iProducts['securedSiteUrl']. "/index.php\" method=\"POST\" name=\"createAccountForm\">
<br>Create an Account
<br>Email Address:
<input name=\"emailAddress\" type=\"text\" size=\"50\" maxlength=\"255\">

<input type=\"hidden\" name=\"pageId\" value=\"123\">

<input type=\"hidden\" name=\"redirect\" value=\"" . $iProducts['securedSiteUrl']. "/index.php?fa=ORDER.checkoutShipping&message=Your account has been created\">
<input type=\"submit\" value=\"Create an account\">
</form>

";
</source>

Page Templates:Creating a Shopping Cart Template

2009-04-13T12:56:51Z

71.163.185.8:

{{Page Template Managers Shortcuts}}
== Create shopping cart template ==

Below is an example shopping cart template:

<source lang="php">

// shopping cart

// get our order info
$completeOrderArray = eV::orderGetCompleteArray($_SESSION['order']['orderId']);

// shortcut the assoc arrays returned, easier to reference later
$orderArr = $completeOrderArray['order'];
$itemArr = $completeOrderArray['items'];
$discountArr = $completeOrderArray['discounts'];
// payment info not usually shown in cart, but for the sake of this example ill shortcut it also
$paymentArr = $completeOrderArray['payments'];

// get shipping information to be used in shipping selection
// first set a blank array
$shipArr = array();
// than populate the array onlyy if items are in the cart
// this will error out with no items in cart as the attempt...
// ... to get the zip code from an invalid item index will error
// note we pass the zip code from the first item - ship addresses are tied to items
// note we get the weightTotal from the orderArr

// below is a sample call if we are using zip, weight based shipping:
if(!empty($itemArr)) $shipArr = eV::orderGetShipArray(NULL,$itemArr[0]['zipCode'],$orderArr['weightTotal']);

// below is a smple call if we are using shipping levels
// which are $ based, not ship / weight based
if(!empty($itemArr)) $shipArr = eV::orderGetShipArray($orderArr['itemTotal']);

// link to continue checkout process
// note we only show it if items are in the cart. No reason to checkout on empty cart
// note we are using the redirectIfRegistered attribute to have user skip this page if they are registered (logged in) and go directly to the checkoutBilling page
// if your checkout order is shipping BEFORE billing be sure to change the redirect to ORDER.checkoutShipping
// note the $securedSiteURL attribute in the anchor tag - this will retrieve the value in settings for the Secure Site URL
if(count($itemArr) > 0) echo "<a href=\"" . $iProducts['securedSiteUrl']. "/index.php?fa=ORDER.register&redirectIfRegistered=" . rawurlencode('index.php?fa=ORDER.checkoutBilling') . "\">CONTINUE CHECKOUT</a>";

// start the cart form
echo "<form action=\"index.php\" method=\"post\" name=\"cartForm\">";
// hidden attrib - rrquired for cart form, tells it what to do when submitted
echo "<input type=\"hidden\" name=\"fa\" value=\"ORDER.cartUpdate\">";

// display any messages passed into the cart
// this will show notification messages to the shopper, such as when they add discounts to the cart, or a discount gets dropped because they no longer qualify, etc...
if(!empty($message)) echo "<hr>$message";

// drop a message that the cart is empty if nothing is in it
if(count($itemArr) == 0) {
echo "<hr>Your cart is empty";
} else {
// something in it? well lets let visitor know what we are about to display
echo "<hr>Cart Items:";
};

// alrighty lets loop thru items in cart and display them
foreach($itemArr as $item){
// link back to product
// note we can pass the productId in the URL and the system will find the first page that contains that product
echo "<br><a href=\"index.php?productId=" . $item['productId'] . "\">" . $item['productName'] . "</a>";

// display the cart description, only if it has value
if(!empty($item['cartDescription'])) echo "<br>" . $item['cartDescription'];

// does this item have options? lets spit em out then....
if(count($item['options']) > 0){
echo "<br>";
// loop through the options
foreach($item['options'] as $option){
// display the option
echo $option['groupName'] . ": " .$option['title'] . " ";
// if item has a dollar value associated with it, lets show that also...
// the dollarFormat function is a quick shortcut to turn an int/float into a dollar formatted output
if(floatval($option['price']) > 0) echo "(+" . eV::dollarFormat($option['price']) . ") ";
// end looping through options
};
// end if we have options
};

// display the item sku
// the item sku is the full appended sku including the productNumber + all option skus
echo "<br>Item #: " . $item['sku'];

// ONLY SHOW the quantity field and remove link IF THIS IS NOT a free item due to a discount code
// also show "FREE" instead of $0 for line total, if it is a free item due to a discount code
if(empty($item['freeItem_discountId'])){
// quantity field
// note the name is quantity# where # is the itemId
// This tells the recieving script what quantity to change
echo "<input name=\"quantity" . $item['itemId'] . "\" value=\"" . $item['quantity'] . "\" type=\"text\" size=\"5\" />";
// update link
// this link just submits the form
// all quantities will be updates upon form submittion
// the single update function tries to update quantities, discounts and shipping selection
echo "<a href=\"javascript:window.document.cartForm.submit();\">UPDATE</a> ";

// remove link
// this does the same thing as submitting the quantity form...
// except it instructs one item quantity to be set to 0...
// which the system will use as a queue to drop the item all together
// note that other item's quantities are not passed here...
// if not passed, the system will leave thier quantity as is
echo "<a href=\"index.php?fa=ORDER.cartUpdate&quantity" . $item['itemId'] . "=0\">REMOVE</a> ";
// output the price per item and the total price (quantity x pricePer)
echo "x " . eV::dollarFormat($item['pricePer']) . " = " . eV::dollarFormat(($item['pricePer'] * $item['quantity']));
} else {
// if this is a free item, lets display FREE instead of $0
echo " FREE ";
};

// end looping through items
};

// merchandise total
echo "<hr>TOTAL:" . eV::dollarFormat($orderArr['itemTotal']);

// add a discount/coupon form field
echo "<hr>Enter Coupon Here: <input name=\"discountCode\" type=\"text\" size=\"15\" /> ";

// link to post discount
// note this link submits the cart form...
// this means that all quantities will be updated as well based on entries above
// and vice-verse if a discount is entered and the update is clicked for a quantity...
// the system will attempt to apply the discount
// the single update function tries to update quantities, discounts and shipping selection
echo "<a href=\"javascript:window.document.cartForm.submit();\">APPLY</a>";

// display the discounts
// loop thru discount array
foreach ($discountArr as $disc){

// discount the discount code
// this is the same code entered by the user to apply the discount
echo "<br>Discount: " . $disc['discountCode'];

// display a link to remove the discount
// this is necessary as some discounts will not work with other discounts in the cart
// also admins can set the carts to only allow one discount per order in Settings
echo " <a href=\"index.php?fa=ORDER.discountRemove&discountId=" . $disc['discountId'] . "\">remove</a> ";

// discount description
echo $disc['description'];

// discount value
// note we add the negative "-" sign
// as all discount values are in the array as positive numbers
// only show this discount amount if it isn't $0 (free product discounts will show as $0)
if($disc['amount'] > 0) echo " -" . eV::dollarFormat($disc['amount']);

// end loop through discounts
};

// shipping options
// lets only display if there are items in the cart
if(count($itemArr) > 0){

echo "<hr>Select Shipping Option: ";
// shipping option select field
// note the name of the field "shipping4addressId#...
// .. this is to support multiple shipping addresses with different ship methods...
// .. a future function
// also note that the address and shipping data are attached to the item(s)
// we call on the sale_addressId from the first item since we are not using multi-shipto-addresses
// only need this field if multiple shipping options for visitor, otherwise don't include
echo "<select name=\"shipping4addressId" . $itemArr[0]['sale_addressId'] . "\">";
// loop thru each shipping option and display as an option
for($i=0;$i<count($shipArr);$i++){
// start the option box, set the typeCode as the value
echo "<option value=\"" . $shipArr[$i]['typeCode'] . "\"";
// if this matches the current ship method selected by user, than select this option
if($shipArr[$i]['typeCode'] == $itemArr[0]['shipTypeCode']) echo " selected ";
// complete the option box, display the full ship type and it's cost
echo ">" . $shipArr[$i]['type'] . " : " . eV::dollarFormat($shipArr[$i]['shipAmount']) . "</option>";
// end loop through shipping options
};

// close out the shipping select field
echo "\n</select>";

// zip code entry field for shipping
echo " Enter Zip Code: ";
// note we popoulate it with the zipCode from the first item in the cart
// only need zipCode here if using zip based shipping, like fedex
// level shipping is not zip code based, therefore dont need this field
echo "<input type=\"text\" name=\"zipCode\" value=\"" . $itemArr[0]['zipCode'] . "\" size=\"12\" maxlength=\"10\"> ";
// update link
// as before, updating the form will post changes to shipping, add discount and post changes to quantities
echo "<a href=\"javascript:window.document.cartForm.submit();\">update</a>";
// current shipping charge
echo " Shipping: " . eV::dollarFormat($orderArr['shippingTotal']);

// lets show the total due
echo "<hr>Total: " . eV::dollarFormat($orderArr['totalDue']);

// end if items in cart
};

// repeat link to continue checkout process
// note we only show it if items are in the cart. No reason to checkout on empty cart
// note we are using the redirectIfRegistered attribute to have user skip this page if they are registered (logged in) and go directly to the checkoutBilling page
// if your checkout order is shipping BEFORE billing be sure to change the redirect to ORDER.checkoutShipping
// note the $securedSiteURL attribute in the anchor tag - this will retrieve the value in settings for the Secure Site URL
if(count($itemArr) > 0) echo "<hr><a href=\"" . $iProducts['securedSiteUrl']. "/index.php?fa=ORDER.register&redirectIfRegistered=" . rawurlencode('index.php?fa=ORDER.checkoutBilling') . "\">CONTINUE CHECKOUT</a>";

// close out the form
echo "</form>";

</source>

== Create shopping cart page ==
; assign the new cart template to this page
; check the 'hide this page from in-site searches'
; post this page and take note of the page Id

== Set new page as shopping cart ==
; In settings > eCommerce tab: enter the pageId for the page just created into the "cart page id" field.
; post changes to settings

Page Templates:Creating a Confirmation Template

2009-04-13T12:56:18Z

71.163.185.8: added $securedSiteURL

{{Page Template Managers Shortcuts}}
The confirmation / review template shows the visitor all the order information and provided a link to process the order / payment.

After creating the template, setup a page for it. Place the pageId of this new page in Settings > eCommerce tab: "Confirmation Page Id"

Sample content is below:

<source lang="php">

// get order data
$orderArray = eV::orderGetCompleteArray();

// shortcut order info
$orderArr = $orderArray['order'];
// short cut payment info
$payArr = $orderArray['payments'][0];
// short cut the item info
$itemArr = $orderArray['items'];
// short cut shipping address info
$shipArr = $itemArr[0];
// shortcut discount data
$discArr = $orderArray['discounts'];

// output shipping address
echo "<br>Shipping to: ";
// link to change shipping address
echo "<br><a href=\"index.php?fa=ORDER.checkoutShipping\">EDIT</a>";
// shipping address data
echo "<br>" . $shipArr['firstName'] . " " . $shipArr['lastName'] . "
<br>" . $shipArr['street1'] . "
<br>" . $shipArr['street2'] . "
<br>" . $shipArr['city'] . ", " . $shipArr['state'] . " " . $shipArr['zipCode'] . "
<br>" . $shipArr['country'];

// shipping instructions
echo "<br>Instructions: ";
echo "<br>" . $shipArr['instructions'];

// output billing address
echo "<br>Billing Method: ";
// link to change billing address
echo "<br><a href=\"" . $iProducts['securedSiteUrl']. "/index.php?fa=ORDER.checkoutBilling\">EDIT</a>";
// billing adddress data
echo "<br>" . $payArr['firstName'] . " " . $payArr['lastName'] . "
<br>" . $payArr['street1'] . "
<br>" . $payArr['street2'] . "
<br>" . $payArr['city'] . ", " . $payArr['state'] . " " . $payArr['zipCode'] . "
<br>" . $payArr['country'];

// output items in shopping cart
echo "<br>Items: ";
// link to go back to cart
echo "<br><a href=\"" . $iProducts['securedSiteUrl']. "/index.php?ORDER.cartView\">EDIT</a>";
// loop thru items
foreach($itemArr as $item){
// link back to product page
// note we can pass the productId in the URL and it will find the first page with that product in it
echo "<br><a href=\"" . $iProducts['siteUrl']. "index.php?productId=" . $item['productId'] . "\">" . $item['productName'] . "</a>";
echo " Item #: " . $item['sku'];
if($item['isDiscontinued']) echo " Discontinued ";
echo $item['quantity'] . " x " . eV::dollarFormat($item['pricePer']) . " = " . eV::dollarFormat($item['quantity'] * $item['pricePer']);
echo "<br>" . $item['cartDescription'];
};

// output item total
// this is the merchandise total for all the items in the cart added up
echo "<br>Merchandise Total: " . eV::dollarFormat($orderArr['itemTotal']);

// output shipping method
echo "<br>Shipping Method: " . $shipArr['shipTypeCode'] . ": " . $shipArr['shipType'];
// shipping cost
echo "<br>Shipping Cost: " . eV::dollarFormat($orderArr['shippingTotal']);

// discount form to submit discount
// start discount form
echo " <form action=\"index.php\" method=\"post\" name=\"discountForm\">";
echo "<br>Enter Promo Code: <input name=\"discountCode\" type=\"text\" size=\"7\" />";
echo "<input type=\"submit\" value=\"Apply Code\">";

// output codes already applied
foreach($discArr as $disc) echo "<br>" . $disc['discountCode'] . ": " . $disc['description'] . " :" . eV::dollarFormat($disc['amount']);

// tax and total
echo "<br>Tax: " . eV::dollarFormat($orderArr['taxTotal']);
echo "<br>Order Total: " . eV::dollarFormat($orderArr['grandTotal']); // use 'totalDue' if accepting partial payments, this will show how much it oustanding instead of total amount

// payment method info
echo "<br>Payment Method: ";
// payment edit link
echo "<br><a href=\"index.php?fa=ORDER.checkoutPayment\">EDIT</a>";
// payment data
echo "<br>**** **** **** " . substr($payArr['accountNumber'],(strlen($payArr['accountNumber'])-4),4);
echo "<br>Expires: " . date('m/Y',strtotime($payArr['expDate']));

// process order link
echo "<br><a href=\"" . $iProducts['securedSiteUrl']. "/index.php?fa=ORDER.process\">PROCESS ORDER</a>";

</source>

Page Templates:Creating a Registration Template

2009-04-13T12:53:38Z

71.163.185.8: added $securedSiteURL

{{Page Template Managers Shortcuts}}
The registration template is very basic. It requires a login form and links to the forgotten password and create account pages. It is recommended a check is done to see if the user is logged in and forward them to the next step in the checkout if they are.

After creating the template, setup a page for it. Place the pageId of this new page in Settings > eCommerce tab: "Registration Page Id"

Sample content is below:

<source lang="php">
// check if user is logged in
// using the core variable isLoggedIn
// and the redirect function
// sending to the shipping checkout page
// sometiems clients want billing address before shipping, simply change to ORDER.checkoutBilling if that is the case
if($isLoggedIn) eV::redirect('index.php?fa=ORDER.checkoutShipping');

// display message (this will contain login errors, etc, if the forms point failures back to this page)
if(!empty($message)) echo "<p><font color=\"red\">$message</font></p>";

// output form and links
// sometiems clients want billing address before shipping, simply change to ORDER.checkoutBilling if that is the case
// note the $securedSiteURL attribute in the anchor tag - this will retrieve the value in settings for the Secure Site URL
echo "
<a href=\"$securedSiteURL/index.php?fa=ORDER.checkoutShipping\">Checkout Without Logging In</a>

<hr>

Log In:
// note the $securedSiteURL attribute in the form action - this will retrieve the value in settings for the Secure Site URL
<form action=\"$securedSiteURL/index.php\" method=\"post\" name=\"registeredLoginForm\">

<br>Email Address:
<input name=\"emailAddress\" size=\"20\" type=\"text\" />

<br>Password:
<input name=\"password\" size=\"20\" type=\"password\" />


<br><a href=\"index.php?pageId=1223\">Forgot your password</a>

<br><input type=\"submit\" value=\"Log In\">


<input name=\"fa\" type=\"hidden\" value=\"USER.login\" />



<input name=\"redirect\" type=\"hidden\" value=\"$securedSiteURL/index.php?fa=ORDER.checkoutShipping&message=You have successfully logged in\" />


<input name=\"redirectOnFailure\" type=\"hidden\" value=\"$securedSiteURL/index.php?fa=ORDER.register&message=Login Failure\" />

</form>

<hr>
Don't have an account?




<br><a href=\"$securedSiteURL/index.php?pageId=2&redirect=index.php%3Ffa%3DORDER.checkoutShipping\">CLICK HERE</a> to create one



<form action=\"index.php\" method=\"POST\" name=\"createAccountForm\">
<br>Create an Account
<br>Email Address:
<input name=\"emailAddress\" type=\"text\" size=\"50\" maxlength=\"255\">

<input type=\"hidden\" name=\"pageId\" value=\"123\">

<input type=\"hidden\" name=\"redirect\" value=\"$securedSiteURL/index.php?fa=ORDER.checkoutShipping&message=Your account has been created\">
<input type=\"submit\" value=\"Create an account\">
</form>

";
</source>

Page Templates:Creating a Shopping Cart Template

2009-04-13T12:51:08Z

71.163.185.8: added $securedSiteURL

{{Page Template Managers Shortcuts}}
== Create shopping cart template ==

Below is an example shopping cart template:

<source lang="php">

// shopping cart

// get our order info
$completeOrderArray = eV::orderGetCompleteArray($_SESSION['order']['orderId']);

// shortcut the assoc arrays returned, easier to reference later
$orderArr = $completeOrderArray['order'];
$itemArr = $completeOrderArray['items'];
$discountArr = $completeOrderArray['discounts'];
// payment info not usually shown in cart, but for the sake of this example ill shortcut it also
$paymentArr = $completeOrderArray['payments'];

// get shipping information to be used in shipping selection
// first set a blank array
$shipArr = array();
// than populate the array onlyy if items are in the cart
// this will error out with no items in cart as the attempt...
// ... to get the zip code from an invalid item index will error
// note we pass the zip code from the first item - ship addresses are tied to items
// note we get the weightTotal from the orderArr

// below is a sample call if we are using zip, weight based shipping:
if(!empty($itemArr)) $shipArr = eV::orderGetShipArray(NULL,$itemArr[0]['zipCode'],$orderArr['weightTotal']);

// below is a smple call if we are using shipping levels
// which are $ based, not ship / weight based
if(!empty($itemArr)) $shipArr = eV::orderGetShipArray($orderArr['itemTotal']);

// link to continue checkout process
// note we only show it if items are in the cart. No reason to checkout on empty cart
// note we are using the redirectIfRegistered attribute to have user skip this page if they are registered (logged in) and go directly to the checkoutBilling page
// if your checkout order is shipping BEFORE billing be sure to change the redirect to ORDER.checkoutShipping
// note the $securedSiteURL attribute in the anchor tag - this will retrieve the value in settings for the Secure Site URL
if(count($itemArr) > 0) echo "<a href=\"$securedSiteURL/index.php?fa=ORDER.register&redirectIfRegistered=" . rawurlencode('index.php?fa=ORDER.checkoutBilling') . "\">CONTINUE CHECKOUT</a>";

// start the cart form
echo "<form action=\"index.php\" method=\"post\" name=\"cartForm\">";
// hidden attrib - rrquired for cart form, tells it what to do when submitted
echo "<input type=\"hidden\" name=\"fa\" value=\"ORDER.cartUpdate\">";

// display any messages passed into the cart
// this will show notification messages to the shopper, such as when they add discounts to the cart, or a discount gets dropped because they no longer qualify, etc...
if(!empty($message)) echo "<hr>$message";

// drop a message that the cart is empty if nothing is in it
if(count($itemArr) == 0) {
echo "<hr>Your cart is empty";
} else {
// something in it? well lets let visitor know what we are about to display
echo "<hr>Cart Items:";
};

// alrighty lets loop thru items in cart and display them
foreach($itemArr as $item){
// link back to product
// note we can pass the productId in the URL and the system will find the first page that contains that product
echo "<br><a href=\"index.php?productId=" . $item['productId'] . "\">" . $item['productName'] . "</a>";

// display the cart description, only if it has value
if(!empty($item['cartDescription'])) echo "<br>" . $item['cartDescription'];

// does this item have options? lets spit em out then....
if(count($item['options']) > 0){
echo "<br>";
// loop through the options
foreach($item['options'] as $option){
// display the option
echo $option['groupName'] . ": " .$option['title'] . " ";
// if item has a dollar value associated with it, lets show that also...
// the dollarFormat function is a quick shortcut to turn an int/float into a dollar formatted output
if(floatval($option['price']) > 0) echo "(+" . eV::dollarFormat($option['price']) . ") ";
// end looping through options
};
// end if we have options
};

// display the item sku
// the item sku is the full appended sku including the productNumber + all option skus
echo "<br>Item #: " . $item['sku'];

// ONLY SHOW the quantity field and remove link IF THIS IS NOT a free item due to a discount code
// also show "FREE" instead of $0 for line total, if it is a free item due to a discount code
if(empty($item['freeItem_discountId'])){
// quantity field
// note the name is quantity# where # is the itemId
// This tells the recieving script what quantity to change
echo "<input name=\"quantity" . $item['itemId'] . "\" value=\"" . $item['quantity'] . "\" type=\"text\" size=\"5\" />";
// update link
// this link just submits the form
// all quantities will be updates upon form submittion
// the single update function tries to update quantities, discounts and shipping selection
echo "<a href=\"javascript:window.document.cartForm.submit();\">UPDATE</a> ";

// remove link
// this does the same thing as submitting the quantity form...
// except it instructs one item quantity to be set to 0...
// which the system will use as a queue to drop the item all together
// note that other item's quantities are not passed here...
// if not passed, the system will leave thier quantity as is
echo "<a href=\"index.php?fa=ORDER.cartUpdate&quantity" . $item['itemId'] . "=0\">REMOVE</a> ";
// output the price per item and the total price (quantity x pricePer)
echo "x " . eV::dollarFormat($item['pricePer']) . " = " . eV::dollarFormat(($item['pricePer'] * $item['quantity']));
} else {
// if this is a free item, lets display FREE instead of $0
echo " FREE ";
};

// end looping through items
};

// merchandise total
echo "<hr>TOTAL:" . eV::dollarFormat($orderArr['itemTotal']);

// add a discount/coupon form field
echo "<hr>Enter Coupon Here: <input name=\"discountCode\" type=\"text\" size=\"15\" /> ";

// link to post discount
// note this link submits the cart form...
// this means that all quantities will be updated as well based on entries above
// and vice-verse if a discount is entered and the update is clicked for a quantity...
// the system will attempt to apply the discount
// the single update function tries to update quantities, discounts and shipping selection
echo "<a href=\"javascript:window.document.cartForm.submit();\">APPLY</a>";

// display the discounts
// loop thru discount array
foreach ($discountArr as $disc){

// discount the discount code
// this is the same code entered by the user to apply the discount
echo "<br>Discount: " . $disc['discountCode'];

// display a link to remove the discount
// this is necessary as some discounts will not work with other discounts in the cart
// also admins can set the carts to only allow one discount per order in Settings
echo " <a href=\"index.php?fa=ORDER.discountRemove&discountId=" . $disc['discountId'] . "\">remove</a> ";

// discount description
echo $disc['description'];

// discount value
// note we add the negative "-" sign
// as all discount values are in the array as positive numbers
// only show this discount amount if it isn't $0 (free product discounts will show as $0)
if($disc['amount'] > 0) echo " -" . eV::dollarFormat($disc['amount']);

// end loop through discounts
};

// shipping options
// lets only display if there are items in the cart
if(count($itemArr) > 0){

echo "<hr>Select Shipping Option: ";
// shipping option select field
// note the name of the field "shipping4addressId#...
// .. this is to support multiple shipping addresses with different ship methods...
// .. a future function
// also note that the address and shipping data are attached to the item(s)
// we call on the sale_addressId from the first item since we are not using multi-shipto-addresses
// only need this field if multiple shipping options for visitor, otherwise don't include
echo "<select name=\"shipping4addressId" . $itemArr[0]['sale_addressId'] . "\">";
// loop thru each shipping option and display as an option
for($i=0;$i<count($shipArr);$i++){
// start the option box, set the typeCode as the value
echo "<option value=\"" . $shipArr[$i]['typeCode'] . "\"";
// if this matches the current ship method selected by user, than select this option
if($shipArr[$i]['typeCode'] == $itemArr[0]['shipTypeCode']) echo " selected ";
// complete the option box, display the full ship type and it's cost
echo ">" . $shipArr[$i]['type'] . " : " . eV::dollarFormat($shipArr[$i]['shipAmount']) . "</option>";
// end loop through shipping options
};

// close out the shipping select field
echo "\n</select>";

// zip code entry field for shipping
echo " Enter Zip Code: ";
// note we popoulate it with the zipCode from the first item in the cart
// only need zipCode here if using zip based shipping, like fedex
// level shipping is not zip code based, therefore dont need this field
echo "<input type=\"text\" name=\"zipCode\" value=\"" . $itemArr[0]['zipCode'] . "\" size=\"12\" maxlength=\"10\"> ";
// update link
// as before, updating the form will post changes to shipping, add discount and post changes to quantities
echo "<a href=\"javascript:window.document.cartForm.submit();\">update</a>";
// current shipping charge
echo " Shipping: " . eV::dollarFormat($orderArr['shippingTotal']);

// lets show the total due
echo "<hr>Total: " . eV::dollarFormat($orderArr['totalDue']);

// end if items in cart
};

// repeat link to continue checkout process
// note we only show it if items are in the cart. No reason to checkout on empty cart
// note we are using the redirectIfRegistered attribute to have user skip this page if they are registered (logged in) and go directly to the checkoutBilling page
// if your checkout order is shipping BEFORE billing be sure to change the redirect to ORDER.checkoutShipping
// note the $securedSiteURL attribute in the anchor tag - this will retrieve the value in settings for the Secure Site URL
if(count($itemArr) > 0) echo "<hr><a href=\"$securedSiteURL/index.php?fa=ORDER.register&redirectIfRegistered=" . rawurlencode('index.php?fa=ORDER.checkoutBilling') . "\">CONTINUE CHECKOUT</a>";

// close out the form
echo "</form>";

</source>

== Create shopping cart page ==
; assign the new cart template to this page
; check the 'hide this page from in-site searches'
; post this page and take note of the page Id

== Set new page as shopping cart ==
; In settings > eCommerce tab: enter the pageId for the page just created into the "cart page id" field.
; post changes to settings

Template:Page Template Functions Shortcuts

2009-04-13T01:02:32Z

71.163.185.8: added orderGetFirstName

<table align=right style="background-color: #DDDDDD;" cellpadding=0 cellspacing=0 border=0>
<tr>
<td valign=top>
{{Page Template Managers Shortcuts}}
</td>
</tr>
<tr>
<td valign=top>
[[Page Templates:Functions|Page Template Functions]]
*[[functions:addressCountryOptions|addressCountryOptions]]
*[[functions:addressCountryNameGet|addressCountryNameGet]]
*[[functions:addressStateOptions|addressStateOptions]]
*[[functions:addressZipDetailsGet|addressZipDetailsGet]]
*[[functions:authorizeIsLoggedIn|authorizeIsLoggedIn]]
*[[functions:authorizeIsLoggedOut|authorizeIsLoggedOut]]
*[[functions:captchaCheck|captchaCheck]]
*[[functions:catalogProductsGet|catalogProductsGet]]
*[[functions:continueShoppingGet|continueShoppingGet]]
*[[functions:continueShoppingSet|continueShopppingSet]]
*[[functions:dollarFormat|dollarFormat]]
*[[functions:fullyQualifyAllURLs|fullyQualifyAllURLs]]
*[[functions:ipBlockCheck|ipBlockCheck]]
*[[functions:itemLayout_dataString2Array|itemLayout_dataString2Array]]
*[[functions:mysqlquery2array|mysqlquery2array]]
*[[functions:orderExpDateOptions|orderExpDateOptions]]
*[[functions:orderGetCompleteArray|orderGetCompleteArray]]
*[[functions:orderGetEmail|orderGetEmail]]
*[[functions:orderGetFirstName|orderGetFirstName]]
*[[functions:orderGetPayTypes|orderGetPayTypes]]
*[[functions:orderGetShipArray|orderGetShipArray]]
*[[functions:orderGetSummary|orderGetSummary]]
*[[functions:ordersGetList|ordersGetList]]
*[[functions:orderPayTypeOptions|orderPayTypeOptions]]
*[[functions:orderShipFedexRate|orderShipFedexRate]]
*[[functions:orderShipAdjustRate|orderShipAdjustRate]]
*[[functions:pageBreadcrumbsFamilyGet|pageBreadcrumbsFamilyGet]]
*[[functions:pageBreadcrumbsHistoryGet|pageBreadcrumbsHistoryGet]]
*[[functions:pageChildrenGet|pageChildrenGet]]
*[[functions:pageContentAttribSet|pageContentAttribSet]]
*[[functions:pageContentAttribsSet|pageContentAttribsSet]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribStart]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribEnd]]
*[[functions:pageCustomSearchGroup|pageCustomSearchGroup]]
*[[functions:pageForumPostsGet|pageForumPostsGet]]
*[[functions:pageGet|pageGet]]
*[[functions:pageGetHomeId|pageGetHomeId]]
*[[functions:pageMenuGet|pageMenuGet]]
*[[functions:pagePollQuestionsGet|pagePollQuestionsGet]]
*[[functions:pagePollResultsGet|pagePollResultsGet]]
*[[functions:pageProductsGet|pageProductsGet]]
*[[functions:pageSearchGet|pageSearchGet]]
*[[functions:pageZoneGet|pageZoneGet]]
*[[functions:pagination|pagination]]
*[[functions:phpObjToJS|phpObjToJS]]
*[[functions:prodArrayToJS|prodArrayToJS]]
*[[functions:prodOptionString2Array|prodOptionString2Array]]
*[[functions:recentlyViewedAdd|recentlyViewedAdd]]
*[[functions:recentlyViewedGet|recentlyViewedGet]]
*[[functions:redirect|redirect]]
*[[functions:TEMConversionTag|TEMConversionTag]]
*[[functions:userAccountAndAddressCreate|userAccountAndAddressCreate]]
*[[functions:userAccountEdit|userAccountEdit]]
*[[functions:userAddressAddEdit|userAddressAddEdit]]
*[[functions:userBlogEntriesGet|userBlogEntriesGet]]
*[[functions:userBlogEntryAddEdit|userBlogEntryAddEdit]]
*[[functions:userBlogSetup|userBlogSetup]]
*[[functions:userFriendsGet|userFriendsGet]]
*[[functions:userGetAddresses|userGetAddresses]]
*[[functions:userWishListGet|userWishListGet]]
*[[functions:usersAmbassadorGet|usersAmbassadorGet]]
*[[functions:usersGet|usersGet]]
*[[functions:valueArrayFromQuery|valueArrayFromQuery]]
*[[functions:verifyEmail|verifyEmail]]
</td>
</tr>
</table>

Discounts

2009-04-11T02:36:01Z

71.163.185.8: added tiered discount

Discounts provides a way for site managers to add, edit and delete coupons and automatic discounts. Discounts can be accessed via the 'discounts' link in the administration link list. Note that only administrators and product managers can access the discounts area.

Each discount has benefits and conditions. Any order that fits the discount conditons can qualify to receive the discount, and it's benefits.

==Discount Listing==
The discount listing will show all discounts currently in the system. The listing also provided edit and add links to manage the discounts.

==The Discount Management Form==
The discount form contains fields to set the discount meta information (info about the discount); Discount benefits and; discount conditions.
*Discount Meta Fields
:*Discount Code: each discount must have a unique code, if code entry is required (see discount conditions), this is the 'coupon code' that the buyer must enter to receive the discount. This is also the code that will show in the shopping cart / checkout process along with the discount benefit price.
:*Description: The discount description should completely and concisely describe the discount benefit. This information will appear in the shopping cart and checkout process along with the discount code.
:*Notes: Internal information about the discount - visible to other site managers, but not visible to web site visitors.
*Discount Benefit Fields
:*Percentage Off: The order will benefit from this percentage off the subtotal, or specific products, depending on the percentage application selection.
:*Percentage Application: selects if the percentage off applies to the entire order subtitle or to the applicable products based on the 'accept or deny products' option and the products in the relationship window.
:*Dollar Off: sets a fixed dollar discount to be applied to the order.
:*Free Shipping Option: selects a shipping option that will be free, if this shipping option is selected by the buyer and the order qualifies for the discount.
:*Free Product: selects a free product that will be automatically added to the shopping cart if the order qualifies for the discount. The free product will appear in the cart at it's price, and the discount will be presented as a separate line item with a value countering the product price.
*Discount Condition Fields
:*Code Entry Required: if selected, the buyer must enter the discount code in order to receive the discount. If not selected, the discount will automatically appear in the shopping cart once the order qualifies for the discount.
:*Start Date: The beginning date that the discount will be available. Leave blank and the discount will be available always (until the end date is reached).
:*End Date: The ending date that the discount will be available. Leave blank and the discount will always be available (so long as the start date has been passed). Leave both the start and end date blank to make the discount available always.
:*Minimum Order Amount: The minimum subtotal the order must meet in order to qualify for the discount. The discount cannot be applied until this minimum amount is met (or if the discount is automatic - a.k.a not requiring code entry - the discount will not automatically appear in the shopping cart until the minimum amount is met).
:*Exclusive: select if the discount is one time use. Once the discount is applied to an order, it will automatically be deactivated and made unavailable for anyone else. Use this to provide private discounts to individual customers.
:*Mutually Exclusive: select to make the discount not valid with any other discounts. If selected, and any other discounts are in the cart, this discount cannot be added - also if this discount is in the cart, no other discounts can be added.
:*Accept or Deny Products: If checked all products will qualify except for the products in the product relationship window. If unchecked then only the products in the product relationship window will qualify. A qualifying product must be in the shopping cart in order for the discount to be applied.
:*Products Relationship Window: A list of products that either qualify or disqualify an order from the discount (depending on the selection made in the accept or deny products checkbox). See [[Relationships Management]] on how to add and remove items from this window.

==Add Discount==
To add a discount, select the 'add new discount' link above the Discount Listing. The discount management form will be provided, empty and ready for entry of a new discount. See the discount management form information above for details on how to use this form.

==Edit Discount==
To modify a discount, select the 'edit' link next to the discount in the discount listing. The discount management form will be provided, populated with data for the selected discount. See the discount management form information above for details on how to use this form.

==Delete Discount==
To delete a discount, select the 'edit' link next to the discount in the discount listing. The discount management form will be provided, populated with data for the selected discount. Select the 'delete' button at the bottom of the discount management form to delete the discount.

==Tiered Discounts==
Tiered discounts are single discount codes that change benefit as conditions change. An example of a tiered discount would be offering $10 off an order for purchasing $100 or more; $25 off for $200 or more and $40 off for $300 or more. The goal of tiered discounting is to push buyers to buy specific items, more items and larger quantities. The visitor enters the discount once and the discount automatically changes benefit as the new condition is met. A tiered discount is created by adding multiple discounts that use the same discount code - setting each discount with the condition and benefit for it's 'tier'. The web site visitor will automatically get the discount tier with the greatest benefit, that they qualify for, applied to their order. As the order changes state, and the qualify for a new discount or disqualify for the current discount, the discount will automatically change to the appropriate tier.

Functions:pageSearchGet

2009-04-08T15:29:57Z

71.163.185.8: /* Examples */

Functions:pageSearchGet

2009-04-08T14:48:33Z

71.163.185.8:

Functions:pageSearchGet

2009-04-08T14:48:05Z

71.163.185.8: added complex example

Template:Page Template Functions Shortcuts

2009-04-07T11:59:29Z

71.163.185.8: added TEMConversionTag, orderGetEmail

<table align=right style="background-color: #DDDDDD;" cellpadding=0 cellspacing=0 border=0>
<tr>
<td valign=top>
{{Page Template Managers Shortcuts}}
</td>
</tr>
<tr>
<td valign=top>
[[Page Templates:Functions|Page Template Functions]]
*[[functions:addressCountryOptions|addressCountryOptions]]
*[[functions:addressCountryNameGet|addressCountryNameGet]]
*[[functions:addressStateOptions|addressStateOptions]]
*[[functions:addressZipDetailsGet|addressZipDetailsGet]]
*[[functions:authorizeIsLoggedIn|authorizeIsLoggedIn]]
*[[functions:authorizeIsLoggedOut|authorizeIsLoggedOut]]
*[[functions:captchaCheck|captchaCheck]]
*[[functions:catalogProductsGet|catalogProductsGet]]
*[[functions:continueShoppingGet|continueShoppingGet]]
*[[functions:continueShoppingSet|continueShopppingSet]]
*[[functions:dollarFormat|dollarFormat]]
*[[functions:fullyQualifyAllURLs|fullyQualifyAllURLs]]
*[[functions:ipBlockCheck|ipBlockCheck]]
*[[functions:itemLayout_dataString2Array|itemLayout_dataString2Array]]
*[[functions:mysqlquery2array|mysqlquery2array]]
*[[functions:orderExpDateOptions|orderExpDateOptions]]
*[[functions:orderGetCompleteArray|orderGetCompleteArray]]
*[[functions:orderGetEmail|orderGetEmail]]
*[[functions:orderGetPayTypes|orderGetPayTypes]]
*[[functions:orderGetShipArray|orderGetShipArray]]
*[[functions:orderGetSummary|orderGetSummary]]
*[[functions:ordersGetList|ordersGetList]]
*[[functions:orderPayTypeOptions|orderPayTypeOptions]]
*[[functions:orderShipFedexRate|orderShipFedexRate]]
*[[functions:orderShipAdjustRate|orderShipAdjustRate]]
*[[functions:pageBreadcrumbsFamilyGet|pageBreadcrumbsFamilyGet]]
*[[functions:pageBreadcrumbsHistoryGet|pageBreadcrumbsHistoryGet]]
*[[functions:pageChildrenGet|pageChildrenGet]]
*[[functions:pageContentAttribSet|pageContentAttribSet]]
*[[functions:pageContentAttribsSet|pageContentAttribsSet]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribStart]]
*[[functions:pageContentAttribStart/pageContentAttribEnd|pageContentAttribEnd]]
*[[functions:pageCustomSearchGroup|pageCustomSearchGroup]]
*[[functions:pageForumPostsGet|pageForumPostsGet]]
*[[functions:pageGet|pageGet]]
*[[functions:pageGetHomeId|pageGetHomeId]]
*[[functions:pageMenuGet|pageMenuGet]]
*[[functions:pagePollQuestionsGet|pagePollQuestionsGet]]
*[[functions:pagePollResultsGet|pagePollResultsGet]]
*[[functions:pageProductsGet|pageProductsGet]]
*[[functions:pageSearchGet|pageSearchGet]]
*[[functions:pageZoneGet|pageZoneGet]]
*[[functions:pagination|pagination]]
*[[functions:phpObjToJS|phpObjToJS]]
*[[functions:prodArrayToJS|prodArrayToJS]]
*[[functions:prodOptionString2Array|prodOptionString2Array]]
*[[functions:recentlyViewedAdd|recentlyViewedAdd]]
*[[functions:recentlyViewedGet|recentlyViewedGet]]
*[[functions:redirect|redirect]]
*[[functions:TEMConversionTag|TEMConversionTag]]
*[[functions:userAccountAndAddressCreate|userAccountAndAddressCreate]]
*[[functions:userAccountEdit|userAccountEdit]]
*[[functions:userAddressAddEdit|userAddressAddEdit]]
*[[functions:userBlogEntriesGet|userBlogEntriesGet]]
*[[functions:userBlogEntryAddEdit|userBlogEntryAddEdit]]
*[[functions:userBlogSetup|userBlogSetup]]
*[[functions:userFriendsGet|userFriendsGet]]
*[[functions:userGetAddresses|userGetAddresses]]
*[[functions:userWishListGet|userWishListGet]]
*[[functions:usersAmbassadorGet|usersAmbassadorGet]]
*[[functions:usersGet|usersGet]]
*[[functions:valueArrayFromQuery|valueArrayFromQuery]]
*[[functions:verifyEmail|verifyEmail]]
</td>
</tr>
</table>

Installation

2009-04-05T23:22:04Z

71.163.185.8: /* MySQL Configuration */

'''Currently building automated installation package'''.

Below is the manual process until the package is operational.

==File Upload==
FTP The entire site file content to the target root of the web site

==Web Server Setup==
;Windows IIS
*Open 'computer management' (right click 'my computer' and select manage)
*Expand Computer Management > Services and Applications > Internet Information Services > Web Sites
*Right click 'Web Sites' and select 'New Web Site'. When the 'Web Site Creation Wizard' opens, click 'Next'.
*Enter the site name (use a test subdomain if you do not want to interrupt a site currently using the domain i.e.: test.yourdomain.com instead of www.yourdomain.com). Next.
*Set the IP address to that given by your Hosting ISP (ask you ISP if you do not know what that is), leave TCP port to 80 and set Host Header to the domain/subdomain you selected in the previous step. Next.
*In the Path field browse to the folder you FTPd all the site files too, than hit OK. Leave allow anonymous access to this website on. Next.
*Select Read and Run scripts. Next. Finish.
;Linux Apache 2+
*Open /etc/httpd/conf/httpd.conf
*Add the following 404 error document line (remove the existing one first, if present) - this sets the index.php as the default 404 error document which will kick in url_map/title page access when appropriate.
;;;ErrorDocument 404 /index.php
*Add the following documentRoot line (remove the existing one first, if present)
;;;DocumentRoot /path/to/your/website
:::where "/path/to/your/website" is the absolute path from the root of the server drive to the folder containing the website. Usually "/var/www/html/www.yoursitedomain.com" where yoursitedomain is the domain name of your site.
*Modify the <Directory> tag value to:
;;;<Directory "/path/to/your/website">
:::where "/path/to/your/website" is the absolute path from the root of the server drive to the folder containing the website. Usually "/var/www/html/www.yoursitedomain.com" where yoursitedomain is the domain name of your site.
*Add the following directoryIndex line (remove the existing one first, if present)
;;;DirectoryIndex index.php

==Setup DNS==
Call your Hosting ISP for specific instructions on how to set up DNS for your web site.
You can setup your local HOSTS file (located in c:\windows\system32\drivers\etc on a windows client) so that your web browser will resolve the domain to the web server until DNS is set and propigated. Follow instructions in the HOSTS file to add a line for your domain / web server IP address.

==Database Setup==
*NOTE: If on linux you find you cannot create databases (err 103), it's most likely a permissions issue, run the following shell command in linux:
;;;chown mysql\:mysql /var/lib/mysql
*Backup the latest database version at the commend prompt in windows / shell in linux: (substitute m.d.y with current month.day.year; substitute "username" with the root user name):
<source lang="dos">mysqldump -u username -p iproductsbase > iproductsbase.m.d.y.sql</source>
*FTP the backup to the new server
*Create the database on the new server in mysql (substitute "databasename" with the name you wish to call the database):
<source lang="mysql">
Create database databasename;
</source>
*move the files into the database at the command prompt in windows / shell in linux (substitute "databasename" for the newly create database name; substitute 'username' for the root user; substitute "m.d.y" for the month.day.year in the iproductsbase backup file name):
<source lang="dos">mysql -u username -p databasename < iproductsbase.m.d.y.sql</source>
*Create a database user account with the appropriate access in mysql (substitute "newusername" with your website database username you wish; substitute "databasename" with the name of the database you created for the site; substitute "password" with your password of choice):
<source lang="mysql">GRANT CREATE TEMPORARY TABLES, DELETE, INSERT, LOCK TABLES, SELECT, UPDATE ON databasename.* TO 'newusername'@'localhost' identified by 'password';</source>
*Point to the appropriate database in the appGlobals.php file (located in the root of the website). Change the following code (located at the beginning of the file) by filling in your "databasename", "username" and "password" for database access:
<source lang="php">
$iProducts['dbUser'] = "username";
$iProducts['dbPassword'] = "password";
$iProducts['dbDatabase'] = "databasename";
</source>

==Scheduled Task Setup==

All core scheduled tasks are executed by the following file located in the root of the website:
/taskScheduler.php

;For linux servers
Setup the below cron jobs:
<pre>
* * * * * /usr/bin/lynx -source http://www.websitedomainname.com/taskScheduler.php
* 1 * * * root ntpdate 0.pool.ntp.org
</pre>
*The first cron job calls the task scheduler every minute. Change "www.websitedomainname" to match the domain name of your website.
*The second cron job ensures the system clock is accurate.
*Add the following 3rd cron job line if using EBO (TEM by Fiddlehead):
<pre>
*/10 * * * * . /path/to/website/root/folder/ebo/xmlExporter.sh >> /dev/null 2>&1 # TEM XML Exporter
</pre>
Replace "/path/to/website/root/folder/" with the path to the website root folder on your server

==Directory Setup==

;Images and Files
Create a root folder for the images and files to be used by the image and file management libraries. They can be in root of the website (/images, /files), in a common directory (/library/images, /library/files) or even within each other (/files, /files/images). These folders will need to be entered into the site settings when later configuring the website via the administration console.

;Clear and Set Parsed
*Delete contents of /parsed (located in the root of the web site)
*Set parsed for full access (linux > chmod 777 parsed)

==MySQL Configuration==

;Open the config file
*Look for my.ini in Windows (usually located in the C:\Program Files\MYSQL folder)
*Look for my.conf in Linux (usually located in the /etc folder)

;Perform the following to the config file
*Set Sort Buffer
::sort_buffer_size=1M
*Turn on Query Caching:
::query_cache_type=1
::query_cache_limit=1M
::query_cache_size=32M
*Set Max Connections:
::max_connections=1000
*Reduced wait_timeout to prevent idle clients holding connections.
::wait_timeout=15
::connect_timeout=10
*Reduced key buffer it by checking current size of *.MYI files, see notes below. Recommended to set between 1/4 - 1/2 total server memory
::key_buffer=1024M
*thread_concurrency = 2 * (no. of CPU)
::thread_concurrency=4
*The default is 64. Each time MySQL accesses a table, it places it in the cache. If the system accesses many tables, it is faster to have these in the cache. Check opened tables and adjusted accordingly after running for a while.
::table_cache=1024
*MyISAMCHK sort_buffer: The sort_buffer is very useful for speeding up myisamchk operations (which is why it is set much higher for that purpose in the default configuration files), but it can also be useful everyday when performing large numbers of sorts.
::sort_buffer=64M
*If you have a busy server that's getting a lot of quick connections, set your thread cache high enough that the Threads_created value in SHOW STATUS stops increasing. This should take some of the load off of the CPU.
::thread_cache=128
*tmp_table_size:: "Created_tmp_disk_tables" are the number of implicit temporary tables on disk created while executing statements and "created_tmp_tables" are memory-based. Obviously it is bad if you have to go to disk instead of memory all the time. 32M by default.
::tmp_table_size=128M
*log slow queries is a must. Many queries that take more than 2 seconds. If so, then your tables need enhancement. Be sure to create log file and set rights so mysql can manage the file.
::log_slow_queries=/var/log/mysql/mysqld.slow.log
::long_query_time=2
*read_buffer_size=128K by default.
::read_buffer_size=1M
*ft_min_word_len: defaults to 4 but most clients will want 3 characters min search word length. NOTE THIS MUST APPEAR BELOW [MySQLd] in the my.ini/cnf file OR IT WILL NOT WORK
::ft_min_word_len=3

*NOTE: memory=key_buffer+(sort_buffer_size+read_buffer_size)*max_connections

*If commented, uncomment all innodb my.conf vars
*set up mysql logging, test

==PHP Configuration==

;Open the php.ini config file
*Default location in Windows is C:\PHP
*Default location in Linux is /etc

;Perform the following to the config file
*Set the session lifetime by adding or uncommenting the "session.cookie_lifetime" variable and setting to "2592000" (30 days). For 8x8 eComm sites set to 3 months 7776000:
::session.cookie_lifetime=2592000
*Add or uncomment GPC_magic_quotes and set to "off":
::GPC_magic_quotes = OFF
*Set default time zone (we recommend client headquarters time zone)
::[Date]
::date.timezone = America/New_York

==FUSEBOX Configuration==

;Open the fusebox.xml.php config file located in the root of the web site
;Perform the following the the config file
*Set fusebox mode to "production" (scripts are stored in memory for optimal performance, set back to "development" when modifying web site scripts):
::<parameter name="mode" value="production" />

==Mail Order Manager Integration==

If integrating with MOM (Mail Order Manager), a scheduled task needs to be setup on the windows server that is hosting MOM. Change the "URL" attribute to use the domain name of your web site:

<source lang="asp">
Dim fileName
Dim URL
URL = "http://www.yourwebsitedomain.com/index.php?fa=ORDER.orderExportMOM_5_4&dBug=0"
fileName = "c:\MOMIMPORT." & DatePart("yyyy",Now) & "_" & DatePart("m",Now) & "_" & DatePart("d",Now) & "_" & DatePart("h",Now) & "_" & DatePart("n",Now) & "_" & DatePart("s",Now) & ".txt"
' get web page data
Set WinHttpReq = CreateObject("WinHttp.WinHttpRequest.5.1")
WinHttpReq.Open "GET",URL,False
WinHttpReq.Send
' save to file
Set fso = CreateObject("Scripting.FileSystemObject")
set f = fso.OpenTextFile(fileName,2,True)
f.Write WinHttpReq.ResponseText
</source>

==Table Fixes for Linux==

On linux run the following to fix the case of the table names.

This is necessary because Windows makes the table names lower case, regardless of specifying upper case letters in the table names. Since the starting database is being transferred from a windows box, the table names will be set to lower case by windows. The linux file system is case sensitive, meaning that if a script calls for the table using any upper case letters where the table name is stored as lower case, it will not find the table. To correct this, the below commands need to be run in order to change the table names to their correct case.

The following commands need to be run in mysql. This can be done by logging on to SSH for the server housing the database than logging into mysql on that server. The below commands can all be run by copying the entire command list and pasting it into your ssh session while in the mysql prompt.

<source lang="mysql">
alter table customfields rename customFields;
alter table customfieldvalues rename customFieldValues;
alter table customlibraries rename customLibraries;
alter table customlibraryitems rename customLibraryItems;
alter table page_forumpostagree rename page_forumPostAgree;
alter table page_forumposts rename page_forumPosts;
alter table page_pollanswers rename page_pollAnswers;
alter table page_pollquestions rename page_pollQuestions;
alter table page_searchgroup_languages rename page_searchGroup_languages;
alter table page_searchgroups rename page_searchGroups;
alter table page_searchoption_languages rename page_searchOption_languages;
alter table page_searchoptions rename page_searchOptions;
alter table page_send2friend rename page_send2Friend;
alter table pendingapproval rename pendingApproval;
alter table prod_optiongroups rename prod_optionGroups;
alter table prod_optiongroup_link rename prod_optionGroup_link;
alter table stat_pageviews rename stat_pageViews;
alter table user_groupaccess rename user_groupAccess;
alter table user_loginsessions rename user_loginSessions;
alter table user_usersingroups rename user_usersINgroups;
alter table user_wishlist rename user_wishList;
alter table lk_zipcodes rename lk_zipCodes;
alter table lk_fedexzipstozones rename lk_fedexZipsToZones;
alter table lk_paytypes rename lk_payTypes;
</source>

CSR: Support

2009-04-05T02:06:24Z

71.163.185.8: New page: Weekly: *Conference Call: comments, complaints, ideas *Error Log Review: MySQL, Http, Https *Marketing: email campaigns, web advertising *Wish list: what the client would like to see chang...

Weekly:
*Conference Call: comments, complaints, ideas
*Error Log Review: MySQL, Http, Https
*Marketing: email campaigns, web advertising
*Wish list: what the client would like to see changed

Monthly:
*Cart Report Review: Evaluate solutions that focus on gaps
*Keyword search analysis: zero return searches, most popular searches
*Category activity: Visitation, Visitation vs products viewed, Visitation vs products to cart, Visitation vs purchases
*Product activity: Visitation, Visitation vs products to cart, Visitation vs purchases

Quarterly:
*Evaluate competitor websites, note new functions, changes
*Usability: discuss admin areas for improvement
*Discuss new features available

Whirlwind eCommerce Engine Wiki

2009-04-05T01:54:58Z

71.163.185.8:

== Welcome ==

* [[The Administration Console:First Look]] - Get an overview of what you can do with your Whirlwind Web Site
* Give us feedback via [[Wiki Suggestions]] and [[Upgrade Requests / Bugs]]

==Content Managers==
* [[Pages]]: Create pages for products, categories, information or anything. Manage the content of ALL pages including the checkout process, account management and more. Have pages double as RSS feeds so you can manage content in one place that is displayed as a web page to web site visitors and as an RSS feed to feed subscribers.
* [[Image Library]]: Manage all your site images via a simple, photo album style interface. Easily place images into content, upload new images or even crop/resize images through the interface.
* [[File Library]]: Manage all your downloadable files via a simple, file manager style interface. Easily link pdfs, spreadsheets, documents, zip files to you page content.
* [[Menus]]: Control all the menu bar links in your site's C-nav (top tabs, left categories, bottom links, etc) via one centralized location.
* [[Custom Search Groups]]: Manage Keyword drop downs that jump to specific page(s)
* [[Banners]]: Create and manage banner ads, campaigns and zones for campaign/banner placement.

==Marketing==
* [[URL Map]]: Create custom, easy-to-remember alias URLs (links) for promotional materials.
* [[Landing Pages]]: Provide users with targeted content.
* [[Pages:Custom Forms]]: Create custom forms that collect any information you wish. Use custom forms to provide a means for newsletter registration, catalog ordering, contact, help requests, or anything else you can think of. View and manage all submissions made through these forms in one centralized location.
* [[Campaigns]]: Create, manage and track email campaigns.
* [[Banners]]: Create and manage banner ads, campaigns and zones for campaign/banner placement.
* [[Discounts]]: Manage coupons and automatic promotional discounts.

==Moderators==
* [[Users]] : Control user rights, permissions and access
* [[Form Submissions]]: Lookup and edit any, all form submitted information.
* [[Sessions]]: View who is logging into the website and when
* [[Forums]]: Approve pending forum/comment posts. Lookup, edit, delete all forum/comment posts.
* [[Campaign Subscribers]]: Lookup, edit campaign subscribers.
* [[IP Blocks]]: Restrict visitors from accessing and using site tools (forms, comments, ordering, etc). View list of those blocked and add/remove blocks.

==Web Masters / Site Administrators==
* [[Settings]] : Turn on, off and configure the features and functions that will be available on your web site.
* [[Groups]]: Create user groups that can be used to manage administration or content access
* [[Users]]: Manage system user information - control user access, privileges and rights.
* [[Pages]]: Look up and manage content for any page on the web site.
* [[URL Map]]: Transitioning from an existing website? Keeping old links intact so you don't lose search engine rankings. Create custom, SEO-friendly URLs to ANY page on your web site that appeal to search engines and are easy to remember for site visitors.
* [[Client New Site Testing Protocol]]: A checklist to help new site owners pinpoint changes they want on their web site before launch.

==Store Managers==
* [[Pages]]: Manage categories, product lines, product pages, checkout process pages - or any other page content on the site.
* [[Products]]: Add, edit delete products. Control product behavior and pricing. Link products to pages.
* [[Product Price Matrices]]: Manage product price matrices (volume discounting).
* [[Product Option Groups]]: Manage product groups of selectable options. Color, size, or any other option you want to make available on certain products.
* [[Shipping]]: Control shipping methods and pricing
* [[Tax Management]]: Set tax rules for purchases
* [[Discounts]]: Manage coupons and automatic promotional discounts
* [[Orders]]: Lookup and edit orders (both completed, and shopping carts in progress)
* [[Cart Report]]: See return on investment for advertisements, campaigns. Find bottlenecks in the purchase process.

==Integrators==
* [[Attn: Template Integrators]]: New to template integration? Here is some protocol to follow to make your job easier and keep your clients satisfied.
* [[Installation]]: Software setup and configuration to prepare a server to use the Whirlwind eCommerce Engine.
* [[Initial Setup]]: What to do when the new site is turned on for the first time
* [[The Administration Console:First Look]]: Tour of the administration console for managing the site
* [[Settings]]: Your first task on your new site is to specify the initial settings, select which features and functions will be available and configure how those features and functions will operate.
* [[Menus]]: Use Menus to control content in the web site's Cnav. Understand how menus work before building your first templates.
* [[Pages]]: Build content pages for your web site. Understand how pages work before building your first templates.
* [[Page Templates]]: Learn how to qualify and build templates that will govern how content managers control page content and how that content will be presented.
* [[Pages:Custom Forms]]: Setup custom forms for web sites for newsletter registration, information collection, contact and more.
* [[Data Integration]]: Import data from legacy systems. Set up regular data transfers between Point-Of-Sale systems and the web site.
* [[Page_Templates:Functions]]: A reference guide to all functions and calls at your disposal when creating a template
* [[CSR: Support]]: Continuing client support

==Programmers==
* [[Attn: Engine Programmers]]: Custom programming your version of our engine? Here's some tips that will help make your work easier and prepare your modifications for others who will be programming your version of the engine.

Attn: Template Integrators

2009-03-31T13:32:37Z

71.163.185.8: added shipping checks for shopping cart

=Before Site Development=

==Site Configuration==
Set up for proper shipping method. Adjust cart accordingly (don't need zip code entry if using level shipping, don't need shipping selection if only one shipping method is available).

==Testing Criteria==
Generate testing criteria with the client, these will be your measurements of success. Testing criteria will start with the new site checklist below - augment this list with custom functions and templates built for the client. Create at least one testing scenario for each custom function / template possible conditions. If the function / template is to effect other site areas (cart, checkout, orders, importing / exporting) be sure to include a process flow test to ensure those other functions are impacted correctly.

==During Site Development==
===For ANY deviations made from the designs===
*Email the client, verify response
*Note in the code when / how the client was notified of the change.

=After Site Completion=

==New Site Checklist==

===Templates Adjusted to Match Config Settings===
*Shopping cart shipping only shows zip code if using Fedex shipping
*Shopping cart shipping only has option box if more than one shipping method is available

===Address Collection Form Homogeneity===
''Address forms should all have same fields AND validation rules, also that all pages that display addresses include all these fields''
*Create account (if address is included)
*Address book
*Checkout Billing
*Checkout Shipping
*Order Confirmation
*Viewable / Printable Invoice
*Emailed Invoice

===Page Accessibility Conditions are Enforced===
;cannot view while logged OUT:
:*Your Account
:*Edit Account
:*Address Book
:*Order History
;cannot view while logged IN:
:*Welcome (checkout registration)
:*Create Account
:*Lost Password

===Settings Completed===
;All Email Content Entered:
:*Page Management > Send 2 Friend Email Subject and Body
:*Campaign > Registration Email, Subject and Body (OR a page is built in page management and the "Registration Email Page ID" is pointing to that page)
:*Ecommerce > Invoice Header, Footer, Subject and Emails (OR a page is built in page management and the "Checkout (Confirmation) Email Page ID" is pointing to that page)
:*Users > Lost password header, footer, email, subject
;All Forwards Are Completed (and Pages for which are created):
:*Page Management > Search Page Id; 404 (not found) Page Id
:*Campaigns > Opt In / Out Success / Failure Urls
:*Ecommerce > Cart and Checkout Process Page Ids (all a required except "Checkout (Confirmation) Email Page ID")
:*Users > Fail Access Authorization URL; Login Successfully URL; Fail Attempted Login URL; Logout URL; Password Expired Link; Create Account Link; Edit Account Link

===Template Links Tested===
''Click ALL links for a page for every template and verify they link to their target. If links appear / disappear or change based on different conditions (logged in, logged out, appear in a loop such as children, appear when cart has items or meets certain conditions, etc) be sure to test under each condition to ensure link operates correctly''

===Process Flow Tested===
;Navigation Flow:
:*Start at a CNAV category > Category page > Product line page > product page
:*Enter Search Keywords > Search > Select a product
;Email Registration Flow:
:*Enter email into newsletter field > Newsletter registration page > registration complete page > check the email received
;Purchase Flow (after completing all orders, log into administration to check if order is displayed correct and complete):
:*WHILE LOGGED OUT: Add one product utilizing each product template built to the shopping cart > checkout registration (continue as guest) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED OUT: Add one product to the shopping cart > checkout registration (create account) > create account page > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED OUT: Add one product to the shopping cart > checkout registration (log in) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED IN: Add one product to the shopping cart > (should skip checkout registration) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
;Account Management:
:*WHILE LOGGED OUT: Your Account > Create Account > Your Account Page
:*WHILE LOGGED OUT: Your Account > Log in > Your Account Page
:*WHILE LOGGED IN: Your Account > Your Account Page
:*Add one address, edit one address and delete one address from the address book
:*View an order through order history
:*Change your name and password in the edit account form
===Custom Forms Tested===
:*Enter samples into ALL custom forms built for the web site.
:*Verify each form has the 'form type' set to a unique value that will be easy for the client to use when looking up forms in the 'form submissions' area of administration.
:*Look up the submissions in the 'form submissions' area of administration, verify all the fields entered passed correctly.
:*Verify all email recipients specified in the custom form received the emails with the fields correctly filled out.
:*For each form, if newsletter subscription is used, submit the form TWICE (once subscribing, once not) and verify the subscription took by looking them up in the 'subscriptions' area of administration. Follow the newsletter registration process to completion, verify the process works as intended and all content during the course of :*the process is as the client wishes.
===Custom Development Tested===
Test all CUSTOM processes / templates / functions created for client as per the contract. Use testing criteria for evaluation.

Whirlwind eCommerce Engine Wiki

2009-03-20T19:34:17Z

71.163.185.8:

= Welcome =

* [[The Administration Console:First Look]] - Get an overview of what you can do with your Whirlwind Web Site
* Give us feedback via [[Wiki Suggestions]] and [[Upgrade Requests / Bugs]]

{|border=2
|-bgcolor=silver
|
==Content Managers==
* [[Pages]]
* [[Image Library]]: Image Management Library
* [[File Library]]: File Management Library
* [[Content Libraries]]: Reusable, Selectable Content and Image Lists
* [[Menus]]: Persistent menu bar links
* RSS Feeds
* [[Custom Search Groups]]: Manage Keyword drop downs that jump to specific page(s)
* [[Banners]]: Create and manage banner ads, campaigns and zones for campaign/banner placement.
|
==Marketing==
* [[URL Map]]: Keeping old links intact and Alias URLs - Easy Links
* [[Landing Pages]]: Specialized home pages targeted to specific users
* [[Custom Forms]]
* [[Campaigns]]: Create, manage and track email campaigns.
* [[Banners]]: Create and manage banner ads, campaigns and zones for campaign/banner placement.
* [[Discounts]]: Manage coupons and automatic promotional discounts
|
==Moderators==
* [[User Management]]
* [[Form Submissions]]: Lookup any, all custom forms submissions
* [[Sessions]]: View who is logging into the website and when
* [[Forums]]: Approve pending forum/comment posts. Lookup, edit, delete all forum/comment posts.
* [[Campaign Subscribers]]: Lookup, edit campaign subscribers.
* [[IP Blocks]]: View list of computers blocked from form submissions. Add/remove blocks.
|
==Web Masters / Site Administrators==
* [[Settings]]
* [[Groups]]: Create user groups that can be used to manage administration or content access
* [[User Management]]
* [[Pages]]
* [[URL Map]]: Keeping old links intact and Alias URLs - SEO
* [[Client New Site Testing Protocol]]
|
==Store Managers==
* [[Pages]
* [[Content Libraries]]: Reusable, Selectable Content and Image Lists
* [[Products]]: Add, edit delete products. Link products to pages.
* [[Product Price Matrices]]: Manage price matrices (volume discounting) that are available to all products.
* [[Product Option Groups]]: Manage groups of selectable options that are available to all products.
* [[Shipping]]: Control shipping options available and pricing
* [[Tax Management]]: Set tax rules for purchases
* [[Discounts]]: Manage coupons and automatic promotional discounts
* [[Orders]]: Lookup and edit orders (both completed, and shopping carts in progress)
* [[Cart Report]]: See return on investment for advertisements, campaigns. Find bottlenecks in the purchase process.
|
==Integrators==
* [[Attn: Template Integrators]]
* [[Installation]]
* [[Initial Setup]]
* [[The Administration Console:First Look]]
* [[Settings]]
* [[Menus]]: Persistent menu bar links
* [[Page Templates]]
* [[User Management]]
* [[Pages]]
* [[Content Libraries]]: Reusable, Selectable Content and Image Lists
* [[Custom Forms]]
* [[Custom Search Groups]]: Manage Keyword drop downs that jump to specific page(s)
|
==Programmers==
* [[Attn: Engine Programmers]]

|}

Whirlwind eCommerce Engine Wiki

2009-03-20T18:44:20Z

71.163.185.8:

= Welcome =

* [[The Administration Console:First Look]]



** [[URL Map]]: Keeping old links intact and Alias URLs
** [[Menus]]: Persistent menu bar links
** [[Landing Pages]]: Specialized home pages targeted to specific users
** [[Form Submissions]]: Lookup any, all custom forms submissions
** [[Documents]]: Secure files for specific user access
** [[Pending Approval]]: View, edit and post page content changes pending approval
** [[Custom Search Groups]]: Manage Keyword drop downs that jump to specific page(s)
** [[Users]]: Lookup, add and edit users and user group membership.
** [[Sessions]]: View who is logging into the website and when
** [[Groups]]: Create user groups that can be used to manage administration or content access
** [[Forums]]: Approve pending forum/comment posts. Lookup, edit, delete all forum/comment posts.
** [[Campaigns]]: Create, manage and track email campaigns.
** [[Campaign Subscribers]]: Lookup, edit campaign subscribers.
** [[Banners]]: Create and manage banner ads, campaigns and zones for campaign/banner placement.
** [[Products]]: Add, edit delete products. Link products to pages.
** [[Product Price Matrices]]: Manage price matrices (volume discounting) that are available to all products.
** [[Product Option Groups]]: Manage groups of selectable options that are available to all products.
** [[Shipping]]: Control shipping options available and pricing
** [[Tax Management]]: Set tax rules for purchases
** [[Discounts]]: Manage coupons and automatic promotional discounts
** [[Orders]]: Lookup and edit orders (both completed, and shopping carts in progress)
** [[Cart Report]]: See return on investment for advertisements, campaigns. Find bottlenecks in the purchase process.
** [[Page Templates]]: Create page templates that govern how pages are managed and viewed
** [[Settings]]: Setup the site, activate site functions, manage site wide attributes
** [[IP Blocks]]: View list of computers blocked from form submissions. Add/remove blocks.
*[[Wiki Suggestions]]
*[[Upgrade Requests / Bugs]]
*[[Attn: Engine Programmers]]
*[[Attn: Template Integrators]]
*[[Client New Site Testing Protocol]]

{|border=2
|-bgcolor=silver
|
==Content Managers==
* [[Pages]]
* [[Image Library]]: Image Management Library
* [[File Library]]: File Management Library
* [[Content Libraries]]: Reusable, Selectable Content and Image Lists
|
==Marketing==
|
==Moderators==
* [[User Management]]
|
==Web Masters==
* [[Settings]]
* [[User Management]]
* [[Pages]]
|
==Store Managers==
* [[Pages]
* [[Content Libraries]]: Reusable, Selectable Content and Image Lists
|
==Integrators==
* [[Installation]]
* [[Initial Setup]]
* [[The Administration Console:First Look]]
* [[Settings]]
* [[Page Templates]]
* [[User Management]]
* [[Pages]]
** [[Content Libraries]]: Reusable, Selectable Content and Image Lists
|}

Function Template

2009-03-20T18:24:23Z

71.163.185.8:

== Description ==
Function() performs a function that does stuff

== Syntax ==
$returnValue = Function(type $attrib1, type $attrib2 [,type $optionalAttrib3]);

== Paramaters ==
*attrib1
:: description of attribute 1
*attrib 2
:: description of attribute 2
*attrib 3
:: description of attribute 3

== Return Values ==
Return var type or false under conditions. Example returned object structure:

<pre>
Array
(
[0] => Array
(
// elements group 1
[element1] => INT
[element2] => STRING // this is element 2 notes
// elements group 2
[element3] => STRING // this is element 3 notes
)
[1] => Array ...
)
</pre>

Defining the returned object:

Elements from the child page associative array are as follows:
{|border=2
|-
|Element
|Description
|Example
|-
|<b>Title for this section of elements</b>
|-
|element1
|INT - description of element 1
|6
|-
|element2
|STRING - description of element 2
|XYZ
|-
|<b>Title for another section of elements</b>
|-
|element3
|INT - description of element 3
|2
|}

== Examples ==
;example 1
<source lang="php">
// example code 1
</source>
;example 2
<source lang="php">
// example code 2
</source>

== See Also ==
:*[[tag:1|tag 1]]
:*[[tag:2|tag 2]]
:*[[tag:3|tag 3]]

Upgrade Requests / Bugs

2009-03-19T12:56:04Z

71.163.185.8: Audit all queries to confirm 'best practices' used with strings - see referencePHP

*Additional field to shared option groups - so it can have a name that is not the same as it's displayed title.
*Increments for products (visitor must buy in allotted increment)
*Coupon Memory - have the system remember coupon codes entered that where not qualified for, automatically apply coupon as soon as cart qualifies.
*Checkbox to discounts that allow an item to ignore the ‘only 1 discount per cart’ command.
*Text field in discounts for non-qualifying codes that will go into queue, when application is attempted.
*Banner Zones controlled by url data passed (tell a zone to display a specific banner), command expires after order is complete
*Banner repository queue to hold attempted, but unqualified, discount codes, attempt to re-apply with each cart modification.
*Tiered discounts for BOTH % and $ off.
*Checkout modifications to support non-pay accounts, po numbers.
*Cart check function, checks all items, shipping, discounts in cart to make sure they all still qualify, if any do not, remove and display message to visitor.
*Order management to allow product option changes.
*Auto deletion of expired data including: incomplete carts, searches, send2friend, banner tracking, campaign tracking, page views, user sessions.
*Export/Import templates (to duplicate BETWEEN sites)
*Audit all queries to confirm 'best practices' used with strings - see referencePHP

;Completed:
*2/5/2009: Free item alterations, store items as $0, pass controls that allow design changes for these items when presented in cart, etc.
*2/9/2009: When a visitor enters an email/name to register for the newsletter, and the billing/shipping addresses are blank, attach the email/name to the billing/shipping addresses in the order.
*2/13/2008: Reliable exit pop up
*2/16/2008: TEM channelId control for the order process (abandoned cart) manageable through admin console.
*2/18/2008: TEM custom image generation field set up

;In Progress:
*Catalog quick order

Functions:orderGetCompleteArray

2009-03-17T04:00:37Z

71.163.185.8: added company to billing and shipping addresses

Functions:orderGetCompleteArray

2009-03-17T03:21:37Z

71.163.185.8: added poNumber, payMethod, instantCreditAccountNUmber to payments array

Client New Site Testing Protocol

2009-03-16T14:36:49Z

71.163.185.8:

While testing each of the following, verify each process works as you wish and the content produced during each stage in each process is acceptable.

== Cnav links ==
:*Click every link in the top, left and bottom cnav menus. Verify they all go where you wish.
== Banner Ads ==
:*Verify all banner ads are displaying the correct banners and behaving correctly (rotating timing, etc).
== Product Navigation ==
:*In Home page / categories: Click the various links on the children (image, product name, featured category, etc) and verify each link goes where you wish. Do this for at least 5 of the categories, at least 2 children in each category. If you have categories that behave differently, be sure to test each potential behavior.
:*In Product Lines: use the sorting and paging tools (if applicable), verify they work as you wish. Click the various links on the children (image, name) verify they go where you wish. Do this for at least 5 product lines, 2 children for each product line. If you have product lines that behave differently, be sure to test each potential behavior.
== Searching ==
:*Perform keyword searches. Verify results are coming up as expected. Do this for varying types of target objects (products, categories, information pages, etc). Do this for as many target items as it takes for you to feel confident that keyword searches are working to your satisfaction. If you have keyword search reports from previous sites, use these for your tests.
== Purchase Process ==
== Account Management ==
:*Create an account at least once for each scenario you have to create accounts (from links in cnav, from login pages, from the checkout process, etc). Attempt to create accounts while filling and not filling in required fields, verify error messages display to your satisfaction. Verify the account is created and the process continues as you wish (if creating account during checkout process, do you land back in the checkout process after complete? etc.).
:*Edit your account login information
:*Look up and view previous orders
:*Log in to your account at least once for each available log in scenario (from links in cnav, from checkout process, etc). Try logging in with invalid information to test the failure processes and failure content produced. Verify processes continues for each scenario as you wish.
:*Retrieve a lost password. Verify the process and content throughout the process is acceptable.
== Custom Forms ==
== Web 2.0: Forums/Commenting ==

Client New Site Testing Protocol

2009-03-16T13:53:59Z

71.163.185.8:

While testing each of the following, verify each process works as you wish and the content produced during each stage in each process is acceptable.

== Cnav links ==
:*Click every link in the top, left and bottom cnav menus. Verify they all go where you wish.
== Banner Ads ==
:*Verify all banner ads are displaying the correct banners and behaving correctly (rotating timing, etc).
== Product Navigation ==
:*In Home page / categories: Click the various links on the children (image, product name, featured category, etc) and verify each link goes where you wish. Do this for at least 5 of the categories, at least 2 children in each category. If you have categories that behave differently, be sure to test each potential behavior.
:*In Product Lines: use the sorting and paging tools (if applicable), verify they work as you wish. Click the various links on the children (image, name) verify they go where you wish. Do this for at least 5 product lines, 2 children for each product line. If you have product lines that behave differently, be sure to test each potential behavior.
== Searching ==
:*Perform keyword searches. Verify results are coming up as expected. Do this for varying types of target objects (products, categories, information pages, etc). Do this for as many target items as it takes for you to feel confident that keyword searches are working to your satisfaction. If you have keyword search reports from previous sites, use these for your tests.
== Purchase Process ==
== Account Management ==
:*Create an account at least once for each scenario you have to create accounts (from links in cnav, from login pages, from the checkout process, etc). Verify the account is created and the process continues as you wish (if creating account during checkout process, do you land back in the checkout process after complete? etc.).
:*Edit your account login information
:*Look up and view previous orders
:*
== Custom Forms ==
== Web 2.0: Forums/Commenting ==

Client New Site Testing Protocol

2009-03-16T13:53:31Z

71.163.185.8:

While testing each of the following, verify each process works as you wish and the content produced during each stage in each process is acceptable.

== Cnav links ==
;*Click every link in the top, left and bottom cnav menus. Verify they all go where you wish.
== Banner Ads ==
;*Verify all banner ads are displaying the correct banners and behaving correctly (rotating timing, etc).
== Product Navigation ==
;*In Home page / categories: Click the various links on the children (image, product name, featured category, etc) and verify each link goes where you wish. Do this for at least 5 of the categories, at least 2 children in each category. If you have categories that behave differently, be sure to test each potential behavior.
;*In Product Lines: use the sorting and paging tools (if applicable), verify they work as you wish. Click the various links on the children (image, name) verify they go where you wish. Do this for at least 5 product lines, 2 children for each product line. If you have product lines that behave differently, be sure to test each potential behavior.
== Searching ==
;*Perform keyword searches. Verify results are coming up as expected. Do this for varying types of target objects (products, categories, information pages, etc). Do this for as many target items as it takes for you to feel confident that keyword searches are working to your satisfaction. If you have keyword search reports from previous sites, use these for your tests.
== Purchase Process ==
== Account Management ==
;*Create an account at least once for each scenario you have to create accounts (from links in cnav, from login pages, from the checkout process, etc). Verify the account is created and the process continues as you wish (if creating account during checkout process, do you land back in the checkout process after complete? etc.).
;*Edit your account login information
;*Look up and view previous orders
;*
== Custom Forms ==
== Web 2.0: Forums/Commenting ==

Attn: Template Integrators

2009-03-16T13:21:46Z

71.163.185.8: added custom forms testing

=Before Site Development=

==Testing Criteria==
Generate testing criteria with the client, these will be your measurements of success. Testing criteria will start with the new site checklist below - augment this list with custom functions and templates built for the client. Create at least one testing scenario for each custom function / template possible conditions. If the function / template is to effect other site areas (cart, checkout, orders, importing / exporting) be sure to include a process flow test to ensure those other functions are impacted correctly.

==During Site Development==
===For ANY deviations made from the designs===
*Email the client, verify response
*Note in the code when / how the client was notified of the change.

=After Site Completion=

==New Site Checklist==

===Address Collection Form Homogeneity===
''Address forms should all have same fields AND validation rules, also that all pages that display addresses include all these fields''
*Create account (if address is included)
*Address book
*Checkout Billing
*Checkout Shipping
*Order Confirmation
*Viewable / Printable Invoice
*Emailed Invoice

===Page Accessibility Conditions are Enforced===
;cannot view while logged OUT:
:*Your Account
:*Edit Account
:*Address Book
:*Order History
;cannot view while logged IN:
:*Welcome (checkout registration)
:*Create Account
:*Lost Password

===Settings Completed===
;All Email Content Entered:
:*Page Management > Send 2 Friend Email Subject and Body
:*Campaign > Registration Email, Subject and Body (OR a page is built in page management and the "Registration Email Page ID" is pointing to that page)
:*Ecommerce > Invoice Header, Footer, Subject and Emails (OR a page is built in page management and the "Checkout (Confirmation) Email Page ID" is pointing to that page)
:*Users > Lost password header, footer, email, subject
;All Forwards Are Completed (and Pages for which are created):
:*Page Management > Search Page Id; 404 (not found) Page Id
:*Campaigns > Opt In / Out Success / Failure Urls
:*Ecommerce > Cart and Checkout Process Page Ids (all a required except "Checkout (Confirmation) Email Page ID")
:*Users > Fail Access Authorization URL; Login Successfully URL; Fail Attempted Login URL; Logout URL; Password Expired Link; Create Account Link; Edit Account Link

===Template Links Tested===
''Click ALL links for a page for every template and verify they link to their target. If links appear / disappear or change based on different conditions (logged in, logged out, appear in a loop such as children, appear when cart has items or meets certain conditions, etc) be sure to test under each condition to ensure link operates correctly''

===Process Flow Tested===
;Navigation Flow:
:*Start at a CNAV category > Category page > Product line page > product page
:*Enter Search Keywords > Search > Select a product
;Email Registration Flow:
:*Enter email into newsletter field > Newsletter registration page > registration complete page > check the email received
;Purchase Flow (after completing all orders, log into administration to check if order is displayed correct and complete):
:*WHILE LOGGED OUT: Add one product utilizing each product template built to the shopping cart > checkout registration (continue as guest) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED OUT: Add one product to the shopping cart > checkout registration (create account) > create account page > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED OUT: Add one product to the shopping cart > checkout registration (log in) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
:*WHILE LOGGED IN: Add one product to the shopping cart > (should skip checkout registration) > billing address > shipping address > payment > confirmation / review > order complete > view the order > check the email received
;Account Management:
:*WHILE LOGGED OUT: Your Account > Create Account > Your Account Page
:*WHILE LOGGED OUT: Your Account > Log in > Your Account Page
:*WHILE LOGGED IN: Your Account > Your Account Page
:*Add one address, edit one address and delete one address from the address book
:*View an order through order history
:*Change your name and password in the edit account form
===Custom Forms Tested===
:*Enter samples into ALL custom forms built for the web site.
:*Verify each form has the 'form type' set to a unique value that will be easy for the client to use when looking up forms in the 'form submissions' area of administration.
:*Look up the submissions in the 'form submissions' area of administration, verify all the fields entered passed correctly.
:*Verify all email recipients specified in the custom form received the emails with the fields correctly filled out.
:*For each form, if newsletter subscription is used, submit the form TWICE (once subscribing, once not) and verify the subscription took by looking them up in the 'subscriptions' area of administration. Follow the newsletter registration process to completion, verify the process works as intended and all content during the course of :*the process is as the client wishes.
===Custom Development Tested===
Test all CUSTOM processes / templates / functions created for client as per the contract. Use testing criteria for evaluation.

Upgrade Requests / Bugs

2009-03-16T13:16:20Z

71.163.185.8: added export/import templates

Pages Templates:Forum

2009-03-13T00:26:01Z

71.163.185.8:

Forum pages can contain forum post listings and / or a post form. The listing and the form can be separate templates or combined into the same template. The post form can vary in many ways depending on the data you want to collect, security controls and restrictions set up in [[settings]] for forums.

Below are examples of various implementations

=Example: Basic post listing and submission form=
Display's all posts and includes a submission form at the bottom. Submissions will be redirected back to the page containing this form, with a message as to the success / failure of the post.

<source lang="php">

// only process forum requests and output if forums is available and selected for this page
// accessing global settings variable forums_available (sets forum availability for entire site)
// and page core variable $isForum (sets forum availability for specific page)

if($GLOBALS['iProducts']['forums_available'] AND $isForum){
// get postings for current page
// using core variable $page to get forum data for the current page we are in
$forumArray = eV::pageForumPostsGet(NULL,$pageId,NULL,"post_createDate,post_handle,post_copy,post_title");

// shortcut to the post array
$postsArr = $forumArray['posts'];

if(count($postsArr) > 0){
// loop thru posts
foreach($postsArr as $post){
echo "<hr>" . $post['post_title'] . " by " . $post['post_handle'] . " on " . $post['post_createDate'];
echo "<br>" . $post['post_copy'];
};
} else {
// no posts to this forum, lets output this to visitors
echo "no posts to this forum";
};

//////// post submission form ////////////////
// arbitrary variable, passed in "redirect" field to signify a post has just been made
if(isset($attributes['posted'])){
echo "Your posting has been received";
} else {
// anchor forumPostForm to so that kickbacks from submission function jump to the form
echo "<a name=\"forumPostForm\"></a><form action=\"index.php\" method=\"post\" name=\"forumPostForm\">";
// field for visitors to enter handle: must be 50 or less chars
// only show this field if user NOT logged in (if logged in, handle will be pulled from user account)
if(eV::authorizeIsLoggedIn()){
echo "<br>Your entry will be posted under <i>" . $_SESSION['user']['handle'] . "</i>. This not you? <a href=\"index.php?fa=USER.logout\">Click here to log out</a>";
} else {
echo "<br>Enter a Handle: <input type=\"text\" name=\"handle\" size=25 maxlength=50>
<br>Enter your Email Address: <input type=\"text\" name=\"emailAddress\" size=25 maxlength=50>";
};
// max length for post title is 100 chars
echo "<br>Enter a Title for you post: <input type=\"text\" name=\"title\" size=50 maxlength=100>";
// post has not size limit
echo "<br>Enter you post: <textarea name=\"copy\" cols=50 rows=5></textarea>";
// pass the current pageId - required
echo "<input type=\"hidden\" name=\"pageId\" value=\"$pageId\">
<input type=\"hidden\" name=\"fa\" value=\"FORUM.post\">";
echo "<br><input type=\"submit\" value=\"Post!\">";
// validate - this tells the system what fields must have value
echo "<input type=\"hidden\" name=\"validate\" value=\"title,copy,handle\">";

// redirect - this is where to send the visitor after the post has been accepted
echo "<input type=\"hidden\" name=\"redirect\" value=\"index.php?pageId=$pageId&posted=1#forumPostForm\">";
echo "</form>";
// end if $posted
};
// end if foroums available and this is a forum
};
</source>

Pages Templates:Forum

2009-03-12T22:51:44Z

71.163.185.8:

Forum pages can contain forum post listings and / or a post form. The listing and the form can be separate templates or combined into the same template. The post form can vary in many ways depending on the data you want to collect, security controls and restrictions set up in [[settings]] for forums.

Below are examples of various implementations

=Example: Basic post listing and submission form=
Display's all posts and includes a submission form at the bottom. Submissions will be redirected back to the page containing this form, with a message as to the success / failure of the post.

<source lang="php">

// only process forum requests and output if forums is available and selected for this page
// accessing global settings variable forums_available (sets forum availability for entire site)
// and page core variable $isForum (sets forum availability for specific page)

if($GLOBALS['iProducts']['forums_available'] AND $isForum){
// get postings for current page
// using core variable $page to get forum data for the current page we are in
$forumArray = eV::pageForumPostsGet(NULL,$pageId,NULL,"post_createDate,post_handle,post_copy,post_title");

// shortcut to the post array
$postsArr = $forumArray['posts'];

if(count($postsArr) > 0){
// loop thru posts
foreach($postsArr as $post){
echo "<hr>" . $post['post_title'] . " by " . $post['post_handle'] . " on " . $post['post_createDate'];
echo "<br>" . $post['post_copy'];
};
} else {
// no posts to this forum, lets output this to visitors
echo "no posts to this forum";
};

//////// post submission form ////////////////
// anchor forumPostForm to so that kickbacks from submission function jump to the form
echo "<a name=\"forumPostForm\"></a><form action=\"index.php\" method=\"post\" name=\"forumPostForm\">";
// field for visitors to enter handle: must be 50 or less chars
// only show this field if user NOT logged in (if logged in, handle will be pulled from user account)
if(eV::authorizeIsLoggedIn()){
echo "<br>Your entry will be posted under <i>" . $_SESSION['user']['handle'] . "</i>. This not you? <a href=\"index.php?fa=USER.logout\">Click here to log out</a>";
} else {
echo "<br>Enter a Handle: <input type=\"text\" name=\"handle\" size=25 maxlength=50>
<br>Enter your Email Address: <input type=\"text\" name=\"emailAddress\" size=25 maxlength=50>";
};
// max length for post title is 100 chars
echo "<br>Enter a Title for you post: <input type=\"text\" name=\"title\" size=50 maxlength=100>";
// post has not size limit
echo "<br>Enter you post: <textarea name=\"copy\" cols=50 rows=5></textarea>";
// pass the current pageId - required
echo "<input type=\"hidden\" name=\"pageId\" value=\"$pageId\">
<input type=\"hidden\" name=\"fa\" value=\"FORUM.post\">";
echo "<br><input type=\"submit\" value=\"Post!\">";
// validate - this tells the system what fields must have value
echo "<input type=\"hidden\" name=\"validate\" value=\"title,copy,handle\">";

// redirect - this is where to send the visitor after the post has been accepted
echo "<input type=\"hidden\" name=\"redirect\" value=\"index.php?pageId=$pageId&message=You post has been received. Once it is approved you will see it live on our site.\">";
echo "</form>";

// end if foroums available and this is a forum
};
</source>

Pages Templates:Forum

2009-03-12T22:51:00Z

71.163.185.8: New page: Forum pages can contain forum post listings and / or a post form. The listing and the form can be separate templates or combined into the same template. The post form can vary in many ways...

Forum pages can contain forum post listings and / or a post form. The listing and the form can be separate templates or combined into the same template. The post form can vary in many ways depending on the data you want to collect, security controls and restrictions set up in [[settings]] for forums.

Below are examples of various implementations

=Basic forums listing and form page=
Display's all posts and includes a submission form at the bottom. Submissions will be redirected back to the page containing this form, with a message as to the success / failure of the post.

<source lang="php">

// only process forum requests and output if forums is available and selected for this page
// accessing global settings variable forums_available (sets forum availability for entire site)
// and page core variable $isForum (sets forum availability for specific page)

if($GLOBALS['iProducts']['forums_available'] AND $isForum){
// get postings for current page
// using core variable $page to get forum data for the current page we are in
$forumArray = eV::pageForumPostsGet(NULL,$pageId,NULL,"post_createDate,post_handle,post_copy,post_title");

// shortcut to the post array
$postsArr = $forumArray['posts'];

if(count($postsArr) > 0){
// loop thru posts
foreach($postsArr as $post){
echo "<hr>" . $post['post_title'] . " by " . $post['post_handle'] . " on " . $post['post_createDate'];
echo "<br>" . $post['post_copy'];
};
} else {
// no posts to this forum, lets output this to visitors
echo "no posts to this forum";
};

//////// post submission form ////////////////
// anchor forumPostForm to so that kickbacks from submission function jump to the form
echo "<a name=\"forumPostForm\"></a><form action=\"index.php\" method=\"post\" name=\"forumPostForm\">";
// field for visitors to enter handle: must be 50 or less chars
// only show this field if user NOT logged in (if logged in, handle will be pulled from user account)
if(eV::authorizeIsLoggedIn()){
echo "<br>Your entry will be posted under <i>" . $_SESSION['user']['handle'] . "</i>. This not you? <a href=\"index.php?fa=USER.logout\">Click here to log out</a>";
} else {
echo "<br>Enter a Handle: <input type=\"text\" name=\"handle\" size=25 maxlength=50>
<br>Enter your Email Address: <input type=\"text\" name=\"emailAddress\" size=25 maxlength=50>";
};
// max length for post title is 100 chars
echo "<br>Enter a Title for you post: <input type=\"text\" name=\"title\" size=50 maxlength=100>";
// post has not size limit
echo "<br>Enter you post: <textarea name=\"copy\" cols=50 rows=5></textarea>";
// pass the current pageId - required
echo "<input type=\"hidden\" name=\"pageId\" value=\"$pageId\">
<input type=\"hidden\" name=\"fa\" value=\"FORUM.post\">";
echo "<br><input type=\"submit\" value=\"Post!\">";
// validate - this tells the system what fields must have value
echo "<input type=\"hidden\" name=\"validate\" value=\"title,copy,handle\">";

// redirect - this is where to send the visitor after the post has been accepted
echo "<input type=\"hidden\" name=\"redirect\" value=\"index.php?pageId=$pageId&message=You post has been received. Once it is approved you will see it live on our site.\">";
echo "</form>";

// end if foroums available and this is a forum
};
</source>

Client New Site Testing Protocol

2009-03-11T22:33:59Z

71.163.185.8: New page: coming soon

coming soon