RO CSVI
Create a template
| RO CSVI
To create a template in CSVI you take the following steps:
- Click on Components
- Click on CSVI Pro
- Click on Templates in the sidebar menu
- Click on New
- You will now get the template wizard asking for details. Fill in the details to tell CSVI what kind of template you want it to be.
- After filling in the details click on Select source. Select the source if its import operation or Destination for export.
- Click on Select options and fill in all the options needed.
- Click on Select fields. By default there is no option in import template to add fields so move on to last step of finalizing. The fields are optional for import templates because it is possible to use the column headers in a file as fields. For export, you have an button Edit template fields to add required fields as it is important to tell CSVI which fields you are trying to export. Add fields and moved on to last step of finalizing.
- Click close and save the template.
Special buttons
The toolbar features 2 special buttons in the top right corner, these are:
- Advanced
- Help
Advanced button
The advanced button will show or hide extra options available for this operation, by default only the basic options are shown.
Click on the Advanced button to show the extra options, click again to hide the extra options.
Help button
The help button will show you a description of each field below the field.
Clicking the Help button will show the help information, click again and the help information will be hidden.
Read article How to edit a template to know how to change the settings of saved template.
Using Firefox Web Console to analyze problems
| RO CSVI
Sometimes a process generates an error notification or it simply seems to run forever. In this case the error happens in the background and you can't see what is happening. To make it possible to see what is happening, you can use Web console of Firefox.
Requirements
- CSVI
- Firefox
Analyze the problem
With Firefox we can analyze what happens. Follow these steps:
- Prepare your template if you are doing an import or export, otherwise you can skip this step.
- Go to Tools >> Web developer >> Web console
- Click on the Console tab. The console window will tell us what is going on. Your screen should look like this:
If you do not see the bar with Net, CSS, JS etc. Click on the Filter Output option. - Make sure that Enable Persistent logs is checked in Settings panel so that the import information is not lost.
- Start the import/export/maintenance task
- During the execution you can get a screen like this:
- Click on the URL to see the contents.
- Click on the Response tab
- Here you will either see the error that is causing the problem or some code you may not understand. That is not a problem.
- Either look to fix the error or post the full output on the forum and we will have a look
Custom tables import
| RO CSVI
Background information
The custom tables import is a special import. This import allows you to import data into any available database table in your system. The table must have a primary key, otherwise it will not work.
Creating the template
First we will create an import/export template in which we can store all our preference. Let's say we are going to do an custom table import
- Go to Components
- Go to RO CSVI -> Templates
Now you are on the templates page, this is where the import and export templates are created. Click on New button on top corner and follow the Create a template tutorial to create your template.
- Give a descriptive name for the template
- Select Import as Action
- Component as RO CSVI
- Operation as Custom tables
- Enable logging if set to Yes
This is a very important option. Setting this to Yes will tell RO CSVI to create a detailed log of all steps taken during export. This is a very useful report to find any potential problems. Whenever you post a question on the forum, make sure you post this file also. It is the only way to help you out. The How to collect debug information article explains this in further detail.
Setting the options
The next step is to tell CSVI for which custom table you want to import, from the options tab, select the table.
You can now set the field based on with which import should be done. It is now not restricted to primary key field but to any valid column name from the database table. On options tab, under the custom table, you can select the import based on field. If nothing is set then custom table primary key field will be used.
Now that the options are set, Don't forget to click on Save to save your changes in your template and make sure they don't get lost.
Adding the fields
Now that template is created we need to add fields to be imported. Fields depend on the custom table you have selected for importing. In this tutorial, content table is taken as example, so for importing into content table, fields are added like
Once the template and template fields are set, importing is done in a normal way as we do for other templates.
Validation
The custom import does not do any validation on the data being imported. You will have to make sure that the import data is correct.
Adding and updating
Data is managed based on the primary key field of the table. If the primary key field is included in the import file, the data is updated regardless if the primary key exists or not. If the primary key field is not included in the import file, the data is added.
Supported tables
RO CSVI supports all tables that are supported in the Joomla installation to be imported/exported.
Creating A Custom Import File
To create an import file for a custom import it is important to know what data is expected for the table you are going to import. To know which fields are available for your custom import, take these steps:
- Go to Components -> RO CSVI ->Maintainence page -> Available Fields
- Select Import
- Select RO CSVI
- Select Custom tables
- Click on Go
- Click on the column Table to sort the fields on Table
- Now scroll to the table you want to import and you can see the fields that are available for import
Import a Custom Import File
To import your custom import file, take these steps:
- Go to Components -> RO CSVI -> Import
- Select Template we created for custom import
- Click Select file
- Choose the file to import and click on Preview from top corner. CSVI will display the lines from the csv file as a preview.
If the data importing is correct, click on Start import from top right corner and RO CSVI will import all data from the csv file. Once import is done status of the import and logs will be displayed as per preferences set in the template.
Support NULL values
Starting from RO CSVI 8.0.0 version, import of NULL values are supported in Custom table import for fields which support it in database. A NULL value can be used to empty a field, to set a field to NULL, the word NULL must be used as shown in the example below.
"name","title","introtext","note"
"sample article","Sample Article","Example sample article to explain usage of NULL values",NULL
Can I mix fields from different imports/exports?
| RO CSVI
No, this is not possible. You can only use the fields available to one chosen import or export type.