Option to choose CSV Select Format

I'm not sure why the change would make the CSV more helpful. By combining the values into a single cell, it makes it impossible to create charts or graphs based on the the number of responses to each answer. Could you describe why this change is necessary or how it would make the CSV more effective?

I agree with you that for charts and graphs this doesn't make sense, so maybe instead of it being an on/off setting it would be adding a page when you click on Download so that you can download the multi-selects in boolean format or in the format I'm needing. Make sense?

I've been thinking this would be an *excellent* idea for a while (making a page with download options). I'd like to figure out what sort of download options do make the most sense, mostly in the UI that's presented to the user downloading. We should definitely include the field delimiter as an option also (currently it's only on admin/settings/webform).

Field Delimiter:
[ Comma (,) | v ]

File Format:
( • ) Expanded select options (Better for charts)
(   ) Compacted select options (SalesForce Import)

[ Download ]

Hey amariotti, sorry I dropped off the planet right before DrupalCon and am just now getting back to everything. Coincidentally, we just had another workshop in Portland in September (part of the reason for my absence), too bad you couldn't attend again!

I'm about to make a 2.2 release of the module, which will include a configuration form for CSV files (allowing you to choose the format of XLS or CSV), but not include this particular option just yet. Probably the next release. Now that the form is in place though, it makes adding in the option much easier in the future.

Hi!

Posted a topic about this issue : http://drupal.org/node/453034

Is it possible to provide a fix for this in the latest 5.x and 6.x versions?
Have the same problem for importing data into an external application.

Thanks! Cheers,

Any idea if or when this feature will be added to webform?

Hi Nathan!

Kicking this topic again, any news about this request?

Heya dreamlabs and amariotti, I'm still ready to get this in, and our outline seems solid, I just haven't had time to write such functionality. Are you guys interested in providing patches?

My php / drupal knowledge is limited, but I have did some searching through the code and found the following:

Files used for the export:
webform_report.inc
webform_export.inc
components/select.inc

webform_report.inc
Uses this function to produce the rows with headers and used for export.
function webform_results_download($node, $format = 'delimiter', $options = array())

In this function two foreach loops are executed, one for the headers and one for the data.
The header format is produced by select.inc : _webform_csv_headers_select
The data format is produced by select.inc: _webform_csv_data_select

So I think that select.inc needs to be modified that there is an alternative csv select function which uses only one header with and doesn't uses X.
And webform_results_download() needs to have an extra option for alternative select output which uses the alternative header and data select.

But I have no idea if that is a good "Drupal" approach. And I have no clue how to add the options to the download select format.
So I can try to modify this module, but I seriously could use some help :)

Hi Guys,

think I have fixed it for Drupal 5, I'm doing some testing right now, and it all looks fine.
I have added one checkbox: Compacted select options, if you choose it then you get one header with imploded data values, when unselected you get the current situation.

I use tortoise, but my diff / patch file isn't good.

All code is set to - and + everything is added later, I would like a diff file where only the changed lines are changed.
Could someone explain my how to make a proper patch file?

Also can somebody review my code please, I don't know if my solution is proper and fits within this module.

Thanks!

Eric

Well tried to create a diff file with tortoise but it outputs the whole file, so here is the changed code for drupal 5

webform/webform_report.inc

starting at line 331: function: webform_results_download_form

  $form['delimiter'] = array(
    '#type' => 'select',
    '#title' => t('Delimited text format'),
    '#description' => t('This is the delimiter used in the CSV/TSV file when downloading Webform results. Using tabs in the export is the most reliable method for preserving non-latin characters. You may want to change this to another character depending on the program with which you anticipate importing results.'),
    '#default_value' => variable_get('webform_csv_delimiter', '\t'),
    '#options' => array(
      ','  => t('Comma (,)'),
      '\t' => t('Tab (\t)'),
      ';'  => t('Semicolon (;)'),
      ':'  => t('Colon (:)'),
      '|'  => t('Pipe (|)'),
      '.'  => t('Period (.)'),
      ' '  => t('Space ( )'),
    ),
  );
  
 +++ $form['compacted_select_option'] = array(
 +++ 	'#type' => 'checkbox',
 +++	'#title' => t('Compact Select Options'),
 +++	'#description' => t('Select this option if you want to download Select components values as one compacted value.'),
 +++	'#return_value' => 1,
 +++ '#default_value' => variable_get('compacted_select_option', 0), 
 +++	'#prefix' => '<fieldset>',
 +++	'#suffix' => '</fieldset>'
 +++  );
  
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Download'),
  );

