Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:datasource [2015/12/16 12:36] admin |
en:datasource [2021/08/25 10:29] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== - Using data sources (data sources) in Zebrix ====== | + | ====== - Using datasources in Zebrix ====== |
| Zebrix lets you use data sources within your pages. | Zebrix lets you use data sources within your pages. | ||
| Line 12: | Line 12: | ||
| There are two ways to synchronize your data with zebrix: | There are two ways to synchronize your data with zebrix: | ||
| - | * The "Zebrix Connector" program (currently in alpha) is the easiest solution. | + | * The "Zebrix Connector" program (currently in beta version) is the easiest solution. |
| - | She no costs related to a specific development. | + | There is no costs related to a specific development. |
| While responding to the case of the most common usage, the Zebrix Connector includes certain limitations. | While responding to the case of the most common usage, the Zebrix Connector includes certain limitations. | ||
| - | * The development of a specific synchronization program proves the most flexible and efficient solution but generates a cost and development time to be taken into consideration. | + | * The development of a specific synchronization program is the most flexible and efficient solution but generates a cost and development delay to be taken into consideration. |
| - | This development can be supported by the development team Zebrix or by any developer of choice which the how to use the API Zebrix will be filled. | + | This development can be supported by the development team Zebrix or by any developer which has the "how to use the zebrix API" explanation. |
| ==== - Usage of the "Zebrix Connector" ==== | ==== - Usage of the "Zebrix Connector" ==== | ||
| The Zebrix Connector is a software solution for synchronizing data on Windows easy to learn and consists of two applications: | The Zebrix Connector is a software solution for synchronizing data on Windows easy to learn and consists of two applications: | ||
| - | * ** A configurator: ** allowing you to easily define your "Data Links" (datalinks) and refine the data to be synchronized by applying filters and conditions. | + | * ** A configurator: ** allowing you to easily define your "Data Links" and specify the data to be synchronized by applying filters and conditions. |
| - | * ** A Windows service: ** runs in the background and ensures data synchronization based on the "data link" (datalinks) that have been configured. | + | * ** A Windows service: ** runs in the background as a service and ensures data synchronization based on the "data link" that have been configured. |
| 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 will 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 principle compatible with any database for which an ODBC driver exists for Windows is. | + | The Zebrix Connector is in theory compatible with any type of database for which a 32 bits ODBC driver exists for Windows. |
| - | Zebrix tested by the team: | + | |
| + | <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: | ||
| * CSV | * CSV | ||
| * XLS (Microsoft Excel) | * XLS (Microsoft Excel) | ||
| 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 step: Specify 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 | + | |
| - | + | ||
| - | {{:zebrix_connector_-_filter_comparator.jpg?nolink|}} | + | |
| - | + | ||
| - | * Permet sur une colonne donnée de remplacer une valeur par une autre (attention, ceci ne modifie en rien la valeur dans la base de données coté client, ce substitue ne se retrouvera que coté Zebrix) | + | |
| - | + | ||
| - | {{:zebrix_connector_-_filter_replace.jpg?nolink|}} | + | |
| - | + | ||
| - | + | ||
| - | * Dans l'exemple suivant, les filtres "between" et "select" ont été mis en place. On veut les volumes qui sont compris entre 1 et 3 inclus (filtre between) et dont le nom de la série est TINTIN en affichant que les 5 premières colonnes. | + | |
| - | {{:zebrix_connector_-_creation_-_etape_04.jpg?nolink|}} | + | * Allow to filter by a value comparaison (>, <, =, <=, >= ) on a given column |
| - | * Ensuite, on veut Faux à la place de False, on met donc en place le filtre "replace" | + | {{public_media:zebrix_connector_-_filter_comparator.jpg?nolink|}} |
| - | {{:zebrix_connector_-_creation_-_etape_05.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 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. |
| - | === - Timer de la mise à jour et enregistrement du DataLink === | + | {{public_media:zebrix_connector_-_filter_replace.jpg?nolink|}} |
| - | * Sur cette page, on peut choisir la fréquence de mise à jour (en automatique pour des bases de données de type csv) en secondes, minutes ou heures. | + | * In the following example, the filters "between" and "select" has been set up. |
| - | * On s'identifie auprès de Zebrix afin qu'il reçoive les données filtrées. | + | We want the volumes that are between 1 and 3, and the name of the series is Tintin by displaying the first 5 columns. |
| - | * On nomme le DataLink pour qu'il puisse s'enregistrer correctement. Attention, il ne peut exister deux DataLinks avec un même nom, le nom doit être unique et propre à chaque Datalink. | + | |
| - | {{:zebrix_connector_-_creation_-_etape_06.jpg?nolink|}} | + | {{public_media:zebrix_connector_-_creation_-_etape_04.jpg?nolink|}} |
| - | * Une fois les données et le timer choisi, il ne reste plus qu'à valider. | + | * Next, we want to use the french word "Faux" instead of False, so we set up a "replace" filter |
| - | {{:zebrix_connector_-_creation_-_etape_07.jpg?nolink|}} | + | {{public_media:zebrix_connector_-_creation_-_etape_05.jpg?nolink|}} |
| - | * On peut constater sur le screen suivant que le DataLink est maintenant lister avec les autres. | + | === - Interval of the data update and save of the DataLink === |
| - | {{:zebrix_connector_-_creation_-_etape_08.jpg?nolink|}} | + | * On this page, you can choose the update frequency (automatic for file oriented databases (csv, xls)) in seconds, minutes or hours. |
| + | * You must fill in your zebrix client name, username and password | ||
| + | * You can choose the name of the datalink (it will appear with that name in the zebrix cms) | ||
| + | Warning, the datalink name must be unique. | ||
| - | ==== - Modification d'un DataLink ==== | + | {{public_media:zebrix_connector_-_creation_-_etape_06.jpg?nolink|}} |
| - | * Cliquer sur le bouton de modification permet de revenir à l'état les paramètres qu'on avait choisi lors de la création, ce qui permet de pouvoir effectuer les modifications plus rapidement. Par exemple, si on reprend le suivi de la création du DataLink ci-dessus, faire une modification nous permettrait de modifier directement les différents filtres appliqués (voir screen ci-dessous) | + | * 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_05.jpg?nolink|}} | + | {{public_media:zebrix_connector_-_creation_-_etape_07.jpg?nolink|}} |
| - | * Une fois les modifications enregistrées, il suffit de sauvegarder le DataLink comme lors de sa création. | + | * The datalink has been added. You can created as many datalink you want. |
| - | * 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. | + | |
| - | ==== - Suppression d'un DataLink ==== | + | {{public_media:zebrix_connector_-_creation_-_etape_08.jpg?nolink|}} |
| - | * Cliquer sur le bouton suppression efface le DataLink du Zebrix Connector et les données correspondantes dans Zebrix. | + | ==== - Edition of an existing DataLink ==== |
| - | * Attention : un DataLink supprimé ne peut être récupéré, il faudra le recréer. | + | |
| + | * Click on the Edit button to edit it | ||
| + | * for example you can modify filters, column selection, interval, etc. | ||
| + | {{public_media:zebrix_connector_-_creation_-_etape_05.jpg?nolink|}} | ||
| - | ===== - Utilisation des datasources sous Zebrix ===== | + | ===== - How to use your datasources on a zebrix page ===== |
| - | - Créez une page | + | - Create a new page |
| - | - Placez une zone | + | - Add the datasources you want to use in the page {{ public_media:fr_datasource_selection.jpg?nolink |}} {{ public_media:fr_datasource_selectionlist.jpg?nolink |}} |
| - | - Sélection des datasources qui doivent pouvoir être disponibles dans la page {{ :fr_datasource_selection.jpg?nolink |}} {{ :fr_datasource_selectionlist.jpg?nolink |}} | + | - Add a new zone |
| - | -Spécifiez qu'il s'agit d'une zone dynamique {{ ::fr_datasource_zonetype.jpg?nolink |}} | + | - Specify that the zone is a "dynamic datasource" {{ public_media:fr_datasource_zonetype.jpg?nolink |}} |
| - | -Spécifiez le champs souhaité {{ :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 |}} |
| - | -Les données de la zone seront automatiquement modifiées à chaque synchronisation. | + | - Data will automatically be updated in that zone after each synchronization. |
