Winter '25 Revenova PayIQ Installation Guide

Winter ‘25 PayIQ Installation

Instructions

Installation and System-Level Configuration should be performed with the assistance of the System Administrator or Revenova Support.

Package Installation

In order to install PayIQ onto a TMS installation, complete the following steps.

Obtain the latest install link and password by contacting Revenova Support.
Use the password provided, and use the Install for all Users setting.
Check the acknowledgement and click Install.
Wait a few minutes for the application to complete the installation process. An email is sent upon completion of the installation.
Delete the following field when upgrading the TMS to the Fall ‘24 release.
1. From Setup → Object Manager navigate to the Load object.
  1. Delete the Driver Assignment Status field.

Assign Licenses to User Accounts

Assign TMS PayIQ licenses to the appropriate users. Only licensed users have access to PayIQ objects and fields.

PayIQ Fields and Related Lists

Add fields and related lists to the Load record page to allow Users to view pay from the Load the pay was generated.

Navigate to Setup → Object Manager → Load object → Lightning Record Pages. Select the appropriate Load record page.

If necessary, assign the record page as the org default for all users, app default, or app/record type/profile settings. See Salesforce documentation linked in the dialog under “Learn more about Lightning page assignment” for more information.

After assigning the default, customize the Load page layout with the following lists and fields that are applicable to PayIQ.

Participant Matches (related list)
Pay Details (related list)
PayIQ Logs (related list)
PayIQ Locked (field)
Sales Lead (Contact) (field - only relevant if this field is used for pay)
Custom PayIQ Eligible Date (field - only relevant if this field is used to customize when a Load is paid)

Save the page layout when complete.

Permission Sets

One permission set is included with the PayIQ package: TMS Developer PayIQ. This permission set includes all objects and fields within the PayIQ package. Assess the business needs and develop appropriate permission sets for users based on data accessibility. See additional Salesforce documentation on Permission Sets here.

Review fields added by the installation in the PayIQ Data Dictionary. Set user CRUD access as needed.

Sharing Settings

In order for Pay Estimates to appear in the Fleet Email Loop, create sharing rules for the Pay Estimate and Pay Estimate Detail objects.

From Setup, search for and select Sharing Settings.
In the Manage sharing settings for: drop-down, select the Pay Estimate object.
In the Sharing Rules section, click the New button.
1. Enter a Rule Name Label to generate the
2. Select the Guest user access, based on criteria radio button.
3. Choose a Field from the list of Criteria and select an Operator with a nonsensical Value. See the screenshot below for an example.
4. In the Share With drop-down, select Email_Loop Site Guest User.
5. Confirm the Access Level is set to Read Only.
6. Click Save.
Repeat the steps from the Manage sharing settings for: drop-down for the Pay Estimate Detail object.

Upgrading from a Previous Version

Follow the upgrade steps from the oldest release to the newest release, in order, for any upgrades that span multiple releases.

Winter ‘25 PayIQ Upgrade Instructions

All steps below must be completed.

Install and test in a sandbox environment before upgrading to the production environment.
Install and completely configure the PayIQ 7.4 package before installing this upgrade.
Add required picklist values before installing the upgrade package.
1. From Setup → Object Manager navigate to the following objects.
  1. Search for and select the Calculation Tier object.
    1. Select the Fields & Relationships tab. Choose the Calculation Method field.
    2. In the Values section, click the New button.
    3. Enter the following values in the box each on a single line and click Save.
      These picklist values are case-sensitive and must be entered exactly as spelled.
      1. Percent of Load Custom Amount
      2. Rate Per Hour
      3. Rate per Mile
      4. Rate per Kilometer
    4. Select the Fields & Relationships tab. Choose the Criteria field.
    5. In the Values section, click the New button.
    6. Enter the following values in the box each on a single line and click Save.
      1. Load Custom Amount
      2. Hours
      3. Distance (Miles)
      4. Distance (Km)
  2. Search for and select the Participant object.
    1. Select the Fields & Relationships tab. Choose the Type field.
    2. In the Values section, click the New button.
    3. Enter the following values in the box each on a single line and click Save.
      1. Driver
      2. Fleet Asset
  The PayIQ Winter ‘25 package installation updates and renames these picklist values automatically to expand functionality.