You can change the description or title

starting at line 401: function: webform_results_download

if (function_exists($csv_header_function)) {	
			+++ if($component['type'] == 'select' && $options['compacted_select_option'] == 1) $component['options'][compacted_select_option] = true;
			// Let each component determine its headers.
			$component_header = $csv_header_function($component);
			$header[0] = array_merge($header[0], (array)$component_header[0]);
			$header[1] = array_merge($header[1], (array)$component_header[1]);
			$header[2] = array_merge($header[2], (array)$component_header[2]);
}

starting at line 431: function: webform_results_download

if (function_exists($csv_data_function)) {
        +++ if($component['type'] == 'select' && $options['compacted_select_option'] == 1) $component['options'][compacted_select_option] = true;
        // Let each component add its data.
        $raw_data = isset($submission->data[$cid]) ? $submission->data[$cid] : NULL;

webform/components/select.inc

starting at line 403: function: _webform_csv_headers_select

Replace

if ($component['extra']['multiple']) {
  	+++ if($component['options'][compacted_select_option]){
	+++	$headers[0][] = '';
	+++	$headers[1][] = '';
	+++	$headers[2][] = $component['name'];
	+++ }
	+++ else{
		$headers[0][] = '';
		$headers[1][] = $component['name'];
		$items = _webform_select_options($component['extra']['items'], TRUE);
		$count = 0;
		foreach ($items as $key => $item) {
		  // Empty column per sub-field in main header.
		  if ($count != 0) {
			$headers[0][] = '';
			$headers[1][] = '';
		  }
		  $headers[2][] = $key;
		  $count++;
		}
	+++ }	
  }

Same trick at

starting at line 441: function: _webform_csv_data_select

if ($component['extra']['multiple']) {  
  	+++ if($component['options'][compacted_select_option]){
	+++	if(is_array($data['value'])){
	+++		$return = implode(",", $data['value']);
	+++	}else{
	+++		$return = '';
	+++	}
        +++ }
	+++ else{
		foreach ($options as $key => $item) {      
		  if (in_array($key, (array)$data['value']) === TRUE) {
			$return[] = 'X';
		  }
		  else {
			$return[] = '';
		  }
		}
	+++ }
  }

Does this help you??
Let me know if you have an questions! Could you add this to the 5x version to please.
Thanks!!

Hi Nathan and Amarotti,

Any updates? Haven't heard from you guys.
Let me know if the porting to drupal 6 worked for you and if this function can be added to the current version?

Cheers,

I've stopped adding features to the 2.x version so I can focus on a single branch for development (no more Drupal 5 support). However this also means it's much more open to new features. So yes an updated patch against HEAD would definitely help, but it doesn't look like this feature will ever make it to Drupal 5.

Hi Nathan,

I have create a patch for the latest drupal 5 webform (2.9) version. With the option to export the data to a compact format instead of columns with an X as value.
Could you please review my patch and if it's well written include this for any new updates.

Thanks!

As I noted in #23, the 2.x version is no longer getting any new features. This feature won't ever make it to Drupal 5 in the official release.

The patch has some useful code but the approach isn't quite what we should be using. Instead of jamming the option into the $component array, we should make it so that the csv functions take an $options array or something similar. I anticipate there will probably be more options desired in the future.

Thanks for your comment. If I ever need to build this for Drupal 6.x I will use your approach. Cheers.

Well a year and half later... here we are, not much further than where we started. I rewrote the changes to be compatible with the 3.x version, since as I've noted above no new features are being added to the 2.x branch or the Drupal 5 version.

I've added an additional argument to all CSV functions so we can pass each component universal download settings, even through right now only select lists are utilizing it. I also themed the help text for these options to make it clear what each option does. This patch is almost entirely the API change and theming. The actual changes to the CSV download function were pretty trivial. This patch has been committed to the 3.x version.

I've just tested this new feature and it works great!