flexIMPORT : User guide

The documentation to start with flexIMPORT. Thanks to read all before to post in forum.

flexIMPORT  is a Joomla! component developed to let you import datas easily and automaticly in FLEXIcontent.
com_fleximport

Introduction

flexIMPORT is a component who want to help you in your import of massive datas. 
It's possible to create further types of import pre-set associated with FLEXIcontent's type. Each import's type is associated to system fields (title,texte,author...) and users fields.
An import of datas is based of import's type pre-set.
When you make your import, a log file is created to trace all the step of the import. That you let understand why you import work or not work.
The plugin's section will let you add new functionnality to support after new kind of fields or new kind of files (xls,mdb...).

Requirements 

Before to purchase flexIMPORT, be sure that your configuration will be compatible.

  • It will only work if FLEXIcontent is installed.
  • PHP 5.0 or superior.
  • You need to allow the PHP functions ignore_user_abort() and set_time_limit().

The import's type

Actually 2 types are avaible in standard with the component flexIMPORT : XML and CSV. However the settings stay the same, some parameters are specifics.
When adding a new type of import, it will create automatically the fields who depends of FLEXIcontent's type linked that you have selected.

Import type list 

1-Type
You can manage here all yours types of import. With a simply clic on "show the fields", that will display you all the fields associated to this type.

Details of a type

2-import_details
Type 
: The name of your import.
Publish : To publish or unpublish the import.
FLEXIcontent's type : Set here the link with the type of FLEXIcontent.
Format : The format of your data that you want to import.
Description : To add some description or information about your import

