System Administration and Installation Guide for

Transcription

1 System Administration and Installation Guide for Windows 2003/XP Professional Key: msv-t-badger Edition 3.0: April 2008

2

3 Table of Contents Introduction to the MAXitServer... 1 How the MAXitServer Works... 1 The Sentinel key...2 The MAXitServer CD-ROM Key... 3, cover Named User and Book Number... 3 The Book Number... 3 Materials Supplied...3 Hardware Requirements...4 Software Requirements... 4 Microsoft Winsock Libraries... 4 How to Install the MAXitServer... 5 The Custom Dictionaries... 5 The SMART Lexicon Manager... 5 The Dictionary Service Pack... 5 Quick Reference Installation Steps... 6 How to Start the MAXitServer... 7 How to Stop the MAXitServer...7 Start Windows Service 2003/XP Professional... 8 How to Use the Event Viewer... 9 Save and Send the MaxitLog to SMART... 9 The Windows 2003/XP Event Log Table 1: MAXitServer Error Messages The Registry Entries for the MAXitServer MAXitServer Windows Directory Dictionary Maintenance Procedures Windows Task Manager The Temporary Dictionary - Log File How to Release the Temporary Dictionary File from the Arbortext Editor How to Update the TagFile How to Release the Temporary Dictionary File The MAXitClient Test Tool (Windows) Description of the MAXitClient Panel MAXitClient Registry Entries Test the MAXitServer Dictionaries and Networks Test the Word Finder Tool Test the Network for a Server Name Test Emulation for MAXitServer How to Remove the MAXitServer How to Contact SMART... 28

4 Tools for Globalization Technical skill is the mastery of complexity, creativity is the mastery of simplicity. Sir Erik Christoper Zeeman - Catastrophe Theory.

5 Installation and Administration Guide 1 Introduction to the MAXitServer The MAXitServer is the server version of the MAXit Checker, a tool that helps technical writers and authors to write clear, concise English. The MAXitServer version allows 1 to 25 writers share the same dictionaries and grammar rules from different locations. There is no graphical user interface and all access is from either Arbortext Editor, XMetaL or UltraXML. The MAXitServer runs as a Microsoft Windows Service on Windows 2003/XP Professional. See the Services function, shown below. How the MAXitServer Works The MAXitServer runs continuously in the background and uses the Windows Socket (Winsock) technology to communicate with multiple users at the same time. The MAXitServer waits for text blocks from either the Arbortext Editor, JustSystems XMetaL or WebX Systems Ltd., UltraXML. The text blocks can be text, HTML or XML. When the MAXitServer receives blocks of text, they are checked against 9,500 grammar rules and the custom dictionaries. A list of the errors and suggestions is returned to the MAXit Client in the application to show the writer how to correct the English. The MAXitServer checks texts written in both ASD-STE100 Simplified Technical English and SMART Controlled English. One MAXitServer license is needed for 1 to 25 MAXit Clients.

6 2 MAXitServer for Windows 2003/XP/Vista The Sentinel Key (optional) The MAXitServer requires a hardware key on some installations. The purpose of the key is to protect the customer s intellectual property rights and investment in the valuable dictionaries. One Sentinel key is supplied with the MAXitServer software and must be installed during installation and operation. This key needs the Sentinal drivers that are supplied in the CD-ROM or can be downloaded from the This key uses power from the USB port. A small green light illuminates when the key is active. If you do not see the green light, use another USB port or contact support@smartny.com. The Sentinel key is programmed at SMART Communications, Inc., New York, based on your software order. The same key can be used for additional licenses. Not all systems require this key. Where to Put the Sentinel Key Most servers have an extra USB port available to install the Sentinel key. If there are no ports available, contact support@smartny.com to learn how to use a USB hub to expand the number of existing ports. Policy to Replace Lost or Broken Sentinel Keys SMART Communications, Inc., will replace all defective Sentinel keys at no cost. These keys are high-quality and never break. SMART Communications, Inc., will replace a lost Sentinel key for a fee of US$100. KEEP ALL KEYS ON A SERVER OR A SECURE LOCATION.