Obtain the Winter ‘25 installation URL and password from your Revenova representative.
1. Install the upgrade.
  1. Select Install for All Users.
  2. Click Upgrade.
  3. Check the Yes, grant access to these third-party web sites box.
  4. Click Continue.
  5. In Setup, find Deployment Status and click the link to view the progress of the installation.
  6. Wait for the Installation succeeded email.
From PayIQ Admin, select the Configuration tab. Click the Execute Release Update button ONCE and wait for the email indicating completion. This process completes the following tasks.
1. Inserts the following picklist values. (Object → Field → Picklist Value)
  1. Calculation Tier → Calculation Method → Amount per Load.
  2. Calculation Tier → Calculation Method → Percent of Load Margin.
  3. Calculation Tier → Calculation Method → Percent of Load Margin with Min.
  4. Calculation Tier → Calculation Method → Percent of Load Margin with Max.
  5. Calculation Tier → Calculation Method → Percent of Load Margin (Sliding Scale).
  6. Calculation Tier → Calculation Method → Percent of Load Revenue.
  7. Calculation Tier → Calculation Method → Percent of Load Custom Amount.
  8. Calculation Tier → Calculation Method → Rate per Driver Log/Trip Plan Leg Hour.
  9. Calculation Tier → Calculation Method → Rate per Driver Log/Trip Plan Leg Mile.
  10. Calculation Tier → Calculation Method → Rate per Driver Log/Trip Plan Leg Kilometer.
  11. Calculation Tier → Criteria → Load Margin.
  12. Calculation Tier → Criteria → Load Margin %.
  13. Calculation Tier → Criteria → Load Revenue.
  14. Calculation Tier → Criteria → Load Count.
  15. Calculation Tier → Criteria → Load Custom Amount.
  16. Calculation Tier → Criteria → Driver Log/Trip Plan Leg Hours.
  17. Calculation Tier → Criteria → Driver Log/Trip Plan Leg Distance (Miles).
  18. Calculation Tier → Criteria → Driver Log/Trip Plan Leg Distance (Km).
  19. Calculation Tier → Financial Aggregation Method → Aggregated per period.
  20. Calculation Tier → Financial Aggregation Method → Individual (do not aggregate).
  21. Participant → Type → User.
  22. Participant → Type → Contact.
  23. Participant → Type → Driver.
  24. Participant → Type → Fleet Asset.
  25. Role → Eligible Date Field → Expected Ship Date.
  26. Role → Eligible Date Field → Expected Delivery Date.
  27. Role → Eligible Date Field → Custom Pay Eligible Date.
  28. Role → Eligible Date Field → Certified as of.
  29. Role → Eligible Date Field → Arrival Date.
  30. Role → Eligible Date Field → Departure Date.
  31. Role → Eligible Date Field → Last Leg Arrival Date.
  32. Role → Eligible Date Field → Last Leg Departure Date.
  33. Role → Role Field → Customer Sales Rep.
  34. Role → Role Field → Carrier Sales Rep.
  35. Role → Role Field → Sales Lead (Contact)
2. Removes the following picklist values. (Object → Field → Picklist Value)
  1. Role → Eligible Date Field → Custom PayIQ Eligible Date.
  2. Role → Role Field → Sales Lead (Contact).
3. Adds the Dependencies for the following picklist values.
  1. Role → Role Field → Customer Sales Rep.
  2. Role → Role Field → Carrier Sales Rep.
  3. Role → Role Field → Sales Lead (Contact).
4. Updates existing field values in the obsolete Load Role fields to the new Role fields.
5. Sets the Calculation Tier Criteria Revenue Number and Calculation Revenue Number field values to Full Revenue.
6. Updates existing obsolete Load Filters to the Filter Table field value Load.
  Any errors encountered while running the Release Update Job are sent to the email account for the User running the job. Errors can also be found in the Apex Jobs view.
