CIMETRIX LICENSE POLICY
Introduction
Cimetrix provides two types of licenses; Software Development Kit (SDK) licenses and Runtime (RT) licenses. In order to install and use Cimetrix software products, a valid License File is required.
A Certificate of Authenticity (COA) is issued electronically for each SDK or Runtime license at the time of order fulfillment and is used for (i) proof of purchase, (ii) inventory control, and (iii) to obtain a valid License File. Cimetrix provides an online Cimetrix License Generator https://licenses.cimetrix.com/ which uses both the COA and a system’s MAC address to generate a valid License File for the products (purchased/specified/contained) in the order. A valid License File is required to install and run all Cimetrix products. At installation and runtime, Cimetrix license control software checks the product, License File, and the system’s MAC address to verify the product is on the correct system. For an SDK license, if an invalid License File is detected due to a mismatch of the system’s MAC address, the product will not install. For RT licenses, the product will install but will give a warning of the invalid License File and continue to function for a period of 30 days; this allows time for license resolution in case of emergency hardware upgrades.
The Cimetrix License Agreement (“CLA”) https://www.cimetrix.com/cla governs all Cimetrix products obtained, received, or used by OEMs and End Users and covers all Cimetrix software, documentation, and services. While the Cimetrix Licensing Policy and the CLA are designed to be consistent with each other, the CLA will control in the event of any conflict.
Definitions
“License” means the legally binding guidelines for the use and distribution of software developed by Cimetrix.
“License File” means the file that contains the collection of product codes for which the client has a valid license to use and include in their application.
“COA” means a genuine Cimetrix Certificate of Authenticity, whether provided by Cimetrix in electronic or hardcopy form, for a specific Cimetrix software product.
“Named User” means a specific and unique individual person, not a title or position. For example, “John Doe” would be a “Named User” whereas “Developer” would not be a Named User.
“Named User License” means a license assigned to a specific and unique individual person.
“Timed License File” means a License File that will automatically expire and render itself unusable after a defined period of time. For example, a Demo License File generally will generally expire in 30 days at which point it will stop functioning and be unusable without intervention by Cimetrix.
SDK Licenses
The first type of license is an SDK license, which allows software developers to use Cimetrix products in their software applications. Cimetrix uses a “Named User License” system for SDK licenses. Each SDK license or “seat” is issued a unique COA number. The COA is assigned to a unique Named User who is allowed to install and use a single instance of the Cimetrix SDK products in the development of their application.
Cimetrix offers a special SDK license provision for all clients who have a current support contract in place. This special SDK license provision is designed to help clients who use virtual machines (VMs) or secondary computers as part of their individual development process for testing and supporting simultaneous development projects. These VMs usually have a different MAC address than the native system hosting the VM. Also, developers often use a desktop PC in the office, but take a laptop when they have to visit a customer site. To support these different use cases, a Named User (developer) may request License Files for up to five (5) devices, such as computers (including test computers) and VMs to facilitate their application development and testing. Only the developer to whom the COA is assigned may use the additional License Files. Having multiple License Files is not the same as having multiple SDK licenses. A given product license may not be used concurrently on two computers, even if both machines have valid License Files. It is allowable for two computers to use License Files generated for the same COA concurrently only if each computer is running different products. The license agreement does not allow for two instances of a single Cimetrix product to be run on two or more computers or VMs at the same time using the same license. For example, a developer may run one of the Cimetrix testing products on one computer and connect it to another computer running their complete solution using CIMConnect and CIM300 for system level testing.
Runtime Licenses
The second type of license provided by Cimetrix is a Runtime license. This license is installed on each equipment for use with a Bundled Product as defined in the Cimetrix License Agreement. It will allow the Cimetrix products to run in conjunction with the client’s application. One Certificate of Authenticity (COA) is issued at time of order fulfillment for each Runtime License. The Runtime license may only be used on one computer or VM instance.
Obtaining a License File
You can obtain a new Cimetrix License File or transfer an existing License File by going to the Cimetrix License Generator website at https://licenses.cimetrix.com. Log in using your Cimetrix support website credentials (username and password) and you will be able to issue or transfer a License File using the original COA number issued for that license and the MAC address for the system where the License File is to be installed. If you are transferring a license, you will also need the old MAC address. Once the necessary information is input and accepted, you will receive the License File by email.
The Cimetrix License Generator will also accommodate the special SDK license provisions for those clients with a current support contract. If all 5 License Files have been issued, a developer would need to determine which of the existing 5 is no longer in use, and then transfer that one License File in order to install on a new VM or test system.
If the client no longer has a valid support contract, only 1 of 5 SDK license assignments will be valid. A valid support contract is required to use the Cimetrix License Generator. Licenses can still be transferred without a valid support contract, but you will have to contact licenses@cimetrix.com in order to transfer the license. The first year of support is included in all SDK purchases.
If there are any issues with the Cimetrix License Generator, please contact licenses@cimetrix.com for assistance getting your License File.
Frequently Asked Questions
General Licensing Questions
- What is the difference between an SDK license and a Runtime license?
o An SDK license is used by a developer to create applications that use Cimetrix products. A Runtime license is installed on equipment that the OEM is shipping to the end customer.
SDK Named User Licensing Questions
- How do I manage my Named User License Files?
o The Cimetrix License Generator at https://licenses.cimetrix.com is used to assign and review the Named User.
- Is the special SDK license provision applicable to all existing SDK licenses retroactively?
o Yes, with a valid support contract.
- How will I know how many times I have generated an SDK license, for which MAC address, and how many I have remaining available?
o The Cimetrix License Generator will allow you to see what license assignments have already been generated for a given COA.
- Which Cimetrix products are “testing products”?
o GEMHost Messenger, TESTConnect, SECSConnect Cimetrix® HostConnect, ECCE Plus, and EDA Connect.
- Can an application that uses a Cimetrix product and a Named User License be tested by a Cimetrix testing product on another computer using a Named User License for a different user?
o This is allowed as long as both Named User licenses are valid. They do not both need to be for the same Named User.
- What if the Named User for an SDK departs from the equipment development team and a new engineer is assigned?
o Log in to the Cimetrix License Generator and update the Named User license information to reflect the name of the new engineer. If you do not have access to the old MAC addresses, please contact licenses@cimetrix.com for assistance.
- What if the Named User gets a new computer?
o Log in to the Cimetrix License Generator and transfer the License File from the MAC address of the old computer to the MAC address of the new computer.
- What if a virtual machine gets deleted?
o The Named User License for that virtual machine will remain assigned to the VM in the Cimetrix License Generator system until the license is transferred to a different VM or computer and a new License File is generated. Log in to the Cimetrix License Generator to transfer Named User Licenses to a different VM or computer.
- What if two virtual machines have the same MAC address?
o It is recommended that each VM be assigned a unique MAC address. If you use a License File for multiple VMs with the same MAC address, each VM counts as one device regardless of the MAC address.
- What if I have a test equipment in my lab?
o Test equipment is considered part of the client development and test environment. Named User licenses may be used on test equipment, but may not be used on any equipment that is shipped to the client’s customer. However, the restriction of only using one instance of a Named User License at a time remains in effect—if a Named User License is being used on the test equipment, it cannot be concurrently used on any other computer.
Runtime License Questions
- What if I have a cluster tool and need to install a runtime instance of the Cimetrix software on more than one computer within the same equipment?
o A cluster tool is covered by a single Cimetrix license. If a Runtime (RT) product license is needed on more than computer, contact licenses@cimetrix.com for assistance with this licensing scenario.
- What if the equipment’s computer gets replaced?
o Log in to the Cimetrix License Generator at https://licenses.cimetrix.com and transfer the license from the MAC address of the old computer to the MAC address of the new computer.
- What if a network card is replaced?
o Log in to the Cimetrix License Generator and transfer the license from the MAC address of the old network card to the MAC address of the new network card.
- What if two or more equipment share the same computer?
o Each equipment will need a unique COA and Runtime License File.
License Control Panel Questions
- What is the License Control Panel?
o The License Control Panel, introduced in November 2015, provides feedback on license status and provides functionality for viewing, maintaining and updating Cimetrix product licensing. It is a tool tray application that runs continuously in the background and is accessible through a Windows Notification Area (tool tray) icon. Selecting the Cimetrix icon in the Notification Area opens a window displaying all product license codes and status. For additional information and usage, please review the "License Control Panel User Guide.pdf" installed with the Cimetrix products using the new license management.
o Newer product installers select the License File by name, rather than selecting a License File directory location. This permits License Files to have any file name desired instead of having to be named 'license' exactly. This was changed so that it is easier to manage and install Cimetrix License Files.
o The file extension '.clic' is used to better distinguish Cimetrix License Files. The extension is not required, but can be helpful when emailing and locating Cimetrix License Files on your system. License Files will be generated as license.<MACAddress>.clic instead of license.<MACAddress>.
o Note: Prior Cimetrix products still require a file named "license". The .clic file can be used with prior Cimetrix products, but a copy will need to be saved with the name "license" when running the prior product installer.
- Are my old licenses still valid for prior product releases?
o Your old Runtime and SDK licenses provided by Cimetrix are still valid for prior product releases. Each License File is uniquely issued to a specific computer and validated based on a computer's network adapter MAC address. As long as your old License File MAC address (a.k.a. Security ID) matches that of the target computer's MAC address, your licenses are still valid and can be used for installation and running existing Cimetrix products.
- Are my old licenses still valid for new product releases?
o Generally, your old licenses are still valid for new product releases, unless otherwise specified in the product release notes. If the use of a product release version requires a new License File, then a new License File can be generated by using the Cimetrix License Generator to transfer the license from and to the same MAC address of the computer.
- How do I know I need a new license?
o You will need a new License File in instances where the installer indicates your license is invalid at the time of installation, or at any time that the License Control Panel indicates your license is “Invalid”, “Expired” or “Locked”. This could happen if you have a demo license where the time has expired or you have a normal license where there is a MAC address mismatch.
o A MAC address mismatch may happen if:
- The License File generated when you installed the previous Cimetrix products did not include the MAC address. This can be corrected if you have the original License File emailed to you by Cimetrix. If you no longer have the original file, you will need to get a new one. There is no additional cost for this. See the "How do I get a new License File" section below.
- If the products were installed on the wrong computer. In this case you will need to transfer the license to the new computer or obtain a new License File.
- What does "Active" status mean on the License Control Panel?
o The product has a valid license, and the product is allowed to run. The license may be a “Timed License” type which is within the allowed period.
- What does "Expired" status mean on the License Control Panel?
o The product has a Timed License File type, but the current date and time is outside of the period defined by the license. The product is not allowed to run.
- What does "Invalid" status mean on the License Control Panel?
o The product has an invalid license, but the product is allowed to run during a grace period. After the grace period expiration, the license status will become locked.
- What does "Locked" status mean on the License Control Panel?
o The product has an invalid license, the grace period has expired, and the product is not allowed to run.
- What does License Type "Deprecated" mean on the License Control Panel?
o Previous versions of Cimetrix products and licensing have used different formats that are being phased out from distribution. Products with these licenses will continue to run normally without issue. No immediate action is required. The Deprecated type will be resolved when you upgrade those products to a version that uses the new License Management. At that time the License File must be regenerated by transferring the license from and to the same MAC address.
- How do I get a new License File?
o In most cases, you can obtain a new license using the Cimetrix License Generator web site at https://licenses.cimetrix.com. Simply log in and issue or transfer your license using the license COA # (Certificate of Authenticity) and computer MAC address. If any issues are encountered using the web site, contact licenses@cimetrix.com for assistance.
o If you have a Timed License File that has expired, you will need to contact your Cimetrix sales representative to purchase a permanent license or to be issued a new Timed License File.
- How do I apply my new License File?
o Installing Products that use the new License Management: Normally, licenses are updated during the installation process. The process of applying a new License File has been simplified. License Files no longer are required to have the file name 'license' at install time. Simply place the file in a location accessible to the target installation computer. (The installer defaults to the root directory C:\ for simplicity.) When the installer prompts for the License File, navigate to that location and select the file directly. By default the installer filters the selection dialog by the file extension '.clic'. If your License File does not have the '.clic' extension that is ok, simply change the dialog's filter dropdown to 'All files (*.*)' and then select your License File. Proceed and complete the installation. Your License File and product will be installed properly.
o Installing Products that use the old License Management: If the product installer requests a License File folder location, then the file itself must be named "license".
o Updating Products that use either the new or old License Management: For cases where the product is already installed but the License File needs to be updated, you can use the License Control Panel to apply your new license. Open the License Control Panel from the Windows Notification Area (tool tray). Click the 'Update licenses...' button. When the file selection dialog displays, navigate to the location where the new License File is stored and select the file directly. By default the dialog filters by the file extension '.clic'. If your License File does not have the '.clic' extension that is ok, simply change the dialog's filter dropdown to 'All files(*.*)' and then select your License File. If the new License File is valid it will update the installed license with the information from the license you selected.
o See the License Control Panel User Guide for details on definitions for Invalid, Expired and Locked licenses as well as how to resolve related issues.
- When installing the Cimetrix product, I get the warning message: "Specified License File doesn't contain a product code for [Product Name]; Specified License File has a license code for [Product Name] Runtime, but the MAC address doesn't match any MAC addresses on the computer. Continue the installation?". What do I do?
o The License File you are trying to install with is not valid for the computer you are installing on. For Runtime licenses you can proceed with the installation anyway and the product will function for a short grace period of 30 days. However, you will eventually need to obtain a new valid license by either using the Cimetrix License Generator web site at https://licenses.cimetrix.com or by contacting licenses@cimetrix.com for help.
- When installing a Cimetrix product I get the error message: "Specified License File has a license code for [Product Name], but the MAC address doesn't match any MAC addresses on the computer.". What do I do?
o The License File you are trying to install with is not valid for the computer you are installing on. You will need to transfer the license to make it valid on this computer or obtain a new license by using the Cimetrix License Generator web site at https://licenses.cimetrix.com or by contacting licenses@cimetrix.com for help.
- When installing a Cimetrix product I get the error message: "Specified License File doesn't contain any installation licenses". What do I do?
o The License File you are trying to install does not contain license codes recognized by the License Manager. Please confirm that you identified the correct file. If this problem persists, contact licenses@cimetrix.com for help.
- Which MAC address is the product installer looking for?
o If the license is invalid due to a MAC address mismatch, the License Control Panel will indicate the MAC address of the license and MAC address(es) on the computer that are found, if any. The license manager checks all system MAC addresses as reported by the operating system.
- Where is the grace period shown?
o Open the License Control Panel from the Windows Notification Area (tool tray). On any license with an Invalid status, hover over the Comment text. Alternately, extend the "Comments" column to the right, then use the horizontal scrollbar to reach the rightmost extent of the comment.
- I used License Control Panel to "Update Licenses" but my license status is still Invalid/Expired/Locked. What do I do?
o This indicates that the License File used for update did not itself contain a valid license. Please contact licenses@cimetrix.com for help.
- How do I upgrade a single product if I have multiple Cimetrix products installed?
o You can use the original License File emailed to you by Cimetrix or obtained from the Cimetrix online license manager to perform the upgrade. If you do not have the original License File you can re-issue the license by following the instructions under “How do I get a new License File?”
o Once you have a new License File or have located the original License File, please follow the instructions in the product Release Notes in the section 'Upgrade an Existing Installation' for completing the installation of your upgrade.