About us The system Documentation Blog Login Register

Config Tool Guide​


Learn how to use your Integrator with the config tool guide. This guide goes through each and every part of the integrater tool

Config Tool Guide​

The Integrator Configuration Tool consist of three areas: The site overview on the left side, the status panel in the middle and the configuration part on the right side.

Integrator dashboard

Site panel

The site panel gives an overview of the sites (threads) that are created in the installed integrator instance. For each package you get a maximum of two simultaneous running threads towards the same fiscal entity. This panel gives you the possibility to create new sites and remove them again.
Furthermore the panel gives a quick overview of the status of each site, by a small square in the lower right corner. If the Windows Service, the Timers (not including the optional CronJob timer) and the web service connection. If one of these are not working properly, the square will be red, meaning it needs attention. Otherwise it will be green.

Add a site

When adding a site (+ button in the bottom of the panel), you need to define a name for that site. This name must be unique compared to the site already running. After creating the site, it’s good practice to make sure that all the settings in EC and WS Config is correct before pressing start. As there is a maximum of two sites running, it is not possible to add more than two sites.

Remove a site

If you wish to remove a site (- button in the bottom of the panel). When removing a site, the threads running in the service connected to the site will be shut down. There should at all-time be one site connected to the service. Therefore it is impossible to delete the last standing site.
Please note: It is good practice to restart the integrator service after creating and/or removing sites and in order to create less noise in the running system, this should be done off work hours.

Status panel

The status panel is where you get an overview of the currently selected site (marked with a blue tile in the site panel) and is able to control the current state of the threads in the site.

Integrator status

The integrator status panel is where you can control the state of the integrator. The integrator service can be running in order to handle other sites, which means that this status will be the same for all sites in the installed instance of the connector. It is important to understand that even though the Windows Service is running, it doesn’t mean it transfers data. The timers is the ones that needs to be running in order to transfer data from your ERP system.

Integrator Status

Data timer

The heart of the integrator. This is the timer that handles all the data that runs between the CMS system and the ERP system.

Image timer

Handles the transfer of all files that are related to the products in the ERP.

Script timer
General timer

The general timer is responsible for cleaning up unused data. For example deleting unused images in the front, which takes up space on a server.

Cron timer

This timer is optional in order for the integrator to run. In the CMS system, you have to ability to set up some keywords on different methods, which should be run on a regular basis (for example re-indexing search engines).

Web service status

The web service status gives an overview of the connection to the webservice.
As mentioned earlier the Cron Job is optional. If the Cron Job is setup, then the status will be checked with the dedicated Crob Job ashx file that should be poisitioned in the website along with the dll’s of the Framework.
The update button will make a fresh test on the conenction between the windows service and the web service.

Webservice status

Config panel

This is where all of the setup of the Integrator is done. There are several tabs to control different parts of the integrator and this is where all of your Evision System setup checks is done. The setup is done individually from site to site, but can be the same.

EC Config

EC config is the setup of the Windows Service. This is where all of the basic settings for the integrator is setup.

Timer settings

Timer settings handles the timers for each site.

Start time of general timer: The general timer is (as described earlier) the garbage collector. This can be a resource demanding process and should therefore only be run once a day. Therefore it is a good idea to set the start time within a period with less traffic on the integrator in order to preserve the flow.
Service Name: Name of the installed service instance of the integrator.

Timer Delay:

Row Limit: This is the maximum number of rows that the integrator picks from the journal in the database at the time. These rows are packed into files that is transferred to the web service and is unpacked. The larger the row limit, the larger files and the heavier load on the SQL-server. On the other hand, a low number means a lot of calls to the SQL-server and a lot of files to transfer. So this setting is very depending on the setup in the individual companies and could require some testing to find the correct number for your company. The standard row limit is 1000.

Synchronize images and files: As the name suggest. This is whether or not you want to transfer images and files (documents) to the front.

Auto start timers when machine starts: If the Windows Service for some reason is turned off and on again, this setting will auto start the timer threads for the site. If this setting is not set, you should be aware if the thread is running after a restart of the server.

Folder settings

These settings determines where the integrator should search for settings files bound to the integrator and file transfer locations (documents, configuration settings and images).

Erp webservice url:

Web picture path: This is the location of images and files related to products in the ERP system.

Eshop integrator path: The install path of the integrator where the services can find configuration settings files and settings.

Table synchronization settings

This is the where the translation schemas and scripts are set in the integrator.

System Field Diagram: This schema handles the translation of all the non-evision tables in the ERP system.

eTrade4 field diagram: This schema handles the translation of all the Evision tables in the ERP-system

User field diagram: If there has been made any customizations to the ERP system that needs to be transferred to the front, this is the schema that handles the translation of those tables to the front.

System script:

User script:

ERP settings