7 Installation and Administration Guide 3 Smart Communications, Inc., supplies the MAXitServer software on one CD-ROM. The key to the CD-ROM is shown on the cover of this section. During installation, enter this key exactly. The Named-User MAXit Clients Each MAXit Client is assigned to a named-user that is identified in the MAXit Writer s Guide. All copies of the MAXit Client connect to the MAXitServer. The Book Number The book number allows the writer to receive on-line advice about how to write ASD-STE100 Simplified Technical English or SMART Controlled English. Refer to the book number when you contact SMART at support@smartny.com. Materials Supplied 1. The CD-ROM with the software. 2. The key to the CD-ROM, printed on the cover page in red. 3. A Writer s Guide with book number for each named-user. 4. Documentation for the MAXitServer and the MAXit Client. 5. One Sentinel Key per MAXitServer license. (Optional) NOTE: Install the SMART Lexicon Manager (if licensed) before you install the MAXitServer. The SMART Lexicon Manager loads the custom dictionaries into the folder...\maxit\sm_maxit (these dictionaries can be on a network directory or in another folder).

8 4 MAXitServer for Windows 2003/XP/Vista Hardware Requirements The MAXitServer needs a minimum of 2 Gb of memory. Because the dictionaries have different sizes, allow 200 megabytes of free disk space for the MAXitServer program and dictionaries. A minimum server has 2.4 Ghz Pentium processor or AMD equivalent. When your server has more memory and a faster processor, the MAXitServer runs faster and better. All power for the Sentinel Key comes from the USB Port (see page 2). There are no power adapters. The Sentinel software drivers are needed. Software Requirements The MAXitServer is written in efficient Microsoft Visual C/C++ to run under all versions of the Microsoft Windows Operating System. The program requires Microsoft Windows 2003/XP Professional with Service Pack 2.0. Microsoft WinSock Libraries The MAXitServer uses the Microsoft Windows socket libraries that allow the MAXitServer to talk to the clients through the standard TCP/IP protocol. When the MAXitServer service starts, the program looks for the wsock32.dll library. If this file is not found or missing, the MAXit- Server can not start. Contact support@smartny.com for information about how to install this library.

9 Installation and Administration Guide 5 How to Install the MAXitServer There are three files needed to install the MAXitServer as a Windows service. The files on the CD-ROM have these names: Maxitserver.exe The main MAXitServer program. RemMaxitServer.exe The Removal script for Maxitserver.exe MaxitClient.exe A test client - to test the installation. There are four steps to install the MAXitServer, as shown on the next page. The Custom Dictionaries The installer program controls the installation of the.cmp dictionaries. This step is automatic and the files are pre-loaded by SMART. The SMART Lexicon Manager The optional SMART Lexicon Manager program updates the.cmp dictionaries from the Lexicon Manager folder. The SMART Lexicon Manager is installed separately and is not part of the MAXitServer program. Dictionary Service Pack When SMART supplies the.cmp files from a Dictionary Service Pack, these files are copied into the...\\program Files\Maxit\sm_maxit directory. You must stop and restart the MAXitServer to load the dictionary changes.

10 6 MAXitServer for Windows 2003/XP/Vista Quick Reference - Installation Steps Click setupex.exe inside MaxitServer Step 1 Step 2 Use the Browse button to set the MAXit folder for the support files and dictionaries. The preset directory setting is C:\Program Files\Maxit. Automatic IP Address and Host Name Detection Step 3 Allow automatic IP Address detection of your server or use the command ipconfig /all. Install the Sentinel key and Start the MAXitServer Service Step 4 (-e-) Optional

