Mobile On the Go (OTG) Server

Transcription

1 Mobile On the Go (OTG) Server Installation Guide Paramount Technologies, Inc East West Maple Road Walled Lake, MI Phone Fax

2 Copyright Trademarks Copyright 2016 Paramount Technologies. 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 Paramount Technologies. 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. WorkPlace is a registered trademark of Paramount Technologies and is registered in the United States and other countries. Microsoft, Windows, Windows Server and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation or its affiliates in the United States and/or 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, addresses, logos, people, places, and events depicted herein are fictitious. No association with any real company, organization, product, domain name, address, logo, person, place, or event is intended or should be inferred. Intellectual property Paramount 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 Paramount, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property. Warranty disclaimer Paramount Technologies 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 Paramount Technologies. Paramount Technologies assumes no responsibility or liability for any errors or inaccuracies that may appear in this manual. Neither Paramount Technologies 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 Paramount Technologies Support at (in the U.S. or Canada) or Publication date July 2016 Page 2 of 11

3 Table of Contents Overview... 4 Communication Architecture... 4 Web Server System Requirements... 4 Installation... 5 Creating the IIS Virtual Directory/Application... 5 Step 1 Extract OTGS Application to Web Server... 5 Step 2 Create the Application Pool... 6 Step 3 Create the Web Application... 7 Configuring the On-The-Go Server... 8 Step 4 Edit the OTGS web.config... 8 Configuring WorkPlace for OTGS Access Step 5 Configure the WorkPlace Shared User Account Step 6 Configure the WorkPlace Language User Access Finished Step 7 Configure Mobile Device Page 3 of 11

4 Overview The WorkPlace On-The-Go Server (OTGS) functions as an intermediate between the ios and Android Mobile devices and the core WorkPlace Business Intelligence and Data. The OTGS is designed to be placed on the DMZ for external internet access by the mobile devices. Communication Architecture The Android / ios mobile devices perform all communication via the OTG Server which has a direct link to the local WorkPlace application to retrieve and process data. Android / ios Mobile Device OTG Server WorkPlace Web Server System Requirements Component Requirements Notes Operating System Microsoft Windows 10 Microsoft Windows 8 Microsoft Windows 2012 Microsoft Windows 7 It is recommended that the Web Server is not the same machine as the SQL Server. 32 and 64 bit is supported Microsoft Windows XP Microsoft Windows Vista Microsoft Windows 2008 R2 Microsoft Windows 2008 Microsoft Windows 2003 (all editions) Page 4 of 11

5 Component Requirements Notes Windows Internet Information Services (IIS) IIS 6.0 or greater.net Runtime Version NET Runtime version is included with WorkPlace. Installation The OTGS application is downloadable from the Paramount Customer Area and will have a file name such as WPOTGS_ zip. The zip file includes the entire OTGS application which will be setup and configured on a Windows IIS server with Microsoft.NET 4.0 installed. Following are step by step instructions on setting up and configuring the OTGS application within Microsoft Internet Information Services. Creating the IIS Virtual Directory/Application This step is required for a first time installation; it may be skipped when upgrading. An OTGS virtual directory must be configured for each WorkPlace virtual folder configured in the environment. Typical installations will have one OTGS virtual folder tied to one WorkPlace virtual folder. Mobile devices only allow for connection to one OTGS application at a time. The Installation Steps below include screens shots from Windows Server Although the screens may differ slighter, similar setup screens are available for all supported Windows Server and Workstation platforms. Step 1 Extract OTGS Application to Web Server Once the OTGS application is downloaded from the customer area it needs to be extracted into a folder on the web server. For this example the files have been placed into the C:\WPOTGS folder. Page 5 of 11

6 Step 2 Create the Application Pool Open the Internet Information Services (IIS) by navigating to Control Panel Administrative Tools Internet Information Services (IIS) Manager. Once open, right mouse click on Applications Pools and select Add Application Pool On the Add Application Pool screen enter a name for the pool such as OTGS, select.net Framework v4.x.xxxxx (.NET 4.0), accept the rest of the defaults and click OK. Page 6 of 11

