Archive SDK Data Query

A getNextPage call following (scrollId != -1) is included because the size of the results is limited in the performArchiverGlobalSearch call.

string objectName = 'Account';
                
list<OB_Archiver.SearchFilter>request = new list<OB_Archiver.SearchFilter>();

OB_Archiver.SearchFilter filter1 = new OB_Archiver.SearchFilter('Name', 'test');

request.add(filter1);

OB_Archiver.DateRange range = new OB_Archiver.dateRange('CreatedDate',

system.today()-150,system.today());

OB_Archiver.ArchiverAccessorResponse res =

OB_Archiver.ArchiverAccessor.performArchiverGlobalSearch(objectName, request, range);

if(res.getStatusCode() == 200){

system.debug('code: ' + res.getStatuscode());

OB_Archiver.ArchiverAccessorSearchResponse searchResponse = res.getSearchResponseMap();

system.debug('count: '+ searchResponse.totalResultCount);

system.debug('scrollid: '+ searchResponse.scrollId);

system.debug('list size: '+ searchResponse.records.size());

string scrollId = searchResponse.scrollId;

integer page = 1;

while(scrollId != '-1'){

page++;

OB_Archiver.ArchiverAccessorResponse secondPage =

OB_Archiver.ArchiverAccessor.getNextPage(searchResponse.scrollId);

if(secondPage.getStatusCode() == 200){

OB_Archiver.ArchiverAccessorSearchResponse searchResponse2 =

secondPage.getSearchResponseMap();

scrollId = searchResponse2.scrollId;

system.debug('count: '+ searchResponse2.totalResultCount);

system.debug('scrollid: '+ searchResponse2.scrollId);

system.debug('list size: '+ searchResponse2.records.size());

system.debug('page number: '+ page);

} else{

system.debug('response is != 200: '+ secondPage.getStatusCode());

system.debug('body: '+ secondPage.getBody());

break;

} }}else{

system.debug('status code erorr|: '+ res.getStatusCode());

system.debug('status code message|: '+ res.getErrorMessage()); }

Use Case

Your business requires that the Tier 3 Support Team have access to view archived Cases with a high-priority status.

This example shows how to:

• Create a customized Lightning Web Component (LWC).
• Pull archived data using the data query SDK.
• Apply the filter (High Priority).
  

  Note

  Other filters can be customized by referring to the code here.

  This example is limited to 25 records. The SDK allows you to set the results per page at 1,000, the default is 25, with the option of pagination through the results.

Widget Displaying High Priority Cases

Sample SdkUseCaseWidget.js

In this code example, the parameter is AccountRecordId.

import { LightningElement, api, track } from 'lwc';
    import getCases from '@salesforce/apex/ArchiveSdk.getCases';
    export default class SampleSdkUseCaseWidget extends LightningElement {
    @api recordId;
    
    columns = [
    { label: 'Case Number', fieldName: 'caseNumber', type: 'text', cellAttributes: {alignment: 'center'}},
    { label: 'Subject', fieldName: 'subject', type: 'text' , cellAttributes: {alignment: 'center'}, },
    { label: 'Priority', fieldName: 'priority', type: 'text', cellAttributes: {alignment: 'center'}, },
    { label: 'Status', fieldName: 'status', type: 'text', cellAttributes: {alignment: 'center'}, }
    ];
    @track records;
    @track data
    @track _loading;
    
    async connectedCallback() {
    this._loading = true;
    try {
    const result = await getCases({parentId: this.recordId})
    this.records = result;
    this._loading = false;
    } catch (error) {
    this._loading = false;
    }}
}            

Sample SdkUseCaseWidget.html

The Apex controller that the LWC uses calls the Data Query SDK.

OB_Archiver.archiverAccessor.performArchiverGlobalSearch(objectName, request, fields, range);

This is the call for the Archive SDK. It includes these parameters.

• ObjectName—Depicts the Search

• Filters—Used to retrieve the data.

• Fields—The projected fields to return from data.

• Range—The date range used to query the data.

<template>
    <template if:true={_loading}>
        <lightning-spinner></lightning-spinner>
    </template>
    <lightning-datatable
        key-field="caseNumber"
        data={records}
        columns={columns}
        hide-checkbox-column>
    </lightning-datatable>
</template>

ArchiveSdk.cls

This code block is the Apex controller.