11 Installation and Administration Guide 7 How to Start the MAXitServer You must have Systems Administrator permission to stop and start the MAXitServer. The MAXitServer is controlled by the Service Control Manager (SCM). Step 1: Find the Services Icon, as shown to the left. Look in Settings->Control Panel. You can move this icon onto your desktop. Use this icon to stop/start MAXitServer Step 2: Click the Start button, as shown on page 8. Wait for confirmation that the MaxitServer has started. This process runs continuously in the background. The Services panel will display the word started. Step 3: Use the Event Viewer tool to check the Event Log. See pages Click the Event Viewer icon and look for the Applications Log, then look for MaxitLog. The messages are shown in the table on page 11. In normal use, the MAXitServer is not stopped, except to load an updated dictionary, Preferences.txt file and metric conversion table. You must stop the MAXitServer to refresh the dictionaries. How to Stop the MAXitServer Step 1: Click the Services icon and select MaxitServer. Step 2: Click the Stop button. When the MAXitServer is stopped, you can make adjustments to the dictionaries. To Restart after Dictionary Maintenance Step 3: Click the Start button.the MAXitServer is restarted.

12 8 MAXitServer for Windows 2003/XP/Vista Start Windows Service 2003/XP Professional MaxitServer Status: Started (shown above) You must use the Windows Services function to start the MAXit- Server. Because the preset Startup type is set to manual, the MAXitServer must be restarted by the user.

13 Installation and Administration Guide 9 How to Use the Event Viewer Step 1: Find the Event Viewer icon, as shown above in the Settings->Control Panel. Step 2: Click on the Event Viewer icon. Step 3: Click on Log The MAXitServer is a Windows Service that does not have a Graphical User Interface (GUI). The MAXitServer writes messages to the Event Log. Follow these steps to see the Event Log. Step 4: Click on the MaxitLog entry. See page 10. The 37 MaxitLog messages are described on pages 11 to 13. These messages show the progress of the MAXitServer or a problem when the MAXitServer starts or stops. Save and Send the MaxitLog to SMART The best method to resolve problems is to save a copy of the MaxitLog into a file called MaxitLog.txt. Send that file with a description of the problem to support@smartny.com. Always give the MAX-xx number so that the SMART technicians know where to find or duplicate the problem.

14 10 MAXitServer for Windows 2003/XP/Vista The Windows 2003/XP Event Log The RED messages indicate errors. The BLUE messages indicate warnings and information. Select Application Log and view the MaxitLog (Do not select the Security or System log to read the MaxitLog.) For accurate technical support, you can save an Event Log and send the file to The table on pages 11 to 13 describes the MAXitServer error messages found in the MaxitLog.

15 Installation and Administration Guide 11 Table 1: MAXitServer Error Messages Message Text of Message Meaning or Correction MAX-1 MAX-2 MAX-3 MAX-4 MAX-5 MAX-6 MAX-7 MAX-8 MAX-9 MAX-10 MAX-11 The Service Control Manager did not start MAXitServer. Check the Installation. The Service Control Manager started MAXitServer correctly. The Server Socket for MAXit- Server terminated. The Client Socket for MAXitServer did not shut down correctly. The Client Socket for MAXitServer did not close correctly. The metric.txt file for MAXitServer is missing or damaged. A line in metric.txt is missing a comma. The registry keys for MAXitServer are missing. A registry key for MAXitServer is wrong. A registry key for MAXitServer is wrong. MAXitServer needs two or more dictionaries. Check entries in the registry, HKLM\Software\Smart Communications and the registry for the Event Log. NORMAL Restart the MAXitServer service. Contact SMART Contact SMART Contact SMART Check the registry entry DictPath. Make sure metric.txt is in Maxit\sm_maxit. Each line in metric.txt has five commas. Check all new entries. Add the comma. See the Registry Section. Check entries in HKLM\Software\Smart Communications Check the registry entry for Dictionaries. Check spelling. Look for missing commas. Check the registry entry for DictPath. This entry points to the MAXit directory. Check the registry key for Dictionaries. See MAX-9. Two or more are required.

