Import

Overview

The add-on uses CSV files to import, update and export listings and associated fields and media. Below you can read a list of the most important features.

• Import, export and update listings
• Filter exports by directories, listing types or categories and choose the export fields
• Skip duplicates while importing
• Update column selection so listings can be updated based on SKU, serial, ISBN, ...
• Import photos and set main media and media function (gallery, logo, cover)
• Import videos from supported sources (YouTube, Vimeo, Dailymotion, Twitch)
• Automatically create field options if not already present (Countries, State, City, etc.) with field option relations
• Store your import and export profiles with field associations and pre-defined settings, to be able re-use them and save time.

Exporting Listings

1. Adjust the filters for the export job

   • Directories
   • Listing Types
   • Categories

2. Select the fields to include in the exported data

   Fields include standard fields and custom fields. The Listing ID is automatically included in all exports because it's the default column used for update Listings.

3. Export

   Before starting the export job, you have the option of saving the export profile. This is useful when you need to frequently export the same listings because you can skip steps 1 and 2 above.

CSV Files

Before importing or updating listings, you need to have a CSV (comma-separated values) file. The first row in this file needs to contain the field (column) headers, while all other rows contain the actual data for the listings. You can use a spreadsheet software like Excel, Google Sheets, etc. to put together the data and export it as CSV.

Spreadsheet Format

CSV Format

Listing Title,Summary,Description,Country (jr_country)
Business A,The summary,The description,United States
Business B,The summary,The description,Germany

Continue reading the next sections to find specific formatting guidelines for including photos, videos and custom field data.

Importing Listings

1. Select and upload the CSV file

   If the format is correct, you will see 2 columns File Headers and Listing Columns. The number of rows available for selection should match the number of headers included in your file.

2. Associate the file headers with the corresponding listing column

   The names of the headers is not important because you can choose which header corresponds with specific fields in JReviews. When you export from the add-on and leave the headers unchanged, the column association can be done automatically.

3. Skip duplicates and set defaults

   You can prevent duplicate listings from being created using a combination of standard and custom fields.

   At this point, you can also set default values for category, listing owner ID, creation date, publication date, expiration date and custom fields. The defaults are used when not included in the CSV data.

   When importing new listings, the Category ID and User ID are required and can be specified as defaults if not included as columns in your file.

4. Import

   Before starting the import job you can review the column associations and default values. You also have the option of saving the import profile. This is useful when you need to frequently import with the same associations and settings.

Updating Listings

To update listings follow the same Import steps, with just one difference. It's necessary to select the Update Column.

When exporting listings with the add-on the Listing ID header is automatically included in the export. This is a unique ID that can be used to identify the listing when performing updates. If your CSV file includes the Listing ID header, the add-on will automatically select it as the Update Column.

You can use a different update column, as long as it has a unique value for each listing. For example, there are instances where the data source for the listings is regularly updated and instead of having to export the listings from your site, make changes, and re-import them, you can use the original source directly by selecting the unique column there as the update column (SKU, Serial No., ISBN, ...).

It's also possible to import and update listings at the same time. Rows in the file containing a value for the selected update column will be treated as updates, while those not having a value will be treated as new listings.

Importing Photos

To import photos with your new or updated listings, the images need to be present on your server, or another site. They cannot be uploaded directly from your computer.

• Use local paths relative to the root of your site, or absolute URLs to local or remote images
• Add captions by appending them separated with a pipe | character
• Associate the photo headers with the Photo column and choose from the additional photo options (Main Media, Gallery / Cover / Logo).

Importing Videos

To embed videos from supported services with your new or updated listings, include the video URL.

• Add titles by appending them separated with a pipe | character. Otherwise the title provided bythe video service will be used.
• Associate the video headers in your file with the video column.

Importing Custom Fields

To import field data, the fields need to be previously created in JReviews.

Importing custom field data is as simple as entering the text you want for your Listing Custom Fields. This also applies to Select, Radio and Checkbox fields. For Multiple Select and Checkboxes if the Listing has multiple options, just separate them with a comma.

Field Option Relations

To automatically create relationships, include both the control and dependent fields in your file and append the dependent field value with the control field name separated by the pipe | character.

The above tells the add-on that San Francisco is controlled by jr_state, and the value provided for this field within the same row California.

Commas in Field Option Text

If a field option includes a comma as part of the option text, it needs to be escaped with a backslash. For example, if the option text is One, Two, you need to write it as One\, Two. This rule applies to Select, Multiple Select, Radio and Checkbox fields.

On-the-fly Creation of Field Options

If a custom field option doesn't already exist for Select, Radio, and Checkbox field types, the option is automatically created during the import process. The value for the option is a hyphenated slug generated from the option text. For example, San Francisco gets converted to san-francisco for the option value.

Using Profiles

Import and Export profiles will save you time when you need to perform the same import, update, and export jobs periodically.

• It can can be time consuming to go through each step to select export columns or associate import columns with your file headers and set the import defaults.

• In the final step of each job, right before you begin the export or import process, you have the option of saving the profile so you can re-use it later on.

• Once you have at least one profile saved you can find it in the first step of your next job and it will automatically load all your previous settings.

Using with PaidListings

As covered in the paidlistings documentation, a listing without an order will not show custom fields and its media will be unpublished. When you import listings into paid categories, the add-on will not automatically create orders for them.

You need to follow the instructions in the paidlistings documenation and generate the orders for the new listings.

Using with MapsPro

When importing listings without coordinates, needed to show maps and perform location searches, these will not be automatically geocoded from the address fields. You can use the batch geocoding functionality to generate and store the coordinates for the new listings. Just bear in mind that the geocoding provider you use may have limits for the number of geocoding requests you can make during a specified period.

Troubleshooting

Can't download exports and reports?

If you are using a security solution for your site, it's possible that it blocks, or allows, access only to certain file types or directories. Sometimes this is achieved through changes in the .htaccess file if you are uing Apache. For Nginx you'll need to check the Nginx configuration file.

AdminTools for Joomla

In .htaccess Maker, under Exceptions from Server Protection / Allow direct access, except .php files, add the path:

• components/com_jreviews_addons/import/imports/
• components/com_jreviews_addons/import/exports/