public with sharing class ArchiveSDK {
                
    @AuraEnabled
    public static List<CaseTableWrapperExample.CaseRecord> getCases(String parentId) {
    // Create an empty list to hold maps with String keys and Object values
    List<Map<String, Object>> totalRecords = new List<Map<String, Object>>();
    
    // Create a list to store search filter objects
    List<SF_Archive.SearchFilter> request = new List<SF_Archive.SearchFilter>();
    
    // Create a search filter for the 'AccountId' field with a given 'parentId' value
    SF_Archive.SearchFilter filter1 = new SF_Archive.SearchFilter('AccountId', parentId);
    
    // Create a search filter for the 'Priority' field with a given 'High' value
    SF_Archive.SearchFilter filter2 = new SF_Archive.SearchFilter('Priority', 'High');
    
    // Add the filters to the request list
    request.add(filter1);
    request.add(filter2);
    
    // Define the object name as 'Case'
    String sObjectName = 'Case';
    
    // Create a list of Strings representing field names to be retrieved from Archive DB
    List<String> fields = new List<String>{'CaseNumber', 'Subject', 'Priority', 'Status'};
    
    // Create the DateRange based on the created date
    SF_Archive.DateRange range = new SF_Archive.DateRange('CreatedDate', system.today() - 150, system.today());
    
    // Perform an initial global search and store the response
    SF_Archive.ArchiverAccessorResponse res = SF_Archive.ArchiverAccessor.performArchiverGlobalSearch(sObjectName, request, range);
    
    // Check if the HTTP response status code is 200 (success)
    if (res.getStatusCode() == 200) {
        system.debug('code: ' + res.getStatuscode());
        
        // Retrieve the initial search response map
        SF_Archive.ArchiverAccessorSearchResponse searchResponse = res.getSearchResponseMap();
        
        system.debug('count: ' + searchResponse.totalResultCount);
        system.debug('scrollid: ' + searchResponse.scrollId);
        system.debug('list size: ' + searchResponse.records.size());
        
        // Store the scroll ID for pagination
        String scrollId = searchResponse.scrollId;
        
        // Initialize the page number
        Integer page = 1;
        
        // Add the records from the initial search to the totalRecords list
        totalRecords.addAll(searchResponse.records);
        
        // Continue to fetch additional pages while the scroll ID is not '-1'
        while (scrollId != '-1') {
            page++;
            
            // Get the next page of search results using the UPDATED scrollId 
            SF_Archive.ArchiverAccessorResponse nextPageResponse = SF_Archive.ArchiverAccessor.getNextPage(scrollId);
            
            // Check if the HTTP response status code is 200 (success)
            if (nextPageResponse.getStatusCode() == 200) {
            
                // Retrieve the search response for the current page
                SF_Archive.ArchiverAccessorSearchResponse searchResponse2 = nextPageResponse.getSearchResponseMap();
                
                // CRITICAL FIX: Update the scrollId with the value from the new response 
                scrollId = searchResponse2.scrollId;
                
                system.debug('count: ' + searchResponse2.totalResultCount);
                system.debug('scrollid: ' + searchResponse2.scrollId);
                system.debug('list size: ' + searchResponse2.records.size());
                system.debug('page number: ' + page); 
                
                // Add the records from the current page to the totalRecords list
                totalRecords.addAll(searchResponse2.records);
            } else {
                // Output an error message if the HTTP response status code is not 200
                system.debug('response is != 200: ' + nextPageResponse.getStatusCode());
                system.debug('body: ' + nextPageResponse.getBody());
                
                // Break out of the loop if there is an error
                break;
            }
        } // End of while loop
    } else {
        // Handle error from initial search
        system.debug('status code error: ' + res.getStatusCode());
        system.debug('status code message: ' + res.getErrorMessage());
    }
    
    // Return the list of total records
    List<CaseTableWrapperExample.CaseRecord> result = new List<CaseTableWrapperExample.CaseRecord>();
    return CaseTableWrapperExample.getCasesTable(totalRecords);
    }
}

CaseTableWrapperExample.cls

Helper class to formulate class from Apex to LWC

public class CaseTableWrapperExample{
    public static List<caseRecord> getCasesTable(list<map<string,object>> cases){
    List<caseRecord> caseReturnList = new List<caseRecord>();
    for(Map<string,object> caseRecord: cases){
    caseRecord tempCase = new caseRecord();
    tempCase.caseNumber = String.valueOf(caseRecord.get('CaseNumber'));
    tempCase.id = String.valueOf(caseRecord.get('Id'));
    tempCase.origin = String.valueOf(caseRecord.get('Origin'));
    tempCase.status = String.valueOf(caseRecord.get('Status'));
    tempCase.subject = String.valueOf(caseRecord.get('Subject'));
    tempCase.priority = String.valueOf(caseRecord.get('Priority'));
        
    caseReturnList.add(tempCase);
    }
    return caseReturnList;
    }
    
    public class caseRecord {
    @AuraEnabled public string caseNumber;
    @AuraEnabled public string id;
    @AuraEnabled public string origin;
    @AuraEnabled public string status;
    @AuraEnabled public string priority;
    @AuraEnabled public string subject;
}}

The above code describes a sample scenario whereby you can add LWC as a widget to the Lightning page.

To view the actual Lightning data table, add this code to the sampleSdkUseCaseWidget.js-meta.xml file. Then add the Archive Widget to the Lightning Page.

