Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:datasource [2015/12/16 17:13]
admin [2.1 Usage of the Zebrix Connector]
en:datasource [2021/08/25 10:29] (current)
Line 25: Line 25:
 Synchronization is initiated either on the basis of a specified interval (every X seconds / minutes / hours) or on the basis of the detection of a change of data (only with file oriented databases (csv, xls)). ​ Synchronization is initiated either on the basis of a specified interval (every X seconds / minutes / hours) or on the basis of the detection of a change of data (only with file oriented databases (csv, xls)). ​
 Zebrix Connector must be installed on a Windows computer (server or workstation) with access to the source database and ODBC on which a link has to be created. ​ Zebrix Connector must be installed on a Windows computer (server or workstation) with access to the source database and ODBC on which a link has to be created. ​
-The Zebrix Connector is in theory compatible with any type of database for which an ODBC driver exists for Windows.+The Zebrix Connector is in theory compatible with any type of database for which a 32 bits ODBC driver exists for Windows. 
 + 
 +<WRAP center round important 60%> 
 +Warning, zebrix connector is only compatible with **32 bits SYSTEM DSN** ODBC links. ​ Please use the Microsoft 32 bits ODBC software version you will find at the following path:  **C:​\Windows\SysWOW64\odbcad32.exe** 
 +</​WRAP>​ 
 Zebrix team has already tested: ​   Zebrix team has already tested: ​  
   * CSV    * CSV 
Line 38: Line 43:
 ==== - Development of a specific synchronization tool ==== ==== - Development of a specific synchronization tool ====
  
-The Zebrix development team is able to develop a specific connector that can retrieve data from your SI, adapt and synchronize ​in Zebrix.  +The Zebrix development team is able to develop a specific connector that can retrieve data from your information system ​and synchronize ​it to Zebrix.  
-For information about this, thank you to contact your dealer or Zebrix ​[[support@zebrix.net]] ​+For information about this, please take contact ​with your zebrix ​dealer or zebrix support ​[[support@zebrix.net]] ​ 
 Frequently Requested for a specific development: ​   Frequently Requested for a specific development: ​  
   * CSV export, XML export, export JSON      * CSV export, XML export, export JSON   
Line 48: Line 54:
 ===== - How to install the Zebrix Connector ? ===== ===== - How to install the Zebrix Connector ? =====
  
-Click on the file {{:​zebrix_connector_setup_1.jpg?​nolink|}}. +Start the setup {{public_media:​zebrix_connector_setup_1.jpg?​nolink|}}. 
-A windows will open. Please follow instructions:​+Please follow instructions:​
  
   * Start of the installation - click next   * Start of the installation - click next
  
-{{:​zebrix_connector_setup_2.jpg?​nolink|}}+{{public_media:​zebrix_connector_setup_2.jpg?​nolink|}}
  
   * At this step you can choose to add a shortcut on your desktop   * At this step you can choose to add a shortcut on your desktop
  
-{{:​zebrix_connector_setup_3.jpg?​nolink|}}+{{public_media:​zebrix_connector_setup_3.jpg?​nolink|}}
  
   * Click on install and it's done !   * Click on install and it's done !
  
-{{:​zebrix_connector_setup_4.jpg?​nolink|}}+{{public_media:​zebrix_connector_setup_4.jpg?​nolink|}}
  
 Folder "​ZebrixConnector"​ will be created in the root of C: with all relevant files to the execution of software. ​ Folder "​ZebrixConnector"​ will be created in the root of C: with all relevant files to the execution of software. ​
-One can verify that the Windows service "​Zebrix Connector"​ is present among the other services ​as follows+You can verify that the Windows service "​Zebrix Connector"​ is present among the other services ​:
  
-{{:​zebrix_connector_-_service_windows.jpg?​nolink|}} +{{public_media:​zebrix_connector_-_service_windows.jpg?​nolink|}} 
- + 
-Approach to access this window: ​+
 Start> Run> services.msc ​ Start> Run> services.msc ​
 Select the service "​Zebrix Connector"​ and click Start at the top left to start the service. Select the service "​Zebrix Connector"​ and click Start at the top left to start the service.
  
-To start the configurator click on this icon {{:​zebrix_connector_-_executable.jpg?​nolink&​200|}}+To start the configurator click on this icon {{public_media:​zebrix_connector_-_executable.jpg?​nolink&​200|}}
  
 ===== - Zebrix Connector startguide ===== ===== - Zebrix Connector startguide =====
Line 78: Line 83:
 ==== - homescreen ==== ==== - homescreen ====
  
-{{:​zebrix_connector_-_accueil.jpg?​nolink|}}+{{public_media:​zebrix_connector_-_accueil.jpg?​nolink|}}
  
 Here you can see all Datalinks created with Zebrix Connector and information about them:  ​ Here you can see all Datalinks created with Zebrix Connector and information about them:  ​
   - Its name  ​   - Its name  ​
   - Its update frequency  ​   - Its update frequency  ​
