Microsoft Dynamics GP Engineering Data Management Integration Administrator s Guide
Copyright Copyright 2007 Microsoft Corporation. All rights reserved. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of Microsoft Corporation. Notwithstanding the foregoing, the licensee of the software with which this document was provided may make a reasonable number of copies of this document solely for internal use. Trademarks Microsoft, Microsoft Dynamics, and Windows are either registered trademarks or trademarks of Microsoft Corporation or its affiliates in the United States and/or other countries. FairCom and c- tree Plus are trademarks of FairCom Corporation and are registered in the United States and other countries. The names of actual companies and products mentioned herein may be trademarks or registered marks - in the United States and/or other countries - of their respective owners. Unless otherwise noted, the example companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted herein are fictitious. No association with any real company, organization, product, domain name, e-mail address, logo, person, place, or event is intended or should be inferred. Intellectual property Microsoft may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. Except as expressly provided in any written license agreement from Microsoft, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property. Warranty disclaimer Microsoft Corporation disclaims any warranty regarding the sample code contained in this documentation, including the warranties of merchantability and fitness for a particular purpose. Limitation of liability The content of this document is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Microsoft Corporation. Microsoft Corporation assumes no responsibility or liability for any errors or inaccuracies that may appear in this manual. Neither Microsoft Corporation nor anyone else who has been involved in the creation, production or delivery of this documentation shall be liable for any indirect, incidental, special, exemplary or consequential damages, including but not limited to any loss of anticipated profit or benefits, resulting from the use of this documentation or sample code. License agreement Use of this product is covered by a license agreement provided with the software product. If you have any questions, please call the Microsoft Dynamics GP Customer Assistance Department at 800-456-0025 (in the U.S. or Canada) or +1-701-281-6500. Publication date April 2007
Contents Introduction...1 What s in this manual...1 Symbols and conventions...2 Resources available from the Help menu...2 Additional resources...3 Send us your documentation comments...3 Chapter 1: Installation and configuration... 5 Engineering Data Management Integration overview...5 Integration setup checklist...6 Preparing to install Microsoft Dynamics GP Messaging Service...7 Installing software for DWF files...7 Managing MSMQ service...8 Checking MSMQ service...8 Installing MSMQ service...8 Setting up shared folders...9 Granting write access to Microsoft Dynamics GP SQL databases...10 Installing Microsoft Dynamics GP Messaging Service...12 Chapter 2: Maintenance... 17 Repairing service connections...17 Changing configuration settings...18 Changing Windows password for Microsoft Dynamics GP Messaging Service...18 Managing message queues...19 Checking message queue access...19 Viewing message queue contents...20 Managing log files...20 Viewing log files...21 Specifying a separate log file...21 Viewing separate log files...22 Changing log levels...22 Error messages...23 Uninstalling Microsoft Dynamics GP Messaging Service...24 Glossary...25 Index...27 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE i
ii ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
Introduction The Engineering Data Management Integration allows item and bill of materials (BOM) information to be exchanged between a product lifecycle management (PLM) tool and an enterprise resource planning (ERP) system, such as Microsoft Dynamics GP Manufacturing. The integration uses the Microsoft Dynamics GP Messaging Service, which helps to automate the data transfer. It helps to prevent the errors that occur when data is entered manually, and keeps the updated item information synchronized with the ERP system. The product information is typically associated with a design that is created in a visualization file, such as a drawing created with CAD authoring tools. These files are often large in size and difficult to manage. With the integration, users can open and view the design files without requiring the full version of the authoring tool that the files were created with. This introduction is divided into the following sections: What s in this manual Symbols and conventions Resources available from the Help menu Additional resources Send us your documentation comments What s in this manual This manual is designed to give you an understanding of how to install the features of the Engineering Data Management Integration, and how it integrates with the Microsoft Dynamics GP system. To make best use of Manufacturing, you should be familiar with systemwide features described in the System User s Guide, the System Setup Guide, and the System Administrator s Guide. Some features described in the documentation are optional and can be purchased through your Microsoft Dynamics GP partner. To view information about the release of Microsoft Dynamics GP that you re using and which modules or features you are registered to use, choose Help >> About Microsoft Dynamics GP. The manual is divided into the following chapters: Chapter 1, Installation and configuration, provides details about installation requirements and instructions to install the Microsoft Dynamics GP Messaging Service. Chapter 2, Maintenance, describes how to check and change configuration parameters, how to repair configuration settings, and provides solutions for possible errors that can occur during the installation. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 1
INTRODUCTION Symbols and conventions For definitions of unfamiliar terms, see the glossary in the manual or refer to the glossary in Help. Symbol Description The light bulb symbol indicates helpful tips, shortcuts and suggestions. The warning symbol indicates situations you should be especially aware of when completing tasks. This manual uses the following conventions to refer to sections, navigation and other information. Convention Creating a batch File >> Print or File > Print TAB or ENTER Description Italicized type indicates the name of a section or procedure. The (>>) or (>) symbol indicates a sequence of actions, such as selecting items from a menu or toolbar, or pressing buttons in a window. This example directs you to go to the File menu and choose Print. All capital letters indicate a key or a key sequence. Resources available from the Help menu The Microsoft Dynamics GP Help menu gives you access to user assistance resources on your computer, as well as on the Web. Contents Opens the Help file for the active Microsoft Dynamics GP component, and displays the main contents topic. To browse a more detailed table of contents, click the Contents tab above the Help navigation pane. Items in the contents topic and tab are arranged by module. If the contents for the active component includes an Additional Help files topic, click the links to view separate Help files that describe additional components. To find information in Help by using the index or full-text search, click the appropriate tab above the navigation pane, and type the keyword to find. To save the link to a topic in the Help, select a topic and then select the Favorites tab. Click Add. Index Opens the Help file for the active Microsoft Dynamics GP component, with the Index tab active. To find information about a window that s not currently displayed, type the name of the window, and click Display. About this window Displays overview information about the current window. To view related topics and descriptions of the fields, buttons, and menus for the window, choose the appropriate link in the topic. You also can press F1 to display Help about the current window. 2 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
INTRODUCTION Lookup Opens a lookup window, if a window that you are viewing has a lookup window. For example, if the Checkbook Maintenance window is open, you can choose this item to open the Checkbooks lookup window. Show Required Fields Highlights fields that are required to have entries. Required fields must contain information before you can save the record and close the window. You can change the font color and style used to highlight required fields. On the Microsoft Dynamics GP menu, choose User Preferences, and then choose Display. Printable Manuals Displays a list of manuals in Adobe Acrobat.pdf format, which you can print or view. Orientation Training Accesses online tutorials that show you how to complete basic procedures within Microsoft Dynamics GP. Additional tutorials are available through the CustomerSource Web site. What s New Provides information about enhancements that were added to Microsoft Dynamics GP since the last major release. Microsoft Dynamics GP Online Opens a Web page that provides links to a variety of Web-based user assistance resources. Access to some items requires registration for a paid support plan. Customer Feedback Options Provides information about how you can join the Customer Experience Improvement Program to improve the quality, reliability, and performance of Microsoft software and services. Additional resources For information about installing Manufacturing and using Engineering Data Management, refer to the following resources: Microsoft Dynamics GP Installation Instructions Microsoft Dynamics GP Manufacturing Setup manual Microsoft Dynamics GP Manufacturing Core Functions Manual Send us your documentation comments We welcome comments regarding the usefulness of the Microsoft Dynamics GP documentation. If you have specific suggestions or find any errors in this manual, send your comments by e-mail to the following address: bizdoc@microsoft.com. To send comments about specific topics from within Help, click the Documentation Feedback link, which is located at the bottom of each Help topic. Note: By offering any suggestions to Microsoft, you give Microsoft full permission to use them freely. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 3
4 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
Chapter 1: Installation and configuration This information explains the architecture of the system, provides information about requirements, and installation instructions for Microsoft Dynamics GP Messaging Service. This chapter is divided into the following sections: Engineering Data Management Integration overview Integration setup checklist Preparing to install Microsoft Dynamics GP Messaging Service Installing software for DWF files Managing MSMQ service Checking MSMQ service Installing MSMQ service Setting up shared folders Granting write access to Microsoft Dynamics GP SQL databases Installing Microsoft Dynamics GP Messaging Service Engineering Data Management Integration overview The Engineering Data Management Integration allows you to transfer data, so that you can view design data and keep the item information synchronized without starting authoring tools. This transfer is managed by the Microsoft Dynamics GP Messaging Service. The item and drawing information will be imported to Microsoft Dynamics GP Manufacturing using message queues provided by Microsoft Message Queuing. The messaging service communicates with Microsoft Dynamics GP with the help of an SQL server using SQL tables in the Microsoft Dynamics GP database. The Incoming queue delivers the packages to the messaging service. Before a transfer is requested, a diagnostics message can be sent to the messaging service to notify the PLM tool that the service is running. The Outgoing queue contains these notifications, along with the notices created after importing the DWF packages. When a DWF package fails to be processed, the system either retries to download it again or the package goes into the Dead-Letter queue. During the service installation you can configure the number of times to try to download the packages again. If the packages can t be downloaded, the package is delivered to the Dead- Letter queue and is not valid. The message that points to a package that is not valid is immediately moved to the Dead-Letter queue. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 5
CHAPTER 1 INSTALLATION AND CONFIGURATION Integration setup checklist Before you start installing, you should verify that you are using the correct releases of the products and have been given permission to the system. Requirements You must be using the following software. Product.NET FrameWork Release 2.0 Microsoft Windows 2003 or Windows XP Release numbers of integration For current system requirements for Microsoft Dynamics GP, see http://go.microsoft.com/fwlink/?linkid=82118. Autodesk Productstream Release 4.0 Microsoft Dynamics GP Release 10.0 Manufacturing Release 10.0 Microsoft Message Release 2.0 or greater installed Queuing The Engineering Data Management Integration includes the Microsoft Dynamics GP Messaging Service and Microsoft Dynamics GP Manufacturing. You can install the messaging service immediately after installing Manufacturing, or at another time, but you must have Manufacturing installed before you install the messaging service. Setup tasks Complete the following tasks to set up the service: Task Prepare to install Microsoft Dynamics GP Messaging Service Install Microsoft Dynamics GP Messaging Service You must set up the database connection and messaging parameters to be able to exchange item data. Reference Preparing to install Microsoft Dynamics GP Messaging Service on page 7 Installing Microsoft Dynamics GP Messaging Service on page 12 The Microsoft Dynamics GP Messaging Service, the ERP system, and the PLM tool can be installed either on the same computer or on separate ones. If you are running Microsoft Dynamics GP and the PLM tool on separate servers, we recommend that you run the messaging service on the same server as Microsoft Dynamics GP. 6 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
CHAPTER 1 INSTALLATION AND CONFIGURATION Preparing to install Microsoft Dynamics GP Messaging Service Before you install the Microsoft Dynamics GP Message Service, you must complete the following tasks. Task Install software for DWF files This is only necessary if the messaging service isn t going to be installed on the computer that your PLM tool is running on. Check the MSMQ service Be sure that the Microsoft Message Queuing service is running on the computer that you are installing the messaging service on. Set up shared folders Be sure that the attachment folders and the export folders are shared on the network. Grant access to the shared folders to the user who will run the messaging service and to the Microsoft Dynamics GP users who will export data. Grant write access to the Microsoft Dynamics GP SQL database Be sure that the user who will run the Microsoft Dynamics GP Messaging Service has full access to the Microsoft Dynamics GP SQL database. Reference See Installing software for DWF files on page 7. See Managing MSMQ service on page 8. See Setting up shared folders on page 9. See Granting write access to Microsoft Dynamics GP SQL databases on page 10. Only users who have local administrator access to the computer can install the service. Installing software for DWF files You ll need to install software for reading and writing DWF files. DWF files are used to communicate item and BOM information between PLM tools and ERP systems. Install the application on the computer where the Microsoft Dynamics GP Messaging Service is going to be installed. To install software for DWF files: 1. Log in to Windows as a user with local administrator privileges. 2. Open the http://usa.autodesk.com/getdoc/id=dl5078224 page in a Web browser application. 3. Choose the AEDMDwfWrapper-Installer.zip file. The file download page appears. 4. Choose Save. 5. Select the location to save the install package to. 6. Extract the installer file. 7. Double-click the installer. The setup wizard window appears. 8. Choose Next. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 7
CHAPTER 1 INSTALLATION AND CONFIGURATION 9. Select I Agree and choose Next. 10. Choose Close. The application is installed on the computer. Managing MSMQ service To run the integration service, Microsoft Message Queuing (MSMQ) must be installed on the computer where you will install Microsoft Dynamics GP Messaging Service. If MSMQ is not installed, you have to set it up before installing the messaging service. Follow the steps to install MSMQ service on the computer. Checking MSMQ service Installing MSMQ service Checking MSMQ service Verify that the MSMQ service is running on the computer where you will install The Microsoft Dynamics GP Messaging Service. To check the MSMQ service: 1. Choose Start >> Control Panel >> Add or Remove Programs >> Add/Remove Windows Components. 2. Verify that the Message Queuing check box is marked. If it is not marked, you must install the MSMQ service to run the integration service. Installing MSMQ service If the MSMQ service is not installed, follow the steps to install the service. To install the MSMQ service: 1. Choose Start >> Control Panel >> Add or Remove Programs >> Add/Remove Windows Components. 2. Mark the Message Queuing check box. 8 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
CHAPTER 1 INSTALLATION AND CONFIGURATION 3. Choose Next. The system starts to configure the components. 4. When the process is finished, choose Finish. Setting up shared folders You must create a folder for the attachments of the transferred packages and a folder for the export files. You can create the folders on the same computer that the messaging service, the PLM tool, or Microsoft Dynamics GP applications are installed, or on a file server computer. After sharing the folders, you must grant access to the user who will run the service and to the Microsoft Dynamics GP users who will export data. Be sure to note the name and location of this shared directory. The installation procedure also refers to the shared attachment and export directories. To set up shared folders: 1. Create a new folder on the computer where the shared folder will be located. 2. Right-click and choose Properties. Be sure the Read-only and Hidden attributes are not marked. 3. Choose the Sharing tab, and choose Share this folder. 4. Choose Permissions. 5. Choose Add. 6. Type the domain name and the Windows user name. You can click the Examples link to view various formats for entering the domain name and user name. 7. Choose Check Names. If the information you entered is OK, choose OK. If not, go back to step 6. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 9
CHAPTER 1 INSTALLATION AND CONFIGURATION 8. In the Permissions for Share window, select the user information in the upper list. 9. Choose Apply. 10. Choose OK. Granting write access to Microsoft Dynamics GP SQL databases Before you install the Microsoft Dynamics GP Messaging Service, you must grant access to the SQL database to a user who will run the messaging service. To grant write access to the Microsoft Dynamics GP SQL database: 1. On the computer where the SQL server is installed, open the SQL Enterprise Manager. Choose Start >> Microsoft SQL Server >>Enterprise Manager. 2. Expand the SQL server where the SQL databases are stored. 3. Choose Login in the Security folder. 10 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
CHAPTER 1 INSTALLATION AND CONFIGURATION 4. Right-click on the right pane and choose New Login. 5. Enter the user name of the user. 6. Mark Windows Authentication, if the user should log in to the SQL database with the Windows account. Enter the Windows domain of the user. The Windows authentication is supported for security issues. Mark SQL Server Authentication if the user should log in with the SQL account. Type the password of the user s SQL account. This authentication method is less secure than logging in with the Windows accounts. Choose OK. 7. Confirm the SQL account password. 8. Choose the Database Access tab. 9. Mark the databases that the user needs access to. Mark the DYNAMICS database, as well. Each company has a separate database. Mark all of the databases needed for the integration. Choose OK. 10. Expand the Database folder in the left pane. For each database that the user has to access, complete steps 11-15. 11. Expand the database folder and choose Role. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 11
CHAPTER 1 INSTALLATION AND CONFIGURATION 12. Right-click the DYNGRP entry in the right pane and choose Properties. 13. Mark Standard Role and choose Add. 14. Select the user who you granted access to the company and choose OK. 15. Choose OK to save the new settings. 16. Repeat steps 10-15 for each company that the user needs access to. Installing Microsoft Dynamics GP Messaging Service Use this information to install the Microsoft Dynamics GP Messaging Service. To install the Microsoft Dynamics GP Messaging Service: 1. Be sure that you are logged in to Windows as a user with local administrator privileges. 2. Locate and double-click the Setup.exe file. 3. In the Messaging Service Setup Wizard window, choose Next. 12 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
CHAPTER 1 INSTALLATION AND CONFIGURATION 4. Choose I Agree to accept the license agreement and choose Next. 5. The default folder name where the service will be installed is displayed. To install in a different folder, choose Browse and select the folder to install the application to and choose Open. Choose Disk Cost to check the available space on each volume on the hard disk. 6. Select who can access the service. Select Just me if only you can access the application. Choose Next. 7. Choose Next to confirm and start the installation. 8. The installation starts. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 13
CHAPTER 1 INSTALLATION AND CONFIGURATION 9. Review the information in the Database Connection Parameters window. 10. Specify the SQL server name and the name of the SQL database. Accept the default (local) server name if you use the local server for the connection, or specify the name of the SQL server if the SQL server is not locally installed. 11. Select the authentication method. You can use the Windows NT Integrated security settings for the authentication. The system will log the user in to the database with the Windows user name and password. Or you can specify an SQL user name and password to access the SQL database. In this case, be sure that the specified user has access to the SQL database. For the authentication, the Windows NT Integrated security settings are recommended. In case of SQL authentication, the entered password is encrypted and stored in the registry that can be accessed by any user who has local administrator rights on the computer. 12. Choose Test Connection to check the connection to the service with the information you specified. Choose Next. 13. Review the Message Queue parameters. 14 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
CHAPTER 1 INSTALLATION AND CONFIGURATION Define the queue names where the messages about the requested packages will be stored during the transferring process. For more information about message queues, see Engineering Data Management Integration overview on page 5. The following characters cannot be used in the queue names: \ ; +, 14. Choose Next. 15. Enter the account name. The service will run under the name of the user who you specify. Enter and confirm the password for the specified account and choose Next. 16. Specify the messaging service settings. Database poll interval Enter the number of seconds the system has to check for new packages to be processed. Retry interval Specify the number of seconds that the messaging service should wait before attempting to process a DWF package that has failed. Number of retries packages. Enter the number of retries to process the failed DWF You can use the default Microsoft Dynamics GP Messaging Service settings to run the service with optimal parameters. 17. Enter the path to the folder and the name of the attached drawings. 18. Enter the path to the folder and the name of the DWF export files that will be transferred. 19. Choose Finish to close the Messaging Service Settings window. 20. Choose Close to complete the installation and exit. The Installation Wizard starts the service automatically. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 15
16 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
Chapter 2: Maintenance This chapter describes how to check event logs that the Microsoft Dynamics GP Messaging Service creates and saves. It explains how to change configuration settings, manage log files, view message queues, how to repair the connection for the Microsoft Dynamics GP Messaging Service, and provides troubleshooting tips. The following information is discussed: Repairing service connections Changing configuration settings Changing Windows password for Microsoft Dynamics GP Messaging Service Managing message queues Checking message queue access Viewing message queue contents Managing log files Viewing log files Specifying a separate log file Viewing separate log files Changing log levels Error messages Uninstalling Microsoft Dynamics GP Messaging Service Repairing service connections Use this procedure if the PLM tool and Microsoft Dynamics GP Messaging Service are installed on the same computer and the components for the PLM tool are not installed. The PLM tool uninstall process may delete the DWF ToolKit, which is required for the messaging service. To repair service connections: 1. In Start Menu, choose Control Panel then double-click the Add or Remove Programs icon. 2. In the Currently Installed Programs, select the Messaging Service entry. 3. Choose Change. 4. Select Repair Messaging Service. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 17
CHAPTER 2 MAINTENANCE 5. Choose Finish. The Application Parameters window opens. 6. Review the existing information and make the necessary changes to the configuration. For more information, see Installing Microsoft Dynamics GP Messaging Service on page 12. If the service is not running, be sure that the Windows password is correct in the service parameter settings or the user whose name the service runs in has Write access to the message queues. For further information, see Changing Windows password for Microsoft Dynamics GP Messaging Service on page 18 and Checking message queue access on page 19. Changing configuration settings To change the configuration parameters, you can use the Application Parameters Wizard. To change configuration settings: 1. Choose Start >> All Programs >> Microsoft Dynamics >> Messaging Service >> Configure the Messaging Service. The Application Parameters Wizard window opens. 2. Review the existing information and make the necessary changes to the parameters. For more information about parameter details, see Installing Microsoft Dynamics GP Messaging Service on page 12. If you reconfigure the Microsoft Dynamics GP Messaging Service to run under a different account, be sure that you delete all the queues created by the messaging service. See Viewing message queue contents on page 20. Delete all the queues starting with the names that you configured in the messaging service setup. (The default queue names in the Private Queues folder are the following: incoming, outgoing, dead-letter and incoming_<company NAME> outgoing_<company NAME>, deadletter_<company NAME>.) Changing Windows password for Microsoft Dynamics GP Messaging Service If you change the Windows password of the user whose name the service runs in, you have to change the Windows password setting in the Microsoft Dynamics GP Messaging Service service parameters, as well. To change Windows password for Microsoft Dynamics GP Messaging Service: 1. Log on to the computer where the Microsoft Dynamics GP Messaging Service is installed. 2. Choose Start >> Control Panel >> Administrative Tools >> Services. 3. Right-click the Messaging Service in the Services list and choose Properties. 18 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
CHAPTER 2 MAINTENANCE 4. Enter the Windows user name whose name the service runs in. Enter and confirm the Windows password. 5. Choose OK. Managing message queues Microsoft Dynamics GP Messaging Service communicates with the PLM tool with the help of Microsoft Message Queuing. The packages are transferred to the messaging service in the Incoming queues. The Outgoing queue contains the notifications coming from the messaging service to the PLM tool. The messages that the service can t process are transferred to the Dead-Letter queues. For further information, see Engineering Data Management Integration overview on page 5. Checking message queue access If the Microsoft Dynamics GP Messaging Service service is not running, verify that the user whose name the messaging service will run in has write access to the message queues. To check message queue access: 1. Log in to the computer with the Windows user account whose name the integration service runs in. 2. On the desktop or in a file manager application, right-click My Computer and choose Manage. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 19
CHAPTER 2 MAINTENANCE 3. Expand Message Queuing. 4. Right-click Private Queue and choose New >> Private Queue. 5. Enter the queue name and choose OK. 6. If no error messages are displayed, the user has write access to the Message Queuing Service. If the user cannot create message queues in MSMQ, you should consult your network administrator for further assistance. 7. To delete a message queue, select and right-click the message. Choose Delete. Viewing message queue contents You can view the contents of each Microsoft Dynamics GP Messaging Service message queue that is transferred in the system. To view the contents of the message queues: 1. Right-click the My Computer icon and select Manage. The Computer Management window opens. 2. Browse through the Message Queuing folder in the left pane. 3. Click the queues to display their contents in the right pane. 4. Double-click the messages in the right pane to open them. Managing log files The Microsoft Dynamics GP Messaging Service log files track all the actions that were made when the service is running, and displays the error messages and their descriptions that occur during processing. You can check the log file of the service in its default viewer or you can specify a separate file for messaging service actions and errors to handle the messages separately. You can define the content of the log files, depending on what type of event and error messages you want to see or need. 20 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
CHAPTER 2 MAINTENANCE To manage log files you can perform the following tasks: Viewing log files Specifying a separate log file Viewing separate log files Changing log levels Viewing log files Microsoft Dynamics GP Messaging Service service reports events and errors in the event log. You can view the entries of the event log in the Event Viewer. To view log files: 1. Choose Start >> Run. 2. Enter the following in the Open field: eventvwr.msc. 3. Choose OK. The Event Viewer window opens. 4. Click Application in the left pane. The log entries are displayed in the right pane. 5. Browse through the events with Messaging Service in the Source column. 6. Double-click the entries to view the information. Specifying a separate log file To store and view log files separately, you must create a separate log file that will be saved in the folder where the service application is located. To specify a separate log file: 1. On the computer where Microsoft Dynamics GP Messaging Service is installed, open a file manager to find the folder where the application files are stored. 2. Browse to the Microsoft.Dynamics.MessagingService.exe.config file. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 21
CHAPTER 2 MAINTENANCE 3. Right-click the file and select Open With. 4. Select NotePad or WordPad to open the.config file. 5. Find the following entry in the file: <add name="logfile" type="microsoft.dynamics.messagingservice.diagnostics.textwriterlistener, Microsoft.Dynamics.MessagingService.Common" initializedata="debug.log" / > 6. Change the file name in the initalizedata s value. For example, to name your log file EVENTS, change the initializedata= debug.log entry to initilaizedata= EVENTS.log. 7. The log file will be created in the application folder with the name you specified. Viewing separate log files You can view the content of the log files that you created using NotePad or WordPad. To view separate log files: 1. Open a file manager to find the log file. 2. Browse to the log file in the application folder with the name you specified in the.config file. See Specifying a separate log file on page 21. 3. Right-click the file and select Open With. 4. Select NotePad or WordPad to open and view the log file. Changing log levels You can specify the content of the log file. Only the events and messages with the specified content are saved. To change log levels: 1. On the computer where Microsoft Dynamics GP Messaging Service is installed, open a file manager to find the folder where the application files are stored. 2. Browse to the Microsoft.Dynamics.MessagingService.exe.config file. 3. Right-click on the file and select Open With. 4. Select NotePad or WordPad to open the.config file. 22 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
CHAPTER 2 MAINTENANCE 5. Find the following entry in the log file: <appsettings> <add key="loglevel" value="debug" /> </appsettings> 6. Change the value= Debug to the following values: Value Debug Warn Error Log file content Displays all the messages, including debugging information. Displays only errors and warnings. Displays only the critical errors. (For example, database connection is not available, invalid access) If you set the log level value to Debug, the size of the log file will grow quickly, so you should regularly delete the log file. You can find the log file in the application folder. Error messages Error messages, warnings and notifications are created in logs. To fix errors during the installation process, open the log files and view the error messages and warnings that were created during processing. For further information about viewing and managing log files, see Managing log files on page 20. Error message System.Messaging.MessageQueueException: Access to Message Queuing system is denied. System.Data.SqlClient.SqlException: SQL Server does not exist or access denied. System.UnauthorizedAccessException: Access to the path "PATH" is denied. System.Security.SecurityException: The DWF file is too big. Troubleshooting Verify that the user who is running Microsoft Dynamics GP Messaging Service has access to Microsoft MQ queues. Verify that the SQL server connection parameters are configured properly. Verify that the server is accessible and the User has access to it. Verify that the user who is running the service has access to the attachment and the DWF export folders. The maximum size of the downloaded DWF files is 4MB (specified in bytes) by default. Change it in the registry: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft Dynamics GP\Messaging Service \General\MaxDwfSize. If you request data transfer to Microsoft Dynamics GP Manufacturing but the process does not start, be sure that at least one of the companies is active for integration. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 23
CHAPTER 2 MAINTENANCE Uninstalling Microsoft Dynamics GP Messaging Service You can remove the integration service and the message queues that the service created using the Microsoft Windows application removal tool. To uninstall Microsoft Dynamics GP Messaging Service: 1. Choose Start >> Control Panel >> Add or Remove Programs. 2. Select Messaging Service and choose Remove. 3. Confirm that you want to remove the service. 4. The uninstall process removes all the queues that the messaging service created. The queues that contains messages that are not processed must be removed manually. The queues that contain messages that are not transferred are displayed. 5. Select the messages to remove and choose OK. The message queues that are not selected will remain in the system. 24 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
Glossary Bill of Materials (BOM) A list of the components and subassemblies needed to build one unit of a product. The bill of materials also shows quantities for each component. Computer-Aided Design (CAD) A system of programs and workstations used in designing engineering, architectural, and scientific models. Default A value that is displayed in a window automatically and will be used unless a different value is entered. Drawing A schematic or other illustration. You can attach electronic drawing files-such as CAD illustrations, bitmaps and even.avi movies-to records. Drawing Web Format (DWF) A file format specially developed for engineering data. The smaller file size makes it faster to transmit and share design data. DWF package DWF packages contain the information to be transferred. See also Drawing Web Format (DWF). Dead-Letter queue A queue that stores messages that could not be processed. Microsoft Dynamics GP Messaging Service An application that manages the transfer of data between a PLM tool and Microsoft Dynamics GP. Enterprise Resource Planning (ERP) A software system designed to support and automate the processes of an organization, including manufacturing and distribution, accounting, project management, and personnel functions. Incoming queue A queue that delivers the messages that arrive from the PLM tool. Message queuing A message queuing and routing system for Windows that allows distributed applications running at different times to communicate across networks and with computers that may be offline. Outgoing queue A queue that stores the notifications that the system sends during processing. ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 25
26 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE
Index A access, to SQL databases 10 additional resources 3 administration 20 B benefits, integration 1 C changing Windows password for DMS 18 configuration settings, changing 18 connections, repairing 17 conventions, used in manual 2 D DWF files, installing software for 7 E error messages 23 H help, displaying 2 Help menu, described 2 I incoming queue 5 installation Microsoft Dynamics GP Messaging Service 12 MSMQ service 8 requirements 6 setup tasks 6 integration, overview 5 L log files managing 20 specifying separate log files 21 viewing 21 viewing separate log files 22 log level, changing 22 lookup window, displaying 3 M maintenance 17 managing MSMQ service 8 message queues checking access 19 overview 5 viewing contents 20 Microsoft Dynamics GP Messaging Service installing 12 overview 5 uninstalling 24 MSMQ service checking 8 installing 8 managing 8 O outgoing queue 5 overview, integration 5 P preparing, installing Microsoft Dynamics GP Messaging Service 7 R repair, service connections 17 required fields, described 3 requirements, installation 6 resources, documentation 2 S setup checklist 6 setup tasks, installation 6 shared folders, setting up 9 symbols, used in manual 2 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE 27
28 ENGINEERING DATA MANAGEMENT INTEGRATION ADMINISTRATOR S GUIDE