16 12 MAXitServer for Windows 2003/XP/Vista MAX-12 Dictionary problem at Dictionary1. See MAX-11 and MAX-9. Check entries. MAX-13 MAX-14 MAXitServer did not start. Check the dictionary number. MAXitServer can not allocate memory. See MAX-9. Count the dictionaries. Reload from backup or CD-ROM. The server needs a minimum of 512Mb of memory. Contact SMART. MAX-15 MAX-16 MAXitServer can not find WinSock See Microsoft WinSock libraries The Server Socket did not create() Contact SMART MAX-17 The Server Socket did not clear() Contact SMART MAX-18 The Server Socket did not bind() Contact SMART MAX-19 The Server Socket did not listen() Contact SMART MAX-20 MAX-21 The Server Socket did not accept() The main thread for MAXitServer Service Socket failed. Contact SMART Contact SMART MAX-22 All dictionaries loaded correctly. NORMAL MAX-23 MAX-24 MAX-25 MAX-26 A registry key for MAXitServer is wrong, Msv_port. A registry key for MAXitServer is wrong, Msv_IpAddress. The System Administrator stopped MAXitServer. The System Administrator restarted MAXitServer. Check registry entry for Msv_Port. Must have a number from 945 to Check registry entry for Msv_IpAddress. See your System Administrator. Information message only. NORMAL Information message only. NORMAL

17 Installation and Administration Guide 13 MAX-27 The System Administrator paused MAXitServer. Information message only. NORMAL MAX-28 The MAXitServer was stopped. Information message to confirm that all sockets, memory and other resources were released. NORMAL MAX-29 The MAXitServer was stopped. There is a problem with memory The heap memory did not release. resources. Contact SMART MAX-30 MAX-31 MAX-32 MAX-33 MAX-34 Shows the name of the NOT FOUND WORD log file. Shows that the MAXitServer can not create the NOT FOUND WORD log file. Shows that the dictionary file loaded correctly into memory. Shows that the file (name) did not load into memory. Lost file. Shows that the file (name) has the wrong permissions or is not owned by System Administrator. This file will trim automatically at 444,444 bytes or 5000 records. Sets a flag to prevent a write into a blank file. No words are written to the log file. Check file permissions. NORMAL Reload from a backup copy or the original CD-ROM. Check File permissions. Reset to System Administrator READ/WRITE and FULL ownership. MAX-35 Shows that the file (name) is missing from Maxit\sm_maxit Reload from a backup or the CD-ROM. directory. MAX-36 MAX-37 Shows that the file (name) failed internally at FileMapping stage. Shows that the file (name) failed internally at FileMapView stage. Contact SMART Contact SMART

18 14 MAXitServer for Windows 2003/XP/Vista Registry Entries for the MAXitServer The MAXitServer uses the Windows Registry to hold information. The main key is HKEY_LOCAL_MACHINE\Software\Smart Communications. This key is called the main key. There are secondary keys for MAXit for Arbortext, MAXit for UltraXML and MAXit for XMetaL. Use Regedit.exe to make any changes. Description of the registry keys and keys you can change: You can change the values of these keys: Msv_IPaddress to set for another server. (Move the security key.) You must change the client registry entry Lic_IPaddress. Msv_Port to use another port. You must change the client registry entry Lic_Port. Msv_Timer -Increase for a slower server. Decrease for a fast server. Note: Change these keys carefully and follow any instructions from support@smartny.com. If you make a mistake, reinstall the MAXit- Server to restore the keys.

19 Installation and Administration Guide 15 The MAXitServer program is in the C:\Windows\System32 folder. The dictionaries are installed in the folder C:\Program Files\Maxit. The disk drive can have any letter. MAXitServer Windows Directory Directory File Name Description of Program C:\Windows\ System32 C:\Program Files\ Maxit C:\Program Files\ Maxit maxitserver.exe MaxitClient.exe RemMaxit- Server.exe The MAXitServer program. Binary format. See How to get the version number. This program is the main program for MAXitServer. Use this tool to send a test message to the MAXitServer. This program is a test tool. You can send a message to the MAXitServer to check for responses. Click this program to REMOVE the MAXitServer service entry. Remove this directory to remove all the MAXitServer files from the server. C:\Program Files\ Maxit\sm_maxit (There can be more than one xxxtech.) xxxcore.cmp xxxtech.cmp xxxsyn.cmp Compressed, read-only format of Basic Dictionary Compressed, read-only format of Technical Compressed, read-only format of Synonyms C:\Program Files Maxit\TagFile.txt C:\Program Files\ Maxit\sm_maxit\ metric.txt C:\Program Files\ Maxit\sm_maxit NF_MAXITLOG (date).txt TagFile.txt metric.txt NF_MAXITLOG txt A set of linguistic tags that give style hints to the MAXit Grammar engine for sentence boundaries. The metric conversion table. You can use Notepad to edit the values or add new entries. Get instructions from support@smartny.com. A log file of all NOT FOUND WORDS. Trims automatically at 5000 records. The suffix has the date in US format. The Systems Administrator must remove log files that are more than three months old.

