Introduction
This document describes how to set up and maintain an SAP GUI Installation Server for the efficient distribution of SAP Front end Components across workstations in your organization.
Overview
SAP’s Front-End Software Deployment Tool – Netweaver SAPSetup not only allows direct installations from distribution media, but also an Installation Server based deployment mechanism that helps distribute SAP Front-End Software to workstations over a network and also using Microsoft SCCM to deploy the large number of users.
General Features of SAP GUI Installation Server:
Fully-featured installation, uninstallation, update, repair, and patch functions for SAP front end components:
- Front end components are available from an installation server or a distribution medium such as a DVD.
- Install new SAP front end components, uninstall existing ones, and update the remaining components in one cycle.
Easier and more reliable handling of SAP front end components by using installation servers:
- Maintain nearly all Windows-based SAP front end components on a single installation server.
- Integrate additional SAP front end components into an existing installation server, such as Import Product.
- Deploy multiple SAP front end components on workstations using a single command.
- Easily manage the installation server with wizard-driven user interfaces.
- Local Security Handling (LSH), when configured, lets you deploy SAP front end components on workstations without requiring administrator privileges on all machines.
- Whenever installed SAP front end components or packages change on the installation server, the automatic workstation update service (AWUS) will, once configured, automatically update the workstations and reboot them if necessary.
- Easier handling of multiple SAP front end components by configuration of installation packages – by implementing script events, you can customize and extend the installation of such packages.
- Controlling workstations remotely helps you to remotely access and control workstations on which you have administrator privileges. You can collect remote log files, execute processes remotely, and list remote processes.
- The directory for the creation of the installation server is configured automatically. By default, it is made NULL-session accessible. It can be shared automatically on the network for everyone to read.
- If NwSapSetup.exe is started from a batch file, the return code can be caught by the environment variable %ErrorLevel%.
Important Notes for the SAP GUI
It is important that you read the following SAP Notes before you start the installation. These SAP Notes contain the most recent information about the installation, as well as corrections to the installation documentation.
0000026417_SAP GUI Resources Hardware and software
0000038119_SAP Logon Administration of functions
0000066971_Supported SAP GUI platforms
0000147519_Maintenance strategy deadlines for SAP GUI
0000166130_SAP front end Delivery and compatibility
0000328723_GUI default settings during installation
0000508649_Diagnosis of frontend installation problems
0000535308_How to apply a SAP Front End patch
0001053737_Expected release dates for SAP GUI for Windows & ITS Patches
0001085218_NetWeaver 7.x BW Frontend Patch Delivery Schedule
0001144671_New SAP Installer for SAPGUI for Windows 7.10
0001169612_Cannot start NWSAPSetupAdmin over a network path
0001397000_SAP GUI for Windows Security Execution of SAP Shortcuts
0001414580_Jaws & SAP GUI configuration
0001426178_SAP Logon (Pad) create and distribute server configuration file
0001442028_SAP GUI for Windows No support for Office 2010 64bit
0001583967_Release Information Note for SAPSetup 9.0
0001587566_Installation problems with SAPSetup Version 9.0
0001588323_SAP GUI for HTML cannot be started (NW Basis 7.30)
0001652770_BI 7.x in 730 DVD1-BI client tools - contents & versions
0001669254_SAP GUI 7.30_Branding image in title bar
0001670678_730_New Features
0001685221_SAP Logon maintain system entry without sapmsg.ini and service file
0001702037_BW 7.x Frontend in GUI 730 - First Customer Shipment
0001710864_SAP Logon 7.30_possibility to disable views via registry
0001726742_SAPBWNews NW 7.x BW Add-On Frontend Patch 300 - GUI 7.30
0001796138_SAPBWNews NW 7.x BW Add-On Frontend Patch 201 - GUI 7.30
0001797599_RRMX for BEx Analyzer 3X is not supported with SAP GUI 730
SAP GUI Software Download
http://scn.sap.com/community/gui/blog/2013/05/29/sap-gui-730-download
Hardware and Software Requirements
Make sure in advance that your system meets the following requirements:
- The host for server-based installations must meet the following conditions:
- Accessible to all users at all times, even after the installation is complete. This is required for maintenance purposes such as the distribution of patches.
- Have broadband network connection for high throughput
- Have sufficiently free disk space for all SAP front end components
- Use a Windows server as operating system
Note: Read SAP Note 26417 to check that all hardware and software requirements for the front-end workstations have been met.
How to Setup an Installation Server
The installation process from an installation server is flexible, easy, and customizable. It makes maintenance easier in any phase of the distribution process, for example, when applying patches.
When installing SAP front end components with server-based workstation installation, the following options are available:
- Without user interaction (unattended)
- With user interaction (attended), where the user has the following options:
- Select from installation packages that the administrator has configured
- Select from a complete list of SAP front end components available on the installation server
The following figure shows how the installation with an installation server works.
With an installation server, the administrator can group various SAP front end components together as installation packages relevant for certain employee roles. The administrator can also specify which package particular users should receive, or offer a variety of packages and allow the user to choose the most appropriate one.
To keep workstations up to date automatically, use the automatic workstation update service (AWUS). Whenever the installation server is patched, or packages are updated on the installation server, this service will update the workstation(s) and reboot them, if necessary. The AWUS works regardless of whether a user is logged on or not:
Creating an Installation Server
NWCreateInstServer is a wizard-driven tool that helps the administrator to create a new installation server. After the server is set up, NwUpdateInstServer imports SAP front end components from the source into the newly created installation server.
Start NwCreateInstServer.exe from the Setup directory.
Choose Next to continue.
NwCreateInstServer.exe prompts you to supply the path to the directory in which you want to create the installation server.
Choose Browse to navigate to the directory in which you want to create the installation server. Ensure that the directory is empty.
Choose Verify to ensure that the chosen directory meets the prerequisites:
Choose Share to maintain the file-sharing properties of the selected directory for distributing using logon scripts and automatic workstation update service
Choose Next to continue.
Processing is recorded in the file NwCreateInstServer.log located in the SAPSetup log file directory.
The wizard confirms the successful installation of the installation server.
You now have a valid but empty SAPSetup installation server.
If you want to set up an empty installation server, you can skip the update by calling NwCreateInstServer.exe with the parameter /NoServerUpdate on the command line. In this case, the procedure ends here.
To update the installation server, reboot the Installation Server and execute NwUpdateInstServer.exe to transfer SAP front end components to your installation server.
Navigate to the Installation Server folder and Click verify to start the Update
The wizard displays the progress of the installation server update.
NwUpdateInstServer.exe transfers all SAP front end components available in the downloaded objects to the installation server.
If you have .NET Framework version 4 installed, choosing Finish Automatically starts NwSapSetupAdmin.exe from the recently updated installation server.
Administering an Installation Server
After you have successfully set up the installation server, you can find admin tools in the SETUP directory of the installation server.
- NWCreateInstServer: Installation Server Creation Wizard Driven Tool that helps in creating a basic Installation Server and configures.NET Security to administer it over a network path.
- NWUpdateInstServer: Installation Server Update Wizard Driven Tool is used to update an Installation Server with SAP Front-End Components. This utility will also automatically update older versions existing on an Installation Server by newer ones.
- NWSAPSetupAdmin: Installation Server Administration Wizard Driven Tool that helps in maintaining and configuring an Installation Server, creating packages, importing products, apply patches etc. Administrators can create a Package Definition File to deploy the package using like Microsoft SCCM.
- NWSAPSetup: Front-End Installation Tool is used to install SAP Front-End Components available on the Installation Server on a Workstation, to update an installation or to perform un-installations. Administrator can install manually or using command lines to perform the installation silently and unattended deployments
- NWCheckWorkstation: This utility is used to diagnose the health of the Workstation containing installed SAP front-end components. It creates a CAB-file with the error information. If required, you supply the logs to the SAP Primary Support.
- NWSAPSetupDS: This tool allows you to configure (Local Security Handling) that helps administrators to allow domain users with non-administrative privileges to install software locally on their workstations.
Import Product: Use this feature to add new products (for example, SAP front-end components) to an existing installation server for distribution over the network.
Export Product: Use this feature to export front-end components available on one installation server to another.
Delete Product: Use this feature to delete a product from an installation server.
Create Package: Use this feature to create packages for deployment. Packages can contain many components and their installation parameters can also be customized.
Create Package Definition File (PDF): You can create a package definition file (PDF) for an installation server package. PDF is a package description format that simplifies the interoperability and information exchange between the SAP Installer and system management products like the System Management Server from Microsoft.
Configure Package: Use this feature to change the attributes or the content of your packages.
Patch: Use this feature to patch components that are available on the installation server.
Local Security Handling: This feature allows workstation users to install SAP components from the installation server without requiring administrative privileges.
Automatic Workstation Update: Whenever the installation server is patched, or the packages installed are updated, this service will update the workstation and reboot them if necessary. The workstation updater works in two modes - one in the presence of a logged-on user and another in his or her absence:
When a user is logged on, the user is informed of update availability and the update happens on the user's assent. The user is also informed if a reboot is necessary and the reboot is also only executed on the user's assent.
If no user is logged on, the update is done automatically and the reboot (if necessary) is done automatically, too.
Control Remote Workstations: This functionality uses the Windows Management Instrumentation (WMI) to help you remotely access and control workstations on which you have administration privileges. You access this feature via the Remote menu, where you find the options to:
Collect remote log files
Execute processes remotely
Enumerate remote processes
You find detailed information in section Controlling Remote Workstations.
Adding New SAP Front End Components to an Existing Installation Server
Click on Import Products
Click Next and follow the wizard instructions
Navigate to the product download location and select the “Setup” Folder
Product import completed
Updating Products on the Installation Server with a Newer Version
Start “NwUpdateInstServer” from the setup directory and follow the wizard instructions
Navigate to the Installation Server folder you want to update and “Verify” the Installation
Click Next to continue the installation
Check the logs for information if the Installation Server update fails for any reason.
Installation Server has been updated successfully
Deleting Products from the Installation Server
Right click on the product and choose “Delete product….” to delete the product.
Click Next to continue product deletion
Choose Close to finish the product deletion.
Creating a New Installation Package
Navigate to the Packages tab and Click on “New Package” to create a new Package.
Configuring Packages and Event Scripts
Switch to the Packages tab page. In the left window pane, you can see a tree listing the existing packages.
The (X) cross indicator next to a package indicates that the package is incomplete. This typically occurs when a product that the package contains has been deleted from the installation server. You can either delete this package or re-import the missing product.
Select the package that you want to customize and navigate to “Package Configuration”
- Verify the Package Parameters (Variable Name, Package Value and Variable Description)
Add event-scripting to perform custom actions on the user’s workstation during the installation of the package (for example, copying additional files). You can insert scripting samples delivered by SAP via Insert Script and adapt them to your requirements. The scripts are executed at the following events:
- On Begin Install: executed before the installation of a selected package
- On End Install: executed after the completion of package installation
- On Begin Uninstall: executed before the uninstallation of a selected package
- On End Uninstall: executed after the completion of package uninstallation
- On Begin Update: Executed before the update of a selected Package.
- On End Update: Executed after the completion of the Package update.
Example: If you want to check a file for existence on the workstation, navigate to “On Installation End” tab and insert a script sample and modify according to your requirements.
Changing the Package Content
- Switch to the Packages tab. In the left window pane, you can see a tree listing the existing packages.
- Select the package for which you want to update the content, and choose Change Package Content.
You can now select or deselect components. Components added will be newly installed on the workstations. Those removed will be uninstalled from the workstations, if they are not part of any other package marked for installation. When updating a package, the package installation parameters are also refreshed and include new variables or delete those that belong to components that are no longer part of this package.
Follow on screen instructions and Save the package when you are finished.
Deleting an Installation Package
- Navigate to Packages view.
- Right-click the package you want to delete.
- From the context menu, choose Delete Package.
- The package is deleted. It is removed from the Packages view.
Creating and Deploying a Single-File Installer for Packages
You can create single-file self-installing .exe-packages via NWSAPSetupAdmin.exe.
Such a package contains only those files that belong to the components that are a part of the package. Thus, it reduces your network load in certain distribution scenarios where you previously had to make local copies of your installation source before installing.
This single-file self-installer can also install silently without user interaction.
Creating a Self-Installing Package
In the Packages tree, right-click the package you want to create a self-installing file from, and choose Compress To Single-File Installer
Following the wizard instructions, you will get a single exe-self-extractor at the end of the process.
Deploying a Self-Installing Package
- The self-installing file created above can be executed on any workstation to install your package.
- Follow the installation wizard.
- This self-installing package can be installed silently (i.e. without user-interaction) when invoked with the command-line parameter /silent.
- This self-installing package can be installed with no dialog (i.e. user can see the installation progress) when invoked with the command-line parameter /nodlg.
Creating a Package Definition File (PDF)
You can create a package definition file (PDF) for an installation server package. PDF is a package description format that simplifies the interoperability and information exchange between the SAP Installer and system management products like the System Management Server from Microsoft.
On the Packages tab, right-click the package for which you want to create a PDF file and choose Create Package Definition File.
Choose the directory where you want to save the file, enter a file name, and choose Save.
Patching the Installation Server
Patching products on the installation server keeps them up-to-date with the most recent correction and enhancements from SAP.
Choose Patch Server.
Choose Next to continue.
Browse to a valid SAP patch file and choose Next to continue.
NWSAPSetupAdmin.exe now validates the patch, which takes a few minutes.
If the patch is valid, you are prompted to proceed with it.
To ensure that the installation server is not in use, the patch now closes NWSAPSetupAdmin.exe before continuing. It restarts NWSAPSetupAdmin.exe after completing the patch.
Choose Next to continue.
NWUpdateInstServer.exe starts patching the installation server.
Follow the patch wizard, choosing Next as required.
At the end of the process, you see a message indicating that the patch was successful.
Choose Close.
NWSAPSetupAdmin.exe now restarts.
Check Update Log Files:
%ProgramFiles%\SAP\SapSetup\Logs\NWUpdateInstServer.log.
If there are errors, you see a link to an Error Report. Any errors are recorded in the following file, which you can view using your normal web browser:
%ProgramFiles%\SAP\SapSetup\Errors\ NWUpdateInstServerErrors_<CurrentDateTime>.xml.
If you have a problem, create a problem message on component BC-FES-INS and attach these files to the message.
Configuring the Local Security Handling (LSH)
Local security handling (LSH) lets users on the network deploy SAP front-end components on their front ends using NetWeaver SAPSetup without requiring administrative privileges on each workstation.
Choose Services and select Configure local security handling.
The LSH configuration wizard starts.
Choose Next.
The wizard prompts you for the credentials of an account that has administrative privileges for all front ends on the network.
Enter the account name with domain qualifiers.
Choose Verify and Next
The wizard will be prompted to enter details for the installation service (IS) account, Verify, and choose Next to complete the process.
The wizard displays the success state in starting the distribution service and the status bar at the bottom of NWSAPSetupAdmin.exe displays the service state as Active.
Test the functioning of the LSH feature by starting NWSAPSetup.exe from this installation server on a front end where the logged-on user has ordinary user privileges (that is, the user does not have administrative privileges).
If the front-end installer starts successfully and is able to install components available on the installation server, the configuration is successful. If not, you need to reconfigure LSH.
LSH Related Notes
Note 1288344 - NwSapSetupAdmin: Could not store IS user data
Note 593486 - Installing the DS installation service (analysis notes)
Local Security Handling broken on patch level 6
7.xx Installing the DS installation service (analysis notes)
Note 1587566 - Installation problems with SapSetup Version 9.0
Configuring the Automatic Workstation Update Service (AWUS)
The SAP Automatic Workstation Update works only when installed on the workstation. Whenever the installation server is patched, or the packages installed are updated, this service will update the workstation(s) and reboot them if necessary. The workstation updater works in two modes - one in the presence of a logged-on user and another in his or her absence:
- When a user is logged on, the user is informed of update availability and the update happens on the user's assent. The user is also informed if a reboot is necessary and the reboot is also only executed on the user's assent.
- If no user is logged on,the update is done automatically and the reboot (if necessary) is done automatically, too.
Note: This service updates itself, when a patch of automatic workstation update is available.
Choose Services -> Configure automatic update.
The screen Automatic Workstation Update Configurations appears as shown in the following picture:
You have now several options:
- Update check frequency
- The workstations that will have this feature installed, will poll the installation server at this interval to check for update availability. The default is 24 hours and the Maximum can be 744 hours.
- Enforce reboot after every update
- When this flag is not set, the user is asked to reboot only if it is required to complete the deployment process. When the flag is set, a reboot is enforced, which means that the user is always asked to reboot.
- Additional Update Sources (optional)
- You can index additional servers. The update service will then look up the indexed servers per line in the given order for available updates.
Save your entries and close the program.
To make the automatic workstation update service available on workstations, you should create a package using NWSapSetupAdmin.exe on the installation server. This package should consist of SAP GUI for Windows and SAP Automatic Workstation Update. Once automatic workstation update is installed, then the following programs will run on the workstation in the background: NWSAPSetupUserNotificationTool.exe and NWSAPAutoWorkstationUpdateService.exe.
Note: The front-end side will query the last 10 installation sources that are network paths.
You have configured the SAP Automatic Workstation Update and made it available on the workstations.
To disable the service, activate the option ‘Disable Automatic Workstation Updates’ in the configuration tool on the installation server (see picture above). This configuration change is propagated as an update to the workstations at the time of the next update check.
Note: Once disabled, this action cannot be undone until the Automatic Workstation Update Service is reinstalled.
AWUS Notes
Note 1584270 - AWUS & SapSrvSetup.xml
Note 1624251 - Moving an Installation Server to a new machine
Controlling Remote Workstations
The remote workstation control functionality helps you to remotely access and control workstations on which you have administration privileges.
Choose Remote.
You have now several options:
Collect Log Files
With this option, you can collect log files from remote workstations. For this, you just have to enter the workstation name. In case you want to collect log files from several machines, you have to separate the different names by a comma.
Look at the remote workstation log files on your local pc after download.
Execute Process Remotely (WMI)
With this option, you execute processes on a remote workstation. You just have to enter the workstation name as well as the application name in the appropriate field. Also, you can supply the application with the appropriate command line parameter, for example: c:\program files\sap\sapsetup\setup\nwsapsetup.exe /uninstall /all /silent. Then choose Execute to run the process on the remote machine.
Remote Task Manager (WMI)
With this option, you get a list of processes running on a remote workstation. Just enter the workstation name and choose Display. If you want to terminate a process, select the process and choose Terminate.
Note: Be careful with the Terminate option, because the user may lose unsaved date.
Troubleshooting
If you encounter problems with the WMI feature, diagnose WMI connectivity to a remote workstation using the Microsoft tool wbemtest.exe. Note, that you have to supply the connection namespace as \\WorkstationName\root\cimv2.
Delegation
In order to start an installation on a remote workstation that is located on an installation server, delegation is required to be activated for the client machine(s) in question. Please, refer to the Microsoft TechNet article at http://technet.microsoft.com/en-us/library/ee692772.aspx, question 10 for further details.
Installation Process
Installing SAP Front End Components from an Installation Server
This procedure tells you how to install Front end Components from an installation server
Start NWSAPSetup.exe from the SETUP folder on the installation server.
The SAPSetup installation wizard appears.
Choose Next.
The product list is displayed. Products that have already been installed are pre-selected as shown in the following picture:
Select the products or SAP front-end components that you want to install or deselect the ones you want to remove.
Yellow dots indicate changes in the selection list. The Green plus next to a product name indicates that “This item will be installed” when the user installs the package on his or her workstation.
The checkbox with no additional symbols indicates that “This item is already installed” Uncheck the product if you don’t want to reinstall.
If you deselect a product in this list that has already been installed, a Red minus appears to indicate that “This item will be uninstalled”
Follow the wizard instructions to finish the GUI installation.
Installing Packages Configured by the Administrator
This procedure lets you install or remove packages on your front end that have been configured by the administrator on the installation server.
Note: Be careful when removing packages. Make sure you do not mistakenly remove shared components that are used by other packages you want to keep.
Start NWSAPSetup.exe /package from the SETUP folder of the installation server.
A list of the packages that the user is authorized to install or uninstall is displayed. Packages that have already been installed are pre-selected.
In this case, the BW Package has been selected for installation. The yellow dot indicates a change in the selection list. The green plus next to the product name indicates that this object will be installed when the user installs the package on his or her workstation. If you deselected a package, you would see a red minus next to the object selected for de-installation.
Select the components or packages that you want to install or deselect the ones you want to remove.
Note: If errors occur during the installation, SAPSetup displays a link to a document in which the errors have been logged. Contact the administrator of the installation server or the network and pass on the information given in this document.
Installing Packages Using the Logon Script
Since the front-end software is normally installed on a large number of computers, NWSAPSetup lets you automate this task.
By inserting a command line into the logon scripts of the computers on which the front-end software is to be installed, you can start a package installation each time the user logs on.
Enter the following command (both the path and either the package name or unique package identifier must be used):
\\<server>\<shared folder>\setup\NWSAPSetup.exe /package:“<package command-line name>“ /silent
You can also call NWSAPSetupAdmin.exe in the same way to perform this task.
When you start this command for the first time on a computer, NWSAPSetup installs the specified package.
Updating a Workstation from an Installation Server
You can update the front end from an installation server.
Updating the front end basically involves the same steps as an installation; see section Installation of the SAP Front End from an Installation Server
You have the possibility to have the update run unattendedly or automatically:
For unattended update, use the following command line: \\<server_path>\setup\NWSAPSETUP.exe /UPDATE /silent
To update a specific package or product, add:
/package="package command-line name"
Or
/product="product command-line name"
You will find the command-line name of the package or product in the administrative console NWSAPSetupAdmin.exe.
For automatic update, you can use the SAP Automatic Workstation Update. Whenever the installation server is patched, or the packages installed are updated, this service will update the workstation(s) and reboot them if necessary. The workstation updater works in two modes - one in the presence of a logged-on user and another in his or her absence
- When a user is logged on, the user is informed of update availability and the update happens on the user's assent. The user is also informed if a reboot is necessary and the reboot is also only executed on the user's assent.
- If no user is logged on, the update is done automatically and the reboot (if necessary) is done automatically, too.
The SAP Automatic Workstation Update is not SAP GUI-specific, it works with all components available on the installation server. For details, see section 3.9 Configuring SAP Automatic Workstation Update.
Log Files
All the installation tools described in this document maintain an activity record in log files that you can find here:
%ProgramFiles%\SAP\SAPSetup\Logs
Each tool stores the last ten log files.
Error Files
Errors are stored in an XML format in files that you can view in any browser and you can find in the following folder:
%ProgramFiles%\SAP\SAPSetup\Errors
If you have a problem, create a problem message in BC-FES-INS and attach the relevant log files to the message.
| Tool | Log File | Error File |
| NwCreateInstServer.exe | NwCreateInstServer.log | NwCreateInstServerErrors_<DateTime>.xml |
| NwUpdateInstServer.exe | NwUpdateInstServer.log | NwUpdateInstServerErrors_<DateTime>.xml |
| NwSapSetupAdmin.exe | NwSapSetupAdmin.log | NwSapSetupAdminErrors_<DateTime>.xml |
| NwSapSetup.exe – Single File Installer | NwSapSetup.log | SAPSetupErrors_<DateTime>.xml |
Return Codes
The following table describes the return codes for NwSapSetup.exe
| Return Codes | Description |
| 0 | Process ended without detected errors |
| 3 | Another instance of SAPSetup is running |
| 4 | LSH failed |
| 16 | SAPSetup started on WTS without administrator privileges |
| 26 | WTS is not in install mode |
| 27 | An error occurred in COM |
| 48 | General error |
| 67 | Installation canceled by user |
| 68 | Invalid patch |
| 69 | Installation engine registration failed |
| 70 | Invalid XML files |
| 129 | Reboot is recommended |
| 130 | Reboot was forced |
| 144 | Error report created |
| 145 | Error report created and reboot recommended |
| 146 | Error report created and reboot forced |
Additional Information
Troubleshooting
Note 508649 - Diagnosis of frontend installation problems
References
http://scn.sap.com/docs/DOC-25456
http://scn.sap.com/community/gui/blog/2013/05/08/sap-gui-730-installation-errors
http://scn.sap.com/docs/DOC-42976
http://scn.sap.com/community/gui/blog/2013/05/02/sap-gui-730-patches-and-relevant-notes
http://scn.sap.com/community/gui/blog/2013/05/10/sap-gui-branding
***********
11 Comments