Add required picklist values and dependencies.
1. From Setup → Object Manager navigate to the following objects to set field dependencies.
  1. Search for and select the Role object.
  2. Select the Parent Object field.
    1. In the Field Dependencies section, click the New button.
      1. Select the Parent Object field as the Controlling Field.
      2. Select Eligible Date field as the Dependent Field.
      3. Click the Continue button.
      4. Choose the following values to include for the Load, Driver Log, and Trip Plan Leg columns.
        Load: Expected Ship Date, Expected Delivery Date, Custom PayIQ Eligible Date.
        Driver Log: Certified as of.
        Trip Plan Leg: Arrival Date, Departure Date, Last Leg Arrival Date, Last Leg Departure Date.
      5. Click the Include Values button.
      6. Click Save.
  3. Select the Parent Object field.
    1. In the Field Dependencies section, click the New button.
      1. Select the Parent Object field as the Controlling Field.
      2. Select the Lookup Type field as the Dependent Field.
      3. Click the Continue button.
      4. Choose the following values to include for the Load, Driver Log, and Trip Plan Leg columns.
        Load: User, Contact.
        Driver Log: Driver.
        Trip Plan Leg: Driver, Fleet Asset.
      5. Click the Include Values button.
      6. Click Save.

Winter ‘25 Field Modification Summary

Note:
Review fields added by the installation. Set CRUD access as needed.

