--- title: "Spring '25 Revenova PayIQ Installation Guide" slug: "spring-25-revenova-payiq-installation-guide" tags: ["PayIQ", "Admin", "Expanded Content"] updated: 2025-06-09T17:37:33Z published: 2025-08-08T18:57:50Z canonical: "documents.revenova.com/spring-25-revenova-payiq-installation-guide" excludeFromExternalSearch: true --- > ## Documentation Index > Fetch the complete documentation index at: https://documents.revenova.com/llms.txt > Use this file to discover all available pages before exploring further. # Spring '25 Revenova PayIQ Installation Guide ## **Spring ‘25 PayIQ Installation** ## **Instructions** Installation and System-Level Configuration should be performed with the assistance of the System Administrator or Revenova Support. > [!WARNING] > Complete the installation of the TMS Spring ‘25 package first before installing the Spring ‘25 PayIQ package. If upgrading an existing PayIQ installation, make sure the Winter ‘25 PayIQ package is installed and configured before proceeding. ### Package Installation In order to install PayIQ onto a TMS installation: 1. Obtain the latest install link and password by contacting Revenova Support. 2. Use the password provided, and use the **Install for all Users** setting. 3. Check the acknowledgement and click **Install**. 4. Wait a few minutes for the application to complete the installation process. An email is sent upon completion of the installation. ![](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/image-1708095357161.png) ## 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](https://help.salesforce.com/s/articleView?id=sf.lightning_app_builder_customize_lex_pages_activate.htm&type=5)” 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](https://help.salesforce.com/s/articleView?id=sf.perm_sets_overview.htm&type=5). > [!NOTE] > Review fields added by the installation here. 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**, **Pay Estimate Detail**, and **PayIQ Program** objects. 1. From **Setup**, search for and select *Sharing Settings*. 2. In the *Manage sharing settings for:* drop-down, select the **Pay Estimate** object. 3. 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. 1. Avoid using a picklist field when using the *not equal to* operator. Salesforce expects an existing picklist value. 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**. 7. The Sharing Rule also applies to the **Pay Estimate Detail** object. This object does not require a sharing rule as it is a Master-Detail relationship to the Pay Estimate object. 4. Repeat the steps from the *Manage sharing settings for:* drop-down for the **PayIQ Program** object. ![](https://cdn.document360.io/b89abf73-101a-4754-a781-084aef8f68dd/Images/Documentation/sharing setting.png) ## **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. > [!WARNING] > Complete the installation of the TMS Spring ‘25 package first before installing the Spring ‘25 PayIQ package. If upgrading an existing PayIQ installation, make sure the Winter ‘25 PayIQ package is installed and configured before proceeding. ### Spring ‘25 PayIQ Upgrade Instructions All steps below must be completed. 1. You must **install and test in a sandbox** **environment** before upgrading to the production environment. 2. You must have installed and completely configured the **PayIQ Winter ‘25** before installing this upgrade. 3. Obtain the **Spring ‘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. 4. 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. Renames the following picklist values. (Object → **Field** → Old Value → *New Value*) > [!WARNING] > 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. 1. Calculation Tier → **Calculation Method** → Rate per Driver Log/Trip Plan Leg Hour → *Rate per Driver Log Hour*) 2. Calculation Tier → **Criteria** → Driver Log/Trip Plan Leg Hours → *Driver Log Hours*) 5. PayIQ includes two additional fields that may be added to the Fleet Asset. If paying against Fleet Assets, add the following fields to the Fleet Asset Lightning Record Page. 1. Navigate to a Fleet Asset record and select **Setup** → **Edit Page**. 2. Select the *Fields* tab. 3. Drag the following fields onto the Lightning Record Page. 1. **Pay Settlement Email CC** 2. **Pay Settlement Email To** 4. Click **Save**. ### Spring ‘25 Field Modification Summary > [!NOTE] > Review fields added by the installation. Set CRUD access as needed. | **Object** | **Field/Field Set** | **Action** | **Notes** | | --- | --- | --- | --- | | Calculation Tier | Calculation Method | Modify | Relabeled picklist value “Driver Log/Trip Plan Leg Hours” to “Driver Log Hours.” | | Calculation Tier | Criteria | Modify | Relabeled picklist value “Rate per Driver Log/Trip Plan Leg Hour” to “Rate per Driver Log Hour.” | | Participant Match | Matched To | Add | Trip Plan reference support. | | Participant Match | Matched To Type | Add | Trip Plan reference support. | | Participant Match | Trip Plan | Add | Trip Plan reference support. | | Participant Match | Trip Plan Segment | Add | Trip Plan reference support. | | Pay Detail | Paid From | Add | Trip Plan reference support. | | Pay Detail | Paid From Type | Add | Trip Plan reference support. | | Pay Detail | Trip Plan | Add | Trip Plan reference support. | | Pay Detail | Trip Plan Segment | Add | Trip Plan reference support. | | Pay Estimate | Trip Plan | Add | Trip Plan reference support. | | Pay Estimate Detail | Estimated From | Add | Trip Plan reference support. | | Pay Estimate Detail | Estimated From Type | Add | Trip Plan reference support. | | Pay Estimate Detail | Trip Plan | Add | Trip Plan reference support. | | Pay Estimate Detail | Trip Plan Segment | Add | Trip Plan reference support. | | PayIQ Log | Trip Plan | Add | Trip Plan reference support. | | PayIQ Log | Trip Plan Segment | Add | Trip Plan reference support. |