Difference between revisions of "Exporting Data"

From ARK
Jump to: navigation, search
Line 1: Line 1:
In order to allow your users to use the export functionality of ARK you need to set a few settings in the mod_settings.php and settings.php files. An example is [http://ark.lparchaeology.com/wiki/index.php/Mod_settings.php#Export here].
+
In order to allow your users to use the export functionality of ARK you need to set a few settings in the [[mod_settings.php]] and [[env_settings.php]] files. An example is [[Mod_settings.php#Export|here]].
  
You will also need to set up a couple of settings in settings.php, namely:
+
==Env_settings.php==
 
 
==Settings.php==
 
 
===Export Directory===
 
===Export Directory===
 
The export directories are set for each case in the top of the settings file, as seen (INSERT LINK TO SETTINGS). Listed below are example directories for each case
 
The export directories are set for each case in the top of the settings file, as seen (INSERT LINK TO SETTINGS). Listed below are example directories for each case
Line 24: Line 22:
 
</pre>
 
</pre>
  
===Export Tools===
+
===Page_settings - Export Tools===
Each tool used in the download tools toolbar in the search page (data_view) must also be set up in the settings file (INSERT LINK TO SETTINGS).  
+
Each download and export tool used in the results toolbar in the search page (data_view) must also be set up in the [[page_settings.php]] file. These tools allow for exporting search results [[page_settings#Feeds|RSS and Atom feeds]] and exporting [[page_settings#Downloads|CSV]] files.
*'''CSV''':
 
<pre>
 
// DOWNLOADS
 
$res = "results_mode=dl";
 
$group_dls[] =
 
    array(
 
        'type' => 'text',
 
        'href' => "overlay_holder.php?$res&amp;dl_mode=csv&amp;lboxreload=1&amp;sf_conf=conf_mac_exportdownloadcsv",
 
        'css_class' => FALSE,
 
        'mkname' => 'csv',
 
        'lightbox' => 'lightbox|200'
 
);
 
</pre>
 
 
 
*'''RSS and Atom feeds''':
 
<pre>
 
// FEEDS
 
$res = "results_mode=feed";
 
$group_feeds[] =
 
    array(
 
        'type' => 'text',
 
        'href' => "{$_SERVER['PHP_SELF']}?$res&amp;feed_mode=rss",
 
        'css_class' => FALSE,
 
        'mkname' => 'rss',
 
        'lightbox' => FALSE
 
);
 
$group_feeds[] =
 
    array(
 
        'type' => 'text',
 
        'href' => "{$_SERVER['PHP_SELF']}?$res&amp;feed_mode=atom",
 
        'css_class' => FALSE,
 
        'mkname' => 'atom',
 
        'lightbox' => FALSE
 
);
 
</pre>
 
  
 
==Mod_Settings==
 
==Mod_Settings==
Each download mode will now need to be set up as a subform within each of the mod_settings files allowing users to download data. The CSV downloader is pretty much now the model for this now. As the conf is a 'mac' or macro view (a.k.a data_view) subform, it should appear in the mod_settings as such. An example of the configured subform for CSV downloads can be seen in the [http://ark.lparchaeology.com/wiki/index.php/Mod_settings.php#Export mod_settings] documentation.
+
Each download mode needs to be set up as a subform within each of the mod_settings files allowing users to download data. The CSV downloader is the model for this. As the conf is a 'mac' or macro view (a.k.a data_view) subform, it should appear in the mod_settings as such. An example of the configured subform for CSV downloads can be seen in the [[Mod_settings.php#Export|mod_settings]] documentation.
  
 
[[category: Administrator]]
 
[[category: Administrator]]

Revision as of 17:56, 24 February 2011

In order to allow your users to use the export functionality of ARK you need to set a few settings in the mod_settings.php and env_settings.php files. An example is here.

Env_settings.php

Export Directory

The export directories are set for each case in the top of the settings file, as seen (INSERT LINK TO SETTINGS). Listed below are example directories for each case

  • ms4w:
// EXPORT
$export_dir = $ark_dir.'data/tmp/';
  • mac:
// EXPORT
$export_dir = $doc_root.$ark_dir.'data/downloads/';
  • linux:
// EXPORT
$export_dir = $ark_dir.'data/tmp/';

Page_settings - Export Tools

Each download and export tool used in the results toolbar in the search page (data_view) must also be set up in the page_settings.php file. These tools allow for exporting search results RSS and Atom feeds and exporting CSV files.

Mod_Settings

Each download mode needs to be set up as a subform within each of the mod_settings files allowing users to download data. The CSV downloader is the model for this. As the conf is a 'mac' or macro view (a.k.a data_view) subform, it should appear in the mod_settings as such. An example of the configured subform for CSV downloads can be seen in the mod_settings documentation.