koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/csv-profiles.tt

   1 [% INCLUDE 'help-top.inc' %]
   2
   3 <h1>CSV profiles</h1>
   4
   5 <p>CSV Profiles are created to define how you would like your cart or list to export.</p>
   6
   7 <h3>Add CSV Profiles</h3>
   8
   9 <p>To add a CSV Profile</p>
  10
  11 <ul>
  12         <li>Click 'CSV Profiles' from the Tools menu
  13 <ul>
  14         <li>The 'Profile name' will appear on the export pull down list when choosing 'Download' from your cart or list</li>
  15     <li>The 'Profile description' is for your own benefit, but will also appear in the OPAC when patrons download content, so make sure it's clear to your patrons as well</li>
  16         <li>The 'CSV separator' is the character used to separate values and value groups</li>
  17     <li><strong>Tip:</strong> The most common option here is comma because most spreadsheet applications know how to open files split by commas.</li>
  18         <li>The 'Field separator' is the character used to separate duplicate fields
  19 <ul>
  20     <li>Example: You may have multiple 650 fields and this is the character that will appear in between each one in the column</li>
  21 </ul>
  22 </li>
  23         <li>The 'Subfield separator' is the character used to separate duplicate subfields
  24 <ul>
  25         <li>Example: You may have multiple $a subfields in a field</li>
  26 </ul>
  27 </li>
  28         <li>The 'Encoding' field lets you define the encoding used when saving the file</li>
  29     <li>Finally format your CSV file using the 'Profile MARC fields' fields
  30 <ul>
  31     <li>Define which fields or subfields you want to export, separated by pipes. Example :200|210$a|301</li>
  32     <li><strong>Tip:</strong> You can also use your own headers (instead of the ones from Koha) by prefixing the field number with an header, followed by the equal sign. Example : Personal name=100|title=245$a|300</li>
  33 </ul>
  34 </li>
  35 </ul>
  36 </li>
  37 </ul>
  38
  39 <p>When you have entered in all of the information for you profile, simply click 'Submit' and you will be presented with a confirmation that your profile has been saved.</p>
  40
  41 <h3>Modify CSV Profiles</h3>
  42
  43 <p>Once you have created at least one CSV Profile an 'Edit profile' tab will appear next to the 'New profile' button.</p>
  44
  45 <ul>
  46     <li>Choose the profile you would like to edit and alter the necessary fields.</li>
  47     <li>After submitting your changes you will be presented with a confirmation message at the top of the screen</li>
  48     <li>To delete a profile, check the 'Delete selected profile' option before clicking 'Submit Query'</li>
  49 </ul>
  50
  51 <h3>Using CSV Profiles</h3>
  52
  53 <p>Your CSV Profiles will appear on the export list or cart menu under the 'Download' button in both the staff client and the OPAC</p>
  54
  55 <h3>Template Toolkit tags</h3>
  56 [% TAGS [- -] %]
  57 <p>You can use Template Toolkit tags in order to build complex CSV files.</p>
  58 <p>To access to the field list of the current record, you have to use the 'fields' variables (which is a hashref).</p>
  59 <p>All fields of the record is content into this variable in a "field tag name" key.</p>
  60 <p>In order to manage multi-valuated field and subfields, the field and subfields are stored into an arrayref</p>
  61 <p>For example, the following MARC record:</p>
  62 <pre>
  63 008 - FIXED-LENGTH DATA ELEMENTS--GENERAL INFORMATION
  64   @ 140211b xxu||||| |||| 00| 0 eng d
  65
  66 100 ## - MAIN ENTRY--PERSONAL NAME
  67   a Personal name My author
  68
  69 245 ## - TITLE STATEMENT
  70   a Title My first title
  71   a Title My second title
  72   b Remainder of title My remainder
  73
  74 245 ## - TITLE STATEMENT
  75   a Title My third title
  76 </pre>
  77 <p>will be stored into the following structure:</p>
  78 <pre>
  79 {
  80     fields =&gt; {
  81                 008 =&gt; [
  82                         "140211b xxu||||| |||| 00| 0 eng d"
  83                 ],
  84                 100 =&gt; [
  85                             {
  86                                 a =&gt; [
  87                                     "My author"
  88                                 ]
  89                             }
  90                 ]
  91                 245 =&gt; [
  92                             {
  93                                 a =&gt; [
  94                                     "My first title",
  95                                     "My second title"
  96                                 ],
  97                                 b =&gt; [
  98                                     "My remainder"
  99                                 ]
 100                             },
 101                             {
 102                                 a =&gt; [
 103                                     "My third title"
 104                                 ]
 105                             }
 106                 ]
 107     }
 108 }
 109 </pre>
 110 <p>The indicators can be accessible using the 'indicator' key.</p>
 111 <p>Example: [% fields.245.0.indicator.1 %] is the indicator 1 for the first 245 field.</p>
 112
 113 <p>Some examples:</p>
 114 <ul>
 115   <li>Display all 245$a and 245$c into the same column:
 116     <p>
 117     [% FOREACH field IN fields.245 %]
 118         [% field.a.join(' ') %] [% field.c.join(' ') %]
 119     [% END %]
 120     </p>
 121   </li>
 122   <li>Display 650$a if indicator 2 for 650 is set
 123     <p>
 124     Subject=[% FOREACH field IN fields.650 %][% IF field.indicator.2 %][% field.a.0 %][% END %][% END %]
 125     </p>
 126   </li>
 127   <li>Display the language from the control field 008
 128     <p>
 129     Language=[% fields.008.0.substr( 28, 3 ) %]
 130     </p>
 131   </li>
 132   <li>Display the first subfield a for first field 245 if indicator 1 for field 100 is set
 133     <p>
 134     Title=[% IF fields.100.0.indicator.1 %][% fields.245.0.a.0 %][% END %]
 135     </p>
 136   </li>
 137 </ul>
 138 <p>Note that the authorized values won't be replaced by their descriptions.</p>
 139 [- TAGS default -]
 140
 141 <p><strong>See the full documentation for CSV Profiles in the <a href="http://koha-community.org/manual/[% helpVersion %]/html/tools.html#csv-profiles">manual</a> (online).</strong></p>
 142
 143 [% INCLUDE 'help-bottom.inc' %]