EventLog Monitor Tool Setup

Transcription

1 EventLog Monitor Tool Setup 1 EventLog Monitor Tool Setup Introduction The EventLog Monitor Tool is an optional OpenLM component that may be installed and configured to integrate OpenText and EPLAN software license monitoring. Its two main purposes are to convert OpenText and EPLAN output to usable generic format files and to create snapshots of license server activity. These instructions assume that OpenLM Broker has been installed on the system and is currently configured to function with OpenLM. Please see the dedicated documentation for OpenLM Broker installation if that is not the case: Steps for Installation 1. Obtain the EventLog Manager Tool installation ZIP file (e.g., EventLog_Monitor- YYYYMMDD.zip) and place the file in a convenient location on the server where it is to be installed. Please contact support to obtain the file (support@openlm.com). 2. Extract the files (e.g, right-click the file name in the directory where the ZIP file is stored and choose Extract from the pop-up menu that appears). 3. Locate the config.properties file in the extracted file folder EventLog_Monitor and open the file in a text editor. 4. Edit the settings in the config.properties file as necessary. The complete file layout is visible at the end of this document along with comments. All EPLAN specific settings have eplan. as prefix, and Opentext users can ignore these settings. Settings must match the OpenLM Server and Broker configurations and user environment. The following values are required: server = Hostname or IP (e.g., localhost ). This should match the license server name in the OpenLM Broker Configuration Tool. port = The number to identify the output port. This should match the license server port in the OpenLM Broker Configuration Tool. vendor = The vendor reported to the OpenLM Server (e.g., OpenText or EPLAN). monitored.log = The filename and path used for the log file specified for OpenText or EPLAN configurations. The file name pattern is different for OpenText and EPLAN.

2 EventLog Monitor Tool Setup 2 EPLAN file name: monitored.log=temp/elmlogfile_ _00.00.txt OpenText file name: monitored.log=logs/imglm_00_00_00.log license.info = A full path specifying the location of the LicenseInfo.txt file for OpenText users [NOTE: Only for OpenText clients]. The file format for the LicenseInfo.txt file should be: Product: {CODE} Used Seats: {8} Total Seats: {NUMBER OF SEATS} Example: Product: VME Used Seats: 8 Total Seats: 106 Product: ANZ Used Seats: 8 Total Seats: 10 Product: VME33 Used Seats: 8 Total Seats: sync.interval = The number of seconds to update the data. It is recommended that the number be set to 60 for EPLAN and 10 for OpenText. license.manager = EPLAN or OpenText. eplan.elmmonitor.path =[Full path to ElmMonitor.exe tool of EPLAN license manager] (e.g.: C:\\Program Files\\EPLAN\\ECT\\ElmMonitor.exe ) eplan.delete.elm.files = true [NOTE: Set the option to false for initial setup and testing. Set it to true when the installation is tested and fully functional. Execution creates a new file every 60 seconds period. Setting to false for an extended period could occupy a lot of storage space.] 5. Run the Install Service x## BAT file appropriate to your system by locating the file and double-clicking (e.g., C:\<Path>\EventLog_Monitor\service\x86\Install Service x86.bat ). This will install Event Log Monitor as a Windows service. 6. Install Java. Obtain the appropriate installer from and follow the

3 EventLog Monitor Tool Setup 3 installation instructions. It is also possible to run off an existing Java installation for OpenLM Broker by configuring the Event Log Manager. To configure the system to use the existing installation, take the following steps (A to L), otherwise skip to Step #7 after Java the installation is complete. A. Locate the lmstat.bat file in the extracted files from Step #2 (e.g., <Path>\EventLog_Monitor\service\x86\ ). Right click on the file, choose Rename from the popup menu and rename the file to lmstat.bat.old. B. Open the lmstat.bat.old file with a text editing application (e.g., Notepad). The content will appear as -jar EventLog_Monitor.jar lmstat C. Add the full path to the Java installation at the beginning of the second C:\Program Files (x86)\openlm\openlm Broker\jre\bin\java -jar EventLog_Monitor.jar lmstat D. Save the file as lmstat.bat in the original location and close the file. E. Launch the LogMonitorService.exe located in the extracted files from Step #2 (e.g., <Path>\EventLog_Monitor\service\x86\ ). This will open the OpenLM Event Log Monitoring Properties screen. F. Click the Java tab to display the Java options. G. Uncheck Use Default to enable selection of a path to the Java installation in OpenLM Broker. H.Click the [ ] browse button to the right of the Java Virtual Machine field and locate the OpenLM Broker Java installation (e.g.: C:\Program Files (x86)\openlm\openlm Broker\jre\bin\server\ ). I.Select the JVM DLL file from the folder by clicking on it, and then click [Open] to complete the selection (see Figure 1).

