Creating a new Data Exchange package.
Define package
To create a Data Exchange package go to Administration -> System -> Data Exchange -> Packages.
1. Click New Package. The following view will be presented:
2. Edit/configure:
Package Name
Enter an appropriate name for the package.
Scheduled to run after
If required, select the appropriate time period for the Data Exchange to auto run. Alternatively, leave blank if the package is to be run manually.
3. Drag and drop a Data Transfer Task onto the Package Tasks field.
4. Click Configure. The following view will be presented:
Source Plugin
Select the appropriate option.
Note in this example the Easysite Users Data Source has been selected. The following view will be presented:
5. Configure the appropriate fields and click Next. The following view will be presented:
Key Field
Select an appropriate field.
Note: the key field must contain data which is unique to each record, for example user ID.
Hash Fields
Select the appropriate fields.
Note: Hash fields are used to update records. If the data in any of the hash keys has changed the record will be updated.
6. Click Next. The following view will be presented:
7. Select an appropriate Target Plugin.
Note in this example the CSV Data Target has been selected. The following view will be presented:
8. Configure the appropriate fields and click Next. The following view will be presented:
9. Create the appropriate mappings and click Next. The following view will be presented:
Task Name
Enter an appropriate task name.
Incremental mode
Incremental mode is utilised when importing data and works in conjunction with hash fields. Records are saved to the package, and only new records or records where data in a hash field are imported. Without incremental mode, data is cleared from the target and completely reimported. With incremental mode enabled, data is saved in the target and only new and amended records are actioned.
10. Click Next and then Save. The following view will be presented:
If the package has been scheduled it will run as required. Alternatively click Run Now.
For detailed information on specific Target and Source Plugins see the Data Exchange How to Guide.
