Community Brands Payment Gateway Installation Guide

The following instructions provide a step-by-step guide for the installation of Aptify Community Brands Payment Gateway service pack.

• For Aptify 5.5.5 and 5.5.6

• For Aptify 5.5.4

For Aptify 5.5.5 and 5.5.6

1. Backup your database before starting the installation process.
2. Log into the Aptify database server with an account that has administrative privileges.
3. If you have not already done so, back up your Aptify database server.
4. Close the Aptify desktop application on the database server, if currently running.

5. Download the Aptify Community Brands Payment Gateway Installer ZIP file to a folder on the database server and unzip its contents.

   When using low-end hardware, Aptify recommends running the installation program locally on the database server; do not run it over the network.

   The Windows API requires that fully qualified file names are less than 260 characters. Aptify recommends that the Aptify Community Brands Payment Gateway Installer ZIP file is unzipped in a folder close to the drive's root folder (for example C:\Downloads) in order to limit the possibility of exceeding the character limitation for fully qualified file names imposed by the operating system.

6. Browse to the location of the installation files, right-click the Setup application file, and select the Run As Administrator option to launch the Aptify Community Brands Payment Gateway installation program.

   • On Windows Server 2008, the Run as Administrator option bypasses the server's User Access Control (UAC) for the duration of the installation.

7. Review the Installation welcome screen and click Next to continue.
   
   

8. Enter login information for your database server. Specify an account with system administrator privileges to both the Aptify database and SQL Server. The user should also be tied to a Developer license to ensure that the setup can perform such tasks as entity creation when needed.

   Selecting the System Administrator option when creating a user in the Aptify database sets the user to a dbowner in SQL Server. It does not add the user to the sysadmin role. You will need to manually add the user to the sysadmin role through SQL Server. If in doubt, check the user's permissions in the Security > Logins area of SQL Management Studio before proceeding with the installation.

   

9. The Service Pack Installer automatically identifies the current version of Aptify and components installed on the database server and displays them on your system.

   If the Service Pack Installer does not identify the correct Aptify Version installed on your system, please contact your System Administrator.

   

   
   

10. Click Finish to begin the installation process.

    
    
    

11. Click OK once the installation has been completed successfully.
    
    
    
    
12. Launch the 'Aptify Object Repository Synchronizer'.
    
    
13. Browse and select the object cache folder to '<site direcotry>/wwwroot/AptifyServicesAPI/bin'.
    
14. Select the 'Repository User' as a System Administrator user.
    
15. Select the 'Specify Sync Repository Object Record' option and select 'Object name' as 'Aptify HTML5 Web' from the drop-down list.
    

16. Click 'Next'.

    The Synchronizer will identify the list of required dlls that need to be synchronized.

17. Click 'Next'.
18. Click'Finish' to update the DLLs in the AptifyServicesAPI/bin folder.
19. Repeat steps from Step 12 to Step 14.
20. Select the 'Select Objects for Synchronization' option.
    
21. Click 'Next'.
22. Select the 'ElectronicPayment.PaymentsBrands' option.
    
23. Click 'Next'.
24. Click to 'Finish' to update the electronic payment brands dll in the AptifyServicesAPI/bin folder.
25. Log in to Aptify Smart Client with administrative privileges.
26. Navigate to 'Order Entry Administration' application.
27. Open 'Merchant Accounts' service.
    
28. Find the 'Payment Brands Provider' merchant accounts record.
    
29. Open the  'Payment Brands Provider' merchant accounts record.

30. Checkmark 'Is Active?' checkbox to activate the 'Payment Brands Provider' merchant account.

31. Navigate to 'Attributes' tab and include the attribute values for the below:
    

    1. GatewayLocation (for example: 'https://*****/tansaction')

    2. Username
    3. Password
    4. TokenKey
    5. TokenURL (for example: 'https://*****/tokens')
    6. OverrideAddressValidation.
       
32. Set the 'Currency Types' to 'US Dollar'.
    
33. Save and close the record.
34. Log out from Aptify Smart Client.
35. Log into Aptify Smart client again and make sure all the changes carried out are shown.

For Aptify 5.5.4

