Applying Bluepay HPP on classic e-Business 5.5.3

The below page details down the step by step guide to deploy Bluepay Hosted Payment on classic e-Business 5.5.3 running on Aptify 6.1 or higher.


The following prerequisites must be satisfied in order to install the Bluepay Remote Hosted Payment feature on classic e-Business 5.5.3 (CMS and NON CMS):

  • Aptify 6.1 or higher version is installed
  • Classic e-Business 5.5.3 is installed


Before starting the installation, take a backup copy of your existing Aptify Db and classic e-Business 5.5.3 website + related SOA folder.

Install the Aptify Bluepay Hosted Payment Page (HPP) on classic e-Business 5.5.3

To install Aptify  Bluepay Hosted Payment Page (HPP), perform the following steps:

Aptify 6.1 and higher core setup installs the Bluepay Hosted Payment framework automatically with the setup and hence the below instructions are specific to additional steps needed other than the Bluepay Framework which is already installed by default.

Step 1: Create a new stores procedures spIsHostedPaymentActive

Please refer Creating Database Objects topic for more information on how to create a new Database Object.
  1. Login as an administrator on the desktop application. Open a new record from the Database Objects service
  2. Enter the following details in each of the fields mentioned below:
    1. Name: spIsHostedPaymentActive
    2. Description: This Stored Procedure will check remote payment active OR de-active. SP will return 1, if Hosted Payment is active else returns 0. This stored procedure is used in e-Business.
    3. DB: Aptify (or Select the SQL Server database where the object is to reside in the DB field)
    4. Type: Stored Procedure
  3. Enter the SQL statements for the database object in the SQL tab.

    CREATE PROCEDURE spIsHostedPaymentActive
                  SELECT Count(*) AS MerchantAccount
           	merchantaccount ma 
                  INNER JOIN merchantaccountpaytype mpt
                  INNER JOIN PaymentType pt
                  ON mpt.PaymentTypeID=pt.ID
                  ON = mpt.merchantid
                  INNER JOIN merchantaccountcurrencytype ct
                  ON = ct.merchantaccountid
           		ma.isactive = 1 AND 
           		ma.UseHostedPaymentCheckout =1 AND
           		mpt.isactive = 1 AND
           		pt.IsRemotePayment=1 AND
           		pt.WebEnabled=1 AND
           		ct.isactive = 1 
                  ) As MerchantAccount

  4. Click the Grant SQL tab and specify the user permissions as mentioned below:
    "GRANT EXECUTE ON spIsHostedPaymentActive To EndUsers"

Step 2 

Open the Utilities folder in the Aptify Setup and run the ‘Object Synchronizer’ Tool for the sync repository object as e-Business.

To know more about running Object synchronizer utility, please refer Running the Object Repository Synchronizer.

We should not run the synchronizer for all the objects but only for ‘e-Business’. The below list of updated dll’s will be downloaded in the e-Business bin folder after the sync is completed successfully for e-Business sync repository object:

  1. ContributionPaymentObject.dll
  2. Pledge.dll
  3. StandingOrder.dll
  4. AptifyOrdersEntity.dll
  5. PaymentInfoObject.dll
  6. Payments.dll
  7. RemotePaymentEntityService.dll
  8. AptifyMarketplaceListingsEntity.dll
  9. ElectronicPayment.BluePay.dll
  10. AptifyPersonsEntity.dll
  11. RemotePayments.dll
  12. EBusinessShoppingCart.dll
  13. CompanyObject.dll
  14. PaymentInfoControl.dll