7 Step 3 Create the Web Application Now that the Application Pool is created we need to create the Application for the OTGS and tie it to this newly created Application Pool. To create the Application right mouse click on the Web Site that is to contain the Application, in this example we are putting it on the Default Web Site. Select Add Application Now from the Add Application screen enter the alias to use such as OTGS, select the Application Pool we setup in Step 2, now select the physical path where we extracted the WPOTGS zip file to in Step 1. Once done click OK. Page 7 of 11

8 Configuring the On-The-Go Server Now that the OTGS application is setup in IIS it s now time to configure the OTGS web.config file. Step 4 Edit the OTGS web.config The web.config is stored in the root of the extracted OTGS application that was performed in step 1. Open this file in a text editor such as notepad. Once open, set the following keys based on your WorkPlace configuration. Key OTGServerID Value Unique ID to identify the OTG Server environment. If using multiple OTG servers that point to the same WorkPlace instance then this value should be the same on all OTG servers. An example of when this value would be different would be when multiple WorkPlace instances are being hosted which would be common when setting up a test environment to perform user acceptance testing on. What does this value actually do? This value is retrieved and stored on the mobile device when it connects to the OTGS, the mobile device always knows the last OTGS Page 8 of 11

9 Key OTGVersion WorkPlaceURL WorkPlaceADUserName WorkPlaceADPassword WorkPlaceADDmain Value it talked to. When the mobile device connects in the future it always compares the last OTGServerID with the one that is being reported to it when it connects. If the values are different then the mobile device will get a message indicating the change and upon acceptance the mobile device will have all its local records cleared out and full synchronization of WorkPlace data will be sent to it, essentially reinitializing the device. Version of the OTG server. This value is updated for each release. What does this value actually do? This value is similar to the OTGServerID whereas it is retrieved and stored on the mobile device every time it connects. During the connection when the mobile device detects a difference in this value from its previous value the OTGS will resend the mobile application code to do the device and restart the application which will position the user to the default mobile dashboard. This is typical for new OTGS upgrades where new modules and functionality have been added to the mobile applications. Note: This refresh will NOT remove any local data on the device. URL to access the WorkPlace application Active Directory User Name. This value is only necessary if WorkPlace is running under Active Directory/NT Authentication. Active Directory Password. This value is only necessary if WorkPlace is running under Active Directory/NT Authentication. Active Directory Domain. This value is only necessary if WorkPlace is running under Active Directory/NT Authentication. Page 9 of 11

10 Configuring WorkPlace for OTGS Access Step 5 Configure the WorkPlace Shared User Account To facilitate database access from the OTG server, WorkPlace utilizes the shared user configuration options of the web.config (see the WorkPlace Installation Guide for more details). If WorkPlace is already setup to use the Shared Account then no further setup is requires. The two WorkPlace authentication modes where the shared account would not be already setup would be the NT and SQL authentication modes. Step 6 Configure the WorkPlace Language User Access WorkPlace uses the Language User configuration that is setup in the web.config to return messages back to the mobile user. Setup Excerpt from the Language Section of the WorkPlace Installation Guide 1. Configure a SQL user account that will be used to access the Language Resource tables. 2. Set the Default Database of the SQL user account to be one of the companies that WorkPlace is installed against. This is important as the Default Database on the Language User Account tells WorkPlace where the Language Resource tables are. 3. Give the SQL user account permission to the PTIMaster and to the Company database. Within each of these databases give the user access to the PTIWorkPlaceLanguageAccess role. 4. Specify the SQL Language user name and password in the web.config <add key="languageusername" value="wplanguser"/> Page 10 of 11

11 <add key="languagepassword" 5. The default language used by WorkPlace can be specified in the Language section of the web.config. <add key="language" value="english"/> Finished Step 7 Configure Mobile Device After the OTGS is installed and configured the mobile device will be able to connect and access WorkPlace. Enter the OTGS URL in the Settings page of the WorkPlace Mobile application. Refer to the WorkPlace Mobile User Guide for more information in regards to mobile functionality, setup and configuration. Page 11 of 11