Skip to main content
Skip table of contents

Installing the Apps Managed Package

This document describes the steps required to install and configure the Apps Managed Package.

Pre Installation

1 - Install dependent packages

  1. Pitcher Zero - Install the dependent or higher version for Pitcher Zero

2 - Remove deleted components

  1. This step is only valid while upgrading to Pitcher Apps 0.102

  2. Set up → Custom Metadata Types

  3. Search → Lightning Builder (PCH__Lightning_Builder__mdt)

  4. Now click delete (as per the screenshot below) for the below fields, which are deleted from the package but still available in the subscriber org -

    1. Field 1 (Managed - Installed Deleted) -

      1. Label Name - Actions: Custom Controller Class

      2. API Name - PCH__Actions_Custom_Controller_Class__c

    2. Field 2 (Managed - Installed Deleted) -

      1. Label Name - Actions: Custom Controller Class

      2. API Name - PCH__Actions_Custom_Controller_Class__c

  5. Now there should not be any error related to these fields during the upgrade.

3 - Skip the upgrade version

  1. This step is only valid while upgrading to Pitcher Apps 0.91

  2. Only if the “method does not exist copyShareRecords” error occurs

  3. If the below error occurs -

    1. If the below error is Apex compile failure, Details: Apex class AccountExecutionTriggerHandler: line 84, column 21: Method does not exist or incorrect signature: void copyShareRecords(String, String, List<PCH__Account_Execution__c>) from the type PCH.SYS_Utility Apex compile failure.

  4. Then skip the update to Apps 0.91 and directly update to Apps 0.99

Installation

Follow these steps to install/upgrade the package:

  1. Enter the package installation link obtained from your Pitcher representative. This should redirect you to the login page of Salesforce.com. For Sandbox organizations, swap http://login.salesforce.com with http://test.salesforce.com in the URL.

  2. Select Install for Admins Only Install for All Users, or Install for Specific Profiles, depending on the need.

  3. On the Approve Third-Party Access dialogue that appears, use the checkbox to grant access to the Sentry application and click Continue to begin the installation.

  4. To verify the package components before installation/upgrade, click on the “View Components” link

  5. Check the acknowledgement and click Install to proceed.

  6. Once installation completes, the following screen appears:

  7. To confirm the successful installation, check the installed packages, on the Setup > Apps > Packaging > Installed Packages page.

    The Installed Packages Page

  8. To verify the package components after a successful installation/upgrade, follow the steps shown below -

Post Installation

After the Pitcher Apps Managed Package gets installed in the org, you need to perform the following steps:

Step 1 - Assign Permission Sets

  • Assign the permission set PITCHER-Apps Rep to the users who will be using Pitcher in the field.

  • Assign the permission set PITCHER-Apps Operations to the users who will be handling Admin operations.

Step 2 - Sentry Configuration

Add the following values to the Pitcher Apps Custom Settings as per your business requirement. You can add these values for specific users or profiles or default Organization-level values.

  • Sentry: DSN = DSN URL

  • Sentry: Debug = Checked

  • Sentry: Environment Name = [Respective Environment name where this package is installed]

 For reference here are the values that need to be added to the custom metadata.

The Custom Settings Page

Step 3 - Schedule Apex Jobs