20 16 MAXitServer for Windows 2003/XP/Vista Dictionary Maintenance Procedures You must stop and start the MAXitServer through the Services panel each time you update the dictionaries or the file TagFile.txt. See page 7 to Stop or Start the MAXitServer service. When the MAXitServer service is stopped, the user gets the message shown below. Step 1: The System Administrator must stop the MAXitServer. Step 2: Move the.cmp file from either the SMART Lexicon Manager directory or the SMART Dictionary Service Pack directory. Step 3: The System Administrator must restart the MAXitServer. See page 7 for the procedure. Every three months, remove the oldest NF_MAXITLOG files from the folder,...\maxit\sm_maxit. See the SMART Lexicon Manager section for more information about how to update the dictionaries. If you use the SMART Dictionary Service Pack option, copy the.cmp files received from SMART into the..\maxit\sm_maxit folder. You must stop and restart the MAXitServer so that the new dictionaries are loaded.

21 Installation and Administration Guide 17 The Windows Task Manager Click Control->Alt->Delete to activate the Windows Task Manager. The MAXitServer.exe must appear under the Processes tab, as shown above. If you do not see the Maxitserver.exe entry, as shown above, go to page 7 and start the MAXitServer service.

22 18 MAXitServer for Windows 2003/XP/Vista The Temporary Dictionary - Log File (Not available for UltraXML) The MAXitServer receives requests from the MAXit Edit Box to add new terms to the Temporary Dictionary. These requests are recorded in a log file that has a date and a prefix of NF_MAXITLOG. When the log file reaches 444,444 bytes, the log file is closed and a new log file is created with a new date. These log files are in a folder...\\maxit\sm_maxit. For example, NF_MAXITLOG txt was created on February 14, The file suffix is in US date format of mm.dd.yyyy. How to Release the Temporary Dictionary File from the Arbortext Editor or XMetaL. Step 1: From the MAXit Administration Box, click the button marked Release Temporary Dict. Enter the password which is the last word of the key shown on the title page in this section. Step 2: Print the NF_MAXITLOG file.

23 Installation and Administration Guide 19 How to Update the TagFile How to Release the Temporary Dictionary To release the Temporary Dictionary, click the Release Temporary Dict. button, above. Enter the password which is the last word of the serial number printed in the Writer s Guide. See previous page. Print the NF_MAXITLOG file and add new terms to the dictionaries. ALWAYS remove old NF_MAXITLOG files after you print.

24 20 MAXitServer for Windows 2003/XP/Vista The MAXitClient Test Tool (Windows) Use the MaxitClient.exe program found in C:\Program Files\MAXit to test the MAXitServer connections. Click this icon to start this test program. Description of the MAXitClient Panel XMetal, Arbortext, No Licence Select either XMetaL, Arbortext Editor or No License. Each client has the same functions, but has a different set of connections. Use No License for UltraXML test. Test MAXitServer Enter the text in the top box and click the Test MAXitServer button. The reply is shown in the bottom and top window. Word Finder Clear Msg Cancel Click the Word Finder button. Enter a common term and click the Search button to find the word in the MAXit dictionaries. Example: locknut. The the dialog box shows the name of the dictionary where the word was found. Click this button to clear both the Input (top) and Output (bottom) windows. Click to close the MAXitClient and exit the program. Information Functions These buttons do not require input, but talk to the MAXitServer. Registry Information. Click this button to see the registry settings on the client computer. Show Version Click this button to see a list of the MAXitServer dictionaries and versions. The dictionaries are searched in the order shown. Input Window (top panel) You can enter 500 characters in this window to test MAXitServer. Output Window (bottom panel) This window shows the reply from the MAXitServer.