-  - The names of columns ​concercées+  - The names of columns ​you've chosen to synchronize
  
-Icons :+Icons description:
  
-  * {{:​zebrix_connector_-_btn_creation.jpg?​nolink|}} To create a new DataLink +  * {{public_media:​zebrix_connector_-_btn_creation.jpg?​nolink|}} To create a new DataLink 
-  * {{:​zebrix_connector_-_btn_modification.jpg?​nolink|}} To edit an existing DataLink +  * {{public_media:​zebrix_connector_-_btn_modification.jpg?​nolink|}} To edit an existing DataLink 
-  * {{:​zebrix_connector_-_btn_suppression.jpg?​nolink|}} To delete a DataLink+  * {{public_media:​zebrix_connector_-_btn_suppression.jpg?​nolink|}} To delete a DataLink
  
 ==== - Steps for datalink creation ==== ==== - Steps for datalink creation ====
Line 95: Line 100:
 === - Connection === === - Connection ===
  
-  * To begin, click on the create ​button ​a DataLink.    +  * Click on the datalink creation ​button. ​   
-  * Follows the first part: the connection to the database and choosing a table+  * First stepSpecify ​the ODBC connection to the database and chose which table you want to get data from
  
-{{:​zebrix_connector_-_creation_-_etape_01.jpg?​nolink|}}+{{public_media:​zebrix_connector_-_creation_-_etape_01.jpg?​nolink|}}
  
   * The connection is made via the ODBC driver previously created. ​   * The connection is made via the ODBC driver previously created. ​
-It can be created in two different ​places:      +It can be created in two different ​types:      
-    * User (User) ​     +    * User (User accessible only)      
-    * System (System)    +    * System (accessible by the system - best choice !)    
-  * The second option concerns the fact whether a login / password to connect to the database ​  ​ +  * The second option concerns the fact whether a login / password to connect to the database ​is needed ​ 
-  * Once selected options, you can choose the database and the table where we intervene and send the data (see screen ​below)+  * You can then choose the database and the table you want to use (screenshot ​below)
  
-{{:​zebrix_connector_-_creation_-_etape_02.jpg?​nolink|}}+{{public_media:​zebrix_connector_-_creation_-_etape_02.jpg?​nolink|}}
  
 === - Filters === === - Filters ===
  
   * After connecting, two tabs appear: ​       * After connecting, two tabs appear: ​    