SCH_ApexSharingManagerFullSync

  1. Only follow this step, if the customer wants to set up the “Salesforce Apex Sharing” feature (which copying share records from the parent object (like Account) to the child records (like Tag) object.

  2. Only applies to Apps v0.109.0.0 or above

  3. Login to destination org.

  4. Go to the Developer Console.

    1. From the Debug menu, click Open Execute Anonymous Window.

    2. Paste the following apex code based on the scheduled time as per customer need:

      1. For 1 AM use the following code:

        CODE
        PCH.SCH_ApexSharingManagerFullSync mgr = new PCH.SCH_ApexSharingManagerFullSync();
        System.schedule('PCH.SCH_ApexSharingManagerFullSync || Everyday 1 AM', '0 0 1 * * ? *', mgr);
      2. For 12:10 AM use the following code:

        CODE
        PCH.SCH_ApexSharingManagerFullSync mgr = new PCH.SCH_ApexSharingManagerFullSync();
        System.schedule('PCH.SCH_ApexSharingManagerFullSync || Everyday 12:10 AM', '0 10 0 * * ? *', mgr);
    3. Click Execute.

  5. Verify under Setup > Scheduled Job that the apex job PCH.SCH_ApexSharingManagerDeltaSync is scheduled to run daily at the respective time.

SCH_ApexSharingManagerDeltaSync

  1. Only follow this step if the customer wants to set up the “Salesforce Apex Sharing” feature (which copies share records from the parent object (like Account) to the child records (like Tag) object.

  2. Only applies to Apps v0.99.0.0 or above

  3. Login to destination org.

  4. Go to the Developer Console.

    1. From the Debug menu, click Open Execute Anonymous Window.

    2. Paste the following apex code to schedule the job to run every 15 min:

      CODE
      PCH.SCH_ApexSharingManagerDeltaSync apexShareMgr = new PCH.SCH_ApexSharingManagerDeltaSync();
      String sch1 = '0 0 * * * ?';
      System.schedule('PCH.SCH_ApexSharingManagerDeltaSync || Every 15 mins || Job 1', sch1, apexShareMgr);
      String sch2 = '0 15 * * * ?';
      System.schedule('PCH.SCH_ApexSharingManagerDeltaSync || Every 15 mins || Job 2', sch2, apexShareMgr);
      String sch3 = '0 30 * * * ?';
      System.schedule('PCH.SCH_ApexSharingManagerDeltaSync || Every 15 mins || Job 3', sch3, apexShareMgr);
      String sch4 = '0 45 * * * ?';
      System.schedule('PCH.SCH_ApexSharingManagerDeltaSync || Every 15 mins || Job 4', sch4, apexShareMgr);
    3. Click Execute.

  5. Verify under Setup > Scheduled Job that the apex job PCH.SCH_ApexSharingManagerDeltaSync Job 1/2/3/4 is scheduled to run every 15 min.

SCH_ObjMappingManager

  1. Only follow this step, if the customer wants to set up the “Object Mapping” feature (which copying records to big object)

  2. Login to destination org.

  3. Go to the Developer Console.

    1. From the Debug menu, click Open Execute Anonymous Window.

    2. Paste the following apex code based on the scheduled time as per customer need:

      1. For 1 AM use the following code:

      CODE
      PCH.SCH_ObjMappingManager mgr = new PCH.SCH_ObjMappingManager();
      System.schedule('PCH.SCH_ObjMappingManager || Daily 5 AM', '0 0 5 * * ? *', mgr);
    3. For 12:10 AM use the following code:

      CODE
      PCH.SCH_ObjMappingManager mgr = new PCH.SCH_ObjMappingManager();
      System.schedule('PCH.SCH_ObjMappingManager || Daily 12:10 AM', '0 10 0 * * ? *', mgr);
    4. Click Execute.

  4. Verify under Setup > Scheduled Job that the apex job PCH.SCH_ObjMappingManager is scheduled to run daily at the respective time.

SCB_TransactionObjectSyncCountBatch

  1. Only applies to Apps v0.101.0.0 or above

  2. Login in destination org, access setup

  3. Go to Apex classes, click the Schedule Apex button

  4. Set SCB_TransactionObjectSyncCountBatch, weekly, everyday at 6AM

  5. Alternatively, you can use the below code in the developer console → Execute Anonymous:

PCH.SCB_TransactionObjectSyncCountBatch b = new PCH.SCB_TransactionObjectSyncCountBatch();
System.schedule('PCH.SCB_TransactionObjectSyncCountBatch || Daily 6 AM', '0 0 6 * * ? *', b);

SCB_TransactionObjectSyncDaysBatch

  1. Only applies to Apps v0.101.0.0 or above

  2. Login in destination org, access setup

  3. Go to Apex classes, click the Schedule Apex button

  4. Set SCB_TransactionObjectSyncDaysBatch, weekly, everyday at 7AM

  5. Alternatively, you can use the below code in the developer console → Execute Anonymous:

PCH.SCB_TransactionObjectSyncDaysBatch b = new PCH.SCB_TransactionObjectSyncDaysBatch();
System.schedule('PCH.SCB_TransactionObjectSyncDaysBatch || Daily 7 AM', '0 0 7 * * ? *', b);

Step 4 - Sharing Setting (OWD) for Apex Managed Sharing

  1. Only follow this step if the customer wants to set up the “Salesforce Apex Sharing” feature (which copies share records from the parent object (like Account) to the child records (like Tag) object.

  2. Go to Setup > Sharing Setting > Edit.

  3. Based on the current client environment, change the Default Internal Sharing to Private for the following objects:

    • Account

    • Tag__c

  4. Now, go to Setup > Custom Metadata Types > Apex Managed Sharing Setting

  5. And check the Active checkbox for Tag record.

Step 5 - Remove “Managed - Installed Deleted” components

  1. Go to Setup > Custom Metadata Types > Apex Managed Sharing Settings.

  2. Follow the screenshot below.

    1. If fields are AVAILABLE for deleting from the package

      1. click Del for Managed - Installed Deleted fields and the validation rule.

    2. If fields are NOT available for deleting, ignore this step

Step 6 - Update List View for “Apex Managed Sharing Settings”

  1. This is a one-time manual step after upgrading to Apps 0.101 or higher

  2. Setup → Custom Metadata Types

  3. Click “Manage” for “Apex Managed Sharing Settings“

  4. Now click “Edit” for the List View named “All Data”

  5. Match the below “Selected Fields”, move deprecated fields to “Available Fields” and save


Step 7 - Update Page Layouts

1 - Update Page Layout for “Apex Managed Sharing Settings”

  1. This step is needed only once after the upgrade

  2. This is a one-time manual step after upgrading to Apps 0.101 or higher

  3. Setup → Custom Metadata Types

  4. Click “Apex Managed Sharing Settings”

  5. Page Layouts → Click “Edit” for “Apex Managed Sharing Setting Layout”

  6. Match the layout as below

    1. Add two new sections “Full Sync”, and “Delta Sync“

    2. Add drag new fields in new sections and below

    3. Drag and remove deprecated fields from the layout

    4. and save

2 - Update Page Layout “Tag Builder Layout”

  1. This step is needed only once after the upgrade.

  2. This is one time manual step when upgrading to Apps 0.102 or higher

  3. Go to Setup → Object Manager → Tag → Layouts

  4. Click “Edit” next to “Tag Builder Layout.”

  5. Remove field Allocation Logic, click save and yes (overrides user’s local modifications)

Step 8 - Record Type Permissions & Assignments

1 - Tag Record Type

  1. Setup → Profile → Select the desired profile in the Subscriber org

  2. On the selected profile → Go to “Custom Record Type Settings”

  3. Click “Edit” on Tags and ensure that all record types are selected and save

  4. Now go to Object Manager → Select “Tag” → Go to “Record Types”

  5. Click on “Page Layout Assignments” → “Edit Assignments” and select the assignments as below -

    1. Account Tag → Account Tag Layout

    2. Tag → Tag Layout

    3. Tag Group → Tag Group Layout

    4. User Tag → User Tag Layout



Step 9 - Delete the custom setting field.

  1. This step is only valid while upgrading to Pitcher Apps 0.113

  2. Set up → Custom Setting

  3. Search → Pitcher Apps Custom Settings (PCH__Apps_Custom_Settings__c)

  4. Now click delete (as per the screenshot below) for the below fields, which are deleted from the package but still available in the subscriber org -

    1. Field 1 (Managed - Installed Deleted) -

      1. Label Name - Apex Sharing: Batch Size (Full Sync)

      2. API Name - PCH__Apex_Sharing_Batch_Size_Full_Sync__c

Step 10 - Updating action New configuration on Tag object

  • If you are installing (first time) any higher version than v0.121.0.0 then skip this step

  • If you are upgrading to v0.121.0.0 or the higher version only then follow this step

  • Go to Setup → Object Manager → Tag → Buttons, Links and Actions

  • Click triangle next to “New” → Edit

  • Check “Skip record type selection page” checkbox and click Save

Deprecated Steps

Post Installation Steps

1 - Schedule Apex Jobs

SCB_ApexSharingManager (v0.108.0.0 or below)
  1. Login to destination org.

  2. Go to the Developer Console.

    1. From the Debug menu, click Open Execute Anonymous Window.

    2. Paste the following apex code:

      CODE
      PCH.SCB_ApexSharingManager mgr = new PCH.SCB_ApexSharingManager();
      System.schedule('PCH.SCB_ApexSharingManager || Everyday 1 AM', '0 0 1 * * ? *', mgr);
    3. For testing, it can be scheduled earlier. For example, to schedule it at 12:10 AM, use the following code:

      CODE
      PCH.SCB_ApexSharingManager mgr = new PCH.SCB_ApexSharingManager();
      System.schedule('PCH.SCB_ApexSharingManager || Everyday 12:10 AM', '0 10 0 * * ? *', mgr);
    4. Click Execute.

  3. Verify under Setup > Scheduled Job that the apex job PCH.SCB_ApexSharingManager is scheduled to run daily at 1 am.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.