Step 3: Perform the below Config file changes

  1. Navigate to the e-Business installed folder and update the following in Aptify_UC_Navigation.config file. Please see the below screenshot for more details.

    <!-- Added for RemotePayment -->
        <UserControl type="RemotePayment" name="RemotePayment">
             <!--Here we can add any links if required-->
         <!--Added for RemotePaymentReciptControl -->
        <UserControl type="RemotePaymentReciptControl" name="RemotePaymentReciptControl">
            <!--Here we can add any links if required-->
  2. Open the web.config from the e-Business installed path and  add the below key:

    “ <add key="GenericErrorPageURL" value="SecurityErrorPage.aspx" />”

  3. Also update the web.config with a new Key to update the Remote payment URL . In the below example, replace the e-Business site URL with the actual site URL.

    <add key="Aptify.FrameWork.Payment.BluePay.RemoteUrl" value="<e-Business site-URL>/RemotePayment.aspx" />

    An Example:

    <add key="Aptify.FrameWork.Payment.BluePay.RemoteUrl" value="" />

  4. Please note that the URL is case sensitive if you are building the page using CMS site. So mention the URL as it has been created in CMS site.
  5. Add below lines in web.config file as shown in the snapshot below:

            		<requestLimits maxAllowedContentLength="2147483648" maxQueryString="3500" />

  6. Add below changes in the web.config file. Please refer the snapshot below. Save and close the Web.config file

    <httpRuntime maxRequestLength="32768"  maxQueryStringLength="3500" />

Step 4: Perform the below changes for User Controls

Please contact our Support Team for retrieving the updated classic e-Business User Controls with Bluepay Hosted Payment Changes that need to be run with Aptify 6.1 or Aptify 6.2

Add the below updated user controls in respective folders.

  1. Below updated controls should be copied and replaced in UserControls Folder -> Aptify_Product_Catalog folder.
    1. BillingControl.ascx.vb
    2. BillingControl.ascx
    3. AdminPaymentSummary.ascx.vb
  2. Below updated controls should be copied and replaced in UserControls Folder -> Aptify_General folder.
    1. CreditCard.ascx.vb,
    2. CreditCard.ascx
  3. Below updated controls should be copied and replaced in UserControls Folder -> Aptify_Group_Admin folder.
    1. AdminOrderDetail.ascx.vb,
    2. AdminOrderDetail.ascx,
    3. AttendeeTransferWiz.ascx.vb,
    4. AttendeeTransferWiz.ascx,
    5. RenewMultipleMembership.ascx.vb,
    6. RenewMultipleMembership..ascx,
    7. MeetingTransferWiz.ascx.vb,
    8. MeetingTransferWiz.ascx,
    9. RenewMultipleSubscription.ascx.vb,
    10. RenewMultipleSubscription..ascx
  4. Below updated controls should be copied and replaced in UserControls Folder -> Aptify_Customer_Service folder.

    1. MakePayment.ascx.vb,
    2. MakePayment.ascx,
    3. SavedPaymentMethods.ascx.vb,
    4. SavedPaymentMethods.ascx
  5. Below updated controls should be copied and replaced in UserControls Folder -> Aptify_Fundraising folder.
    1. Fundraising.ascx.vb,
    2. Fundraising.ascx
  6. Below updated controls should be copied and replaced in UserControls Folder -> Aptify_Marketplace folder.
    1. NewListing.ascx.vb,
    2. NewListing.ascx
  7. Copy and replace the file vb in App_Code folder available in e-Business installed path.
  8. Below are newly created user controls, need to copy and paste them in UserControls -> Aptify_General folder list.
    1. RemotePayment.ascx
    2. RemotePayment.ascx.vb
    3. RemotePaymentReciptControl.ascx
    4. RemotePaymentReciptControl.ascx.vb
  9. Below are newly created pages., need to copy and paste them in e-Business installed path for a NON-CMS e-Business site.
    1. RemotePayment.aspx and
    2. RemotePayment.aspx.vb

      This page is available for the Non-CMS but if we are using CMS site then we need to create the page on the respective CMS site. This page contains “RemotePaymentReciptControl.ascx”user control as shown in image given below.

  10. Connect to the Aptify classic e-Business website to confirm that it loads properly using a supported web browser.
  11. After all the above changes are done, Please refer Setting up BluePay Hosted Payment Configurations for configuring Bluepay Hosted Payment Page.
  12. Once the configurations are completed, restart the IIS and browse the e-Business. You will observe Bluepay Hosted Payment Option under the payment section.