Solutions
Kepware to LitmusEdge Migrator
19 min
overview the kepware to litmusedge migrator is a web based tool that automatically converts kepware project files into litmusedge compatible format the migrator analyzes kepware json exports and performs intelligent transformations including driver mapping, address translation, and configuration preservation key capabilities automatic driver mapping from kepware to litmusedge equivalents address translation for modbus, siemens, allen bradley, and toyopuc protocols web based interface for file upload and processing direct template application to litmusedge instances detailed migration logs with unmapped address reporting supported drivers kepware driver litmusedge driver modbus tcp/ip ethernet modbus tcp siemens s7 plus ethernet siemens s7commplus siemens tcp/ip ethernet siemens s7 allen bradley controllogix ethernet ab compactlogix ethernet advanced allen bradley compactlogix ethernet ab compactlogix ethernet advanced allen bradley micrologix ethernet ab ethernetip ethernet toyopuc pc3/pc2 ethernet jtekt toyopuc cmp link fanuc focas ethernet fanuc focas (coming soon) running the application prerequisites docker installed on your system kepware project exported as json file (optional) litmusedge instance with oauth2 credentials for direct template application deployment steps load from tar file if the docker pull is not available, load the image from a tar gz file load the docker image docker load i kepware migrator tar gz run the container docker run d p 4001 4001 name kepware migrator kepware migrator\ latest access the application at http //localhost 4001 using the migrator step 1 export kepware project open kepware configuration manager go to file → save as select json format save the file to your computer step 2 upload and convert navigate to the migrator home page at http //localhost 4001 click "choose file" and select your kepware json file click "upload selected file" wait for processing to complete (typically a few seconds) step 3 review results after processing, the interface displays success confirmation message migration summary showing converted channels, devices, and tags list of unmapped addresses (if any) requiring manual configuration step 4 download converted configuration scroll to the "processed files" section click "download file" to download the litmusedge compatible json step 5 apply to litmusedge option a direct application (requires configuration) note the "apply litmusedge template" feature will only work after you configure your litmusedge credentials if the configuration is not set, the apply template functionality will not be available click the config tab in the migrator interface enter your litmusedge credentials litmusedge url (e g , http //192 168 1 100 ) oauth2 client id oauth2 client secret click save configuration return to the home page in the "processed files" section, click "apply litmusedge template" confirm the template application warning applying a template replaces existing flows in your litmusedge instance back up your current configuration before proceeding option b manual upload log in to your litmusedge interface navigate to system → device management → template click "upload template" select the downloaded json file review and test the imported configuration configuration the migrator supports the following environment variables variable description example edge url litmusedge instance url http //192 168 1 100 edge api client id oauth2 client id for api access your client id edge api client secret oauth2 client secret your client secret these can be configured through the web interface ( config page) or via a env file in the container troubleshooting port already in use if port 4001 is unavailable, map to a different port docker run d p 8080 4001 name kepware migrator kepware migrator\ latest access the application at http //localhost 8080 migration produces unmapped addresses unmapped addresses indicate tags that couldn't be automatically converted, typically due to unsupported address formats custom addressing schemes driver specific syntax not recognized these addresses are listed in the migration log and require manual configuration in litmusedge template application fails or button not available the "apply litmusedge template" feature requires configuration to be set before it can be used verify the following litmusedge credentials are configured in the config page (url, client id, and client secret) configuration has been saved successfully litmusedge credentials are correct litmusedge instance is accessible from the migrator container you have a valid litmusedge license network connectivity exists between the migrator and litmusedge if the "apply template" button does not appear or is disabled, navigate to the config page and configure your litmusedge credentials first upload fails ensure file is in json format (not opf or other kepware format) file size is under 16mb json is valid and not corrupted file was exported from kepware (not manually created) use cases migrating legacy kepware systems organizations transitioning from kepware to litmusedge can accelerate migration by automatically converting existing configurations, preserving years of device and tag definitions while adapting to the new platform multi site deployments for companies deploying litmusedge across multiple facilities with similar equipment, convert a single kepware reference project and replicate the configuration across sites with minimal manual work batch processing multiple projects process multiple kepware projects sequentially, download all converted files, and review unmapped addresses across projects to identify common manual configuration patterns before deployment best practices backup original files always retain copies of original kepware projects before migration review unmapped addresses carefully examine the migration log for unmapped addresses and plan manual configuration test incrementally after importing to litmusedge, test device connections one at a time verify device settings review timeouts, polling rates, and communication parameters in litmusedge post migration download migration logs keep migration logs for reference during troubleshooting and future migrations limitations only kepware json format is supported (not opf binary format) drivers not in the supported list require manual configuration tag grouping within devices may be flattened depending on driver type some device specific parameters may require manual adjustment after import template application requires valid litmusedge license