1. Backup your database before starting the installation process.
2. Log into the Aptify database server with an account that has administrative privileges.
3. If you have not already done so, back up your Aptify database server.
4. Close the Aptify desktop application on the database server, if currently running.

5. Download the Aptify Community Brands Payment Gateway Installer ZIP file to a folder on the database server and unzip its contents.

   When using low-end hardware, Aptify recommends running the installation program locally on the database server; do not run it over the network.

   The Windows API requires that fully qualified file names are less than 260 characters. Aptify recommends that the Aptify Community Brands Payment Gateway Installer ZIP file is unzipped in a folder close to the drive's root folder (for example C:\Downloads) in order to limit the possibility of exceeding the character limitation for fully qualified file names imposed by the operating system.

6. Browse to the location of the installation files, right-click the Setup application file, and select the Run As Administrator option to launch the Aptify Community Brands Payment Gateway installation program.

   • On Windows Server 2008, the Run as Administrator option bypasses the server's User Access Control (UAC) for the duration of the installation.

7. Review the Installation welcome screen and click Next to continue.
   
   

8. Enter login information for your database server. Specify an account with system administrator privileges to both the Aptify database and SQL Server. The user should also be tied to a Developer license to ensure that the setup can perform such tasks as entity creation when needed.

   Selecting the System Administrator option when creating a user in the Aptify database sets the user to a dbowner in SQL Server. It does not add the user to the sysadmin role. You will need to manually add the user to the sysadmin role through SQL Server. If in doubt, check the user's permissions in the Security > Logins area of SQL Management Studio before proceeding with the installation.

   

9. The Service Pack Installer automatically identifies the current version of Aptify and components installed on the database server and displays them on your system.

   If the Service Pack Installer does not identify the correct Aptify Version installed on your system, please contact your System Administrator.

   

   
   

10. Click Finish to begin the installation process.

    
    
    

11. Click OK once the installation has been completed successfully.
    
    
    
    
12. Launch the 'Aptify Object Repository Synchronizer'.
    
    
13. Browse and select the object cache folder to '<site direcotry>/wwwroot/AptifyServicesAPI/bin'.
    
14. Select the 'Repository User' as a System Administrator user.
    
15. Select the 'Specify Sync Repository Object Record' option and select 'Object name' as 'Aptify HTML5 Web' from the drop-down list.
    

16. Click 'Next'.

    The Synchronizer will identify the list of required dlls that need to be synchronized.

17. Click 'Next'.
18. Click 'Finish' to update the dlls in the AptifyServicesAPI/bin folder.
19. Repeat steps from Step 12 to Step 14.
20. Select the 'Select Objects for Synchronization' option.
    
21. Click 'Next'.
22. Select the 'ElectronicPayment.PaymentsBrands' option.
    
23. Click 'Next'.
24. Click to 'Finish' to update the electronic payment brands dll in the AptifyServicesAPI/bin folder.
25. Navigate to '<site direcotry>/wwwroot/AptifyServicesAPI' folder.
26. Locate and open the Web.Config' file and update the 'Newtonsoft.Jason' attribute as per the below figure.
    
27. Save and close the 'Web.Config'file.
28. Log in to Aptify Smart Client with administrative privileges.
29. Navigate to 'Oder Entry Administration' application.
30. Open 'Merchant Accounts' service.
    
31. Find the 'Payment Brands Provider' merchant accounts record.
    
32. Open the  'Payment Brands Provider' merchant accounts record.

33. Checkmark 'Is Active?' checkbox to activate the 'Payment Brands Provider' merchant account.

    Make sure you use one active merchant account for one payment type to be aware of which merchant account is in use.

34. Navigate to 'Attributes' tab and include the attribute values for the below:
    
    1. GatewayLocation (for example: https://*****/tansaction)
    2. Username
    3. Password
    4. TokenKey
    5. TokenURL (for example: https://*****/tokens)
    6. OverrideAddressValidation.
       
35. Set the 'Currency Types' to 'US Dollar'.
    
36. Save and close the record.
37. Log out from Aptify Smart Client.
38. Log into Aptify Smart client again and make sure all the changes carried out are shown.