commiting uncommited changes on live site
[weblabels.fsf.org.git] / crm.fsf.org / 20131203 / files / sites / all / modules-new / civicrm / templates / CRM / Event / Import / Form / DataSource.hlp
1 {*
2 +--------------------------------------------------------------------+
3 | CiviCRM version 4.6 |
4 +--------------------------------------------------------------------+
5 | Copyright CiviCRM LLC (c) 2004-2015 |
6 +--------------------------------------------------------------------+
7 | This file is a part of CiviCRM. |
8 | |
9 | CiviCRM is free software; you can copy, modify, and distribute it |
10 | under the terms of the GNU Affero General Public License |
11 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
12 | |
13 | CiviCRM is distributed in the hope that it will be useful, but |
14 | WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
16 | See the GNU Affero General Public License for more details. |
17 | |
18 | You should have received a copy of the GNU Affero General Public |
19 | License and the CiviCRM Licensing Exception along |
20 | with this program; if not, contact CiviCRM LLC |
21 | at info[AT]civicrm[DOT]org. If you have questions about the |
22 | GNU Affero General Public License or the licensing of CiviCRM, |
23 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
24 +--------------------------------------------------------------------+
25 *}
26 {htxt id="upload-title"}
27 {ts}Import File Format{/ts}
28 {/htxt}
29 {htxt id="upload"}
30 <p>{ts}Files to be imported must be in the 'comma-separated-values' format (CSV). Most applications will allow you to export records in CSV format. Consult the documentation for your application if you're not sure how to do this.{/ts}</p>
31 <h1>{ts}Required Participant Data{/ts}</h1>
32 <p>{ts}Participant import data MUST include the following columns:{/ts}</p>
33 <ul>
34 <li>{ts}Event Title OR Event ID (a unique integer assigned by CiviEvent, displayed in the Manage Events listing){/ts}</li>
35 <li>{ts}Participant Status (ie. Registered, Attended, Cancelled, etc.){/ts}</li>
36 </ul>
37 <p>{ts}The event's default Participant Role (usually Attendee) will be assigned if you do not include a value for role. Valid values for Status and Role can be found in the CiviEvent section of the Administer CiviCRM screen. You can also import Fee Level, Registration Date and any other standard or custom Participant fields.{/ts}</p>
38 <h1>{ts}Contact Records for Event Participants{/ts}</h1>
39 <p>{ts}Participant import requires that each person, household or organization already exists as a contact record in your CiviCRM database. If you need to import participant information for contact records which haven't been added to CiviCRM yet - you will do this in 2 steps. First, use <strong>Import Contacts</strong> to add the contact records. If possible, include a unique 'External ID' for each new contact which you can then use to match participant info such as event registration to the corresponding contact record. Then return to this screen and import the participant records.{/ts}</p>
40 <h1>{ts}Matching Participant Data to Contacts{/ts}</h1>
41 <p>{ts}Participant import files must contain data needed to <strong>match the participant to a contact record in your CiviCRM database</strong>. This 'matching' can be handled in several different ways:{/ts}</p>
42 <ul>
43 <li>{ts}Include the data fields used for contact 'matching' based on your configured <strong>Unsupervised Duplicate Matching</strong> rules. For the default duplicate matching rules, you would include a column in each row with the contributors' Email Address.{/ts}</li>
44 <li>{ts}If you've stored a unique <strong>External Identifier</strong> for each contact in CiviCRM, you can include that value as a column in your import file. Participant data will then be matched to contact records using their External ID. Please note that you must use an "On Duplicate Entries" setting of "Skip" or "No Duplicate Checking" to be able to upload using the External ID field.{/ts}</li>
45 <li>{ts}You can include a column with each contact's <strong>Internal Contact ID</strong>. This is the unique ID assigned by CiviCRM which is displayed at the bottom of the Contact Summary screen - and can be exported.{/ts}</li>
46 </ul>
47 <p>
48 {ts}Save the CSV file with your participant data and 'contact matching' data to your local hard drive (or an accessible drive on your network) - and you are now ready for step 1 (Upload Data).{/ts}
49 </p>
50 {/htxt}
51
52 {htxt id="id-onDuplicate-title"}
53 {ts}Matching to Contacts for Inserts and Updates{/ts}
54 {/htxt}
55 {htxt id="id-onDuplicate"}
56 <p>{ts}For each import, you can either INSERT new event registration (participant) records, or UPDATE existing records. You can not do both types of operations in a single import session.{/ts}</p>
57 <p>{ts}If you are INSERTING new participant records, you will need to include a column in your data file containing the values used to link the event registration to an existing contact. You can use the 'Internal Contact ID', an 'External Identifier' (if you are using those in your contact records), OR the property defined in your Unsupervised Duplicate Matching rule (which is Email Address by default).{/ts}</p>
58 <p>{ts}If you are UPDATING existing participants, you will need to include a column containing the unique CiviCRM-assigned participant ID to match to the existing participant record.{/ts}</p>
59 {/htxt}