Vous êtes sur la page 1sur 21

FinancialForce ClickLink Rule Documentation

for Cash Entries & Chargent

November 15, 2015

Table Of Contents
Version Control ...................................................................................................................................................3
Summary ................................................................................................................................................................3
Step 1: Create Required Fields.....................................................................................................................4
Step 2: Create ClickLink Rules ................................................................................................................... 10
Step 3: Associate Rules ................................................................................................................................ 13
Step 4: Create Buttons ................................................................................................................................. 14
Step 5: Create Scheduling ........................................................................................................................... 19
Step 6: Testing ................................................................................................................................................. 20

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

Version Control
Version
1.0

Description
Initial version

Date
November 15, 2015

Summary
ClickLink is a FinancialForce.com (FFDC) tool that can move data between objects. The
ClickLink process creates a mapping between fields and can be executed using object
buttons or batch job.
This documentation shows how you can eliminate data entry and streamline processes by
connecting FinancialForce.com and the Chargent Payment Processing for Salesforce
application using the ClickLink tool.
Steps to create ClickLink rules:
1.

Create required fields

2.

Create the ClickLink rules

3.

Associate the header and lines rules together

4.

Create the Single and List View Buttons and place it on the page layout

5.

Create the Scheduling job

6.

Test

The below details will follow through the steps on how to create ClickLink rules to be used
with Chargent Payment Processing apps and FinancialForce Accounting (FFA). The
Chargent application will take a credit or ACH payment and create a transaction record.
That transaction record is then used to create a cash entry in FFA.

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

Chargent Transaction Types and their FFA behavior:


o Authorization no FFA cash entry created
o Charge create an FFA cash entry Receipt transaction
o Refund create an FFA cash entry Refund transaction
o Void - create an FFA cash entry Refund transaction
More detailed instructions and online help can be found on the FinancialForce Xtra site.
Request access to this site via your FFDC Customer Success Manager.
User Guide:
https://www.financialforce.com/Security/login?BackURL=%2Fservices%2Fxtra%2Fdocumentat
ion%2Ffinancialforce-clicklink%2Fuser-guide%2F
Online Help:
http://help.financialforce.com/clicklink/5X/Default.htm#topics/Overview.htm%3FTocPath%3D
Overview%7C_____0

Step 1: Create Required Fields


The first steps to create a ClickLink rule is to ensure that all the fields that you need have
been created already. For the creation of a Cash entry the below fields are required.
Additional fields can be created on either the source or target objects and map them.
Bank Account (Chargent Transaction Header):
A Bank Account is required on the cash entry transaction. The bank account can be
defaulted based on the Company or it can be defaulted based on the Gateway the
transaction is coming from.

Option 1 requires the Company set-up for every company to have a default bank
account selected.

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

+ / Companies / Bank Account


Option 2 bank account per Gateway. This will require a few new fields to be
created to add a default bank account per Gateway and bring that information to
the Chargent Transaction
Add new field on Gateway record lookup to FFA Bank Account
**Recommend making required field

Open the Gateway and select a value for Bank Account on all records

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

Create a Formula field to pull the value of the Bank Account onto all transactions
dependent on the Gateway used.
Two fields Bank Account Name and Bank Account ID

No need to put the Bank Account ID field on a page layout as it will only be needed for
ClickLink rules.
Processed (Chargent Transaction Header):
This is a checkbox field that will be populated once a cash transaction has a related cash
entry created.

A workflow needs to be created to change this Processed field when a Void transaction is
created as a Void does not create a new Chargent transaction record but instead changes
the type.
The workflow details are below:

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

Account (Chargent Transaction Header):


Create a formula field to pull the Account ID into the Chargent Transactions object to be
used when creating the cash entry.

Reference Field (Chargent Transaction Header):


When you create the cash entry there should be some sort of reference field created that
can be used to reconcile transactions with cash entries. In this example the Order Number
Name formula field is created on the Transaction object and is used to populate the Cash
Entry Description.

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

Note: This new field does not need to be added to the Transaction page layout for the
user to see.

Cash Entry Type (Chargent Transaction Header):


When a Chargent transaction is a Charge then the cash entry type should be receipt and
when it is a Refund the cash entry type should be Refund.