4 EventLog Monitor Tool Setup 4 Figure 1: Using OpenLM Broker Java installation. J.Click [Apply] to accept the changes. K.Check the service is working by clicking on the General tab and clicking [Start] in the Service Status panel at the bottom of the screen. If the setup is correct, the status will change from Stopped to Started (see Figure 2). If the status does not change, review the setup and log files or contact support (support@openlm.com). Log files are located in the path listed under the Logging tab in the OpenLM Event Log Monitor Properties screens.

5 EventLog Monitor Tool Setup 5 Figure 2: Java alternative installation Success. L.Click [OK] to accept the changes and close the OpenLM Event Log Monitoring Properties screen. Skip to Step #8. 7. Be sure the Log Monitor windows service is running. This can be done in several ways. Double-click the LogMonitorService.exe in the files extracted in Step #2 (e.g., C:\<Path>\EventLog_Monitor\service\x86). When the OpenLM Event Log Monitor Properties screen appears, click [Start] button if available (if the service is already running the start button will not be available and the Service Status will appear as Started ). The result should look like Figure 2. Open Task Manager (right-click [Start] and choose Task Manager from the menu that appears). Click the Services tab and locate LogMonitorService. Right-click the service and choose Start from the pop-up menu. Open Windows Services (e.g., type Services in the Windows Search bar and choose the

6 EventLog Monitor Tool Setup 6 Services App). Locate the OpenLM Event Log Monitor service. Right-click on the service name and choose Start from the pop-up menu. 8. Open the OpenLM Broker Configuration Tool by choosing OpenLM > OpenLM Broker Configuration Tool from the Windows Start menu (e.g., default path C:\ProgramData\Microsoft\Windows\Start Menu\Programs\OpenLM\Broker). This will allow setup of OpenLM Broker to work with the Event Log Manager. 9. Choose a license server from the navigation pane at left by clicking the desired license server name (see Figure 3). Figure 3: Selected License Server. 10. Click [ADD] at the upper left of the screen and choose Port from the Add menu. A

