Understanding Chargent Updates

Why Update? #

Over the years, Chargent has released various fixes, updates, and new features to enhance our customers’ experience and solve a growing number of use cases. As we move forward, we want to ensure that all our customers are on the most current version of Chargent. Updating will also ensure that Chargent continues working with the most current versions of Salesforce. Better yet, it’s free to update!

To help you update from older versions of Chargent, we have compiled a list of considerations and best practices to help guide you through the process.

Not sure what version of Chargent you’re on? Here’s how to find out!

Push Updates #

Starting in 2023, we began rolling out push updates to groups of customers using Chargent version 6.0 and above. Email notifications are sent to each customer individually so you know exactly when the updates will occur. We plan to move all customers to push updates at a later date.

For more information, visit our Push Updates FAQ.

Update Using the PIM #

You should always use the Package Installation Manager (PIM) on the AppFrontier website if you want to update Chargent manually. Using the PIM, you may only install or update to the latest version of Chargent, which includes features, enhancements, and fixes from all previous versions.

For detailed instructions, visit Installing and Updating Chargent.

Update in a Sandbox First #

Chargent always recommends updating your Sandbox first. Your Production Org will process real credit card transactions. Testing in a Sandbox will allow you to verify compatibility with your Salesforce customizations without jeopardizing your data. This will help prevent any damage to the existing data or accidentally processing erroneous charges to your customers. That is why updating and testing in your Sandbox is always essential. You should test your current payment flows as both an Admin and an end user.

Every gateway has its own considerations and test card data. For more information, visit the Payment Gateway Guide for your specific gateway.

Note: If you are using a Full or Partial copy sandbox, your data, batches, and gateways (including any value in Endpoint Override field) will be copied from your Production org. Ensure you disable the Recurring Billing Batch to make sure no accidental live transactions are processed.

After updating and testing in your sandbox, you’re ready to update Chargent in Production. Make sure you run a live transaction — either a customer transaction you prepared for the switch or use your credit card and void it afterward.

Release Notes #

To learn about the most recent features, fixes, and updates to Chargent, see our Release Notes.

Updating from Chargent v5.20 or Lower #

Card Security Code (CSC) Wizard

In version 5.20, Chargent released the CSC Wizard. The CSC Wizard was designed to walk you through removing the CSC field and its data from your Salesforce Org. This was done to help make your Salesforce Org more PCI Compliant. Review the following information if you are updating from a version at or below 5.20.

• Tokenization should be enabled if you are processing recurring payments. If you are not currently using tokenization with Recurring Billing, removing the CSC field could cause some payments to decline. You should ensure you enable and test tokenization before you update.

• The CSC field can be set as required in your gateway portal and on the Gateway record in Chargent. When you update, you want to ensure this is disabled from both. To disable the CSC in the Chargent Record, navigate to the gateway, edit the page, select Advanced Settings, and uncheck the “Require Security Code” box. Secondly, log into your gateway portal and disable any settings that require the CSC field.

Remove Validation Rules, Automation, or Code that use the CSC field

Since Validation Rules can often prevent records from being saved when the data is not there, you should check over any Validation Rules that may rely on the CSC field. Processes in Process Builder, Flow, Workflow Rules, and Apex Code can also break when removing the CSC field. Remember, the field will no longer exist after updating to 5.20, so anything that relies on that field will no longer work.

Some people who are updating from an earlier version of Chargent may receive the following message:

There is a validation rule(s) that needs to be deleted to move to the next step.  (We wanted to do this for you but, alas, we are unable)

This error message happens when trying to update your Chargent package from one prior to 5.20. Since a Validation Rule uses the Card Security Code (CSC), you need to delete the CSC field from the Validation Rule.

Manually remove the validation rule(s) on the following setup page(s) in your Salesforce instance.

1. Click Setup
2. Visit the Object Manager tab
3. Search for and select the Chargent Order object
4. Click Fields & Relationships in the left sidebar
5. Click the Card Security Code field
6. Scroll to the Validation Rules section
7. If a Validation Rule is present
   • Click Del next to the rule
   • When asked, ‘Are you sure?’ Click OK

You can now continue the update process.

Card Security Code Popup

After updating, there will be no change when processing a payment from the Payment Console or Payment Request. If you are processing a payment from the Chargent Order or Opportunity record, you will see a new popup window asking for the CSC to be entered, but it will not be stored.

When processing a credit card, you may see a message in the popup window saying a “CSC is Required”.  We recommend using tokenization and disabling the Require Security Code box from your Gateway settings. When this setting is disabled, your staff can either enter the card security code or not.

We recommend enabling tokenization with your payment gateway if you are not already using it. Tokenization allows you to store a token corresponding to the payment information stored at your payment gateway for recurring billing or future charges without storing sensitive payment information in Salesforce.

In newer versions of Chargent, when the “Charge” or “Authorize” button is clicked, a popup window will ask for the Card Security Code to send to the payment gateway.

This is optional, and no information should be entered unless you have the “Require Card Security Code” checked on the Gateway record in Salesforce. For most use cases, this field should not be checked.

If you are seeing any issues with your testing, you may be able to adjust Card Security Code verification settings with your Payment Gateway. Most payment gateways allow you to adjust settings related to the Card Security Code, including whether it is needed and validated.

Updating from Chargent v5.55 or Lower #

If updating from Chargent versions prior to 5.55, permissions related to additional Visualforce and Apex will need to be added to your Chargent User profile permissions (look for items with the word Chargent they do not have access to). You can also add the new Chargent Permission Sets to those users.

Updating from Chargent v6.45 or Lower #

Removing Next Transaction Date

The validation rule error, “FIELD_CUSTOM_VALIDATION_EXCEPTION: Next transaction date field is not editable” can occur if the Next Transaction Date field is present on your Chargent Orders Page Layout for Chargent Base and Orders v6.55 and higher (see Release Notes). We recommend that users upgrading from previous versions of Chargent remove the now-deprecated Next Transaction Date field and add the Payment Status Viewer component to their Chargent Orders page layout.

For more information, visit Validation rule error: Next transaction date field is not editable.

Error Messages When Updating #

Please see the following errors that can occur when installing or updating Chargent, along with their associated fix.

If you encounter an “Install Script Exception” error:

• In the AppLauncher, search for and select the Chargent Settings tab
• Navigate to the Advanced Settings subtab
• Click Save (no need to change or enter any values)

You should then be able to continue updating the Chargent packages.

Other errors that you might encounter when attempting to install Chargent include:

• ERROR: The user license doesn’t allow the permission: Delete ChargentBase__Payment_Source__c
• ERROR: “Data Not Available” when updating Chargent
• ERROR: Chargent Logo AppFrontier Document does not have an owning library
• Installation Error – Chargent_Logo_AppFrontier: An unexpected error occurred
• Validation rule error: Next transaction date field is not editable

Updating in Classic #

Customers using Salesforce Classic can update to the most current version the same way as Lightning users.

That being said, Chargent became Lightning Ready in version 5.0. Since Salesforce plans to switch all users to Lightning Experience, we encourage all customers to consider moving to Lightning as soon as possible. As a bonus, many new Chargent features are only available in Lightning.

If you are interested in updating to Lightning, follow these guidelines:

• You are on Chargent version 5.0 or later
• My Domain is set up in your Salesforce Lightning Org
  • There is a time delay from registering My Domain to deployment. Completing this step could take up to 24 hours.
• Chargent Components are on the Lightning Page (Salesforce no longer uses the old buttons)
• The Page is activated and assigned to the correct group of users