Please note: This content is intended for Practifi System Administrators and is technical. The steps described in this article cannot be completed without System Administrator permissions.
Overview
Integration logs are automatically generated when integrations run in a Practifi organization. Over time, these Integration Log records can accumulate and consume a large percentage of your organization's data storage. You can manually delete older Integration Log records to free up data space in your firm's organization. As of the Graciano release, you can also enable the Integration Log Retention Period setting to automate this cleanup, removing the burden of routine manual maintenance.
This article guides you through deleting Integration Log records in your organization.
Please note: For instructions on viewing integration logs for troubleshooting, see Using Salesforce Inspector Reloaded in Practifi.
- Understanding the Integration Log Retention Period Setting
- Updating the Integration Log Retention Period Setting
- Manual Deletion Requirements
- Retrieve Integration Log IDs
- Delete Integration Log Records
Understanding the Integration Log Retention Period Setting
To help free up storage space by removing unnecessary integration logs, a Practifi Custom Setting called Integration Log Retention Period allows administrators to define a retention period in days, ranging from 0 to 182. Logs older than the specified number of days will be deleted automatically, keeping storage in check without ongoing intervention.
The Integration Log Retention Period setting defaults to Null, meaning a scheduled job runs daily but does not delete any logs. We strongly recommend entering a value to clear old logs, as they are primarily used to troubleshoot integration issues, and logs older than a few days are rarely required.
The setting works as follows:
- 0 days is the minimum value. Entering a 0 means logs will be cleared daily.
- 182 days (six months) is the maximum value.
- 32 days is the recommended value.
- Null (default value) means that logs will not be deleted.
Updating the Integration Log Retention Period Setting
To set an integration log retention period for your Practifi organization:
- Navigate to Salesforce Setup by clicking the cog icon in the upper right-hand corner and selecting Setup from the drop-down menu.
- Use the Quick Find search bar to search for and select Custom Settings.
- Click the Manage link next to Practifi Settings.
- At the top of the Practifi Settings page, click the Edit button.
-
On the edit screen, enter a numerical value in the Integration Log Retention Period field.
Please note: 32 is the recommended value. Entering a 0 means Integration Log records will be deleted on a daily basis.
- Click Save.
Please note: The ScheduledIntegrationLogCleanupJob Apex class is automatically created via the post-install script. However, in rare cases where it isn't deployed, you should manually schedule it in the Apex Classes area of Salesforce Setup using the following Cron expression:
0 0 0 ? * * ?Manual Deletion Requirements
Your user profile must have permission to delete Integration Log records. Typically, a Practifi System Administrator already has these permissions on their user profile. If you are not a system administrator, please get in touch with your firm's system administrator to perform these steps.
To perform the steps outlined in this article, you must install the Salesforce Inspector Reloaded browser extension in Microsoft Edge or Google Chrome. This extension is a helpful tool for organizing data and maintaining it, and will be used to delete the Integration Log records in these steps.
We recommend deleting Integration Log records with a CreatedDate older than 30 days. Before deleting these records, you should perform a data backup.
Retrieve Integration Log IDs
Before deleting the Integration Log records, you must retrieve the Integration Log IDs to identify which records to delete. To retrieve the Integration Log IDs:
- In your Practifi organization, look for the Salesforce Inspector icon. This is a small blue box with an arrow on the right side of the screen. Click the Salesforce Inspector icon to expand the Salesforce Inspector panel.
- Click the Data Export button in the Salesforce Inspector panel.
- This will open a query window where you can enter SOQL queries to retrieve data from your firm's organization. Use the following query to retrieve a list of all Integration Log records: SELECT Id, CreatedDate FROM practifi__Integration_Log__c
-
You may want to narrow your query to Integration Log records older than a specific timeframe. To narrow your query, you can use a WHERE condition on the CreatedDate field, like this: SELECT Id, CreatedDate FROM practifi__Integration_Log__c WHERE CreatedDate < LAST_90_DAYS
Please note: This article does not cover all possible SOQL queries. For additional information about SOQL queries, please consult this Salesforce Help article.
- Once you've narrowed down your query to the Integration Logs you would like to delete, click the Copy (Excel Format) button. This copies all data from the query output to your clipboard.
- Next, open the Salesforce Inspector panel and click Data Import.
Delete Integration Log Records
Now that the data from your query is in your clipboard and the Data Import screen is open, you're ready to delete these records. To delete the Integration Log records:
- Set the Action to Delete and the Object to practifi__Integration_Log__c.
- Click in the Data box and paste the data from your clipboard. If you've done this correctly, you will see a preview of the pasted data.
- Click the Skip button on the Field Mapping panel for all fields except the Id field. Delete operations require only the ID of the records.
- Lastly, click the Run Delete button. This will begin the deletion process, which should take only a few moments. When the deletion is successful, you will receive a success message on each row.
Comments
Article is closed for comments.