Add support for fetchxmlpagingcookie when executing a fetchXML query

[KhashRastin]

Request support for the annotation Microsoft.Dynamics.CRM.fetchxmlpagingcookie to enable paging for fetchxml queries.

[davidyack]

Thanks for adding this to the list

[SolzIT]

Hi David,
Any updates on this?

[EkoZuluDev]

I really am in need of the paging cookie support :-(
Is there a way to manually insert the pagingcookie annotation in fetchxml string?

[SolzIT]

Hi, We were finally able to make some changes to source code and achieve this. It at least solved our purpose. I am not sure how to create a fork or I can share the changes as desired. Regards, Nikhil Soluzione IT From: EkoZuluDev <notifications@github.com> Sent: 27 March 2019 13:30 To: davidyack/Xrm.Tools.CRMWebAPI <Xrm.Tools.CRMWebAPI@noreply.github.com> Cc: Nikhil Gahlot <nikhil.g@solzit.com>; Comment <comment@noreply.github.com> Subject: Re: [davidyack/Xrm.Tools.CRMWebAPI] Add support for fetchxmlpagingcookie when executing a fetchXML query (#49) Is there a way to manually insert the pagingcookie annotation in fetchxml string? — You are receiving this because you commented. Reply to this email directly, view it on GitHub<#49 (comment)>, or mute the thread<https://github.com/notifications/unsubscribe-auth/AWT8YnXkMScE9BPMGpLGS-612rJgQDnIks5vayTngaJpZM4P8sPZ>. Our company 'Soluzione IT Services Pvt. Ltd.' accepts no liability for the content of this email, or for the consequences of any actions taken on the basis of the information provided, unless that information is subsequently confirmed in writing. If you are not the intended recipient you are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this information is strictly prohibited. Please immediately delete it and all copies of it from your system, destroy any hard copies of it and notify the sender.

[davidyack]

@SolzIT can you post the key changes here at least until it gets integrated others can take advantage of it

[SolzIT]

Sure thing. Here you go. We had made the below changes to the CRMWebAPI.cs file and CRMGetListResult.cs file namely:

1. Added a new method GetLargeList which is almost similar to GetList function but supports fetchxml based pagining cookie.
2. Updated function FillPreferHeader to accommodate annotations in case of paging cookie.
3. Updated CRMGetListResult.cs file to include paging cookie.

For the sake of clarity we have marked the changes by tag SolzIT.

To invoke the GetLargeList function
`
///

/// Get more than 5000 records
///

/// Fetch xml
/// Entity name
/// List of records
public async Task GetMoreThen5000Records(string querry, string entityName)
{
try
{
//Connect to crm
var api = await _crm.GetAPI();
dynamic finalResult = null;

            // Define the fetch attributes.
            // Set the number of records per page to retrieve.
            int fetchCount = 5000;
            // Initialize the page number.
            int pageNumber = 1;
            // Specify the current paging cookie. For retrieving the first page, 
            // pagingCookie should be null.
            string pagingCookie = null;

            while (true)
            {
                string xml = Helpers.CreateXml(querry, pagingCookie, pageNumber, fetchCount);

                dynamic result = await api.GetLargeList(entityName, QueryOptions: new CRMGetListOptions() { FetchXml = xml, FormattedValues = true });

                string count = result.List.Count.ToString();

                if (finalResult == null)
                    finalResult = result;
                else
                    finalResult.List.AddRange(result.List);

                if (result.PagingCookie != null)
                {
                    //Increment the page number to retrieve the next page. if count is equal to 5000
                    pageNumber++;
                    pagingCookie = result.PagingCookie;
                }
                else
                    //If count is less than result nodes, exit the loop.
                    break;
            }
            return finalResult;
        }
       
        catch (Exception Ex)
        {
           //Do exception handling               
        }
    }

`

Reference to the changed cs files is in attached zip. Please note this might not be the latest files as per Xrm.Tools.CRMWebAPI build
CRMWebAPI.zip

[mohsinonxrm]

@KhashRastin , I'll be opening a pull request in a couple of days (already coded, going to test a bit more) and submitting the changes for @davidyack to review and merge.

@SolzIT , I've looked at your sample and also a sample which Microsoft always provided since 4.0 days, I'm going to slightly modify that and not have the users do the looping, it'll just be a parameter and if you want to get all records, it'll return all records.