Authorization (Chargent Transaction Header):


Not all Chargent transactions should create cash entries. Authorization are transactions
that will check the credit card to ensure there is credit available but does not actually
charge the card. To ensure these transactions do not create a cash entry we create a
checkbox on the Transaction that says if it is a transaction that should be processed.
Called the Source Object Process Field on the ClickLink rule.

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

To populate this checkbox correctly there either needs to be a manual process to select
only the transactions that should be processed prior to the next run of the ClickLink
schedule or a workflow could be created to populate it at the correct time.
If creating a workflow it should look something like this where the Authorization never get
a cash receipt created; Charges always get Cash Receipt created; Voids and Refunds get a
Cash Refund created. Note that a transaction can start as a Charge and then change to a
Void therefore the workflow has to run on all edits of transactions.

Absolute Value - (Chargent Transaction Header)


When creating a cash transaction the value always needs to be a positive value. Therefore,
need to create an Absolute value of the order amount and use this field to create the cash
entry.

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

Step 2: Create ClickLink Rules


This is object-to-object and field-to-field mapping. When you have header and lines then
you need to create two rules and associate them to work together.
To create the first rule follow these directions:

+ / ClickLink Rules / New

ClickLink Rule = Cash Entry Header

Source Object = ChargentOrders__Transaction__c

Source Object Name Field = Name

Target Object = c2g__codaCashEntry__c

Target Object Name Field = Name

Source Object Processed Field = Processed__c

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

10

The following table outlines the lines that are required for this ClickLink rule:
Source Field

Target Field

Mapping

Mapping

Source

Type

Literal

Value is
ID

Name

c2g__Reference__c

Source Field

Order_Number__c

c2g__Description__c

Source Field

Bank_Account_ID__c

c2g__BankAccount__c

Source Field

ffcash__DeriveBankAccountDimen

Source Field

True

ffcash__DeriveBankAccount__c

Source Field

True

ffcash__DeriveBankChargesAnalysi

Source Field

True

ffcash__DeriveCurrency__c

Source Field

True

ffcash__DerivePeriod__c

Source Field

True

c2g__Type__c

Source Field

c2g__PaymentMethod__c

Literal

Checked

sions__c

s__c

Cash_Entry_Type__c

Electronic

There are two ways to create these lines on the ClickLink rule there are two buttons
New ClickLink Mapping and New ClickLink Basic Mapping.

The ClickLink Basic Mapping is a great way when the source and target are fields.

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

11

Click on the button New ClickLink Basic Mapping

Select the Source field and the Object Field

Source = Bank Account ID / Target = Bank Account

The ClickLink Mapping allows for more detailed mapping and creation of literal values. I
literal value means that you can enter a name or checkbox value as the same literal value
every time the ClickLink rule is run.

Click on the button New ClickLink Mapping

Select appropriate mapping type based on the table above

Enter source field, mapping literal, source value ID and target field per the table
above

Save

The next step is to create a new ClickLink rule for the Line level information on the cash
entry.
To create the first rule follow these directions:

+ / ClickLink Rules / New

ClickLink Rule = Cash Entry Line Items

Source Object = ChargentOrders__Transaction__c

Source Object Name Field = Name

Target Object = c2g__codaCashEntryLineItem__c

Target Object Name Field = Name

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

12

The following table outlines the lines that are required for this ClickLink rule:
Source Field

Target Field

Mapping

Mapping

Source

Type

Literal

Value is
ID

AccountID__c

c2g__Account__c

Source Field

Null

ChargentOrders__Amount_

c2g__CashEntryValue__c

Source Field

Null

Null

ffcash__DeriveLineNumber__c

Literal

True

Null

ffcash__DerivePaymentMethod__c

Literal

True

Null

ffcash__DeriveAccountDimensions

Literal

True

Checked

_c

__c

Step 3: Associate Rules


When there is a header and line relationship between two ClickLink rules there needs to be
an association made between the two of them.
Open the Header ClickLink rule and select the New ClickLink Relationship button:

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

13

Enter the following information:

Description = Header to Lines

Detail ClickLink Rule = Cash Entry Line Items

Target Relationship Field = c2g__CashEntry__c

Step 4: Create Buttons


