Kepware to LitmusEdge Migrator

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 using oauth2, an api token, or username and password detailed migration logs with unmapped address reporting, exportable as text or html light and dark themes 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 client credentials, an api token, or a username and password for direct template application deployment steps download kepware migrator tar gz and 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" wait for processing to complete (typically a few seconds) step 3 review results after processing, a new entry appears under recent upload activity click it to expand the details unmapped kepware addresses tags that could not be converted, with the address and the reason successful migration summary the converted channels and the devices under each one use copy logs or download logs to keep a record of the migration logs are stored in your browser, and clear logs removes them step 4 download converted configuration scroll to the "processed files" section click "download" to download the litmusedge compatible json use the delete button next to a file to remove it from the migrator step 5 apply to litmusedge option a direct application (requires configuration) note the "apply to litmus edge" feature only works after you configure your litmusedge connection on the config page click the config tab in the migrator interface enter the edge url (e g , 192 168 1 100 or https //edge example com ) if you leave out the scheme, https is assumed choose an authentication method and enter its credentials oauth2 client api client id and api client secret api token an api token (or jwt) generated in litmusedge username / password a local litmusedge user click save configuration the status row at the top of the page shows configured once the url and credentials are set return to the home page in the "processed files" section, click "apply to litmus edge" config page with an oauth2 connection configured 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 (https if no scheme) 192 168 1 100 edge auth method oauth , token , or jwt (username and password) oauth edge api client id oauth2 client id (for oauth ) your client id edge api client secret oauth2 client secret (for oauth ) your client secret edge api token api token or jwt (for token ) your api token edge username litmusedge username (for jwt ) admin edge password litmusedge password (for jwt ) your password 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 kepware data types with no litmusedge equivalent for that address these addresses are listed in the migration log and require manual configuration in litmusedge template application fails or button not available the "apply to litmus edge" feature requires configuration to be set before it can be used verify the following the edge url and credentials for the selected authentication method are configured on the config page 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 applying the template fails with an authentication error, navigate to the config page and check your litmusedge credentials 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