Copyright Copyright 2010 Automated Data Capture (ADC) Technologies, Incorporated. 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 ADC Technologies Inc. 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, Active Directory, ActiveSync, Dexterity, Microsoft Dynamics, SharePoint, Windows, Windows Mobile, and Windows Server, are either registered trademarks or trademarks of Microsoft Corporation or its affiliates in the United States and/or other countries. BarTender is a trademark of Seagull Scientific, Incorporated and is registered in the United States and other countries. x10data and EasyTrac are trademarks of ADC Technologies Incorporated 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 ADC Technologies 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 ADC Technologies, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property. Warranty disclaimer ADC Technologies Incorporated 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 ADC Technologies Incorporated. ADC Technologies Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in this manual. Neither ADC Technologies Incorporated 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 ADC Technologies Customer Assistance Department at +1-949-752-2328. Publication date July 2010
Contents Section 1 System Requirements... 3 Configuration Options... 3 Database Server Requirements... 3 Web Server Requirements... 3 Supported Applications... 4 Section 2 x10data component installations... 7 Before running Setup... 7 Special Note regarding Windows Server 2008 and IIS 7... 8 x10data Application Platform installation... 13 Section 3 First-Time Configuration and Setup... 24 Installing x10data Platform Components... 24 Appendix A: Updating x10data Components... 33 Creating a Restore Point... 33 Downloading the Update... 36 Installing the Update... 39 Appendix B: Configuring the optional x10data Process Server... 45 Overview... 45 Installation and Configuration... 46 Stopping and Starting the x10data Process Server... 54 Appendix C: Uninstalling x10data Application Platform Components... 55 Workstation / Server Components... 55 Appendix D: Troubleshooting... 56 Installation Incomplete The installer was interrupted... 56 Installation Error in x10data Process Server Application... 57 Server Error in x10mobilesvc Application... 58 IIS Metadata not found error... 59 Failed to access IIS metabase... 60 Page 2 of 60
Section 1 System Requirements Configuration Options Small Business Configuration Enterprise Configuration 1-20 Concurrent Users 21-100 Concurrent Users 500 Transactions Per Hour 1,500 Transactions Per Hour Database Server Requirements Operating System: Microsoft Windows Server 2003 R2 or Microsoft Windows Server 2008 Installed Applications: Microsoft SQL Server SQL Server 2005 Processor: RAM: Small Bus: 1.6 GHz Enterprise: Dual/Quad-Core 3.2 GHz Small Bus: 2 GB Enterprise: 4 GB Web Server Requirements Operating System: Microsoft Windows Server 2003 R2 or Microsoft Windows Server 2008 Installed Applications: Internet Information Services (IIS) IIS with ASP.NET 2.0.NET Framework 2.0 SP2 NOTE: If using IIS 6, the following Web Service Extensions must be Allowed Active Server Pages ASP.NET v2.0.50727 NOTE: If using IIS 7.0 you must also install IIS6.0 Metabase Compatibility (refer to special note for Windows Server 2008) Processor: RAM: Internet Access: FTP Access: Small Bus: 1.6 GHz Enterprise: Dual/Quad-Core 3.2 GHz Small Bus: 2 GB Enterprise: 4 GB Access to the Internet is required for authentication and validation during the initial installation. Periodic software updates also require access to the Internet. FTP services are used to download the current database backup files from the x10data ftp site, and therefore must be available. Ensure that FTP services are not blocked by a firewall. NOTE: NOTE: SQL Server can be installed on the same computer that you are using for the x10data Application Platform (web server), or on a separate computer that is connected by a local area network and is in the same Domain. SQL Server authentication must be enabled. To check your version of SQL Server, see the following link: http://support.microsoft.com/kb/321185 Page 3 of 60
Supported Applications The following applications have been tested and are compatible with the x10data Application Platform: Product Title BarTender Label Printing Software Crystal Reports Report Generator Malvern Shipping Server Manufactured By Seagull Scientific Versions Supported Automation Edition: 9.3 Enterprise Edtion: 8.0 through 9.2 Compatible x10data Component Mobile Server Smart Client for Windows Business Objects 8.5 through 11.5 Malvern Systems 3.0 Smart Client for Windows Mobile * - server-side printing Please note that 3 rd party applications have their own system and hardware requirements. For example, some applications do not support 64-bit operating systems. Careful planning can prevent costly rework and/or delays. Refer to the x10data Application Server Requirements 1 document when considering the applications you wish to integrate in a targeted environment. 1 Full URL: http://install.x10data.com/documents/x10data_application_server_v7.1_requirements.pdf Page 4 of 60
Page 5 of 60
Page 6 of 60
Section 2 x10data component installations Before running Setup 1. As previously stated in the System Requirements, if your Database Server and Web Server are running on separate machines, they must be on the same network and in the same Domain. 2. Login to your computer with an ID that has administrator privileges. 3. IMPORTANT: IIS (Internet Information Server) MUST be installed. 4. Run Windows Update (repeatedly) until all Critical Updates have been installed. 5. If you are installing on Windows Server 2008, then please read the special note that follows. Otherwise you may skip to x10data Platform Application installation. Page 7 of 60
Special Note regarding Windows Server 2008 and IIS 7 NOTE: IMPORTANT To successfully install the x10data Application Platform on Windows Server 2008, you must configure the machine with the Web Server (IIS) role, and also install IIS6.0 Metabase Compatibility. This is done through the Server Manager Console on the Windows Server 2008 machine. Follow these steps: 1. Launch the Server Manager Console by clicking Start, Administrative Tools, Server Manager. Page 8 of 60
2. In the Server Manager tree view left-hand pane, expand the Roles node and click the Web Server (IIS) node. Page 9 of 60
3. With the Web Server (IIS) node selected, in the right-hand pane scroll down to the Role Services, look under Management Tools, and confirm that IIS 6.0 Metabase Compatibility is installed. Page 10 of 60
4. If 6.0 Metabase Compatibility is not installed, then scroll back up to the beginning of the Role Services and click the link for Add Role Services at the right-hand edge of the screen. Page 11 of 60
5. In the Add Role Services dialog box, scroll to the bottom and check IIS 6.0 Metabase Compatibility, and then click the Install button at the bottom. NOTE: you may have to reboot the server after installing this component. Page 12 of 60
x10data Application Platform installation 1. The current version of the x10data Application Platform Installer is downloaded from http://download.x10data.com. From this page, click the link for x10data Application Platform v7.1 : 2. This launches the file download process. 3. Click Run. A self-extracting setup program is downloaded to verify that the prerequisites have been satisfied. Page 13 of 60
4. When you see the following: 5. Click Run to start the self-extracting process. Page 14 of 60
6. Click Unzip to complete the self-extracting process. NOTE: The default location for unzipping the setup program is: c:\x10install\x10data Platform Installer\ All subsequent instructions in this guide assume that this is the location chosen. 7. When the self-extraction process has completed, click OK. 8. A small program is launched to verify that certain prerequisite software components are installed. 9. Click Install to complete the prerequisite check. Page 15 of 60
10. When the prerequisite check installation has completed, click Close. 11. If all prerequisites are satisfied, the installation will continue with the full install package. If a prerequisite is missing, you are prompted to install it from the appropriate Microsoft site. Page 16 of 60
12. Click Next to install the x10data Application Platform. Page 17 of 60
13. On the Welcome screen, click Next to proceed with the installation. Page 18 of 60
14. Review the x10data Application Platform software requirements, and then click Next. Page 19 of 60
15. Review and accept the terms of the license agreement, then click Next. Page 20 of 60
16. Select the Installation Address. For ease of installation, it is recommended to accept the default value for the Virtual Directory. Click Next. Page 21 of 60
17. Confirm the Installation and begin by clicking Next. Page 22 of 60
18. Click Close when the installation has completed. Page 23 of 60
Section 3 First-Time Configuration and Setup Installing x10data Platform Components After you install the x10data Application Platform, the x10data Administrator program is launched automatically. The x10data Administrator is used for: getting the latest system databases from the x10data ftp site, installing report and label definitions, installing the optional x10data Process Server component, and creating (or upgrading) your x10data account database The first time that the x10data Administrator is run, it detects that no account database has been created. It then opens a dialog box prompting for the information necessary to create the account database. To create the x10data account database, follow these steps: 1. Enter the SQL Server Connection information including authentication type. In the Account Name field, enter the name specified in your licensing agreement. Specify whether Integration with Dynamics is required, then click the Execute button. 2. The x10data Administrator will perform many steps, including the download and restore of the most current x10data SYSTEM databases. Provided that no errors were encountered, the x10data Administrator will finish the component installation process looking similar to this: Page 24 of 60
3. When you are satisfied with the results, click Action, and then Exit. Page 25 of 60
NOTE: IMPORTANT The x10data Smart Client for Windows is designed to be run on a workstation and has the following prerequisites: Microsoft.NET Framework 3.5 Microsoft SQL Server Compact 3.5 However, it is possible to successfully install it on your server as long as these prerequisites are not in conflict with the way that you have configured your server. It is generally recommended that you install the x10data Smart Client for Windows on a separate workstation. NOTE: The x10data Smart Client for Windows is installed from the following URL: http://go.x10data.com Refer to the installation instructions at http://download.x10data.com Page 26 of 60
4. Launch the x10data Smart Client for Windows. After an initial splash screen, you will see this: 5. From the menu, select File and then Select Host. Page 27 of 60
6. From the Host Lookup list, select F4-New to start a new host connection record. Page 28 of 60
7. Enter values for the following fields: Host Name: [choose a name for this Host record] Site: [enter the IP Address or Hostname of the machine that is running the x10data Mobile Server web service] Virtual Directory: [leave this value as x10mobilesvc ] Retries: [not used] Seconds to Wait: [the number of seconds to wait before timing out communication to the host] Auto Log On: [toggles the User Name and Password fields] User Name: [the x10data userid set up by your account administrator] Password: [the x10data password set up by your account administrator] Account: [the account name assigned in the registration process] NOTE: Fields that are BOLD are required. The initial User Name, Password, and Account are provided at the end of the Account database creation process. 8. When finished entering the Host detail information, click F10-Save, and then ESC-Close to close the Host detail window. Page 29 of 60
9. The host record that you just saved is automatically selected. To connect to this host, press Enter, or click F10-Select. Page 30 of 60
10. At this point, you have successfully created an account database, and logged into the System Manager role for your account (shown as Audio above). Page 31 of 60
11. To exit the x10data Smart Client, from the menu click File, and then Exit. Page 32 of 60
Appendix A: Updating x10data Components The x10data Application Platform is updated as part of each Service Release. If new Smart Clients are included in the release, then the x10data Application Platform will automatically make them available to the devices and desktops as they connect to the x10data Mobile Server web service. Prior to performing the update, please ensure that all x10data Smart Clients have been closed (Menu / File / Exit). Also exit from any x10data server utility such as the x10data Administrator. Creating a Restore Point It is good practice to have a method to restore to the current release before any update is applied. There are 3 files associated with the current release that should be renamed; thus providing a restore point. You need only rename the first file as the other two are handled automatically. x10v7.1.full.net.exe x10system.bak (a copy is made automatically during the software update) x10easytrac.bak (a copy is made automatically during the software update) By renaming these files prior to downloading the update, you ensure a path back to your current environment. NOTE - IMPORTANT: By renaming these files, you have a way to roll-back to the prior installation. If you do not rename the files, they will be replaced with the latest copies from our ftp server. To rename these files, perform the following steps on the server where the x10data Application Platform is installed: Page 33 of 60
1. Open a Windows Explorer by clicking Start, and then Run 2. Type c:\x10install and click OK. Page 34 of 60
3. Rename the x10v7.1.full.net.exe file to x10v7.1.full.net_old.exe. NOTE: If there is already _OLD file there, you can safely delete it before renaming the current install package. NOTE: Another option is to use a naming convention that indicates the version and build. For example: rename x10v7.1.full.exe to x10v7.1.0020.full.net.exe. This provides a running history of the software versions that have been installed. 4. After renaming the installation file, click the to close the window. Page 35 of 60
Downloading the Update 1. The current version of the x10data Application Platform Installer is downloaded from http://download.x10data.com. From this page, click the link for x10data Application Platform v7.1 : 2. This launches the file download process. 3. Click Save and save it to the C:\x10Install directory on your server. Page 36 of 60
Page 37 of 60
4. Click Save. 5. The file is saved to the location specified. Page 38 of 60
Installing the Update If you unchecked the checkbox for Close this dialog box when download completes, then click the Open Folder button. Otherwise, 1. Open another Run command dialog box 2. Type c:\x10install and click OK. Page 39 of 60
3. Select x10v7.1.full.net.exe and Open the file (either right-click on the file and select Open; or select the file and press Enter). 4. Click Run. Page 40 of 60
5. Keep the default settings and click Unzip. 6. When the self-extraction is complete, click OK. 7. Keep all the default settings and click Next until the installation is complete. NOTE: These screens are the same as for the first-time installation. Refer to section x10data Application Platform installation in this document for details. Page 41 of 60
NOTE: After the installation completes, the x10data Administrator will automatically be launched to complete the update of the x10data Platform Components. NOTE: If you have purchased licenses to run the optional x10data Application Platform components for BarTender Label Printing, then you may also need to update the standard label definition files. To update these files, mark the checkboxes for Update Report Definitions and Install Process Server before beginning the update process. Refer to Appendix B: Configuring the optional x10data Process Server for details on how the x10data Process Server is installed and configured. Page 42 of 60
8. To complete the update of the x10data Platform Components, click the Execute button. 9. The x10data Administrator displays the status and progress of the update process. When complete, a summary message is logged indicating whether any errors were encountered during the update. Page 43 of 60
10. If errors are indicated, further information is found in the x10data.log file. This log is opened from the menu by clicking Action and Display x10data.log file 11. From the menu, click File, then Exit to close the x10data Administrator application. Page 44 of 60
Appendix B: Configuring the optional x10data Process Server Overview The optional x10data Process Server is installed to run as a background service on the same server where you have the x10data Application Platform installed. Its function is to manage communication between the x10data Application Platform and optional 3 rd party software that has been certified to function with x10data. (refer to section Supported Applications for specific applications that are supported) So that x10data Smart Clients can perform server-side printing, they need to know which printers have been set up on the server. They request this information from the x10data Mobile Server. However, the x10data Mobile Server runs under the credentials of ASP.NET and therefore does not normally have access to printers that are installed on the server. This is by design and should not be circumvented due to the security concerns of granting such access to ASP.NET. To facilitate server-side printing for the x10data Smart Clients, the x10data Process Server is configured to run using credentials that have the necessary access and permissions for using the printers. During the installation of the x10data Process Server, you are prompted to enter the credentials necessary for this access. NOTE: IMPORTANT - These same credentials should be used for running integrated 3rd party software; such as Seagull Scientific s Commander service (installed with the BarTender Suite). When the x10data Process Server is started, it gets a list of all of the printers that it has access to through its logon credentials. This list is stored in the x10data system database so that the x10data Smart Clients can retrieve the names of the printers. NOTE: IMPORTANT - If a new printer is added, or an existing printer setup is changed, it should always be done by logging on using the same credentials as the x10data Process Server. Once the printer modifications have been completed, the x10data Process Server must be stopped and then restarted. When the x10data Process Server is started, it updates the database and replaces the previous printer list with the updated printer list. The steps to stop and start the x10data Process Server are shown later in this section. Page 45 of 60
Installation and Configuration The following steps illustrate the process of installing and configuring the x10data Process Server. The steps are performed from within the x10data Administrator program. 1. Click Action and then select Update x10data Platform Components. 2. In the Update x10data Platform Components dialog box, mark the checkboxes for Update Report Definitions and Install Process Server. Then click Execute. Page 46 of 60
3. After the Report Definitions have been installed, the x10data Process Server Setup Wizard is launched. Click Next. Page 47 of 60
4. Because the x10data Process Server will be running as a service, select Everyone and click Next. Page 48 of 60
5. A helpful reminder to read this document. Click Next. Page 49 of 60
6. Click Next to begin the installation. Page 50 of 60
7. During the installation of the x10data Process Server, the Set Service Login dialog box is displayed in the upper left-hand corner of the screen. You must provide a valid username and password that has the appropriate rights to work with the printers that you intend to use for server-side printing. Click OK to continue. NOTE: If you mistype the password or supply an incorrect password, the installation of the x10data Process Server will fail and it will roll back to the pre-installation state. If this happens, you can retry the installation from the x10data Administrator by clicking Action and then Update x10data Platform Components Page 51 of 60
8. Click Close to exit the installation process. 9. When you return to the x10data Administrator, the Start x10data Process Server dialog box is displayed. Accept the defaults and click OK. Page 52 of 60
10. Status messages are displayed that track the installation process. Page 53 of 60
Stopping and Starting the x10data Process Server 1. If you wish to stop the x10data Process Server, click Action and then Stop Process Server. 2. To start the x10data Process Server, click Action and then Start Process Server Page 54 of 60
Appendix C: Uninstalling x10data Application Platform Components Workstation / Server Components The x10data components should be removed in the order specified below. NOTE: If you did not install an optional component, then skip to the next one in the list. x10data Smart Client x10data Process Server x10data Application Platform x10data Prerequisite Checker 1. Open the Control Panel and launch the Add or Remove Programs applet. 2. Select the x10data Smart Client. Click Remove. Response Yes when prompted for Are you sure 3. Select the x10data Process Server. Click Remove. Response Yes when prompted for Are you sure 4. Select the x10data Application Platform. Click Remove. Response Yes when prompted for Are you sure 5. Select the x10data Prerequisite Checker. Click Remove. Response Yes when prompted for Are you sure 6. Close the Add or Remove Programs dialog box. Page 55 of 60
Appendix D: Troubleshooting Installation Incomplete The installer was interrupted During the installation of the x10data Application Platform, you see the following message: This occurs on Windows Server 2008 platforms that do not have the necessary prerequisite components installed. To correct this problem, review and follow the steps detailed earlier in this document: Special Note regarding Windows Server 2008 and IIS 7. Page 56 of 60
Installation Error in x10data Process Server Application If you uninstall and then try to reinstall the x10data Process Server, you might get the following message: To correct this problem, open a command line window and type the following two commands: cd "C:\Program Files\x10DATA Application Platform\ x10data Process Server " NOTE: If installed in a different folder, then modify the above command to go to that folder. "C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\installutil" /u x10procsrvr.exe This will remove the installed service so that it can be reinstalled from the setup window. msdn documentation: http://msdn2.microsoft.com/en-us/library/50614e95(vs.80).aspx Page 57 of 60
Server Error in x10mobilesvc Application If, prior to installing the.net Framework 2.0, the.net Framework v1.x was loaded on the server, then you may get an error similar to the following: Server Error in x10mobilesvc Application Configuration Error Description: An error occurred during the processing of a configuration file required to service this request. Please review the specific error details below and modify your configuration file appropriately. Parser Error Message: Unrecognized configuration section 'xhtmlconformance' Source Error: Line 73: --> Line 74: <globalization requestencoding="utf-8" responseencoding="utf-8"/> Line 75: <xhtmlconformance mode="legacy"/> Line 76: </system.web> Line 77: </configuration> Source File: C:\inetpub\wwwroot\x10MobileSVC\web.config Line: 75 -------------------------------------------------------------------------------- Version Information: Microsoft.NET Framework Version:1.1.4322.2032; ASP.NET Version:1.1.4322.2032 To correct this error: 1. Open the Internet Information Services (IIS) applet (under Control Panel, Administrative Tools). 2. Open the node for the default web site. 3. Select the node for x10mobilesvc 4. Right-click and select Properties 5. Click the ASP.NET tab 6. Change the value in the combo box for ASP.NET Version to show: 2.0.50727 7. Click OK 8. Confirm that the error is fixed by browsing to: http://localhost/x10mobilesvc/communicatorservice.asmx Page 58 of 60
IIS Metadata not found error If.NET Framework is loaded before IIS, you can get error IIS Metadata not found. To remap ASP.Net with IIS, run the following from the command line: "%windir%\microsoft.net\framework\v2.0.50727\aspnet_regiis.exe" i For more information, go to http://support.microsoft.com/kb/306005/en-us. Page 59 of 60
Failed to access IIS metabase The most probable cause for this error is that Internet Information Services (IIS) was installed after the installation of Microsoft.NET Framework. Follow the steps given below to fix this error 1. Go to Start Control Panel Add and Remove Programs 2. Click on the entry titled Microsoft.NET Framework 2.0 and select Change/Remove. The Microsoft.NET Framework 2.0 Setup dialog box opens up. 3. Select the option titled Repair and the setup automatically performs the required repair work. 4. You are prompted to reboot the system after the completion of the process. 5. Run the affected ASP.NET 2.0 application once again and the application should work fine without any problems. For more information, go to http://support.microsoft.com/kb/555583 Page 60 of 60