Now that the button has been created there needs to be a way to execute this rule. There
are two buttons that are created:
1.

Detail Page Button this will create a button that will allow a user to create a
cash entry from the transactions.

2.

List Button this will create a button on the Transactions list view to create
multiple cash entries from a selection of transactions.

Detail Page Button:

Open the Header ClickLink rule and scroll down to the ClickLink buttons related list
and select New ClickLink Button.

Enter a name for the button and select the Save button. After save you will see the
button page samples listed as below.

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

14

Use the Detail Page Button information to create a VisualForce Page

Setup / Develop / VisualForce Pages / New

Create a Label and Description then paste the Detail Page Button code from the
ClickLink Button page onto the VisualForce Page
o Label = CL_CreateFFCashReceipt
o Description = This page will be used on a button on the
ChargentOrders__Transactions object to create an FFA Cash Receipt.

Save.

Then go back to the ClickLink Button page and associate this VF page with the
button:

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

15

Then go to the ChargentOrders__Transactions__c object

Buttons/Links and Actions / New Button or Link

Enter in the details as below and select the VisualForce page you just created. Save

Go to the page layout of the ChargentOrders__Transactions__c object and add the


new button to the layout

List View Button:


AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

16

Open the Header ClickLink rule and scroll down to the ClickLink buttons related list
and select New ClickLink Button.

Enter a name for the button and select the Save button. After save you will see the
button page samples listed as below.

Use the List Button information to create a VisualForce Page

Setup / Develop / VisualForce Pages / New

Create a Label and Description then paste the Detail Page Button code from the
ClickLink Button page onto the VisualForce Page
o Label = CL_CreateFFCashReceipt
o Description = This page will be used on a button on the
ChargentOrders__Transactions object List View to create an FFA Cash Receipt.

Save.

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

17

Then go back to the ClickLink Button page and associate this VF page with the
button and enter the name of the VisualForce page in the Button Detail field:

Then go to the ChargentOrders__Transactions__c object

Buttons/Links and Actions / New Button or Link

Enter in the details as below and select the VisualForce page you just created. Save

Go to the page layout of the ChargentOrders__Transactions__c object and select the


Search Layout and Edit Transactions List View

Add the new button to the List View

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

18

Step 5: Create Scheduling


The above buttons will allow a manual step between the transaction and cash entry which
is often beneficial. However, there is often a need for this job to be a scheduled job. To
complete that follow the below instructions.
Note the Processed flag is always checked when the cash entry has been created and
therefore this job will only select the entries that have Processed__c = null. Create a new
List view on the Transactions object that pulls only Processed__c = null and use that as
part of the job info below.

+ / ClickLink Jobs / New

Enter the data into the Job Fields as below


o ClickLink Rule = Cash Entry Header
o Job Name = Create FF Cash Receipts
o List View Name = Processed_null (or unique list view name of list created as
above)

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

19

This job can be run by selecting the Run Now button on the ClickLink Job object
or the Schedule Job

Before scheduling the Edit Schedule button should be selected


o Select the schedule that you want the job to run; daily, weekly, etc

o
o Click Save

Click Schedule Job you will receive a message like the below:

o
This job will now be listed in the Scheduled jobs list
o Setup / Jobs / Scheduled Jobs

Step 6: Testing
Use Cases to be tested:
AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

20

1.

Create Chargent transactions and select the Creae FF Receipt button on object.
The expected results are as follows:
a. Authorization no cash entry
b. Charge cash entry with type = Receipt
c. Refund - cash entry with type = Refund
d. Void - cash entry with type = Refund

2.

Button on list view


a. Authorization no cash entry
b. Charge cash entry with type = Receipt
c. Refund - cash entry with type = Refund
d. Void - cash entry with type = Refund

3.

Scheduled job
a. Authorization no cash entry
b. Charge cash entry with type = Receipt
c. Refund - cash entry with type = Refund
d. Void - cash entry with type = Refund

Once the Cash entry is created select the Post button. Once posted there will be a FFA
Transaction created. Click on the Transaction link associated to the cash entry and you
will see the DR and CR.
Account Entries for Charge:

Accounting Entries for Refund:

AppFrontier LLC | Chargent Payment Processing for Salesforce | www.AppFrontier.com

21