Microsoft Dynamics GP Web Client User Manual
广告
广告
Microsoft Dynamics
®
GP 2013
Web Client Installation and Administration Guide
Copyright
Limitation of liability
Intellectual property
Trademarks
Warranty disclaimer
License agreement
Copyright © 2012 Microsoft. All rights reserved.
This document is provided “as-is”. Information and views expressed in this document, including
URL and other Internet Web site references, may change without notice. You bear the risk of using it.
Some examples depicted herein are provided for illustration only and are fictitious. No real association or connection is intended or should be inferred.
This document does not provide you with any legal rights to any intellectual property in any
Microsoft product.
You may copy and use this document for your internal, reference purposes.
Microsoft, Dexterity, Excel, Internet Explorer, MapPoint, Microsoft Dynamics, Outlook,
SharePoint, Visual Studio, SQL Server, Windows, Windows Server, and Windows Vista are trademarks of the Microsoft group of companies. FairCom and c-tree Plus are trademarks of
FairCom Corporation and are registered in the United States and other countries.
All other trademarks are property of their respective owners.
Microsoft Corporation disclaims any warranty regarding the sample code contained in this documentation, including the warranties of merchantability and fitness for a particular purpose.
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
December 2012 -- Last updated December 10, 2012
Contents
Introduction
.................................................................................................................................................
2
Part 1: Getting started
..................................................................................................................
6
Chapter 1: Installation overview
............................................................................................
7
Chapter 2: Deployment configurations
.........................................................................
11
Chapter 3: Web client operation
..........................................................................................
13
Part 2: Back office server preparation
................................................................
20
Chapter 4: Microsoft Dynamics GP configuration
.............................................
21
Chapter 5: Security groups and user accounts
.....................................................
23
Part 3: Web server preparation
......................................................................................
26
Chapter 6: Prerequisite software
........................................................................................
27
Chapter 7: Web sites
.......................................................................................................................
29
Chapter 8: Security certificates and SSL
....................................................................
31
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N i
C O N T E N T S
Part 4: Web client installation
........................................................................................
40
Chapter 9: Single machine installation
.........................................................................
41
Chapter 10: Scale out installation
.....................................................................................
47
Part 5: Web client administration
..............................................................................
60
Chapter 11: Managing web client sessions
...............................................................
61
Chapter 12: Logging
67
Chapter 13: Repairing the web client
.............................................................................
69
Chapter 14: GP Web Resource Cache
.............................................................................
71
Chapter 15: Troubleshooting
...................................................................................................
75
ii W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C O N T E N T S
Part 6: Using the Web client
.............................................................................................
80
Chapter 16: Connecting to the web client
.................................................................
81
Chapter 17: Working with the web client
...................................................................
87
Appendix
......................................................................................................................................................
92
Appendix A: Importing a Self-signed Security Certificate
.........................
93
Glossary
.........................................................................................................................................................
97
Index
...................................................................................................................................................................
99
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N iii
iv W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Introduction
Use this manual to install the Microsoft Dynamics GP Web Client. This documentation explains how to install the web client in the most common configurations.
Check for current instructions
This information was current as of December 10, 2012. The documentation may be updated as new information becomes available. Check the Documentation
Resources for Microsoft Dynamics GP 2013 Web site http://go.microsoft.com/ fwlink/?LinkId=249465 for the most current documentation.
This introduction is divided into the following sections:
•
•
•
Send us your documentation comments
What’s in this manual
This manual provides step-by-step instructions for installing the Microsoft
Dynamics GP Web Client. It includes the following parts:
•
, provides an overview of the installation process and describes the supported deployment configurations.
•
Part 2, Back office server preparation , describes how to configure Microsoft
Dynamics GP and other back office server settings to prepare for the web client installation.
•
Part 3, Web server preparation , lists the prerequisite software you must install
on your web server and explains how to set up the web site that will host the web client.
•
Part 4, Web client installation , provides the steps you need to follow when
running the web client installer.
•
Part 5, Web client administration , contains information about administrative
tasks you will perform for the web client.
•
, provides information for end-users of the web client.
2 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
I N T R O D U C T I O N
Symbols and conventions
This documentation uses the following symbols and conventions to make specific types of information stand out.
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.
Convention Description
Creating a batch
TAB
or
ENTER
Italicized type indicates the name of a section or procedure.
File >> Print or File > Print 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.
Small capital letters indicate a key or a key sequence.
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: [email protected].
Note: By offering any suggestions to Microsoft, you give Microsoft full permission to use them freely.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 3
4 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Part 1: Getting started
This part of the documentation provides an overview of the installation process and describes the common deployment configurations. The following chapters are included:
•
Chapter 1, “Installation overview,” briefly describes the Microsoft Dynamics GP
web client and provides an installation checklist.
•
Chapter 2, “Deployment configurations,” describes the common deployment
configurations for the Microsoft Dynamics GP web client.
6 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 1: Installation overview
This chapter briefly describes the Microsoft Dynamics GP web client and introduces the major parts of the installation. It also provides an installation checklist.
The following sections are included:
•
•
•
What is the web client?
The Microsoft Dynamics GP web client provides access to Microsoft Dynamics GP through the Internet Explorer web browser. The user experience and functionality provided by the Microsoft Dynamics GP web client closely matches the experience of using the Microsoft Dynamics GP desktop client.
No client application software is installed on the user’s local system. The Microsoft
Dynamics GP application process for the user is running on a separate server. A
Silverlight 5 application running inside the web browser on the user’s computer presents the application.
The following illustration shows the Sales area page in the Microsoft Dynamics GP
Web Client.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 7
P A R T 1 G E T T I N G S T A R T E D
Parts of the web client
There are several parts of the web client installation that function together to present the web client to the user.
Web site
An Internet Information Services (IIS) web site is the main entry point for the
Microsoft Dynamics GP web client. This is the web site that users connect to when they access the web client. It displays the login page where users supply their credentials to access the system. The site must be configured to use Secure Sockets
Layer (SSL) to help ensure data security.
Session Hosts
The server machines that run the sessions of the Microsoft Dynamics GP web client are called session hosts. Each session host machine will have an installation of
Microsoft Dynamics GP.
Session Service
The Session Service that is running on each session host machine and manages the process that is created each time a user logs into the Microsoft Dynamics GP web client.
Session Central Service
The Session Central Service controls the communication between the web site and the session host machines. When multiple session host machines are available, the
Session Central Service will balance the processing load among the available machines.
Microsoft Dynamics GP Web Client runtime
The Microsoft Dynamics GP Web Client runtime is a component of the Microsoft
Dynamics GP installation. A web client runtime process is created by the Session
Service each time a user logs into the Microsoft Dynamics GP web client. Like the
Dynamics.exe process used by the desktop client, the web client runtime process accesses the business logic in the application dictionaries and the data in the SQL database. Instead of displaying the user interface in a Windows application, the web client runtime displays the user interface as a Silverlight application.
You may hear this component referred to as the Runtime Service.
Web Management Console
The Web Management Console is a separate Silverlight application that is used to perform administrative tasks for the Microsoft Dynamics GP web client. These tasks include actions like removing abandoned web client sessions.
8 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 I N S T A L L A T I O N O V E R V I E W
Installation checklist
To install the Microsoft Dynamics GP web client, complete the following tasks in the order shown.
Task For more information, see...
1. Select a deployment configuration.
Select whether you want to install the Microsoft
Dynamics GP web client on a single machine or as a scale-out installation.
2. Check the Microsoft Dynamics GP installation.
Verify that the Microsoft Dynamics GP installation is running properly and that the required web client runtime components are installed.
Chapter 2, “Deployment configurations”
Chapter 4, “Microsoft Dynamics GP configuration”
3. Create the security groups and user accounts.
Determine which users will access the Microsoft
Dynamics GP web client and the Web
Management Console.
4. Verify the prerequisite software.
Install the software needed to support the
Microsoft Dynamics GP web client.
Chapter 5, “Security groups and user accounts”
Chapter 6, “Prerequisite software”
5. Create and configure web sites.
Create and configure the web sites that will host the Microsoft Dynamics GP web client and the
Web Management Console.
Chapter 8, “Security certificates and SSL”
6. Obtain security certificates and configure SSL.
Determine the type of security certificate you want to use. Configure the web site to use SSL.
7. Install the web client.
Complete the installation procedure based on the type of deployment that you chose.
Part 4, Web client installation
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 9
10 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 2: Deployment configurations
There are three common deployment configurations for the Microsoft Dynamics GP web client. This chapter discusses these configurations. It is divided into the following sections:
•
•
•
Single machine
The single machine configuration is the simplest configuration to use when deploying the Microsoft Dynamics GP web client. In this configuration, the web site, Session Central Service, Session Service, and Microsoft Dynamics GP web client runtime are all installed on a single server machine.
A typical single machine configuration is shown in the following illustration.
Local Network
Web Server
+
Web Site
Session Central Service
Session Service
Dynamics GP with Web Client runtime
SQL Server with
Microsoft Dynamics GP Data
This configuration is used when the number of users accessing the system is low. It is also commonly used by developers who are creating and testing integrations for the Microsoft Dynamics GP web client.
One limitation of the single machine configuration is that there is no redundancy. If the server machine is down, such as when installing an update, no web client users will be able to access Microsoft Dynamics GP.
Scale out
The scale out configuration is used when an organization has a larger number of users that will be accessing the Microsoft Dynamics GP web client. In this configuration, one server contains the web site and the Session Central Service. Two or more session host machines each contain the Session Service and the Microsoft
Dynamics GP web client runtime. The Session Central Service balances the processing load among the session host machines.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 11
P A R T 1 G E T T I N G S T A R T E D
A typical scale out configuration is shown in the following illustration.
Session Service
Dynamics GP with
Web Client runtime
Web Server
+
Web Site
Session Central Service
SQL Server with
Microsoft Dynamics GP Data
Session Service
Dynamics GP with
Web Client runtime
The scale out configuration has some redundancy. If one of the session host machines must be taken out of service, such as when installing an update, the other session host machines will continue supporting web client users.
Multi-tenant
The multi-tenant configuration is typically used by organizations that host
Microsoft Dynamics GP for other customers. This configuration can support a large number of users. This configuration has the following characteristics:
• There are multiple front-end web servers that are each running the Session
Central Service. These web servers may be load-balanced.
• Multiple session host machines host the sessions of the Microsoft Dynamics GP web client. Each of these session host machines contains the Session Service and the Microsoft Dynamics GP web client runtime.
• The Tenant Service is used with this configuration to allow multiple Microsoft
Dynamics GP installations to be run on the same physical server.
The multi-tenant configuration has the best redundancy of any of the typical
Microsoft Dynamics GP web client configurations. In addition to multiple session host machines, having multiple front-end web servers can allow web client users to access the system even when one of the web servers is unavailable.
This is a more complex configuration and is not covered in this documentation.
12 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 3: Web client operation
It is important to understand how all of the components of the Microsoft Dynamics
GP web client installation work together as a user logs in, performs standard operations, and logs out of the web client. This information can be helpful when you are troubleshooting any issues with the web client. The following topics are discussed:
•
•
•
Logon
The logon process has multiple steps, although most of them are not visible to the web client user. For simplicity, the log on process for a typical scale out configuration is described. The parts of the configuration are shown in the following illustration.
Session Server 1
Client Machine with
Web Browser
Web Server
+
Session Central Service
SQL Server
Session Server 2
1. User accesses the web client site.
In the first step of the logon process, the client machine with a web browser accesses the URL for the Microsoft Dynamics GP web client site. The logon page for the site is displayed.
1
Client Machine with
Web Browser
Web Server
+
Session Central Service
Session Server 1
Session Server 2
SQL Server
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 13
P A R T 1 G E T T I N G S T A R T E D
2. The user supplies their windows account credentials.
Typically, these will be their domain credentials. If the web site can verify that the user is allowed to access the Microsoft Dynamics GP web client, the logon process is allowed to proceed.
2
Session Server 1
Client Machine with
Web Browser
Web Server
+
Session Central Service
SQL Server
Session Server 2
3. The Session Central Service directs the session request.
Session information for the current user is retrieved.
3
Session Server 1
Client Machine with
Web Browser
Web Server
+
Session Central Service
SQL Server
Session Server 2
The session Central Service performs several action to determine how it will direct the user’s request.
• It will determine whether the user has existing sessions already running on the session host machines. If one or more sessions exist, they are presented in a list for the user. The user can re-connect to an existing session, or create a new session.
• If no previous sessions exist, the Session Central Service will determine on which session host machine the new session will be created.
14 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 3 W E B C L I E N T O P E R A T I O N
4. The Silverlight application is loaded into the browser.
The web site retrieves the Silverlight application (.xap file) from the session server machine that will be hosting the Microsoft Dynamics GP web client session. A page containing the Silverlight application is loaded into web browser on the client machine.
4
Session Server 1
Client Machine with
Web Browser
Web Server
+
Session Central Service
SQL Server
Session Server 2
5. The Session Service creates a new runtime session.
On the session host machine that was chosen by the Session Central Service, the
Session Service will create a new instance of the runtime service. This is the process that accesses the business logic in the application dictionaries and the data in the SQL database. It also communicates with the Silverlight application to display the client user interface.
5
Session Server 1
Client Machine with
Web Browser
Web Server
+
Session Central Service
SQL Server
Session Server 2
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 15
P A R T 1 G E T T I N G S T A R T E D
6. The Microsoft Dynamics GP login window is displayed.
After the connection is established between the Silverlight application on the client and the runtime session on the session server machine, the Microsoft
Dynamics GP application will start, and the login window will be displayed.
6
Session Server 1
Client Machine with
Web Browser
Web Server
+
Session Central Service
SQL Server
Session Server 2
Standard operations
When a user logs on to the Microsoft Dynamics GP web client, a connection is created between the Silverlight application that is loaded in the web browser and the runtime session that is created on the session host server. After this connection is established, the web server that hosts the site for the Microsoft Dynamics GP web client does not play any part in the interaction.
Session Server 1
Client Machine with
Web Browser
Web Server
+
Session Central Service
SQL Server
Session Server 2
The connection between the Silverlight application and the runtime session transmits all of the information needed to present the application user interface, as well as any input supplied by the user. The runtime session on the session server machine interacts with the SQL Server database, just as the Microsoft Dynamics GP desktop client would.
16 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 3 W E B C L I E N T O P E R A T I O N
If the user is disconnected, such as by closing their web browser without logging out of Microsoft Dynamics GP, the runtime session on the session server machine will remain running. The next time the user logs in, that existing runtime session will be found by the Session Central Service. The user will have the option to reconnect to that existing session, and continue where they left off.
Logoff
When the user clicks the Sign Out link in the upper-right corner of the Microsoft
Dynamics GP web client window, the standard Microsoft Dynamics GP logoff procedure is performed. The connections between the runtime session and the SQL
Server are closed, and the runtime session is ended. The user is returned to the main logon screen for the Microsoft Dynamics GP web client site.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 17
18 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Part 2: Back office server preparation
This portion of the documentation helps you configure Microsoft Dynamics GP and create the security groups and user accounts needed for the web client installation.
The following chapters are included:
•
Chapter 4, “Microsoft Dynamics GP configuration,” explains how to configure
the Microsoft Dynamics GP installation to support the web client.
•
Chapter 5, “Security groups and user accounts,” describes how to set up the
security groups and user accounts needed for the web client.
20 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 4: Microsoft Dynamics GP configuration
Before you can install the Microsoft Dynamics GP web client, you must have
Microsoft Dynamics GP installed, including the necessary web client runtime components. The following sections provide the details:
•
Microsoft Dynamics GP installation
•
•
Microsoft Dynamics GP installation
Microsoft Dynamics GP should be installed, configured, and operating properly before you install any components for the Microsoft Dynamics GP web client. While most administrative tasks can be performed with the web client, some important tasks such as creating companies cannot. These actions must be done with the
Microsoft Dynamics GP desktop client and GP Utilities.
Each server that will be acting as a session host must have a Microsoft Dynamics GP desktop client installation installed. Use the desktop client to verify that the server is able to connect to the Microsoft Dynamics GP database.
Web client runtime components
Each session host server must have the Microsoft Dynamics GP web client runtime components. These components are part of the Microsoft Dynamics GP installation.
To install these components, complete the following procedure:
To install the web client runtime components
1.
Open the Programs and Features control panel.
2.
Select the Microsoft Dynamics GP 2013 application, and then click Change.
3.
In the Program Maintenance window, click Add/Remove Features.
4.
Be sure that the Web Client Runtime feature is marked to be installed.
5.
Click Next to continue, and then click Install to complete the installation process.
6.
Click Exit.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 21
P A R T 2 B A C K O F F I C E S E R V E R P R E P A R A T I O N
Printing setup
To enable printing from the Microsoft Dynamics GP web client, a Default System
Printer must be configured for Microsoft Dynamics GP on the session host machine.
This procedure must be performed in the Microsoft Dynamics GP installation for each session host machine.
Complete the following procedure to enable printing for the session host machine.
1.
Open the Devices and Printers control panel.
2.
Specify the printer to use as the default printer on the machine. Web client users will not send output to this printer. Instead, the information about the default printer will be used by the web client during the printing process. Follow these guidelines when choosing a printer:
• Choose a standard printer like one that you would use in a typical
Microsoft Dynamics GP installation.
• Avoid choosing special printers, such as the Microsoft XPS Document
Writer.
• Don’t choose any redirected printer that was created through a Remote
Desktop connection.
3.
Start the Microsoft Dynamics GP desktop client on the session host machine.
4.
Choose Administration >> Setup >> System >> Named Printers.
5.
If the Named Printer Options window is displayed, supply a Machine ID for the session host machine, and then click OK.
6.
You will be prompted to set up the default printer. Choose the same printer that you selected in step 2.
7.
In the Setup Named Printers window, you can supply an optional description in the Extra Description field. Click Assign, and then choose to save your changes.
8.
The Assign Named Printers window will list the Default System Printer that you just created. Click OK.
22 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 5: Security groups and user accounts
To properly secure the Microsoft Dynamics GP web client installation, some security groups and specific user accounts are required. Information is divided into the following sections:
•
•
Security groups
Security groups are used to control which users are allowed to access the Microsoft
Dynamics GP web client and the Web Management Console. These security groups can be machine groups (for the single machine configuration) or domain groups.The domain groups must be security groups, not distribution groups.
Typically, you should create one security group for the Microsoft Dynamics GP web client, and another security group for the Web Management Console. You can add individual users to these groups. If you have a more complex installation with a large number of users, you may want to create additional groups that you add users to.
User accounts
Several user accounts are needed to run the web site and services that are part of the
Microsoft Dynamics GP web client installation. For the single-server installation, these are typically machine accounts. For the multiple-server installation, these are typically domain accounts. Ideally, these user accounts should have limited privileges, and a password that does not expire. You may want to use the same account for multiple components of the configuration.
For the Microsoft Dynamics GP Web Client beta release, these user accounts must also be in the Administrators group for the machine where the web client components are installed.
Create the user accounts before you start installing the Microsoft Dynamics GP web client. You must have user accounts for the following:
GP Web Client site application pool
This is the user account that runs the application pool for the web site that hosts the
Microsoft Dynamics GP web client.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 23
Web Management Console application pool
This is the user account that runs the application pool for the web site that hosts the
Web Management Console.
Session Central Service
This is the user account that runs the Session Central Service.
Session Service
This is the user account that runs the Session Service on each session host machine.
24 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Part 3: Web server preparation
This portion of the documentation explains how to configure the web server that is used for the Microsoft Dynamics GP web client installation. The following chapters are included:
•
Chapter 6, “Prerequisite software,”
describes the software needed for the web server.
•
Chapter 7, “Web sites,” explains the web sites that are needed to host the
Microsoft Dynamics GP web client and the Web Management Console.
•
Chapter 8, “Security certificates and SSL,”
discusses security certificates and how to use them to set up secure sockets layer (SSL) for the web client site.
26 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 6: Prerequisite software
Before you can install the Microsoft Dynamics GP web client, you must install other software on the web server and the session host servers. The following sections describe these software prerequisites:
•
•
Internet Information Services (IIS) and ASP.NET
Server operating system
To install the Microsoft Dynamics GP web client, the web server and the session host servers must be running one of the following operating systems:
• Microsoft Windows Server 2008 R2
• Microsoft Windows Server 2012
You cannot install any of the Microsoft Dynamics GP web client components on a server that is also being used as a domain controller.
Internet Information Services (IIS) and ASP.NET
Internet Information Services (IIS) and ASP.NET must be installed on the web server on which you will be installing the Microsoft Dynamics GP web client.
Windows Server 2008 R2
To install these items, complete the following steps for Windows Server 2008 R2:
1.
Open the Server Manager.
2.
Click Roles.
3.
Choose Add Roles. In the Add Roles Wizard, click Next.
4.
Mark Web Server (IIS) and then click Next.
5.
At the Introduction screen, click Next.
6.
Select the role services to install. Be sure that you mark ASP.NET. Also be sure to mark Windows Authentication in the Security group. Click Next.
7.
Click Install. The roles and role services will be added.
8.
After the installation is complete, click Close.
Windows Server 2012
To install these items, complete the following steps for Windows Server 2012:
1.
Open the Server Manager.
2.
Click Manage >> Add Roles and Features.
3.
An the Add Roles and Features Wizard, click Next.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 27
P A R T 3 W E B S E R V E R P R E P A R A T I O N
4.
Choose Role-based or feature-based installation, and then click Next.
5.
Select your server from the server pool, and then click Next.
6.
Mark Web Server (IIS) and then click Next.
7.
Select the features to install. Be sure that you mark ASP.NET 4.5. In the WCF
Services
group under .NET Framework 4.5 Features, be sure that you have marked HTTP Activation.
Click Next.
8.
The screen for the Web Server Role (IIS) is displayed. Click Next.
9.
Mark Windows Authentication in the Security group. Click Next.
10. Click Install. The roles, features, and role services will be added.
11. After the installation is complete, click Close.
28 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 7: Web sites
This portion of the documentation discusses the web sites that are needed for the
Microsoft Dynamics GP web client installation. Information is divided into the following sections:
•
•
Required web sites
Two web sites are used for the Microsoft Dynamics GP web client installation. These two web sites can be hosted in a single IIS web site, or on separate IIS web sites.
The IIS web sites must be configured for SSL (secure sockets layer). This means each must have a security certificate. If you use two separate IIS web sites, then you will need two security certificates. If both both web sites are hosted on the same web site, then only one security certificate is required.
Dynamics GP Web Client site
This web site hosts the Microsoft Dynamics GP web client. It is the web site that the users connect to with their web browser when they log into the Microsoft Dynamics
GP web client. You can use the default web site in IIS (port 80) or you can create a new web site that runs on a different port.
Web Management Console site
This site hosts the Web Management Console that is used to manage the Microsoft
Dynamics GP web client installation. In basic web client installations, you can use the same web site that the Microsoft Dynamics GP web client is installed on.
Extending sites with ASP.NET
On Windows Server 2008 R2, the web sites that you use for the Microsoft Dynamics
GP web client must be extended with ASP.NET functionality. This step is not necessary on Windows Server 2012, because the sites will already have been extended with .NET Framework 4.
To extend the web site, complete the following procedure:
1.
Open a command prompt with administrative privileges.
2.
Set the current directory to this location:
C:\Windows\Microsoft.NET\Framework64\v4.0.30319\
3.
Run this command: aspnet_regiis -i
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 29
30 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 8: Security certificates and SSL
Security certificates and secure sockets layer (SSL) are used to help improve the security of the data being transmitted by the Microsoft Dynamics GP web client.
The web site that hosts the web client must be configured to use SSL. The runtime service must be configured to use a security certificate. Optionally, the Session
Central Service and Session Service can be configured to use a security certificate to improve their security.
Information about security certificates is divided into the following sections:
•
Security certificate requirements
•
Externally signed security certificates
•
Using an externally signed security certificate for a web site
•
Self-signed security certificates
•
Configuring the web site to use SSL
•
Installing a security certificate on a server
Security certificate requirements
The security certificates that you use for your Microsoft Dynamics GP web client installation must meet some requirements to work properly.
Certificate purpose
To be used for the Microsoft Dynamics GP web client, the security certificate must have “Server Authentication” listed as one of its intended purposes. You can use the
Certificates snap-in for the Microsoft Management Console to view the Intended
Purpose column for the certificate.
Private key
It’s essential that the security certificate that you are using for the runtime service has a private key. This allows the security certificate to be bound to the port that is being used for the runtime service.
To verify that a security certificate has a private key, you can view the details of the the certificate file. At the bottom of the details, you should see that the certificate has a private key. If it does not, then the security certificate cannot be used for the runtime service.
The security certificate must have a private key in order to be bound to the runtime service port.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 31
P A R T 3 W E B S E R V E R P R E P A R A T I O N
Externally signed security certificates
Externally signed security certificates are the easiest way to implement SSL for the
Microsoft Dynamics GP web client. They must be purchased from the third-party supplier. Due to the additional cost, externally signed security certificates are typically used in a production environments.
There are three basic types of externally signed security certificates:
Single domain
This type of security certificate is issued for a specific machine.
For example you could get a security certificate issued for the machine with the following name:
•
GPweb.contoso.com
.
You would typically use this type of certificate when installing the Microsoft
Dynamics GP web client in a single machine configuration. This is the leastexpensive type of certificate to purchase.
Multiple domain
This type of security certificate is issued for a set of specific machines. You must know the machine names at the time that you are purchasing the security certificate. For example, you could get a security certificate issued that could be used for machines with the following names:
• GPweb.contoso.com
• ServiceHost1.contoso.com
• ServiceHost2.contoso.com
• ServiceHost3.contoso.com
You would typically use the multiple domain certificate when installing the
Microsoft Dynamics GP web client in a scale out configuration. The certificate would contain entries for each of the machines that will be part of your web client installation. This security certificate is more expensive, because the same certificate can be used on multiple machines.
Wildcard
This type of security certificate is not issued for specific machines.
Instead, it is issued for a specific domain. The security certificate can be used for any machines that follow the naming convention for the domain. For example, if you purchased a wildcard certificate for the *.contoso.com domain, any machine in that domain (such as GPweb.contoso.com) could use the wildcard certificate.
You would typically use the wildcard certificate when installing the Microsoft
Dynamics GP web client in the scale out configuration. The wildcard certificate is especially useful when you expect to add additional machines to the configuration, but do not know their names at the time you are purchasing the certificate. The extra flexibility does come with a cost. Wildcard certificates are the most expensive externally signed security certificates.
32 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 8 S E C U R I T Y C E R T I F I C A T E S A N D S S L
Using an externally signed security certificate for a web site
When an externally signed security certificate is used for a web site, the third-party certificate authority handles the certificate validation when users connect to the web client site. No additional action is needed by the Microsoft Dynamics GP web client users.
To use an externally signed security certificate
1.
Obtain the security certificate (.cer or .pfx) file from the third-party certificate supplier.
2.
In Administrative Tools on the web server system, open Internet Information
Services (IIS) Manager.
3.
In the left pane, select the computer name.
4.
In the IIS group, open Server Certificates.
Select the computer name and then open
Server Certificates.
5.
Install the certificate, based on the type of file that has been provided:
• If your certificate has been provided as a .cer file, complete these actions. In the Actions pane, click Complete Certificate Request. Select the certificate
(.cer) file that you obtained from the third-party certificate supplier. In the
Friendly name
field, enter the name that will be displayed for the certificate. Click OK.
• If your certificate has been provided a .pfx file, complete these actions. In the Actions pane, click Import. Select the certificate (.pfx) file that you obtained from the third-party certificate supplier. Enter the password for the security certificate. Click OK.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 33
P A R T 3 W E B S E R V E R P R E P A R A T I O N
Self-signed security certificates
Self-signed security certificates are the least expensive way to implement SSL for the Microsoft Dynamics GP web client. You can generate these security certificates from within IIS Manager. They are typically used when you are setting up a
Microsoft Dynamics GP web client installation for testing or development purposes.
Self-signed security certifcates have some limitations. You must use the default subject alternative name (SAN) that is assigned when the security certificate is created. Self-signed security certificates have a limited lifespan, typically one year.
When you use a self-signed security certificate, there is no external authority to handle the certificate validation when users connect to the web client site. Because of this, a certificate error will be displayed when users access the Microsoft
Dynamics GP web client site. To prevent the certificate error, users must import the security certificate onto their own machine. Refer to
certificate.
To use a self-signed security certificate
1.
In Administrative Tools on the web server system, open Internet Information
Services (IIS) Manager.
2.
In the left pane, select the computer name.
3.
In the IIS group, open Server Certificates.
Select the computer name and then open
Server Certificates.
4.
In the Actions pane, click Create Self-Signed Certificate.
5.
Supply the friendly name for the security certificate.
6.
Click OK. The security certificate will be created.
34 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 8 S E C U R I T Y C E R T I F I C A T E S A N D S S L
Configuring the web site to use SSL
The web site used for the Microsoft Dynamics GP web client must be configured to use SSL. Before configuring the web site, be sure that you have imported an externally signed security certificate or have created a self-signed security certificate.
To configure the web site for SSL
1.
In Administrative Tools on the web server system, open Internet Information
Services (IIS) Manager.
2.
In the left pane, expand the Sites group. Within the Sites group, select the site that you are configuring to use SSL. For example, select the Default Web Site.
3.
In the Actions pane, click Bindings.
4.
In the Site Binding window, click Add.
5.
In the Add Site Bindings window, select https for the type, and then choose an
SSL certificate that you installed.
Click OK.
6.
Click Close.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 35
P A R T 3 W E B S E R V E R P R E P A R A T I O N
Installing a security certificate on a server
If you are setting up the scale out configuration for the Microsoft Dynamics GP web client installation, the session host machines must have a security certificate that can be used when configuring the runtime session. If you are using an externally signed security certificate, you will need to install the security certificate onto each session host machine so that the certificate is available to be used.
To install a security certificate
1.
On the computer that will be used as a session host, open the Run prompt.
(Choose Start > Run or press Window-R)
2.
In the Open field, type MMC and then click OK.
3.
In the Microsoft Management Console, open the File menu and choose Add/
Remove Snap-in
.
4.
In the Add or Remove Snap-ins window, choose the Certificates snap-in from the Available snap-ins list, and then click Add.
5.
In the Certificates snap-in dialog box, choose Computer account and then click
Next
.
6.
In the Select Computer dialog box, choose Local computer and then click
Finish
.
7.
In the Add or Remove Snap-ins window, click OK.
8.
In the left pane, expand the Certificates (Local Computer) node, and then expand the Personal node.
9.
Under Personal, right-click the Certificates node, point to All Tasks, and then click Import.
10. In the Certificate Import Wizard welcome screen, click Next.
36 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 8 S E C U R I T Y C E R T I F I C A T E S A N D S S L
11. In the File to Import screen, click Browse.
12. Browse to the location of the security certificate that you want to use. Typically, this will be a file with a .pfx extension, because the certificate contains a private key. Select the file and click Open. Click Next to continue.
13. Enter the password for the certificate. This is the private key password that was either provided with the certificate, or that you defined when you exported the certificate for use on another machine. Be sure that you mark the Include all
extended properties
box. Click Next to continue.
14. In the Certificate Store screen, verify that the certificate is being added to the
Personal store. Click Next.
15. Click Finish to complete the import process.
16. Close the Microsoft Management Console window.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 37
38 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Part 4: Web client installation
This part of the documentation explains how to use the Microsoft Dynamics GP web client installer to deploy the web client. The following chapters are included:
•
Chapter 9, “Single machine installation,” provides step-by-step instructions for
installing the Microsoft Dynamics GP web client on a single server.
•
Chapter 10, “Scale out installation,” provides step-by-step instructions for
installing the Microsoft Dynamics GP web client in a scale-out configuration.
40 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 9: Single machine installation
This chapter contains the procedures you need to follow to install and verify the
Microsoft Dynamics GP web client on a single machine installation.
The following sections are included:
•
•
Install the web client
Use the following steps to install the Microsoft Dynamics GP web client on a single machine.
1.
From the Microsoft Dynamics GP installation media, double-click the Setup.exe file to open the Microsoft Dynamics GP installation window.
2.
Click Web Client and then click Install.
3.
In the License Agreement window, read the terms and conditions. Select I
accept the terms in the License Agreement
. Click Next.
4.
Click Single Machine to perform a single machine installation.
5.
Configure the Session Central Service.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 41
P A R T 4 W E B C L I E N T I N S T A L L A T I O N
Specify the Port (the default is 48650). Optionally, you can specify the security certificate that you want to use. You can use the same certificate that you are using for the Microsoft Dynamics GP web client site.
Supply the credentials for the user account that will be running the Session
Central Service.
Click Next to continue.
6.
Specify the SQL Server that will manage the Session Central database. You must supply credentials that allow you to connect to the SQL Server and create the database.
If the user installing the Microsoft Dynamics GP web client has sufficient privileges, you can use Windows Trusted Authentication. Otherwise, you should use SQL Authentication and supply a SQL Login ID and Password for a
SQL user account with sufficient privileges.
Click Next to continue.
7.
Supply the names of the Windows security groups that specify which users can access the Microsoft Dynamics GP web client and which users can access the
Web Management Console.
For machine groups, the name must be prefixed by the machine name. For domain groups, the name must be prefixed by the domain name.
Click Next to continue.
42 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 9 S I N G L E M A C H I N E I N S T A L L A T I O N
8.
Select the web site that will host the Microsoft Dynamics GP web client. This site must have been configured to use secure sockets layer (SSL).
Specify the user account that will run the application pool for the Microsoft
Dynamics GP web client.
Decide whether the same web site will be used to host the Web Management
Console. If you do not mark the option to use the same site, you will be prompted to select the web site and provide credentials to run the application pool for the site.
Click Next to continue.
9.
Specify the SQL Server that will manage the information for the Web
Management Console. You must supply credentials that allow you to connect to the SQL Server and create the database.
If the user installing the Microsoft Dynamics GP web client has sufficient privileges, you can use Windows Trusted Authentication. Otherwise, you should use SQL Authentication and supply a SQL Login ID and Password for a
SQL user account with sufficient privileges.
Click Next to continue.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 43
P A R T 4 W E B C L I E N T I N S T A L L A T I O N
10. Configure the Session Service.
Specify the Port (the default is 48651). Optionally, you can specify the security certificate that you want to use. You can use the same certificate that you are using for the Microsoft Dynamics GP web client site.
Supply the credentials for the user account that will be running the Session
Service.
Click Next to continue.
11. Configure the Runtime Service URL.
Specify the Port (the default is 48652).
Specify the security certificate to use. This is required for the runtime service.
You can use the same certificate that you are using for the Microsoft Dynamics
GP web client site.
Verify the host name. The host name must match the common name (CN) or the subject alternative name (SAN) on the security certificate.
Click Next to continue.
12. Review the installation settings and then click Install.
13. Click Exit. The Web Client Configuration Wizard will start.
14. At the Welcome screen, click Next.
44 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 9 S I N G L E M A C H I N E I N S T A L L A T I O N
15. Specify the type of authentication you want to use to connect to the SQL Server where the database for the Web Management Console will be created. Click
Next
to continue.
16. Specify the type of authentication you want to use to connect to the SQL Server where the database for the Session Central service will be created. Click Next to continue.
17. If necessary, verify that the databases will be created. Click Next to continue.
18. Click Exit.
Verify the installation
After the Microsoft Dynamics GP web client installation is complete, verify that you can access the web client.
1.
Open Internet Explorer.
2.
Enter the URL of the Microsoft Dynamics GP web client site. The default address of the site is: https://ServerName:PortNumber/GP
ServerName is the fully-qualified domain name (FQDN) for the server that is hosting the web site. This name must match the name you used when you requested the security certificate that you applied to the site when setting up
SSL.
PortNumber is the port for the web site that you are using. If you chose to install on the default web site (port 80) then you do not need to supply the port number.
A typical URL to access the Microsoft Dynamics GP web client looks similar to the following: https://gpuaweb.contoso.com/GP
3.
After entering the URL, you will be directed to the logon page. This is the first page that will be displayed to users who are accessing the Microsoft Dynamics
GP web client.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 45
P A R T 4 W E B C L I E N T I N S T A L L A T I O N
If you are using a self-signed security certificate, and are accessing the Microsoft
Dynamics GP web client from another computer, you will see a certificate error.
To resolve this error, you must import the security certificate into the certificate store on the machine that is accessing the web client.
4.
Enter your user credentials. These are domain user credentials or machine user credentials for a user that is part of the security group you created to control access to the Microsoft Dynamics GP web client. This security group is described in
Chapter 5, “Security groups and user accounts.” These are not your
Microsoft Dynamics GP login name and password.
Click Sign In.
5.
A session will be created, and the standard Microsoft Dynamics GP login window will be displayed.
6.
Log in with your Microsoft Dynamics GP login name and password.
46 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 10: Scale out installation
This chapter contains the procedures you need to follow to install and verify the
Microsoft Dynamics GP web client in the scale out configuration.
The following sections are included:
•
•
Install the session host machines
•
Install the web server
Use the following procedure to install components on the web server machine.
1.
From the Microsoft Dynamics GP installation media, double-click the Setup.exe file to open the Microsoft Dynamics GP installation window.
2.
Click Web Client and then click Install.
3.
In the License Agreement window, read the terms and conditions. Select I
accept the terms in the License Agreement
. Click Next.
4.
Click Custom.
5.
Select the features that you want to install. On the web server machine, you will typically install the Web Server, Session Central, Web Site, and the Web
Management Console.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 47
If you are using the Tenant Service, you should mark the Tenant Manager snapin as well. Use the default location for the installed components, or choose a different location.
Click Next to continue.
6.
Configure the Session Central Service.
Specify the Port (the default is 48650). Optionally, you can specify the security certificate that you want to use. You can use the same certificate that you are using for the Microsoft Dynamics GP web client site.
Supply the credentials for the user account that will be running the Session
Central Service.
Click Next to continue.
7.
Specify the SQL Server that will manage the Session Central database. You must supply credentials that allow you to connect to the SQL Server and create the database.
If the user installing the Microsoft Dynamics GP web client has sufficient privileges, you can use Windows Trusted Authentication. Otherwise, you should use SQL Authentication and supply a SQL Login ID and Password for a
SQL user account with sufficient privileges.
Click Next to continue.
48 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 0 S C A L E O U T I N S T A L L A T I O N
8.
Supply the names of the Windows security groups that specify which users can access the Microsoft Dynamics GP web client and which users can access the
Web Management Console.
For machine groups, the name must be prefixed by the machine name. For domain groups, the name must be prefixed by the domain name.
Click Next to continue.
9.
Indicate whether you are using a multitenant configuration. If you are installing the web client for a stand-alone instance of Microsoft Dynamics GP, simply click
Next
.
If you are installing the Microsoft Dynamics GP web client for a multitenant configuration, choose Deploy for multiple tenants. Supply the URLs for the
Tenant Discovery Service and the Tenant Management Service. Click Next.
Refer to the Tenant Installation and Administration Guide for complete details about deploying Microsoft Dynamics GP web client in a multitenant configuration.
10. Provide the details of the Microsoft Dynamics GP configuration. If you are not deploying for a multitenant configuration, you must specify the location of the
Microsoft Dynamics GP runtime, the Dynamics.set file, and the Dex.ini file for the Microsoft Dynamics GP installation on each session host machine.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 49
P A R T 4 W E B C L I E N T I N S T A L L A T I O N
The default locations for these files are supplied. The locations must be the same on each session host machine. After you have supplied the locations, click
Next
to continue.
11. Select the web site that will host the Microsoft Dynamics GP web client. This site must have been configured to use secure sockets layer (SSL).
Specify the user account that will run the application pool for the Microsoft
Dynamics GP web client.
Decide whether the same web site will be used to host the Web Management
Console. If you do not mark the option to use the same site, you will be prompted to select the web site and provide credentials to run the application pool for the site.
Click Next to continue.
12. Specify the web server farm configuration.
If you are installing the web site onto only a single web server, simply click
Next
to continue.
If you are installing the web client site on multiple web servers in a load balanced configuration, choose Deploy on multiple web servers. Specify the
SQL Server that will manage the Web Client Session State database. You must supply credentials that allow you to connect to the SQL Server and create the database.
If the user installing the Microsoft Dynamics GP web client has sufficient privileges, you can use Windows Trusted Authentication. Otherwise, you should use SQL Authentication and supply a SQL Login ID and Password for a
SQL user account with sufficient privileges.
Click Next to continue.
13. Specify the SQL Server that will manage the information for the Web
Management Console. You must supply credentials that allow you to connect to the SQL Server and create the database.
50 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 0 S C A L E O U T I N S T A L L A T I O N
If the user installing the Microsoft Dynamics GP web client has sufficient privileges, you can use Windows Trusted Authentication. Otherwise, you should use SQL Authentication and supply a SQL Login ID and Password for a
SQL user account with sufficient privileges.
Click Next to continue.
14. Review the installation settings and then click Install.
15. Click Exit. The Web Client Configuration Wizard will start.
16. At the Welcome screen, click Next.
17. Specify the type of authentication you want to use to connect to the SQL Server that will be managing a configuration database for the web client. Click Next to continue.
Repeat this process for each database that is required for the configuration options you have specified.
18. If necessary, verify that the databases will be created. Click Next to continue.
19. Click Exit.
Install the session host machines
It is assumed that you have installed a Microsoft Dynamics GP desktop client onto the session host machine, and that the desktop client is able to log in to Microsoft
Dynamics GP. The following prerequsites must have been completed:
• The web client runtime components for the Microsoft Dynamics GP installation must also have been installed on the session host machine. Refer to
on page 21 for more information.
• It is also assumed that you have installed the security certificate on each session
Installing a security certificate on a server
Use the following procedure to install components on each session host machine.
You will repeat this process for each session host machine that you add to the web client installation.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 51
P A R T 4 W E B C L I E N T I N S T A L L A T I O N
1.
From the Microsoft Dynamics GP installation media, double-click the Setup.exe file to open the Microsoft Dynamics GP installation window.
2.
Click Web Client and then click Install.
3.
In the License Agreement window, read the terms and conditions. Select I
accept the terms in the License Agreement
. Click Next.
4.
Click Custom.
5.
Select the Session Server feature.
Specify the location where you want to install the web client files.
If you don’t install to the default location, pay attention to the path length you specify for the install location. If the path length exceed 100 characters, you may get application errors, such as not being able to re-open forms in the web client.
Click Next.
52 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 0 S C A L E O U T I N S T A L L A T I O N
6.
Specify the SQL Server that is managing the Session Central database. You must supply credentials that allow you to connect to the SQL Server and access this database.
If the user installing the Microsoft Dynamics GP web client has sufficient privileges, you can use Windows Trusted Authentication. Otherwise, you should use SQL Authentication and supply a SQL Login ID and Password for a
SQL user account with sufficient privileges.
Click Next to continue.
7.
Supply the name of the Windows security group that specifies which users can access the Microsoft Dynamics GP web client. For machine groups, the name must be prefixed by the machine name. For domain groups, the name must be prefixed by the domain name.
Click Next to continue.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 53
P A R T 4 W E B C L I E N T I N S T A L L A T I O N
8.
Configure the Session Service.
Specify the Port (the default is 48651). Optionally, you can specify the security certificate that you want to use. You can use the same certificate that you installed onto the server to use for the runtime service.
Supply the credentials for the user account that will be running the Session
Service.
Click Next to continue.
9.
Configure the Runtime Service URL.
Specify the Port (the default is 48652).
Specify the security certificate to use. This is required for the runtime service.
You can use the certificate that you installed on the session host machine.
Verify the host name. The host name must match the common name (CN) or the subject alternative name (SAN) on the security certificate. If you are using a wildcard certificate, you must supply the full name you want to use.
Click Next to continue.
10. Review the installation settings and then click Install.
11. Click Exit. The Web Client Configuration Wizard will start.
54 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 0 S C A L E O U T I N S T A L L A T I O N
12. At the Welcome screen, click Next.
13. Specify the type of authentication you want to use to connect to the SQL Server where the database for the Session Central Service database is located. Click
Next
to continue.
14. Review the configuration actions that will be performed. Click Next to continue.
15. Click Exit.
16. Restart the Session Central Service for the Microsoft Dynamics GP web client installation. You must do this on the machine where you installed the Session
Central Service, typically the machine that is hosting the web site. This step is necessary to allow the Session Central Service to establish communication with the session host machine.
Verify the installation
After the components for the scale out web client installation have been installed, give the system a few minutes to get synchronized. The Session Central Service will be updated with information that is provided by the Session Service running on each session host machine.
Web Management Console
You can use the Web Management Console to verify that the session host machines are accessible.
1.
Open Internet Explorer.
2.
Enter the address of the Web Management Console site. The default address of the site is: https://ServerName:PortNumber/WebManagementConsole
ServerName is the fully-qualified domain name (FQDN) for the server that is hosting the web management console site. This name must match the name you used when you requested the security certificate that you applied to the site when setting up SSL.
PortNumber is the port for the web site that you are using. If you chose to install on the default web site (port 80) then you do not need to supply the port number.
A typical URL to access the Web Management Console looks similar to the following: https://gpuaweb.contoso.com/WebManagementConsole
3.
You may be prompted for your domain credentials when you access the Web
Management Console. If you are, provide your domain name and password.
4.
In the Web Management Console, click the Session Management snap-in. You should see the session host machines listed in the pane on the left side of the console.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 55
P A R T 4 W E B C L I E N T I N S T A L L A T I O N
The session host machines in the scale out configuration will be listed here.
Creating a session
After you have verified that the session host machines are working, verify that you can access the web client.
1.
Open Internet Explorer.
2.
Enter the URL of the Microsoft Dynamics GP web client site. The default address of the site is: https://ServerName:PortNumber/GP
ServerName is the fully-qualified domain name (FQDN) for the server that is hosting the web site. This name must match the name you used when you requested the security certificate that you applied to the site when setting up
SSL.
PortNumber is the port for the web site that you are using. If you chose to install on the default web site (port 80) then you do not need to supply the port number.
A typical URL to access the Microsoft Dynamics GP web client looks similar to the following: https://gpuaweb.contoso.com/GP
3.
After entering the URL, you will be directed to the logon page. This is the first page that will be displayed to users who are accessing the Microsoft Dynamics
GP web client.
56 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 0 S C A L E O U T I N S T A L L A T I O N
4.
Enter your user credentials. These are domain user credentials or machine user credentials for a user that is part of the security group you created to control access to the Microsoft Dynamics GP web client. This security group is described in
Chapter 5, “Security groups and user accounts.” These are not your
Microsoft Dynamics GP login name and password.
Click Sign In.
5.
A session will be created, and the standard Microsoft Dynamics GP login window will be displayed.
6.
Log in with your Microsoft Dynamics GP login name and password.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 57
58 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Part 5: Web client administration
This part of the documentation provides information about performing administrative tasks for the Microsoft Dynamics GP web client. The following chapters are included:
•
Chapter 11, “Managing web client sessions,” provides information about the
tools available to manage web client sessions.
•
Chapter 12, “Logging,” describes the logging capabilities that are available for
the web client installation.
•
Chapter 13, “Repairing the web client,” explains common repair scenarios for
the web client.
•
Chapter 14, “GP Web Resource Cache,” explains how to use the GP Web
Resource Cache to help improve web client performance.
•
Chapter 15, “Troubleshooting,” contains information that can be helpful as you
resolve web client issues.
60 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 11: Managing web client sessions
The administrator of the Microsoft Dynamics GP web client installation has the responsibility to monitor and manage the web client sessions. Information about this task is divided into the following topics:
•
•
•
•
Suspending a session host machine
•
•
•
Session Management snap-in
The Session Management snap-in for the Web Management Console is the primary tool that you will use to manage web client sessions. Use the following procedure to access this snap-in.
1.
Open Internet Explorer.
2.
Enter the address of the Web Management Console site. The default address of the site is: https://ServerName:PortNumber/WebManagementConsole
ServerName is the fully-qualified domain name (FQDN) for the server that is hosting the web management console site. This name must match the name you used when you requested the security certificate that you applied to the site when setting up SSL.
PortNumber is the port for the web site that you are using. If you chose to install on the default web site (port 80) then you do not need to supply the port number.
A typical URL to access the Web Management Console looks similar to the following: https://gpuaweb.contoso.com/WebManagementConsole
3.
You may be prompted for your login credentials when you access the Web
Management Console. If you are, provide your login name and password.
4.
In the Web Management Console, click the Session Management snap-in.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 61
P A R T 5 W E B C L I E N T A D M I N I S T R A T I O N
Connecting to Session Central
To use the Session Management snap-in to monitor Microsoft Dynamics GP web client session, the snap-in must be configured to access the Session Central Service.
The Session Central Service is the component of the Microsoft Dynamics GP web client installation that creates and tracks web client sessions.
To connect to the Session Central Service, the Session Management snap-in must have the URL for the service. In most cases, this will be automatically configured when the Microsoft Dynamics GP web client components were installed. Use the following procedure to manually configure the connection to the Session Central
Service.
Connecting to Session Central
1.
With the Session Management snap-in selected, click Configure in the ribbon of the Web Management Console.
2.
In the window that is displayed, supply the URL for the Session Central
Service. A typical URL to access the service looks like the following: http://machinename:48650/SessionCentralService
Substitute machinename with the name of the computer on which the Session
Central Service is running. The default port used for the service is 48650. If you have used a different port for the service, you must use that port number in the
URL.
If the Session Central Service has been configured to use SSL (secure sockets layer) than the URL must begin with https, instead of http.
3.
Click OK. The value entered will be validated. If the Session Central Service cannot be contacted, an error will be displayed. Correct the URL and then click
OK to save the changes.
62 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 1 M A N A G I N G W E B C L I E N T S E S S I O N S
Session host machines
The left pane of the Session Management snap-in lists the session host machines that are configured to host Microsoft Dynamics GP web client sessions. Select the machine name to see the detailed information about that machine. The following details are provided:
Last Status Update
Indicates the last time that the status information was updated. Click Refresh in the ribbon to retrieve the latest information from the
Session Central Service.
Memory Utilization
Indicates the percentage of memory that is used on the selected machine.
Total Sessions Running
Indicates the total number of web client sessions that are running on the selected machine.
Potential Sessions Remaining
Provides an estimate of the number of additional web client sessions that could be hosted on the selected machine. This estimate is based primarily on the amount of available memory on the machine.
Full Computer Name
Displays the full name of the machine.
Session List
Lists the individual web client sessions that are running on the machine.
Suspending a session host machine
An active session host machine allows new web client sessions to be created for it.
You may want to remove a session host machine from service, such as when you want to apply system updates. To do this, you can suspend the session host machine, which prevents it from accepting any new web client sessions. To do this, complete the following procedure.
1.
In the left pane of the Session Management snap-in, select the session host machine that you want to suspend.
2.
In the ribbon, click Suspend.
Suspending a machine does not affect the web client sessions that are already running on the machine. The existing web client sessions will continue to run until they are closed.
Sessions
When a session host machine is selected in the left pane of the Session Management console, the sessions running on that machine are displayed. The following details are provided for each session:
Created Date
Indicates the date and time that the web client session was created.
Dynamics GP Company Name
Displays the company in the Microsoft
Dynamics GP installation that the user logged in to.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 63
P A R T 5 W E B C L I E N T A D M I N I S T R A T I O N
Dynamics GP User
Displays the Microsoft Dynamics GP user name that the web client user supplied when they signed into the company.
Dynamics GP Version
Provides the version number of Microsoft Dynamics GP that is being used for the web client session.
User ID
Displays the user ID supplied when the user signed in to the Microsoft
Dynamics GP web client.
Host Machine Name
Displays the name of the machine that is hosting the web client session.
Session ID
Shows the internal session ID.
Tenant Name
Displays the name of the tenant that is being used for the web client session. If the Tenant Service is not being used, the tenant name is
GPWebApp.
Last Heartbeat
Indicates that last time the web client communicated with the session host machine.
Ending a session
A web client session ends when the user signs out. However, situations occur in which a session may be left running on the session host machine. For example, the web client user may have closed their web browser without signing out. first. You may have a need to manually end a session that a web client user has left running on a session host machine.
When you manually end a session there is a risk of data corruption, because the Microsoft
Dynamics GP session was not closed down normally.
To manually end a web client session, complete the following procedure:
1.
Select the session that you want to end.
2.
In the ribbon, click End Session.
3.
In the End Session window, verify that you really want to end the session. If you are sure you want to end the session, click End Session.
Session timeout
You can configure whether inactive web client sessions are automatically closed after a specified amount of time has passed.
Single tenant
If you are using the Microsoft Dynamics GP web client in a single tenant configuration (not using the Tenant Service), a settings in the
TenantConfiguration.xml
file of the web client installation controls the session timeout. This file is typically found in this location on the machine that is hosting the the web site for the web client installation:
C:\Program Files\Microsoft Dynamics\GP Web Client\GPweb\
64 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 1 M A N A G I N G W E B C L I E N T S E S S I O N S
The <HeartbeatTimeout> element in the TenantConfiguration.xml file controls the amount of time that must pass before an inactive web client session is automatically closed. The format for the value is:
Days.Hours:Minutes:Seconds
The value 0.00:00:00 indicates that the timeout is infinite, and no inactive web client sessions will be automatically closed.
Multiple tenants
If you are using the Microsoft Dynamic GP web client in a multitenant configuration, you will use the Tenant Management snap-in for the Web
Management Console to control the session timeout value. Refer to the Tenant
Services Installation and Administration Guide or the Tenant Management snap-in help for information about how to configure the session timeout value in a multitenant configuration.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 65
66 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 12: Logging
The logging capability provided by the Microsoft Dynamics GP web client installation can help you troubleshoot issues that users may experience with the
Microsoft Dynamics GP web client. Information about logging is divided into the following topics:
•
•
•
Enabling logging for a session
Logging overview
To effectively use logging, a basic understanding of the logging features is helpful.
Levels of logging
Logging can be configured at multiple levels for a web client installation:
• At the top level, you can enable logging for all of the users of a specific tenant.
• If you are using multitenant environment, you can enable logging for specific users of a tenant.
• At the lowest level, you can enable logging for a specific web client session.
Types of logs
The following types of logs are available:
Runtime Log
Provides details about the actions performed by the web client runtime process.
Script Log
Contains a record of all of the sanScript scripts that are run by the
Microsoft Dynamics GP web client runtime process.
Timing Log
Contains timing details for web client operations. Microsoft can analyze this information to isolate issues with web client performance.
SQL Log
Contains a record of all of the SQL statements there were issues by the
Microsoft Dynamics GP web client runtime process.
Log location
The logs are generated on the session host machine where the web client session is being run. The default location for the log files is:
C:\ProgramData\Microsoft Dynamics\GPSessions\Logs
To view the ProgramData folder, you will need to show the hidden files and folders on the session host machine.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 67
P A R T 5 W E B C L I E N T A D M I N I S T R A T I O N
Enabling logging for a tenant
The tenant configuration you are using determines how you enable logging for the tenant.
Single tenant
If you are using the Microsoft Dynamics GP web client in a single tenant configuration (not using the Tenant Service), you can enable logging for all users of the installation. Settings in the TenantConfiguration.xml file of the web client installation control the logging. This file is typically found in this location on the machine that is hosting the the web site for the web client installation:
C:\Program Files\Microsoft Dynamics\GP Web Client\GPweb\
The <RuntimeLogEnabled> element in the TenantConfiguration.xml file controls logging for all users of the web client installation. When it has the value true, the runtime log is generated for every web client user.
The <CustomRuntimeSettings> element controls whether the other log types are generated. If the setting for the specific log type is set to true, that log will be generated.
If logging for a tenant is enabled for an extended time, the quantity and size of the log files generated can become very large. Be sure to disable logging after it is no longer needed.
The following example shows the settings in the TenantConfiguration.xml file that cause all of the logs to be generated.
<RuntimeLogEnabled>true</RuntimeLogEnabled>
<CustomRuntimeSettings>ScriptLogEnabled=true|TimingLogEnabled=true|
SqlLogEnabled=true</CustomRuntimeSettings>
Multiple tenants
If you are using the Microsoft Dynamic GP web client in a multitenant configuration, you can enable logging for a specific tenant or for specific users of the tenant. You will do this using the Tenant Management snap-in for the Web
Management Console. Refer to the Tenant Services Installation and Administration
Guide or the Tenant Management snap-in help for information about how to configure logging in a multitenant configuration.
Enabling logging for a session
The Session Management snap-in of the Web Management Console is used to enable logging for a specific web client session. To enable logging for a session, complete the following procedure:
1.
Select the session that you want to enable logging for.
2.
In the ribbon, click Logging.
3.
In the Logging Settings window, select the log types that you want to create.
4.
Click OK. The logging for the session will begin.
Be sure that you disable logging when you have finished creating the logs.
68 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 13: Repairing the web client
If the Microsoft Dynamics GP web client installation becomes damaged, the repair operations available may help resolve the issues. Information about repairing is divided into the following sections:
•
•
Common repair scenarios
When using the Microsoft Dynamics GP web client, there are some common scenarios that can be fixed through using a repair operation.
Corrupted configuration
The Microsoft Dynamics GP web client has numerous configurable components. If something has corrupted the configuration for one of these components, the repair action can return the component to its originally installed condition.
Expired security certificates
The security certificates that are used in the web client installation have a finite lifespan. When a security certificate expires, it will no longer function properly in the web client installation. The security certificate must be replaced. After the new security certificate is installed into the certificate store on the machine, you can select the new certificate during the web client repair process.
Changed user credentials
If the credentials (user name and/or password) have changed for one of the user accounts that is used in the web client installation, the web client will not work correctly. For instance, one of the services for the web client may not start. You can supply the updated credentials as part of the web client repair process.
Performing a repair
To repair the Microsoft Dynamics GP web client installation, complete the following steps:
1.
Log in to the machine where the repair operation is to be performed.
2.
Open the Programs and Features control panel.
3.
From the list, select Microsoft Dynamics GP Web Client. Click Change.
4.
In Program Maintenance, click Repair.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 69
P A R T 5 W E B C L I E N T A D M I N I S T R A T I O N
5.
The components to be configured during the repair process will depend upon which components are installed on the machine where the repair is being performed. Supply the required values for each component that will be repaired. For example, if you were replacing an expired security certificate, you would choose the new certificate during the repair process.
When replacing an expired security certificate, you would select the new certificate during the repair process.
6.
After all of the components have been configured, click Next to start the repair actions. The repair steps will be performed.
7.
After the repair is complete, click Exit. The Web Client Configuration Wizard will start.
8.
At the Welcome screen, click Next.
9.
If required, specify the type of authentication you want to use to connect to the
SQL Server where the database for the Web Management Console is being stored. Click Next to continue.
10. If required, specify the type of authentication you want to use to connect to the
SQL Server where the database for the Session Central service is being stored.
Click Next to continue.
11. Review the status information for the databases. Click Next to continue.
12. After the repair actions are complete, click Exit.
70 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 14: GP Web Resource Cache
The Microsoft Dynamics GP Web Resource Cache is an optional component that you can install on the session host machines of your web client installation to help improve the performance and resource utilization. It is a Windows service that runs on the session host machines for the web client installation. Information about caching is divided into the following sections:
•
•
Installing the GP Web Resource Cache
•
Caching for the web client
Any form that is displayed by the web client is first retrieved from the application dictionary and then converted into a format that can be used by the web client.
Because the result is the same each time, it is useful to cache the converted form.
In the standard Microsoft Dynamics GP web client installation, form caching is done at the session level. Each user session on the session host machine has its own cache folder that stores cached versions of the forms that the user has opened during that session. If a user re-opens a form that had previously been opened, the cached version is used. When the user closes the session, the contents of the cache are deleted.
The GP Web Resource Cache allows caching at the machine level. When a user accesses a form in the web client, the form is cached on the session host machine. If any other user session running on that machine accesses that same form in the web client, the cached version is used. The content of the machine level cache is persistent. It is not affected when users close their web client sessions.
The machine level cache can help improve performance in three ways:
• It’s faster to use the cached version of a form, rather than to retrieve and convert the form definition from the application dictionary.
• Because it is persistent beyond the life of individual user sessions, the cached information does not have to be re-created for each session.
• The cached information is shared. The first time a web client user accesses a form, the form is cached. After that time, other web client users will access the cached version of the form.
If a form in the Microsoft Dynamics GP web client installation has changed, such as being customized with the Modifier, the cache is updated automatically the next time the form is accessed.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 71
P A R T 5 W E B C L I E N T A D M I N I S T R A T I O N
Installing the GP Web Resource Cache
You can install the GP Web Resource Cache on any session host machine (a machine that is running the Session Service). Use the following procedure to install the cache:
1.
From the Microsoft Dynamics GP installation media, double-click the Setup.exe file to open the Microsoft Dynamics GP installation window.
2.
Click GP Web Resource Cache and then click Install.
3.
At the Welcome screen, click Install.
4.
After the installation is complete, click Finish. The GP Web Resource Cache will begin working immediately.
Managing the cache
In most cases, you won’t need to do any configuration or management actions for the GP Web Resource Cache. There are actions you can take to manage the cache, and some configuration settings that you can use to control the behavior of the cache.
Starting and stopping the cache
The GP Web Resource Cache is a Windows service, so you can use the Services control panel to start or stop the cache. As soon as you stop the cache, any new web client sessions will fall back to session level caching.
Any time the GP Web Resource Cache is not available, session level caching is used.
Cache configuration file
A configuration file for the GP Web Resource Cache can be found in this location:
C:\Program Files\Microsoft Dynamics\GP Web Resource Cache\Providers
The configuration file has the following name:
Microsoft.Dynamics.GP.Web.Services.Runtime.Caching.Provider.FileSystem.dll.config
72 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 4 G P W E B R E S O U R C E C A C H E
The following settings are found in this configuration file:
Location
This setting specifies the complete path to the location of the machine level cache. The default value is the empty string ("") which causes the cache to be created in the temporary folder for the user account that is running the GP Web
Resource Cache service.
You may want to supply a specific location for the machine level cache for special circumstances, such as when you have a high-performance storage device like a solid state disk available. You should always keep the machine level cache on the local machine. Do not put it on a network or shared location.
CleanupInterval
The GP Web Resource Cache will automatically remove infrequently used content. This setting specifies how often the GP Web Resource
Cache will scan the cache content for content that has not been accessed within the specified time period (defined by the CleanupMaxAge setting). The default value is once a day. The format for this setting is days:hours:minutes:seconds.
CleanupMaxAge
This setting specifies the minimum amount of time that must have elapsed since the content was last accessed before it is removed by the automatic cleanup action. The default value is 30 days. The format for this setting is
days:hours:minutes:seconds.
After you have made any changes to the configuration file, be sure to restart the Microsoft
Dynamics GP Web Resource Cache service in the Services control panel.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 73
74 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 15: Troubleshooting
Use the information in this chapter to help you troubleshoot issues you may have when you are installing or using the Microsoft Dynamics GP web client. The following topics are discussed:
•
Errors reported on the main page
•
•
Web client is Initializing and becomes unresponsive
•
•
•
Errors reported on the main page
When a sign-on error occurs and is reported on the main page for the web client, look on the Dynamics section of the Event Log on the machine running the web site and Session Central Service for the web client installation. The information provided in the error(s) listed there can help you troubleshoot the issue.
If the error detail indicates that a file cannot be found, be sure that you have installed the web client runtime components on the session host machines. The file that cannot be found may be one of these components.
You should also verify that the Session Central Service and the Session Service are both started.
Incomplete sign-on
Many actions occur during the sign-on process.Issues in any of those actions can prevent the sign-on from completing.
If you do no t see the status bar in the bottom portion of the web client window, with the status “Initializing”, this may indicate that the Silverlight application (.xap file) for the web client has not loaded. Verify that the .xap file was installed with the web client runtime components.
Web client is Initializing and becomes unresponsive
If the status bar indicates “Initializing” for an extended period of time, but no web client windows are displayed, then there is likely a communication problem between the Silverlight application in the web browser and the runtime service.
Check the following:
• Verify that you didn’t have any certificate errors when you access the Dynamics
GP web client site. A certificate error can prevent the sign-on action from completing.
• Verify that you can access the Runtime service. This is the service that the web client application communicates with on the session host machine. By default, this service is accessed through port 48652. The port is secured with a security certificate. If there are any problems with the security certificate, the connection cannot be made. Use a web browser to access the following file on the session host machine:
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 75
P A R T 5 W E B C L I E N T A D M I N I S T R A T I O N
https://session_host_machine:48652/clientaccesspolicy.xml
The XML content for the file should be displayed in the web browser. If it is not, then there is an issue with the configuration of the runtime service. Usually the issue involves the security certificate that is used for the port. Use the following command to find the details of the security certificate that is bound to the port: netsh http show sslcert
If you do not see that there is a security certificate bound to port 48652, then the web client will need to be repaired or re-installed, so that a security certificate can be bound to the port.
Port issues
For the web client to work properly, the appropriate ports must be opened in the computer’s firewall. The Microsoft Dynamics GP Web Client installer opens the appropriate ports when components of the web client are installed. You can use the following command to list the ports that are open on a system: netstat -anob
Port accessibility issues are more likely to occur in scale out installation, when web client components are installed on different machines. For example, the session host machines must be able to access the Session Central Service, which is typically done through port 48651. That means this port must be open on the system that is running the Session Central Service.
Another common port accessibility problem is port 48652, the port that in a default installation is used for the runtime service. This port must be opened so that the web client on an end-user machine can access the runtime instance on the session host machine.
Performance issues
In a typical installation of the web client, the performance of the web client is comparable to the performance of a desktop client. You can expect that some operations may be slower in the web client, while other actions may be faster. If you notice that the web client does not have good performance, it is worth further investigation.
Session host performance
To gauge the overall system performance, verify the performance that you see when you run the Microsoft Dynamics GP desktop client on each session host machine. If the desktop client does not have optimal performance, the web client sessions that are hosted on that machine will also have sub-optimal performance. When you resolve the desktop client performance issues, the web client performance should also improve.
Real-time virus scanning
On each session host machine, consider turning off real-time virus scanning for the runtime session process. The runtime session process is going to be very active, and can attract the attention of antivirus software. Limiting the scanning can speed up performance of the web client sessions.
76 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 5 T R O U B L E S H O O T I N G
Virtual machine configuration
You may be using a virtualization solution such as Hyper-V, and installed the web client into a virtual machine configuration. Check the settings for the virtual machines to be sure they are optimal for the workload of the web client. For example, a virtual machine that is running low on memory may have reduced performance.
Another situation that can occur with virtual machines involves Network Interface
Card (NIC) settings that are not fully compatible with the operating system settings.
Specifically, NIC settings may be set to use “offload” optimizations that actually slow down network performance for the virtual machine. To turn off these optimizations, do the following on each virtual machine.
1.
Open the Network and Sharing Center.
2.
Click the link for Connections to view the information about the local network connection.
3.
Click Properties.
4.
Click Configure.
5.
Click the Advanced tab.
6.
Disable all of the settings that have “offload” in their name.
7.
Click OK to save the changes. This will reset the NIC for the virtual machine.
Printing issues
The follow printing issues may occur.
Context errors
If web client users receive an error that context cannot be retrieved when they attempt to print a report, be sure that printing has been properly configured for the session host machines. Refer to
on page 22 for details about how to
configure printing on each session host machine.
Printing to a file
When a web client user prints a report that uses a Word template, and chooses to save the report to a file, the file may not be saved in the location that was specified.
The user may also see a “file not found” error if they chose to display the report on their local machine. Typically, this indicates that the security settings for Internet
Explorer are preventing the file from being written to the local machine.
To solve this problem, perform one or both of these actions inthe Internet Options window for Internet Explorer:
• Display the Security tab. Add the URL for the Microsoft Dynamics GP web client site to the Trusted sites list.
• Reduce the security level for the specified zone. For example, if you are running the Microsoft Dynamics GP web client in an intranet setting, reduce the security level for the Local intranet zone.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 77
78 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Part 6: Using the Web client
This part of the documentation provides information for users of the Microsoft
Dynamics GP web client. The following chapters are included:
•
Chapter 16, “Connecting to the web client,”
explains how to create and manage a connection for a web client session.
•
Chapter 17, “Working with the web client,”
describes common actions that users will need to perform while working with the web client.
80 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 16: Connecting to the web client
To have the Microsoft Dynamics GP web client installation work as efficiently as possible, it’s important that users follow the proper process for connecting to the web client. Information about this is divided into the following topics:
•
•
•
•
•
Signing in
To sign in to the web client, use the following procedure.
1.
Open Internet Explorer.
2.
Enter the URL of the Microsoft Dynamics GP web client site. The default address of the site is: https://ServerName:PortNumber/GP
ServerName is the fully-qualified domain name (FQDN) for the server that is hosting the web site. This name must match the name you used when you requested the security certificate that you applied to the site when setting up
SSL.
PortNumber is the port for the web site that you are using. If you chose to install on the default web site (port 80) then you do not need to supply the port number.
A typical URL to access the Microsoft Dynamics GP web client looks similar to the following: https://gpuaweb.contoso.com/GP
3.
View the sign on page. If the site displays a security certificate error, report the issue to your system administrator, and do not continue the sign on process.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 81
P A R T 6 U S I N G T H E W E B C L I E N T
4.
Enter your user credentials (User Name and Password). These are either domain user credentials or machine user credentials, depending on how the web client installation is configured. The User Name will have the format:
domain\username or
machine\username
These are not your Microsoft Dynamics GP login name and password.
Click Sign In.
5.
If you are using a multitenant configuration, and have access to more than one tenant, you will be prompted to choose the tenant (installation of Microsoft
Dynamics GP) that you want to connect to. Choose a tenant and then click
Create New Session
.
If you are using a single tenant configuration, or have access to only one tenant, no prompt will be displayed.
6.
A session will be created, and the standard Microsoft Dynamics GP login window will be displayed.
7.
Log in with your Microsoft Dynamics GP login name and password.
Disconnecting from a session
In general, you should avoid closing the web browser when you have an active connection to the Microsoft Dynamics GP web client. When you close the web browser while connected, your web client session remains active on the server. The resources used by your session are still dedicated to it, and cannot be used for other web client sessions.
To help prevent you from accidentally closing the web browser, the following message is displayed when you attempt to close the web page or navigate away to another web page.
82 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 6 C O N N E C T I N G T O T H E W E B C L I E N T
If you accidentally navigated away from the web client session, click Cancel to return to the web client.
Sometimes, disconnecting from a session by closing the web browser can be useful.The following are two examples:
• Assume you need to shut down your computer, but you have multiple windows open in the Microsoft Dynamics GP web client with data displayed in them. Disconnecting from the session allows those windows to remain open.
When you reconnect to the session, which is discussed in the next section, the windows will have maintained their state information.
• A long-running process that you want to allow to finish is another reason to close the web browser and leave the session running on the server. After the process has started, it will continue processing, even after the web browser has been closed.
Reconnecting to a session
Reconnecting to an existing session is just like the process of signing in to the web client. To reconnect to a session, complete the following procedure.
1.
Open Internet Explorer.
2.
Enter the URL of the Microsoft Dynamics GP web client site.
3.
At the sign on page, enter your user credentials, and click Sign In. The Session
Central Service will find any exsiting session that you had disconneced from.
These sessions will be listed.
Select one of the existing sessions in this list, and then click Connect To
Existing Session.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 83
P A R T 6 U S I N G T H E W E B C L I E N T
4.
Select the one of the sessions in the list and then click Connect to Existing
Session
to reconnect.
The web client will restore as many of the existing session’s session characteristics as possible. The web client will does not know which area page had been displayed.
It will restore the correct set of windows, though the exact placement of the windows may not match the configuration that existed when you disconnected from the session.
Signing out
To fully sign out of the web client, click Sign Out in the upper-right corner of the web browser. You will be logged out of Microsoft Dynamics GP, the web client session will end on the server, and the Sign In page will be displayed.
When you have finished working with Microsoft Dynamics GP, it’s a good idea to sign out, rather than to just disconnect from the session. Some of the advantages of signing out include the following:
• System resources are made available for other web client sessions.
• It releases a Microsoft Dynamics GP user in the system, so you are less likely to encounter the user limit.
• It reduces the possibility of data loss that might be caused the web client session had to be forcibly ended.
Web browser security settings
You may be accessing the Microsoft Dynamics GP web client through an intranet or over the Internet. Depending on the access method, you may need to adjust your web browser security settings to allow printing and local file access to work properly. Do this in the Internet Options window for Internet Explorer.
84 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 6 C O N N E C T I N G T O T H E W E B C L I E N T
You will have to do one or both of the following actions:
• Display the Security tab. Add the URL for the Microsoft Dynamics GP web client site to the Trusted sites list.
• Reduce the security level for the specified zone. For example, if you are running the Microsoft Dynamics GP web client in an intranet setting, reduce the security level for the Local intranet zone.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 85
86 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Chapter 17: Working with the web client
Working with the Microsoft Dynamics GP web client is very similar to working with the desktop client. This chapter provide information about functionality that is specific to the web client. It is divided into the following topics:
•
•
•
•
•
Connection status
Use the Connection Status indicator in the lower right corner to help you determine the status of the web client. The following table lists the status values.
Color
Green
Yellow
Yellow
Yellow
Red
Status
Connected
Waiting for a response from server
Processing response from server
Initializing
Error
Description
The web client is ready to communicate with the server.
An action has been performed in the web client. The web client is waiting for the server to process the action and return a response.
The response has been received from the server and is being processed by the web client.
The web client is starting and creating a secure connection to the server.
A problem has occurred that is preventing the web client from communicating with the server or processing any requests.
Web client errors
If an error occurs with the web client, the details of the error may be accessible from the status bar at the bottom of the web client window.
Click the error icon in the status area to view details of an error that occurred for the web client.
You can click the error icon to display the details of the error that occurred. The information provided can be helpful when you work with your system administrator to troubleshoot issues with the web client.
Multiple errors may be listed. Click an error to display details for it.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 87
P A R T 6 U S I N G T H E W E B C L I E N T
In some cases when an error might occur that you cannot recover from. You will need to close your web client session and reconnect using the standard sign in procedure.
Some errors may require you to close the web client session.
Trusted mode
For some actions, the Silverlight application that is used for the Microsoft Dynamics
GP web client must access resources on the local machine. For exmaple, when a user generates a report that uses a Microsoft Word template, the Microsoft Word document that is created must be stored locally so that it can be viewed. Users also need to access the local file system, such as when using the attachments feature in
Microsoft Dynamics GP.
By default, the Silverlight application for the web client runs in “sandboxed” mode, which restricts the access the application has to local machine resources. In this mode, prompts are displayed to the user each time that local resources are accessed.
In sandboxed mode, prompts like this are displayed each time local resources are accessed.
You can find out if the web client is running in sandboxed mode by looking at the status bar. If you see the padlock icon, then you are running in sandboxed mode.
This icon in the status area indicates that the web client is running in sandboxed mode.
The local machine can be configured to allow the Silverlight application to be run in
“trusted” mode, which allows the application to access local system resources with fewer prompts for the user.
An installer file named DynamicsGPTrustedApp.msi is provided on the web site for the Microsoft Dynamics GP web client installation. Users can download and run this installer, which configures the local system to trust Silverlight applications that run in the web browser. It also installs a security certificate that is used to sign the
Silverlight application. This is also necessary so the application can be run in fulltrust mode.
To access this installer, open Internet Explorer, and begin entering the URL that you typically use to access the web client site. At the end of the URL, append the following:
/DynamicsGPTrustedApp.msi
88 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
C H A P T E R 1 7 W O R K I N G W I T H T H E W E B C L I E N T
As an example, the following is the full URL to access this installer file for the
Contoso sample web client installation: https://gpuaweb.contoso.com/GP/DynamicsGPTrustedApp.msi
Elevated privileges are required to run this installer. After you have completed the installation, you will have to restart any web client session on the machine.
Accessing help
The Help menu is available in the status bar at the bottom of the web client window.
Click here to display the Help menu for the application.
You can choose Contents to display help for the active application. You can choose
About This Window
to display context-sensitive help for the current window. The same Help menu items are available in the ribbon for most windows in the web client.
Reports and Printing
You can use standard Report Writer reports, Report Writer reports with Word templates, and SSRS reports with the Microsoft Dynamics GP web client.
Standard Report Writer reports
When you print a Report Writer report, you will see the standard Report
Destination dialog. If you choose the Standard report type, and choose to send the report to the screen, then the report will be displayed in the Screen Output window.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 89
P A R T 6 U S I N G T H E W E B C L I E N T
If you choose the Standard report type, and choose to send the report to the printer, you will be prompted to indicate whether you trust the application to print to the local printer. Click OK to allow printing to continue.
You will see this dialog when you print Standard report to the printer.
The report will be displayed in the Screen Output window, and then sent to the printer. After the report has been sent to the printer, a dialog box is displayed to indicate that printing is complete. Then you can close the Screen Output window.
Report Writer reports with Word templates
When you print a Report Writer report and choose the Template report type,
Microsoft Dynamics GP will use a Word template for the report. If a Word template has already been previously defined for the report, that template will be used. If no template has been defined for the report, a template will be automatically generated by the Report Template Generator and used.
You will be prompted for a location where you want to safe the local report. If you have configured the application to run in trusted mode, you will be asked this only one time for your web client session.
The Microsoft Dynamics GP web client doesn’t remove any content from the location you specify. It’s up to you to be sure that any sensitive information is removed from the location that you choose on your local workstation.
SSRS reports
You can generate SQL Server Reporting Services (SSRS) reports from the web client.
These reports are rendered in a separate web browser window.
90 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Appendix
The following appendices are included for this documentation:
•
Appendix A, “Importing a Self-signed Security Certificate,”
describes how to import the security certificate onto a local computer when you are using a selfsigned security certificate for the Microsoft Dynamics GP web client installation.
92 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Appendix A: Importing a Self-signed Security
Certificate
When you are using a self-signed security certificate, there is no certificate authority available to verify the certificate. If you use an another computer to connect to the
Microsoft Dynamics GP web client installation that is using a self-signed security certificate, you will see a certificate error displayed in the web browser.
If a self-signed security certificate is used for the
Microsoft Dynamics GP web client installation, you will see a security certificate error when you try to connect from a different computer.
If the same self-signed security certificate is used for both the web site and for the web client runtime service, the certificate error can prevent you from successfully logging into the Microsoft Dynamics GP web client. The solution is to import the security certificate into the machine that will be accessing the web client. This appendix describes how to do this. First, you must retrieve the security certificate from the server, and then you must install the certificate onto your local machine.
To retrieve the security certificate
1.
Open Internet Explorer on the computer that will be used to connect to the
Microsoft Dynamics GP web client.
2.
Connect to the Microsoft Dynamics GP web client site. The browser will display a message indicating that there is a problem with the web site’s security certificate. Click Continue to this website.
3.
The URL area of the browser you will appear in red, indicating a security certificate error. Click Certificate error to display the details of the error.
4.
In the drop-down, click View certificates.
5.
In the Certificate window, click the Details tab.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 93
A P P E N D I X A I M P O R T I N G A S E L F - S I G N E D S E C U R I T Y C E R T I F I C A T E
6.
Click Copy to File to open the Certificate Export Wizard. Click Next.
7.
Choose the DER encoded binary X.509 format, and click Next.
8.
Click Browse to open a file dialog box that allows you to name the certificate file and select a location for it. A common practice is to name the certificate based on the computer that it is being accessed. In this example, the computer being accessed is named GPUA2, so the certificate is named GPUA2.cer. Choose a convenient location for the file, such as the desktop. Click Save.
9.
In the Certificate Export Wizard, click Next. Then click Finish. A message will be displayed indicating that the security certificate was exported.
10. Click OK to close the Certificate window.
To install the security certificate
1.
On the computer that will be used to connect to the web client, open the Run prompt. (Choose Start > Run or press Window-R)
2.
In the Open field, type MMC and then click OK.
3.
In the Microsoft Management Console, open the File menu and choose Add/
Remove Snap-in
.
4.
In the Add or Remove Snap-ins window, choose the Certificates snap-in from the Available snap-ins list, and then click Add.
5.
In the Certificates snap-in dialog box, choose Computer account and then click
Next
.
6.
In the Select Computer dialog box, choose Local computer and then click
Finish
.
7.
In the Add or Remove Snap-ins window, click OK.
8.
In the left pane, expand the Certificates (Local Computer) node, and then expand the Trusted Root Certification Authorities node.
94 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
A P P E N D I X A I M P O R T I N G A S E L F - S I G N E D S E C U R I T Y C E R T I F I C A T E
9.
Under Trusted Root Certification Authorities, right-click the Certificates node, point to All Tasks, and then click Import.
10. In the Certificate Import Wizard welcome screen, click Next.
11. In the File to Import screen, click Browse.
12. Browse to the location of the security certificate that you retrieved from the previous procedure. Select the .cer file and click Open. Click Next to continue.
13. In the Certificate Store screen, verify that the certificate is being added to the
Trusted Root Certification Authorities store. Click Next.
14. Click Finish to complete the import process.
15. Close the Microsoft Management Console window.
To test the security certificate
1.
If any Internet Explorer windows are open, close them.
2.
Open an instance of Internet Explorer.
3.
Browse to the site for the Microsoft Dynamics GP web client. When you access the site, you should no longer see a security certificate error.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 95
96 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Glossary
Session Hosts
The server machines that run sessions of the
Microsoft Dynamics GP web client.
Session Central Service
The service that control communication between the web site and the session host machines.
Session Service
The service that runs on each session host machine and manages the process that is created each time a user logs into the web client.
Web Client Runtime
A component of the Microsoft Dynamics GP installation. A web client runtime process is created by the Session Service each time a user logs into the web client.
Web Management Console
A Silverlight application that is used to perform administrative tasks for the
Microsoft Dynamics GP web client.
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 97
98 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
Index
A
ASP.NET
installing 27 authentication mode, required for web client site 27, 28
B
back office server preparation 20
C
caching, for web client forms 71
certificates, see security certificates
configurations
connecting to the web client 81
context errors, when printing 77
D
default printer, setting up for session host machine 22
deployment configurations
overview 11 scale out 11 single machine 11
disconnecting from a web client session 82
documentation, symbols and conventions
DynamicsGPTrustedApp.msi
E
errors
expired security certificate, repairing 69
externally signed security certificates
G
GP Web Resource Cache
H
help, online help for web client 89
I
initializing issues, in web client 75
installation
Internet Explorer
Internet Information Services, installing
L
log off process, for web client 17
log on process, for web client 13
logging
described 67 levels of logging 67 log location 67 types of logs 67
logging in, to web client 46, 57
M
machine level caching, described 71
Microsoft Dynamics GP installation requirements 21
multiple domain security certificates 32
O
operating system requirements 27
P
passwords, repairing expired passwords
ports, port access in web client 76
prerequisites for web client 27
printing
setting up on session host machines
private key, for security certificates 31
Processing response from server (status)
R
reconnecting to a web client session 83
repair
common repair scenarios 69 for web client 69 performing 69
reports
reports with Word templates 90
Screen Output window 89 standard Report Writer reports 89
roles, machine roles required 27
runtime, see web client runtime
S
Screen Output window, in web client 89
Secure Sockets Layer (SSL)
configuring web sites to use 35
security certificates
private key for 31 purpose of 31 requirements for 31
security certifications, repairing expired certificates 69
security groups, for managing user access
security level, setting for Internet Explorer
security settings, for Internet Explorer 84
self-signed security certificates
Session Central Service
Session Central service
session host machines
session hosts
session level caching, described 71
Session Management snap-in, described
Session service
sessions
sign in procedure, for web client 81
sign out procedure, for web client 84
Silverlight 5, use with web client 7
single domain security certificates 32
single machine configuration 11
single machine installation 41
W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N 99
I N D E X
standard reports in web client 89
suspending session host machines 63
T
timeout values, for sessions 64
troubleshooting, web client issues 75
trusted mode
configuring web client for 88 described 88 for web client 88
trusted sites
U
updated documentation, checking for 2
URL for Session Central service 62
user accounts
repairing in web client installation 69
required for web client installation 23
V
verifying, web client installation 45, 56
W
Waiting for a response from server (status)
web client
Web Client Configuration Wizard
web client runtime
web client sessions, see sessions 63
Web Management Console
web sites
using an externally signed security certificate 33
wildcard, security certificates 32
Word template reports in web client 90
100 W E B C L I E N T I N S T A L L A T I O N A N D A D M I N I S T R A T I O N
文档公共链接
广告