<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion>55.0</apiVersion>
    <isExposed>true</isExposed>
    <targets>
    <target>lightning__RecordPage</target>
    <target>lightning__AppPage</target>
    </targets>
    <targetConfigs>
    <targetConfig targets="lightning__RecordPage">
    <supportedFormFactors>
    <supportedFormFactor type="Small" />
    <supportedFormFactor type="Large" />
    </supportedFormFactors>
    </targetConfig>
    <targetConfig targets="lightning__AppPage">
    <supportedFormFactors>
    <supportedFormFactor type="Small" />
    <supportedFormFactor type="Large" />
    </supportedFormFactors>
    </targetConfig>
    </targetConfigs>
</LightningComponentBundle>

For more information, see Salesforce documentation on Apex Governor Limits

Use Case

Your business requires that the Tier 3 Support Team has access to view archived Cases with a high-priority status.

This example shows how to work around an error when the number of archived records retrieved via the SDK is too large. The error reads: OB_Archiver.ArchiverAccessor.ArchiverAccessorException: Exceeded time allotted for callout, please contact support.

This use case is created using code from these Apex classes.

ArchiveSecondPageJob

This class processes paginated data from Archive using a scroll ID, making callouts as needed. It runs asynchronously via the Queueable interface, tracking the total execution time to avoid exceeding limits and enqueuing itself for continued processing if necessary. The class handles responses, updates the scroll ID, and logs details about each retrieved data page.

public class ArchiveSecondPageJob implements Queueable,Database.AllowsCallouts {
                          
       private String scrollId;
       private long totalTime;
       private integer pageNumber;

       public archiveSecondPageJob(String prevScrollId, integer pageNumber) {
           scrollId = prevScrollId;
           this.pageNumber = pageNumber;
       }

       public void execute(QueueableContext context) {
           system.debug('executing');
           doExecute();
       }
       private void doExecute() {
               OB_Archiver.ArchiverAccessorSearchResponse searchResponse = null;
               integer page = 1;
               long totalTime = 0;
  
                       while(scrollId != '-1')
                       {       
                           //avoid 12000 ms limit
                           if(totalTime > 90000){
                               system.debug('Creating new task');
      archiveSecondPageJob q = new archiveSecondPageJob(scrollId,this.pageNumber);
                               System.enqueueJob(q);
                               return;
                           }
                           //Get the next page using the scrollId     
                           Long startTime = DateTime.now().getTime(); 
                           OB_Archiver.ArchiverAccessorResponse nextPage = OB_Archiver.ArchiverAccessor.getNextPage(scrollId); 
                           Long stopTime = DateTime.now().getTime();
                           totalTime += stopTime - startTime;
                           if(nextPage.getStatusCode() == 200){     
                               this.pageNumber++;
                               OB_Archiver.ArchiverAccessorSearchResponse searchResponse2 =nextPage.getSearchResponseMap();      
                               scrollId = searchResponse2.scrollId;
                               system.debug('count: '+ searchResponse2.totalResultCount);    
                               system.debug('scrollid: '+ searchResponse2.scrollId); 
                               system.debug('list size: '+ searchResponse2.records.size());  
                               system.debug('body: '+ searchResponse2.records);  
                               system.debug('page: '+ pageNumber);  
                               system.debug('time: '+ totalTime); 
                           }       
                           else{           
                               system.debug('response is != 200: '+ nextPage.getStatusCode());           
                               system.debug('body: '+ nextPage.getBody());
                               return;
                           }           
                       }
       }
}
            

The ArchiveSearch class performs a search on the Case object using specific filters, retrieves the results, and logs details such as the total count and scroll ID. If the search returns a valid scroll ID (indicating more pages of results), it enqueues the archiveSecondPageJob to process the next page asynchronously. This class essentially initiates the search and hands off further processing to the previously defined archiveSecondPageJob.

The format for the initial search call.

public class ArchiveSearch {
                    
    public void doSearch(){
        
                string objectName = 'Case';
        list<OB_Archiver.SearchFilter> request = new list<OB_Archiver.SearchFilter>();
    
        OB_Archiver.SearchFilter filter1 = new OB_Archiver.SearchFilter('Priority', 'High');
        request.add(filter1);
        
        list<string> fields = new list<string>{'CaseNumber', 'Id'};
        
        OB_Archiver.ArchiverAccessorResponse res = OB_Archiver.ArchiverAccessor.performArchiverGlobalSearch(objectName, request,fields);   
        if(res.getStatusCode() == 200){
           system.debug('code: ' + res.getStatuscode());
           OB_Archiver.ArchiverAccessorSearchResponse searchResponse = res.getSearchResponseMap();
           system.debug('count: '+ searchResponse.totalResultCount);
           system.debug('scrollid: '+ searchResponse.scrollId);
           system.debug('list size: '+ searchResponse.records.size());
           string scrollId = searchResponse.scrollId;
           integer page = 1;   
           if(scrollId != '-1'){
               system.debug('calling next page');
               integer pageNumber = 2;
               archiveSecondPageJob q = new archiveSecondPageJob(scrollId, pageNumber);
               System.enqueueJob(q);
   }}}}

For more information, see Salesforce Apex Developer Guide.