Import Service is an automatic function to import Xml file data into Signifikant databases. It is run as a WIndows Service and is always active on a server. The same server may be available in the Signifikant Server and in the Signifikant Web Viewer, but with separate configuration.
The service acts on new files, Files and handles them in a pipe line - files are transformed into internal data format - data is uploaded to a remote server or stored locally.
Xml file transformations are configurable through scripts, in case no further programming is needed to convert a new custom Xml file format into the internal format accepted for upload and stored into a database. The remote server Api is called using REST calls, at HTTP port 80, to reduce the need to setup a network to access remote server.
The service do not import documents, images, illustrations. video or other media data. It is intended to update Signifikant databases, either the editor database or the server database.
This service is available in version 5.0 and later
Overview
The import process require a configuration of folders, filenames, transformers, handlers, logging etc,. Once this is setup the service is working automatically to handle new data.
Data flow and process:
A new file is generated on a predefined disk area by an external system
The service supervises the disk area and detects the new file, the file name is compared to a name pattern to determine if the file is handled and how it is handled
The import handler is called to transform the file to an internal format suitable for upload
The items loaded to the importer is passed to the uploader
The uploader handler calls a remote server Api, passing a chunk of items
The remote Api will handle the data and store it to the server, the REST call indicates what interface is called and type of the data to store
Details
Imported data
Currently we handle part prices, part availability, organisations and customers - all is imported to the Server database on a remote server.
Configuration
Api permissions are setup in: C:\ProgramData\Signifikant\Assert\api-permission.config, see Technical documentation - Signifikant REST API authentication .
The service configuration is in: C:\ProgramData\Signifikant\Assert\importer-service.config.
Tags | Description | Options |
|---|---|---|
Options | Used to define alternatives to control the import | See separate table below. |
Options tag has a set of keys.
Key | Value | Description | Options |
|---|---|---|---|
PurgeAfter | bool | After last call with all uploaded part numbers, a valid number list with all valid part numbers are uploaded. All parts in the price list or warehouse lists which not in the valid numbers list removed from that price list or warehouse list. That way removed prices/warehouse stock will get deleted. Use this method if full price lists or warehouse lists are sent. | |
Customization
Handlers for import or upload to remote server may be added in a customize module. By referring the custom handler in service configuration, any customer use case regarding automated file import, can be implemented. Custom modules require programming.
Permissions
The remote server may require permissions to access the upload Api interface. In that case we use basic authentication with a username/password to secure the function.
In this case the service need to declare login parameters for an upload handler, in the service configuration.
Logging
Configuration declares folders for logging, where each handler appends text to one file per day. Example of a log file name: UploadService_20200528_PartsPrice.log, indicating price information was uploaded.
The service also logs to an application log file, normally found at: C:\ProgramData\Signifikant\Assert\ImportService.log