7 EventLog Monitor Tool Setup 7 new port will be added to the selected license server and the Add New Port dialog will open suggesting that the Port Number and vendor details be updated appropriately (see Figure 4). Figure 4: Add New Port dialogue. 11. Click [OK] to close the dialogue. The Port Number field, License Manager Type drop list and Advanced link will be displayed in the License Manager Port pane. 12. Select the OpenLM Generic license type from the License Manager Type drop list at the right of the screen and change the Port Number if appropriate. The port should match the port in the config.properties file (Step #4.B.

8 EventLog Monitor Tool Setup 8 Figure 5: Applied changes to the License Manager Port. 13. Click [APPLY] to accept the changes. The Commands tree for the selected license server will expand (see Figure 5). 14. Click data_inquiry under the Command tree node. The right panel of the screen will change to the Command Definition panel. 15. Enter the path for lmstat.bat extracted in Step #2 in the Command Line field. A path may have pre-loaded depending on your selection for License Manager Type [NOTE: the target file used to be unified.xml, but was replaced in V4+ of OpenLM to improve functionality.]. The lmstat.bat file is responsible for initiating event log processing. The entry should contain the full path to the lmstat.bat executable (see Figure 6). Enter the detail in the following format (note that there are spaces after

9 EventLog Monitor Tool Setup 9 cmd and /C ): cmd /C <Path>\EventLog_Monitor\lmstat.bat Figure 6: The lmstat.bat file entry in the Command Line field. 16. Click [Execute] to check that the entry for the Command Line field is correct. A message will display in the Test execution of the data_inquery command line screen. If the process is working a success message will appear (see Figure #7) and the installation should continue with Step #16. If there is a problem, error messages will appear that can be used for resolving the issue or troubleshooting with OpenLM support (support@openlm.com).

10 EventLog Monitor Tool Setup 10 Figure 7: Test Execution success screen. 17. Close the Test execution of the data_inquery command line screen using the [X] in the upper right of the screen. 18. Click [Apply] to store the changes. 19. Click on Vendor Name to be Filled under the Vendors node in the navigation tree at left. This will reveal the Vendor Definition panel at the right of the screen. 20. Type in the vendor name in the Vendor Name field and click [Apply]. The item in the node under vendors in the port definition will change to the name as entered (see Figure 8).

11 EventLog Monitor Tool Setup 11 Figure 8: Applied changes to the Vendor Definition. 21. Click on the Log Files node in the navigation pane. This will reveal the Log File Definition pane to the right of the screen. 22. Click the [Add] button at the upper left of the screen and choose Log File from the menu when it appears. 23. Choose the type from the Type drop list. This list will be filtered depending on your configurations. 24. Enter a name appropriate for identifying the log file definition in the Name field. This is a free text field for identification.

12 EventLog Monitor Tool Setup Click the [ ] browse button to choose a location for the log file. The log file will have to exist; if it does not exist, it needs to be created before browsing for it. 26. Choose the vendor from the Vendor drop list. The options here will be limited to configured possibilities. 27. Click [Apply] to commit the changes. A confirmation will appear stating that the data has been saved successfully (see Figure 9). The Log Files node will be updated to reflect the Name as entered in the Log File Definition. Figure 9: Data saved confirmation. 28. Click [OK] to close the confirmation window. The configuration will be complete (see Figure 10).

13 EventLog Monitor Tool Setup 13 Figure 10: Completed OpenLM Broker Configuration Tool Event Log Monitoring Setup. 29. Click [Restart Broker] to restart the service reflecting the new configuration. 30. Close the OpenLM Broker Configuration Tool by clicking [Exit].

14 EventLog Monitor Tool Setup 14 Example config.properties File with Comments The following is the complete file layout for config.properties. Please note descriptions in Step #4 above. Care should be taken in being sure the settings entered here match those in other areas of your configuration. ######################## # IMPORTANT!!! # Use / as file separator # If you copy-paste a path from Windows like the one below # INVALID: D:\OpenLM\LogMonitor\logs\imglm_01_29_14.log # Make sure to escape backslashes for configuration # VALID: D:\\OpenLM\\LogMonitor\\logs\\imglm_01_29_14.log # VALID: D:/OpenLM/LogMonitor/logs/imglm_01_29_14.log ########################################### # Available log levels # SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST # The FINEST level is a bit slow. It logs XML on each event processed. Use FINEST for troubleshooting # Use INFO by default log.level=fine # File name to log processing information log.file=logs/event_monitor-%g.log # Configuration for log file rotation

15 EventLog Monitor Tool Setup 15 log.file.max.size= log.file.max.count=10 # Unified XML predefined fields # server also used in EPLAN command line server=localhost port=27081 vendor=opentext # ImgLM log file to process and monitor # The log name is used as a pattern. The LogMonitor does lookup of the newest file with the similar name but different # numbers to read from it. Configured via ImgLM.ini #monitored.log=imglm_00_00_00.log for Open Text #monitored.log=temp/elmlogfile_ _00.00.txt for EPLAN monitored.log=logs/imglm_00_00_00.log unified.xml=broker/unified.xml #The value is in seconds. Use 10 for OpenText sync.interval=10 # EPLAN or OpenText license.manager=opentext

16 EventLog Monitor Tool Setup 16 ### lmstat command ### lmstat.binding.host= lmstat.port=27081 ################## # OpenText # ################## # License info file path. OpenText only license.info=logs/licenseinfo.txt # Parsing date formats. OpenText only date.format=mm/dd/yyyy HH:mm:ss ################## # EPLAN # ################## eplan.log.encoding=utf-16le # ElmMonitor.exe is a GUI tool. It produces GUI popup messages in case of errors. # /Silent flag is strongly recommended to avoid ElmMonitor.exe process leak #eplan.elmmonitor.path= C:\\Program Files\\EPLAN\\ECT\\ElmMonitor.exe eplan.elmmonitor.path=d:/program Files/EPLAN/ELM/ElmMonitor.exe

17 EventLog Monitor Tool Setup 17 eplan.elmmonitor.xml=eplan_openlm.xml # Format applied to /From and /To parameters eplan.elmmonitor.datetime.format=dd.mm.yyyy HH:mm:ss eplan.elmmonitor.timeout.seconds=60 eplan.delete.elm.files=true ########### EPLAN log file layout ########### # Format applicable to both single date time and separated date and time columns. # In case of separated columns, values are concatenated before parsing eplan.datetime.format=dd.mm.yy HH:mm:ss #Header size eplan.skip.lines= #Name of the 1st column common for all sections. Processing uses it to skip header lines eplan.skip.keyword=module #Column layout eplan.column.module= eplan.column.issued=1 eplan.column.bundle=2 eplan.column.name=3 eplan.column.id=4 eplan.column.computer=5

18 EventLog Monitor Tool Setup 18 # Use datetime if value is available in a single column #eplan.column.date=3 #eplan.column.time=4 eplan.column.datetime=6 eplan.column.action=7 eplan.column.state=8 eplan.column.inuse=9 eplan.column.free=10 eplan.column.totalchanging=11 eplan.column.expiretime=12 ########### Broker debug log settings ########### # Required to transfer denials. These settings may have eplan. prefix in old config files which is also acceptable broker.debug.log.path=broker/debug-log.log broker.debug.log.size= broker.debug.log.limit=10