-    * Filters ​(Filters) ​     +    * Filters ​     
-    * Update & Save (Update and Backup ​  +    * Update & Save
   * You can see on the screen below the various filters that can be applied on our table   * You can see on the screen below the various filters that can be applied on our table
  
-{{:​zebrix_connector_-_creation_-_etape_03.jpg?​nolink|}}+{{public_media:​zebrix_connector_-_creation_-_etape_03.jpg?​nolink|}}
  
   * Different filters Check all / Uncheck all (just check / uncheck all) or so, we do not check that the relevant ​  ​columns. ​     * Different filters Check all / Uncheck all (just check / uncheck all) or so, we do not check that the relevant ​  ​columns. ​  
   * Number of rows (number of lines) which limits the result to a required number of lines      * Number of rows (number of lines) which limits the result to a required number of lines   
   * Refresh (Refresh) that visually update the table according to the filters applied ​     * Refresh (Refresh) that visually update the table according to the filters applied ​  
-  * There are 3 filters ​more "​complex"​:    +  * There are 3 advances ​filters: ​   
-  * Allows a given column select a range of values ​​(between 1 and 3 in the following example) +    * Allows a given column select a range of values ​​(between 1 and 3 in the following example) 
-{{:​zebrix_connector_-_filter_between.jpg?​nolink|}} ​+{{public_media:​zebrix_connector_-_filter_between.jpg?​nolink|}} ​
  
-  ​* Allow to filter by a value comparaison (>, <, =, <=, >=) on a given column+    ​* Allow to filter by a value comparaison (>, <, =, <=, >= ) on a given column
  
-{{:​zebrix_connector_-_filter_comparator.jpg?​nolink|}}+{{public_media:​zebrix_connector_-_filter_comparator.jpg?​nolink|}}
  
-  ​* Allow to replace a given value (in the column of your choice) by another. For example this feature will allow you to replace a "True / False" boolean value by another text string as "Open / Close" or "​Available / Not available"​ you can also replace a stock value "​0"​ to the "Out of stock" text. Please ​not that this would of course not change the data in your source database.+    ​* Allow to replace a given value (in the column of your choice) by another. For example this feature will allow you to replace a "True / False" boolean value by another text string ​such as "Open / Close" or "​Available / Not available"​ you can also replace a stock value "​0"​ to the "Out of stock" text. Please ​note that this would of course not change the data in your source database.
  
-{{:​zebrix_connector_-_filter_replace.jpg?​nolink|}}+{{public_media:​zebrix_connector_-_filter_replace.jpg?​nolink|}}
  
   * In the following example, the filters "​between"​ and "​select"​ has been set up.    * In the following example, the filters "​between"​ and "​select"​ has been set up. 
-We want the volumes that are between 1 and 3 inclusive (entre filter), and the name of the series is Tintin by displaying the first 5 columns.+We want the volumes that are between 1 and 3, and the name of the series is Tintin by displaying the first 5 columns.
  
-{{:​zebrix_connector_-_creation_-_etape_04.jpg?​nolink|}}+{{public_media:​zebrix_connector_-_creation_-_etape_04.jpg?​nolink|}}
  
-  * Next, we want to the french word "​Faux"​ instead of False, so it sets up the filter ​"​replace"​+  * Next, we want to use the french word "​Faux"​ instead of False, so we set up "​replace" ​filter ​
  
-{{:​zebrix_connector_-_creation_-_etape_05.jpg?​nolink|}}+{{public_media:​zebrix_connector_-_creation_-_etape_05.jpg?​nolink|}}
  
 === - Interval of the data update and save of the DataLink === === - Interval of the data update and save of the DataLink ===
  
-  * On this page, you can choose the update frequency (automatic for csv type databases) in seconds, minutes or hours. ​   +  * On this page, you can choose the update frequency (automatic for file oriented ​databases ​(csv, xls)) in seconds, minutes or hours. ​   
-  * We identify with Zebrix to receive updates filtered data.    +  * You must fill in your zebrix client name, username and password ​   
-  * It is called DataLink for him to record properly.  +  * You can choose the name of the datalink (it will appear ​with that name in the zebrix cms)  
-Warning, there can be two DataLinks ​with the same name, the name must be unique ​to each Datalink. +Warning, the datalink ​name must be unique.
- +
-{{:​zebrix_connector_-_creation_-_etape_06.jpg?​nolink|}} +
- +
-  * Once the data and the chosen timer, it only remains to confirm.+
  
-{{:​zebrix_connector_-_creation_-_etape_07.jpg?​nolink|}}+{{public_media:​zebrix_connector_-_creation_-_etape_06.jpg?​nolink|}}
  
-  * It can be seen on the following screen ​the DataLink ​is now list with others.+  * Then you just have to confirm. If you see the confirmation message it means that the first synchronisation ​is done (if you have an error it might mean that your client name, username, password could be wrong)
  
-{{:​zebrix_connector_-_creation_-_etape_08.jpg?​nolink|}}+{{public_media:​zebrix_connector_-_creation_-_etape_07.jpg?​nolink|}}
  
-==== - edition of an existing DataLink ====+  * The datalink has been added. You can created as many datalink you want.
  
-  * Click on the Change button to return to the state the parameters that had been selected when creating, which allows to make changes more quickly +{{public_media:​zebrix_connector_-_creation_-_etape_08.jpg?​nolink|}}
-For example, if we take monitoring the creation of the DataLink above, a change to allow us to directly modify the different filters applied (see screen below)+
  
-{{:​zebrix_connector_-_creation_-_etape_05.jpg?​nolink|}}+==== Edition of an existing DataLink ====
  
-  * Une fois les modifications enregistrées,​ il suffit de sauvegarder le DataLink comme lors de sa création. +  * Click on the Edit button to edit it 
-  * Attention : il n'est pas possible de changer la base de données et la table sur lesquelles les différents filtres s'​appliquaient ni de modifier le nom du DataLink+  * for example you can modify filters, column selection, interval, etc.
  
-==== Deletion of a DataLink ====+{{public_media:​zebrix_connector_-_creation_-_etape_05.jpg?​nolink|}}
  
-  * Once you save your changes, simply save the DataLink as when created. ​   
-  * Warning: it is not possible to change the database and the table on which the different filters applied or change the name of DataLink. 
  
-===== - How to your datasources on a zebrix page =====+===== - How to use your datasources on a zebrix page =====
  
   - Create a new page   - Create a new page
-  - Add to the page the datasources you want to use in the page {{ :​fr_datasource_selection.jpg?​nolink |}} {{ :​fr_datasource_selectionlist.jpg?​nolink |}}+  - Add the datasources you want to use in the page {{ public_media:​fr_datasource_selection.jpg?​nolink |}} {{ public_media:​fr_datasource_selectionlist.jpg?​nolink |}}
   - Add a new zone   - Add a new zone
-  - Specify that the zone is a "​dynamic ​data" {{ ::​fr_datasource_zonetype.jpg?​nolink |}} +  - Specify that the zone is a "​dynamic ​datasource" {{ public_media:​fr_datasource_zonetype.jpg?​nolink |}} 
-  - Specify which field you need {{ :​fr_datasource_fieldselection.jpg?​nolink |}} {{ :​fr_datasource_fieldselection2.jpg?​nolink |}} +  - Specify which field you need to display ​{{ public_media:​fr_datasource_fieldselection.jpg?​nolink |}} {{ public_media:​fr_datasource_fieldselection2.jpg?​nolink |}} 
-  - Data will automaticaly ​be updated in that zone for each synchronization.+  - Data will automatically ​be updated in that zone after each synchronization.