Export to Excel without a table

I found myself wanting to create a blank hidden table today just to use the export to excel function. Is there a way to create a button to export all the fields from a model using the same functionality as the table export? (just without the table)

Actually, yes, you can! At the simplest possible level, you can just call the "exportData() method on any Skuid Model once you get a reference to it:

var model = skuid.model.getModel('LeadData'); model.exportData(); 

and this will do what you’re looking for. However, the exportData method takes a LOT of possible optional parameters. We haven’t exposed all these to our API yet, but here’s some you can rely on that you might want to use: fileName: the name of the file that will be generated rows: an array of the particular data rows in the model that you want to export fields: an array of the particular Model Fields that you want to have included in the export (as the Columns) useAPINamesForHeaders: boolean. Defaults to false, but if true, the API Names for fields will be used as Column Headers instead of the Labels. Can be useful for doing imports/exports between systems. additionalConditions: an array of JavaScript Condition objects to limit the data in your Model that actually gets exported. These conditions will be applied to rows, if rows is specified, or to model.data, if rows is not provided. These can be used like this:

var model = skuid.model.getModel('LeadData'); model.exportData({ fileName: 'MyFile', additionalConditions: [ { field: "IsConverted", value: false, operator: '=' } ] }); 

See the docs for more information.

Woo! Thanks Zach!

Hey Zach, Can you clarify how to use ‘fields:’?  Struggling to get this right.  If we don’t use ‘fields:’ we get everything.  However we want to select the fields to export and when we specify them in an array it breaks.  

Sure Peter, fields is an Array of Model Field objects, which we recommend that you retrieve via model.getField(fieldAPIName), like this:

var model = skuid.model.getModel(‘MyModel’);
model.exportData({
    fileName: ‘MyFile’,
    fields: [
        model.getField(‘Name’),
        model.getField(‘BillingCountry’),
        model.getField(‘Industry’),
        model.getField(‘Owner.Name’)
    ]
});



Zach,

I have a customer who wants to export data and when using the Excel export option she can not pull all data without having to use the More button and with thousands of records it takes a long time.  What she is trying to do is export data to excel based on criteria to create a custom report in excel.  Would the above example work for this use case or is there a better way for her to do this?  She can only set the model to show about 500 records at a time before she throws an error using the table.  

David, we are working on adding some options to Export to Excel in our upcoming release or the release after that, but ultimately we will only be able to let you export a theoretical max of 10,000 records using the Skuid-based export approach, due to limitations in how many “offset” records can be retrieved and limitations in Apex JSON Heap Size. Current state today, it would take some custom JavaScript that uses the Skuid Model API to achieve a “Load All” functionality.

Hello Zach,

I have another question related to the exportData method.  This functionality has been very beneficial in allowing us to export data that has not yet been saved in the model.

Is there a condition that can be set when calling the method so leading zeros in text fields are not truncated?  We have department numbers like “000220” that are converted to “220” when exported.  

Thanks for your help.

I’m pretty sure that it is Excel,  or whatever tool you are using to open the file that is stripping out the leading zeros.  You can test this by openining your downloaded file in a text editor and validating whether the leading zeros are there.  You can configure how Excel does the data import from the CSV.  See this document:  http://superuser.com/questions/431637/why-is-excel-removing-leading-leading-zeros-when-displaying-cs…

Hello Zach, 

We have implemented a custom export button that calls the exportData() method on our model, the problem is our customer requested for the record ID to not be included in the exported file. I have tried including the fields parameter with the hopes it would only export the fields I specified, but the record Id is still appended to each row in the generated export file. I know you can remove the option to “append record id column” for the standard export button on a table, but is there a way to turn off this option via a parameter in the exportData() method?

Thank you.

What is the best way to get record names rather than ids? For example I have a custom object table that has lookups to a user and an account. It is exporting the account id and user id rather than their names. 

Do I need to use the solution above rather than the standard export to excel functionality?

Thanks!

Ryan, the export process by default exports BOTH the lookup record’s Id and Name. You can circumvent this by only requesting the Name field in your export, e.g. using the example above / in the docs, request model.getField(‘User__r.Name’) and model.getField(‘Account__r.Name’) rather than model.getField(‘User__c’):

var model = skuid.model.getModel(‘MyModel’);
model.exportData({
    fileName: ‘MyFile’,
    fields: [
        model.getField(‘Name’),
        model.getField(‘User__r.Name’),
        model.getField(‘Account__r.Name’)
    ]
});

Yes Ross this is possible, just set the parameter doNotAppendRowIdColumn: true when calling exportData(), see the docs on exportData() for more information.

Thanks Zach. For some reason mine is just exporting the lookup ids though. I will try the other method. 

Perfect!  Thanks so much Rob.

Thank you, this is exactly what I was looking for!

Has anyone made any custom export field “Picker” that would allow the end user to choose what fields from the model to export?

My users are asking for a way to export the table data but choose different fields depending on the scenario. Any ideas I can run with let me know.

This post is extremely helpful! Thanks all…

Just thinking out loud here, but maybe you could do a a whole slew of UI-only fields that are checkboxes, that have the same API name of the fields you want. I think you’d want to have a model that has no fields except these UI-Only fields. 

Then in the JavaScript, if there’s some way to “get all the fields in this model”, you could iterate through the fields. I’m not at all a JS developer, but here’s the kind of code I would try, after getting all the fields in a given model in an array called modelFields (not even sure THAT is possible)

 fields: [ $.each(modelFields, function(){ var currentFieldName= this.Name; model.getField('currentFieldName') } ]

When did “Export Columns” become an option!? Or have I been overlooking it this whole time? That’s a great feature!


So many features,  so little time!   Glad you like them.   I believe export columns was a Superbank thing.