Edit Menu
The functions in the Edit menu permit you to modify the tokens file by adding and deleting tokens and adding and deleting classes.
Also, you can change various properties of the Licence Manager. Changing these properties modifies the behaviour of the Licence Manager server process.
Tip: You can access these functions through the shortcut menu when you right-click a tokens file.
Properties
You use this function to view, and if necessary, change various properties of the Licence Manager. When you change these properties, you modify the behaviour of the Licence Manager server process.
All properties for the Licence Manager are saved to the configuration file share\etc\ssilm.cnf. When you select this function, the Edit Configuration form appears showing the properties currently saved in the configuration file. If you change a property and click OK, the changed properties are saved to the same file.
After you save the properties to the configuration file, the licence server process receives a reconfigure signal. After receiving the signal, the licence server process reads the configuration file and then operates with the new parameters.
You cannot change all properties in this way because active licences restrict the ability to change some of the characteristics of the licence.
After you change the values on the form, click OK to reconfigure the licence server.
Fields on the Edit Configuration form
| Field | Description |
|---|---|
| Log File Pathname | The name of the file to which all reports are sent. When you request a report, the report details are sent to this file first and the contents of the file are then displayed. By default, the log file is always called share\etc\ssilm.log.
|
| Standby Timeout |
The number of seconds that a licence held by a client can be idle before the licence state changes to standby. When a licence state becomes standby and if there are no other available licences, other clients can take the licence. This property prevents a user who forgets to exit a program from holding a licence forever.
If you leave the value at 0, Licence Manager treats it as an infinite period (that is, the licence never becomes a standby licence). The recommended value is 600 seconds (which is 10 minutes). |
| Function Logging |
|
| Heartbeat | Each client process session (for example, Surpac or Minex) that uses the licence manager for authorisation sends a heartbeat message to the licence server at regular intervals. These heartbeat messages indicate to the licence server that the licence is active. If the license server computer stops receiving these heartbeat messages, it is assumed the client has failed or stopped responding. The licence is then released for reuse. These heartbeat messages are sent even when the client is busy processing data. The heartbeat interval is the time delay between these regular messages sent by the client computer to the server computer. Ideally, the heartbeat is between 10 and 300 seconds. Greater values reduce network traffic. However, if a client computer fails, the licence is still held for a longer time. Lower values increase network traffic, and allows the server computer to detect client computer failures faster. The recommended value is 30 seconds. |
| Max Log file size | The maximum file size for the log file. The log file that is generated can become large quickly, especially with Function Logging enabled. However, it is unlikely that you need more than the last few messages to troubleshoot any problems that you experience, so a very large file is not required. This option gives you the ability to limit the size of the log file. The default size is 100 KB. When the log file reaches the maximum file size limit, it backs up the current log to ssilm.bak, and starts a brand new log file. In this way, it is easy to see the last several hundred messages, without using large amounts of disk space. Be aware, however, that because the old log is backed up, the disk space you use may be up to double the size you specify in this box. Any previous logs called ssilm.bak are erased. |
| Maximum Unacknowledged Packets | The maximum number of heartbeat messages a client allows to be unacknowledged before it assumes that it has lost its licence. Licence Manager uses a client/server protocol that is layered on top of UDP/IP (a protocol that is inherently not completely reliable). As a result, it is normal to lose some heartbeat messages. The "heartbeat interval" multiplied by "maximum unacknowledged heartbeats" must be less than 300 seconds. The recommended value for this property is 3. This value gives the best mix of "usual events" security, while still allowing the server to respond to a failed client in a timely fashion. |
| Enable Reverse DNS lookup | The reverse DNS lookup is a useful feature, but it can cause problems on some incorrectly configured networks. This option allows you to turn off the feature to see if that is the cause of the problem. If you are having no problems with Licence Manager, leave this option enabled. For more information on this feature, see What is a Reverse DNS lookup? in the Frequently Asked Questions. |
| UDP Port | The Universal Datagram Packet (UDP) port number that you want to use for two-way communication between the client and server processes. It is recommended that you use the default value of 1234, unless using the default value causes a conflict with another program that uses the same port number. If you change the UDP port number, you must restart the Licence Manager service for the change to take effect. For more information, see UDP ports in the glossary. |
| Server to Administer | If Server to Administer is blank, and you run a function from the Report menu, the report shows information for all instances of Licence Manager that are currently running on your subnet of the local network. If you specify the server in this box, the report shows information for the specified licence server only. Server to Administer is useful because it enables you to run reports across virtual private networks (VPN) and across wide area networks (WAN). It is also useful when several Licence Manager server computers are running on the same network, or the network configuration is blocking the message. The format of the server definition is <server name or IP address>[:<port number>]. Some examples are: |
New Token
You use this function to add or update licence tokens to the tokens file. You add or update the licence tokens when you:
- install a new version of a GEOVIA program
- purchase more program modules
- purchase more program licences
When you run this function, you enter tokens into the tokens file. The token is a hexadecimal number that consists of the numbers 0 to 9 inclusive and the letters a to f inclusive. You can obtain valid tokens only from an authorized GEOVIA support office.
When you enter a new token, the token is added to the currently selected class. When you enter a token that is a modification to an existing token, the existing token is updated to the new modules and values.
After you enter a new token, save the changes to the tokens file using File > Save. The licence server then reloads the tokens file so that the new tokens are immediately available for use.
New Class
You use this function to create licence classes and assign tokens to the licence classes that are created. Licence classes are useful for sites to have more control over the usage of GEOVIA products.
When you create a class, you define the host, GEOVIA product version, and the name of the licence class.
After you create a class, save the changes to the tokens file using File > Save. The licence server then reloads the tokens file so that the class you created is available.
Fields on the Create/Delete Class form
| Field | Description |
|---|---|
| Host | |
| Sentinel ID |
The number of the dongle (or sentinel) connected to the computer on which the licence service is running. This value MUST not be changed. Administrators who are experienced with maintaining Licence Manager servers might find this field useful because they can enter the dongle number of a dongle other than the one connected to the licence server computer. When you enter the dongle number of another dongle, you can enter the details of classes and tokens for a second licence server into the one tokens file. You can then use the tokens file on both Licence Manager servers that are running on different computers. |
| Licence Manager | Ensure that you leave this check box selected. For Licence Manager to function correctly, this check box must be selected. |
| License | |
| Class |
The name of the class that you are creating or deleting. The default value is default. When you create a class, you can set this value to any name you want. However, it is conventional to choose licence class names that match department usage of the program. For example, geology, survey, engineering are common names.
If you require assistance in creating multiple licence classes, contact GEOVIA. |
| Release | |
| Product |
The name of the GEOVIA program for which the class is being created or deleted.
|
| Version |
The version number, in the form
|
| Release type |
The release type for the licence class.
|
Delete Token
You use this function to delete a token from the tokens file. When you run this function, you select the token to remove from the tokens file, and then click OK.
After you delete a token, save the changes to the tokens file using File > Save. The licence server then reloads the tokens file so that the tokens you deleted are no longer available.
Tip: You can run this function from the shortcut menu, by right-clicking the token and choosing Delete Token. When you run this function from the shortcut menu, the Token form does not appear because the function is run directly from the token.
Delete Class
You use this function to delete a class from the view. All tokens in the deleted class are still available from the default class.
When you run this function from the menu, you enter the details of the class to be deleted from the tokens file. To be able to delete a class, you must specify the host, GEOVIA product version, and the name of the licence class. For information on the fields available on the Create/Delete Class form, see the table above under the New Class function.
Tip: You can run this function from the shortcut menu, by right-clicking the class and choosing Delete Class. When you run this function from the shortcut menu, the Create/Delete Class form does not appear because the function is run directly from the class.
After you delete a class, save the changes to the tokens file using File > Save. The licence server then reloads the tokens file so that the class you deleted is no longer available.
Change Token Class
You use this function to move a token from an existing class to another class.
For example, you have two classes, default and geology. The default class has three tokens allocated to it, and the geology class has one token allocated to it. On the site, there is usually one geologist who uses the licence. Occasionally, a second geologist works on the site for a short time. During the time when two geologists are on the site, you can select a token from the default class that you want to allocate to the geology class. As a result, the geology class will have two tokens available.
Note: A token can exist in one class only.
After you change a token class, save the changes to the tokens file using File > Save. The licence server then reloads the tokens file so that the token class exists in the class you specified.
Tip: You can run this function from the shortcut menu, by right-clicking the token and choosing Change Token Class. When you run this function from the shortcut menu, the Token form does not appear because the function is run directly from the token. You only have to type the name of the class to which you want to move the token.