ERP settings is the connection towards the ERP system and which kind of ERP system the connector is dealing with.

ERP Type: Type of ERP system

ERP Dataset:

ERP Table Prefix: The fiscal entity of the ERP system

Database type: Type of database that the ERP system uses

Connection string: Credentials, server name and database that the EConnector Service should use to fetch data.

Test Connection: Checks whether or connection string is correct.

Synchronize ERP with Schema: The ‘sync’ button updates the

WS Config

This is the settings of the web service. All settings and actions related to the web service will be handled from this view.

Shop erp data

This is the place where you control the eShop.

eShop Type: Choose between eCommerce and eShop. Most users will pick the eCommerce option as it is meant for CMS system with

eCommerce. The eShop is meant for companies having a php shop to handle.

Reset Shop: Reset shop deletes all data in the front. Pressing this button will give you a new window to avoid accidental clicks. Furthermore you need to type in “RESET” in order for this to go through. From this window you are able to choose whether or not to delete inbound data and saved shopping carts.

Reset RetryCounter: If the connector has had some troubles fetching the data, it will retry five times before leaving the record in the journal. This button sets the retry count to zero.

Reset dialog

Send Config: Sends all the necessary information to the web service. This needs to be done if changes occurred that effects the web shop.

FTP

If shop demands to use the file transfer protocol, this is setup in this area. If enabled, the hostname of the server, credentials and the remote path to the server needs to be defined.

Paths

Contains the path to the Eshop webservice. If you need to test if this setting is correct, you need to press apply in the config window or go to the status panel and press update.

Cron Job

Contains the URL to the Cron Job. This is a page located on the eShop that is available together with the Framework dll’s. The connection string needs to refer to that page. Cron job needs to be enabled in order for it to run.

Validate Schemas

The validate schemas tab is to check if the schemas are set up correctly and if they contain data.
There are four colors that can be show when validating:

  • Green: OK, No issues found and data is present
  • Orange: Warnings, that indicates that something could be wrong, but not necessary is wrong.
  • Red: Failed, Schema and database is not in sync. Schema needs to be corrected.
  • White: No Data!, No issues found and no data is present

You have the possibility to validate both the eShop database (Validate schema for eShop) and the ERP database (Validate Schema for ERP).

Clean Box clears the validate table.

Copy message: Copies the selected row to the clipboard.

Full Upload

The full upload makes sure that data is all up to date in the front. This service is only available in the Configuration Tool and should be initiated manually.

Clean eShopJournal: Clears the journal table in the ERP. If the data that is being uploaded is part of the data that is in the eShopJournal. Then it’s not necessary for the records to be in the journal and should therefore be cleared.

Please note: This should only be checked if the full upload contains all tables.

Smart sync: Deletes all data in the frontend tables that is not present in the backend. Tables can be secured by adding a keyword that brings the table out of the loop.

Run scripts:

Upload data: Is on by default, determines if the full upload should contain data

Upload files: Is on by default, determines if the full upload should contain files (images and documents)

From and to date: Determines in which date-range the data should be uploaded.

The checkboxes on the right is the grouping of tables that needs to be uploaded. The children of the groups are the tables itself. These can be checked/unchecked if they don’t need to be uploaded.

Please note: Before making a full upload, make sure to validate both eShop and ERP database in the “Validate Schema” tab to ensure that all tables are setup correctly.

Errorlog: Is a text file containing information about which tables that might not have been transferred correctly.

Please note: If debug is enabled in administration tab. The full upload might run very slow depending on the debug level

About

Gives an overview of the versions of the DLL’s used within the system. Primarily used for debugging and error handling.

Administration

Usage details

Usage details tells the customer about the current status of the usage of limits. Above the table there’s account information about who bought the license and for how long it lasts. There are three colors to warn the user about the data usage:

  • Green: Data usage is below 80%.
  • Yellow: If the data usage reaches 80%, the row with the limit will turn yellow and a warning mail will be sent to the admin email.
  • Red: If the data usage reaches 100%, the row with the limit will turn red and a notice mail will be sent to the admin email. The timers will stop until the limit has been increased or the data has been deleted. The user has to manually start the timers again afterwards

Buy more data: Redirects the user to the Evision license shop

Debug

Debug is for error handling and troubleshooting. You can determine the level of which you want to debug (Debug level). On the Server that runs the Econnector Service, the debug information will be showing in the Event Viewer. In the front, there’s a table called EventLog, which contains all the information collected during the debug session
If image cannot be transferred the image errors will be shown in eShopStatusLog table in the ERP database

Debug Unique Key: Unique Key is used to differentiate between the different sites that has a debug session running in the event viewer and errorlog table in the front. As a default, this is equal to the Site ID.

Contact information

The email address of the person in the company responsible for the application.

This website uses cookies. By continuing to use the site you are agreeing to its use of cookies. More info