25 Installation and Administration Guide 21 Center Panel shows from left to right the IP Address, Named-User key and the Port Number. Use for local test and laptop. Test 1: Automatic Network test with normal results shown here. In this example select 1, Test Server - No License, then select 2, Test MAXitServer. Look for the reply shown. The normal results are shown above. You must see two sets of the numbers in the Results window, as shown above. These numbers are generated from the MAXitServer, not the MAXitClient test tool. Use Test Server - There is no license button to test UltraXML.

26 22 MAXitServer for Windows 2003/XP/Vista MAXitClient Registry Entries Test 2: MAXitClient registry entries (Test each PC.) Click Registry Information to see the results shown above. Move the MaxitClient.exe program to all PCs to check the settings. Look in the registry at HKEY_LOCAL_MACHINE/Software/ Smart Communications for Server settings like IP_Address and Port_no. (Node locked or laptop must use ).

27 Installation and Administration Guide 23 Test the MAXitServer Dictionaries and Network Test 3: Select Show Version & Dictionaries. See the names of the dictionaries in the bottom panel. The MAXitServer version is shown. If you see a date of less than 2007 and have a maintenance contract, contact support@smartny.com for an update. Make sure the latest dictionaries are loaded by their latest date and search order of tech, core and syn.

28 24 MAXitServer for Windows 2003/XP/Vista Test the Word Finder Tool Test 4: Test the function of the Word Finder tool. Select a common word that you know is in your technical dictionary. Select Word Finder. Click Search and see the results as shown below. This test checks the dictionaries on the MAXitServer. See the previous page for the dictionary search order ( tech, core and syn ). Do not change the order of core and syn.

29 Installation and Administration Guide 25 Test the Network for a Server Name Test 5: Test the Network connection for an IP Address. See Test 2 on page 22 for the IP Address. You can get the IP Address for your server from the Control Panel. Click Start->Control Panel->Network Connections. Click the Local Area Connection, then the Support tab, as shown below. Enter the IP Address shown in the panel into the registry entry called Msv_IPaddress. Do not enter the address shown above because your IP Address is different. NOTE: The network is set for the common TCP/IP protocol. If you need another communications protocol, contact support@smartny.com.

30 26 MAXitServer for Windows 2003/XP/Vista Test Emulation for MAXitServer Test 6: Enter 80 to 500 characters and select either Epic 4.x (includes 5.1) or XMetaL button. Click the Test MAXitServer button and look for the results. There must be a series of numbers and words. Make sure that you see all the errors in the test text as shown below. UltraXML uses the Test Server - No license.

31 Installation and Administration Guide 27 How to Remove the MAXitServer Follow these steps to remove or transfer the MAXitServer. Step 1: Log on as the System Administrator with read and write permissions. Step 2: Click the Services icon and stop the MAXitServer. Step 3: Look in the installation directory C:\Program Files\MAXit for the RemMaxitServer.exe program. Step 4: Click the RemMaxitServer.exe. This program removes the Windows Service entry for the MAXitServer. Step 5: Remove C:\Windows\System32\MaxitServer.exe Step 6: Move to C:\Program Files. Step 7: Remove the MAXit directory. Step 8: Use the C:\Windows\Regedit program to delete these keys from the registry. Use the C:\Windows\regedit.exe program to remove these keys. HKEY_LOCAL_MACHINE\Software\Smart Communcations\MaxitServer HKEY_LOCAL_MACHINE\System\ControlSet001\Services\MaxitServer Step 9: Remove the directory..\maxit. Include all sub-folders.

32 28 MAXitServer for Windows 2003/XP/Vista The MAXit Team listens to our valued users. your ideas, comments or suggestions to us at If possible, we try to add customer suggestions to the next release. Thank you... The MAXit Team