3-standard_properties
(1) only for automatic import, (2) only for FTP import, (3) only for FTP and Web import 
Localisation(1) : Specify the localisation for the file. local: the directory on the local server, web: access of the file by the web, ftp:access of the file by FTP.
Filename(1) : Full name of the file to import.
Filters(1) : Regex who let you find one or more files to import.
Address(1) : Path to access to the file (don't forget the '/' at the end). For a local file, if the path start by '/' it will use the root of the server else it will use the relative path based on the root of your website.
Server(3) : Url or IP of your server.
Username(2) : Username for the FTP.
Password(2) : Password for the FTP.
Delete(1) : If it's set to yes, it will remove the original file of the import.
Archive : Archive or not the file of the import.
Archive path : Path where will be stored the files imported after the import. (default value : images/fleximport/archives/).
Temp path : The import need a full acces to a temporary directory (write / read).(default value : tmp/fleximport/).
Logs path : Path where the logs files will be stored.
Email destinataire log : If an email is set, the results for the import will be send automatically at the end of the import.

4-import_parameters
Default access
 : During the import, if the level access is not set, it will use this value by default.
Allow add : Set if the import can add new datas or not.
Allow update : Set if the import can update datas or not.
Allow delete : Set if the import can delete datas or not.
Primary key : The primary key is the index for a data, that will allow to link an information between the import datas and the datas allready stored. That must be an unique value(ex:référence). If the value of the primary key is found, the import will not add a new data, but it will update the data founded in the database.
Action field : The action field  is the field who will let know the action to do when a primary key will be founded.
Add action value : The value of action field to determine an add.
Update action value : The value of action field to determine an update.
Delete action value : The value of action field to determine a delete.
Delete action : Determine the action for a delete : unpublish,archive or delete.

Specificity for XML import 

5-specs_XML
Root XML
 : It's mandatory to set the tag's root of the xml file. (to determine if the xml file is correct)
Key XML : It's the XML'tag to determine the records to import (mandatory). It's possible to determine further keys seraparing the values with a comma.

Specificity for CSV import

It's mandatory that the CSV's file have in the firt line the name of each columns.
6-specs_CSV 

Separator : The characters to determine a seperator between each value.
Fields surrounded by : The characters to surround the values
Separator for multiple values: It's possible to separate one value in further values to integrate it correctly after. Specify characters to separate the values.

The import's fields

To make working your import you have to link the FLEXIcontent'fields with the flexIMPORT's fields. There is system fields (cannot be delete) and the users fields.

Some fields can be added just to determine the action to do (the primary key and the action field, for more imformation : The Import's type -> details of a type).

Import fields list

7-Fields
You can manage here all the fields for your import. You can use the filters to find easily yours fields that you want to edit.
It's impossible to add or delete system fields.

Details of a field

8-Import_fields_properties
Name
 : The name of the field. This name is automatically generated when the type is created but you can change it as you want.
Fields: The name of the key to find the value in the file that you want to import.(title of the column for a CSV's file, name of the tag for a XML's file). It's possible to use further keys, just separate each one by a comma (that will let you assiociate further values for a same field). For the XML's files, there is a specificity to access to the attribs of a tag. You need to write the tag name followed by @ and the name of the attrib (tag@attrib). 
Publish: Publish or unpublish the field.
Mandatory : Put the field mandatory to import the date. Carefull if the field is empty and there is none default values determined the data will not be imported.
Type de champs : It seems at the FLEXIcontent's fields, but it's the plugins for flexIMPORT. Each plugin have is own parameters. You can't add a system's plugin, they are automatically generated when you create a new type for import. The kind of field "none" can be use if you don't want to import datas but you need it to determine the action field or the primary key (see the parameters of the import's type). 
Types : Link with the FLEXIcontent's type 
FLEXIcontent Field: Link with the FLEXIcontent's field. 
Ordre : Only use to determine the order of the treatment during the import. 
Description : Just let you add some notes about the field.
9-standard_properties
Default value
 : This value will remplace the Null value if it's founded.
Null value : Set the null value for the field (by default it's empty).
Multiple value: Authorize or not to import in the field further value for a same record.
Corresponding value : List to make the correspondence between the value founded in the file to import and the data to be recorded in the database. (write like that : value_file1::value_db1%%value_file2::value_db2%% ...)

Specificity of some fields
Field Title
Prefix: Add a prefix to the title.
Suffix : Add a suffix tot the title.

Field text
Prefix : Add a prefix into the text.
Suffix : Add a suffix into the text.
Delete HTML : Remove all the HTML's tags in the text.
Separator "Read More" : Determine the characters to insert a "Read More" into the text.

Field created_by
Author by default : Determine the author by default for imported article.
Default author nickname : Determine the nickname by default.

Field modified_by
Author by default : Determine the last editor by default for articles updated.

Field state
State : Determine the state by default of a new article.

Field category
Very important !!! Think to determine a category by default, that will save you having problems during the import.
Category : Select here one or further category by default.
Field tags
Tags :  That will add automatically tags during the import, you can add further tags. You need to separate each tags by ;

Field attribs
This field let you set all the attribs that you can set in an article. Its important to set the language if you use Joomfish.

Field picture 
Default directory : Path by default to find the picture. It will use the relative path of your website, exept if you a / at the start of the path, in this case that will use the root of your server. You can also use an URL (http://www.mywwebsite.com).
Action if exist  : Action to use if the picture allready exists in FLEXIcontent.
Use default image : If there is no image in the file to import, you can use a picture by default.
Default image : The default picture to use. (list of the FLEXIcontent's files).

The Import11-Import

Select the import that you want to do, then click on the button "Import" to launch the treatment. That can a long time, so don't try to close or refresh the page.

Manual import 

The manual import offer you the possibility to upload a file and launch the treatment on it.

Automatic import

The automatic import will automatically find the file based on the type's parameters.

The Logs

11-Logs
The logs let you control all the treatment of the import. If you have some errors, maybe you will have the explanation here.

The plugins12-Plugins

List of the plugins used in the current version of flexIMPORT. Be sure to have the last version of each plugins, you can just download and install only one plugin on our website instead of update all flexIMPORT. 
You have 2 kinds of plugins, type's plugins (supported file for the import) and field's plugins.flexIMPORT let you add new functionality, you can develop them and add them here.

Newsletter

Login

Live Support