Object	Field/Field Set	Action	Notes
Accessorial Rule		Add	New object to define the rules for accessorial charges.
Accessorial Rule	Accessorial	Add	Support for paying accessorial charges.
Accessorial Rule	Amount	Add	Support for paying accessorial charges.
Accessorial Rule	PayIQ Program	Add	Support for paying accessorial charges.
Accessorial Rule	Percent	Add	Support for paying accessorial charges.
Accessorial Rule	Rule	Add	Support for paying accessorial charges.
Accessorial Rule	Type	Add	Support for paying accessorial charges.
Calculation Tier	Calculation Custom Currency Field	Add	Support for defining calculation tiers to determine pay brackets.
Calculation Tier	Calculation Driver Log Distance Field(s)	Add	Support for defining calculation tiers to determine pay brackets.
Calculation Tier	Calculation Driver Log Duration Field(s)	Add	Support for defining calculation tiers to determine pay brackets.
Calculation Tier	Calculation Revenue Number	Add	Support for defining calculation tiers to determine pay brackets.
Calculation Tier	Criteria Custom Currency Field	Add	Support for defining calculation tiers to determine pay brackets.
Calculation Tier	Criteria Driver Log Distance Field(s)	Add	Support for defining calculation tiers to determine pay brackets.
Calculation Tier	Criteria Driver Log Duration Field(s)	Add	Support for defining calculation tiers to determine pay brackets.
Calculation Tier	Criteria Revenue Number	Add	Support for defining calculation tiers to determine pay brackets.
Fleet Asset	Pay Settlement Email CC	Add	Support for emailing pay settlements.
Fleet Asset	Pay Settlement Email To	Add	Support for emailing pay settlements.
Filter		Modify	Load Filter object renamed to Filter.
Filter	API Value	Add	Support for Filter records.
Filter	Field	Add	Support for Filter records.
Filter	Field API Name	Modify	Renamed Field API Name field to API Field.
Filter	Table	Add	Support for Filter records.
Load	Custom PayIQ Amount	Add	Support for pay generation.
Log		Modify	PayIQ Log object renamed to Log.
Log	Driver Log	Add	Support for Log records.
Log	Trip Plan Leg	Add	Support for Log records.
Minimum Pay Rule		Add	New object for defining minimum pay per period for a Participant.
Minimum Pay Rule	Contact	Add	Support for minimum Participant pay.
Minimum Pay Rule	Driver	Add	Support for minimum Participant pay.
Minimum Pay Rule	Fleet Asset	Add	Support for minimum Participant pay.
Minimum Pay Rule	Minimum Pay (Per Period)	Add	Support for minimum Participant pay.
Minimum Pay Rule	Pay Schedule	Add	Support for minimum Participant pay.
Minimum Pay Rule	Payee Name	Add	Support for minimum Participant pay.
Minimum Pay Rule	Payee Type	Add	Support for minimum Participant pay.
Minimum Pay Rule	User	Add	Support for minimum Participant pay.
Participant	Allow Pay Estimates	Add	Additional support for Participants.
Participant	Driver	Add	Additional support for Participants.
Participant	Email Out Pay Estimates	Add	Additional support for Participants.
Participant	Fleet Asset	Add	Additional support for Participants.
Participant	Pay Off Load	Add	Additional support for Participants.
Participant Match		Modify	PayIQ Participant Match object renamed to Participant Match.
Participant Match	Driver Log	Add	Additional support for matching Participants.
Participant Match	Trip Plan Leg	Add	Additional support for matching Participants.
Pay Adjustment	Generated	Add	Additional support for Pay Adjustments.
Pay Adjustment	Minimum Pay Rule	Add	Additional support for Pay Adjustments.
Pay Adjustment	Pay Advance	Add	Additional support for Pay Adjustments.
Pay Adjustment	Pay Approved	Add	Additional support for Pay Adjustments.
Pay Adjustment	PayIQ Program	Add	Additional support for Pay Adjustments.
Pay Adjustment	Remaining Balance	Add	Additional support for Pay Adjustments.
Pay Advance		Add	New object to define Advance payments or deductions.
Pay Advance	Adjustment Plan	Add	Support for advance payments or deductions.
Pay Advance	Amount Per Pay Period	Add	Support for advance payments or deductions.
Pay Advance	Category	Add	Support for advance payments or deductions.
Pay Advance	Contact	Add	Support for advance payments or deductions.
Pay Advance	Description	Add	Support for advance payments or deductions.
Pay Advance	Driver	Add	Support for advance payments or deductions.
Pay Advance	Fleet Asset	Add	Support for advance payments or deductions.
Pay Advance	Item Total	Add	Support for advance payments or deductions.
Pay Advance	Paid Amount	Add	Support for advance payments or deductions.
Pay Advance	Payee Name	Add	Support for advance payments or deductions.
Pay Advance	Payee Type	Add	Support for advance payments or deductions.
Pay Advance	Percent Per Pay Period	Add	Support for advance payments or deductions.
Pay Advance	Qty	Add	Support for advance payments or deductions.
Pay Advance	Rate	Add	Support for advance payments or deductions.
Pay Advance	Receipt Attached	Add	Support for advance payments or deductions.
Pay Advance	Remaining Balance	Add	Support for advance payments or deductions.
Pay Advance	Transaction Date	Add	Support for advance payments or deductions.
Pay Advance	Type	Add	Support for advance payments or deductions.
Pay Advance	User	Add	Support for advance payments or deductions.
Pay Advance	Wait For Next Period To Begin Adjusting	Add	Support for advance payments or deductions.
Pay Detail	Accessorial	Add	Additional Pay Header itemization support.
Pay Detail	Accessorial Qty	Add	Additional Pay Header itemization support.
Pay Detail	Accessorial Rule	Add	Additional Pay Header itemization support.
Pay Detail	Accessorial Total	Add	Additional Pay Header itemization support.
Pay Detail	Converted Freight (Invoiced)	Add	Additional Pay Header itemization support.
Pay Detail	Converted Freight (Quoted)	Add	Additional Pay Header itemization support.
Pay Detail	Converted Fuel (Invoiced)	Add	Additional Pay Header itemization support.
Pay Detail	Converted Fuel (Quoted)	Add	Additional Pay Header itemization support.
Pay Detail	Driver	Add	Additional Pay Header itemization support.
Pay Detail	Driver Log	Add	Additional Pay Header itemization support.
Pay Detail	Fleet Asset	Add	Additional Pay Header itemization support.
Pay Detail	Trip Plan Leg	Add	Additional Pay Header itemization support.
Pay Detail	Trip Plan Leg Accessorial	Add	Additional Pay Header itemization support.
Pay Estimate		Add	New object to define Pay Estimate records for a Trip Plan Segment.
Pay Estimate	Driver	Add	Support for Pay Estimates for a Trip Plan.
Pay Estimate	Email Out Pay Estimate	Add	Support for Pay Estimates for a Trip Plan.
Pay Estimate	Estimate Date	Add	Support for Pay Estimates for a Trip Plan.
Pay Estimate	Expired	Add	Support for Pay Estimates for a Trip Plan.
Pay Estimate	Fleet Asset	Add	Support for Pay Estimates for a Trip Plan.
Pay Estimate	Grand Total	Add	Support for Pay Estimates for a Trip Plan.
Pay Estimate	Matched From Driver Log Program	Add	Support for Pay Estimates for a Trip Plan.
Pay Estimate	Status	Add	Support for Pay Estimates for a Trip Plan.
Pay Estimate	Trip Plan Segment	Add	Support for Pay Estimates for a Trip Plan.
Pay Estimate Detail		Add	New object to define Detail records for a pay estimate.
Pay Estimate Detail	Accessorial	Add	Support for creating pay estimates.
Pay Estimate Detail	Accessorial Qty	Add	Support for creating pay estimates.
Pay Estimate Detail	Accessorial Rule	Add	Support for creating pay estimates.
Pay Estimate Detail	Accessorial Total	Add	Support for creating pay estimates.
Pay Estimate Detail	Adjustment	Add	Support for creating pay estimates.
Pay Estimate Detail	Amount	Add	Support for creating pay estimates.
Pay Estimate Detail	Calculation Tier	Add	Support for creating pay estimates.
Pay Estimate Detail	Comment	Add	Support for creating pay estimates.
Pay Estimate Detail	Converted Freight (Quoted)	Add	Support for creating pay estimates.
Pay Estimate Detail	Converted Fuel (Quoted)	Add	Support for creating pay estimates.
Pay Estimate Detail	Converted Margin (Quoted)	Add	Support for creating pay estimates.
Pay Estimate Detail	Converted Revenue (Quoted)	Add	Support for creating pay estimates.
Pay Estimate Detail	Item Total	Add	Support for creating pay estimates.
Pay Estimate Detail	Load	Add	Support for creating pay estimates.
Pay Estimate Detail	Pay Estimate	Add	Support for creating pay estimates.
Pay Estimate Detail	PayIQ Program	Add	Support for creating pay estimates.
Pay Estimate Detail	Trip Plan Leg	Add	Support for creating pay estimates.
Pay Header	Driver	Add	Additional Pay Header support.
Pay Header	Fleet Asset	Add	Additional Pay Header support.
Pay Header	Sent Pay Settlement	Add	Additional Pay Header support.
PayIQ Program	Has Trip Plans Paying Off Loads	Add	Additional PayIQ Program support.
PayIQ Program	Number of Driver Log Roles	Add	Additional PayIQ Program support.
PayIQ Program	Number of Load Roles	Add	Additional PayIQ Program support.
PayIQ Program	Number of Trip Plan Leg Roles	Add	Additional PayIQ Program support.
PayIQ Stored Aggregate		Add	New object to store aggregate values when matching to Participants, per period, per Participant.
PayIQ Stored Aggregate	Driver Log Active Duration (Hours)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Driver Log Driving Distance (Km)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Driver Log Driving Distance (Miles)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Driver Log Driving Duration (Hours)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Driver Log On Duty Duration (Hours)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Driver Log Sleeper Berth Duration (Hrs)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Driver Log Waiting Time Duration (Hours)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Driver Log Yard Move Distance (Km)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Driver Log Yard Move Distance (Miles)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Driver Log Yard Move Duration (Hours)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Freight (Invoiced)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Freight (Quoted)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Fuel (Invoiced)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Fuel (Quoted)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Load Count	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Margin (Invoiced)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Margin (Quoted)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Participant	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Pay Period	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Revenue (Invoiced)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Revenue (Quoted)	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Trip Plan Leg Hours	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Trip Plan Leg Kilometers	Add	Stores aggregate values when matching to Participants.
PayIQ Stored Aggregate	Trip Plan Leg Miles	Add	Stores aggregate values when matching to Participants.
Role		Modify	Renamed the Load Role object to Role.
Role	Parent Object	Add	Support for identifying eligible participants.
User	Allow Overriding Estimates	Add	Support for identifying eligible participants.
User	Estimate Adjustment Lower Limit	Add	Support for identifying eligible participants.
User	Estimate Adjustment Upper Limit	Add	Support for identifying eligible participants.