CustomersExportExtension reference

This article provides reference material about CustomersExportExtension class. All customer export extensions have to be inherited from the CustomersExportExtension which, in turn, inherits from the core Sana Extension class.

CustomersExportExtension inheritance

Methods

CustomersExportExtension

GetLoadOptions

Gets load option LoadOptions for getting customer's info.

public override LoadOptions GetLoadOptions() =>
    new LoadOptions
    {
        LoadBasket = true,
        LoadNewsletterSubscription = true,
        LoadSalesStatistics = true,
        LoadCustomerData = true,
    };

OnStart

Starts the customer export process.

public override void OnStart(ExportContext context)
{
}

OnSuccess

Sana calls OnSuccess method when execution of the task successfully finished.

public override void OnSuccess(ExportContext context)
{
}

OnFail

Sana calls OnFail method when errors occurred during execution of the task.

public override void OnFail(ExportContext context)
{
}

OnFinalize

This method is called at the end of execution.

public override void OnFinalize(ExportContext context)
{
}

ProcessBatch

This method processes data based on loading options and task configurations.

Sana calls ProcessBatch method after OnStart method has been called.

public override void ProcessBatch(ProcessBatchContext context)
{
}

GetFilesToExport

This method returns extension files to be exported as result of the task.

Extension files coping to the Sana documents folder @data/documents/Customer feeds/{website ID}/{extension title}/{extension file path} during OnSuccess call.

public override IEnumerable<string> GetFilesToExport()
{
    return Api.DataFiles.GetFiles();
}

Table of Contents