Sap setup guide
0 likes357 views
This document provides an administration guide for SAPSetup 9.0, which is a tool for installing and managing SAP front-end components on Windows workstations. It allows creating an installation server to host SAP software packages and deploy them to client machines. The guide covers planning installations, setting up and administering the installation server, installing packages on workstations, and troubleshooting. It also documents the Visual Basic scripting APIs that can be used to customize package installations.
![2 Latest Information
The SAP Notes contain the most recent information about SAPSetup 9.0.
Make sure that you read the latest version of the following SAP Notes before your start the installation:
SAP Note Number Description
1587566 Detailed release notes and known issues of SapSetup version
9.0. Description how to retrieve the latest version of SAPSetup.
1583967 General release information note for SAPSetup 9.0
1162270 Installing the DS installation service (analysis notes). Addi
tional information on how to create and maintain an installa
tion server to distribute the SAP Frontend Software for Win
dows to client computers using Local Security Handling.
1177282 End of support for SAP releases using Microsoft products.
You can find the SAP Notes in SAP Support Portal at https:/
/support.sap.com/notes .
To check the latest version of this guide, see the SAP Support Portal athttps:/
/support.sap.com/sltoolset
Front End Installation Guide for SAPSetup or the SAP Help Portal at https:/
/help.sap.com/sapsetup.
History of Changes
The following table provides an overview of new features and most important changes.
Change History
Features and Changes Availability
Major redesign of the whole guide. Added documentation of the API of SAPSetup specific
Visual Basic Script classes that can be used in package event scripts.
SAPSetup 9.0.76
Explanation: Repair Metadata and hashes (see Troubleshooting [page 52]) SAPSetup 9.0.59
You can now start and stop the distribution service in the NwSapSetupAdmin tool (see Con
figuring the Local Security Handling [page 32]).
SAPSetup 9.0.57
You can now execute processes in the NwSapSetupAdmin tool remotely (see Executing a
Process Remotely [page 37]).
SAPSetup 9.0.56
SAPSetup Guide
Latest Information P U B L I C 5](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-5-320.jpg)
![Features and Changes Availability
Explanation: Updating the installation server using NwSapSetupAdmin requires the extrac
tion of a single file installer first (see Updating Products on the Installation Server [page
19]).
SAPSetup 9.0.55
6 P U B L I C
SAPSetup Guide
Latest Information](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-6-320.jpg)
![3 Glossary
See the table below for descriptions of terms and abbreviations used in this guide
The are listed below.
Term Description
AWUS Automatic workstation update service.
For more information, see Installing and Configuring the Automatic Workstation Update
Service [page 34].
distribution medium Contains the installer for an SAP front end component. It is either a directory in the file
system or a single-file installer.
event script A Visual Basic script that extends a package with custom actions. Events are installation,
update and uninstall of a package. Event scripts can be defined to run before or after an
event.
For more information, see Configuring Packages and Event Scripts [page 22].
installation server Central installation repository for distributing SAP front end components to many work
stations.
Prerequisite for packages, AWUS, and LSH.
LSH Local security handling.
For more information, see Configuring the Local Security Handling [page 32]
package Selection of SAP front end components defined by the administrator of an installation
server.
Optionally contains configuration of installation parameters and event scripts.
patch Single-file installer which contains only the parts of an SAP front end component that
changed between two versions.
A patch can be applied to a workstation or an installation server where the base version of
the SAP front end component is already present.
product Synonym for SAP front end component.
SAP front end component SAP software that runs on a workstation and is installed and maintained with SAPSetup
SAPSetup Tool suite for installing, updating, maintaining, and distributing software on Windows™.
single-file installer Self-extracting executable that contains a package, a patch, or an installer for an SAP
front end component.
SAPSetup Guide
Glossary P U B L I C 7](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-7-320.jpg)
![4 Planning the Installation of SAP Front End
Components
This section describes how to plan the installation of SAP front end components.
1. You plan the installation scenario [page 9].
2. You make sure that your system meets the hardware and software requirements [page 11].
3. You review the installation and maintenance flow [page 12].
4.1 Installation Scenarios
You can install SAP front end components for Windows™ either from a distribution medium or from an installation
server.
Installation Scenario Description
Installation from a distribution medium (for exam
ple a DVD)
The administrator takes the distribution medium from workstation to
workstation.
This is mainly for test purpose or for standalone workstations.
Installation from an installation server The administrator sets up an installation server, where the installation of
the SAP front end components on different clients is started remotely.
All necessary files are copied from the server to the clients during installa
tion.
Tip
We recommend you to use the scenario Installation from an installation server because of its greater flexibility
and efficiency, especially if many workstations are involved.
Installation from a Distribution Medium
A local installation on workstations with a distribution medium such as a DVD is useful for installing SAP front end
components on single machines (for example, laptops) that are not connected to a Local Area Network (LAN). You
can also use it for test purposes.
Restriction
This installation scenario has the following restrictions:
SAPSetup Guide
Planning the Installation of SAP Front End Components P U B L I C 9](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-9-320.jpg)
![With an installation server, you as administrator can group various SAP front end components together as
installation packages relevant for certain employee roles. You 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.
In addition, you can configure the distribution service to add LSH functions to the installation server. With LSH, the
installation can be started even by a user who is not a member of the local group of administrators. The
distribution service then installs a service process on the client and starts NwSapSetup.exe in the context of this
service. The user privileges are not altered. The installed service does not start other processes except
NwSapSetup.exe from configured installation servers. Afterwards, the service removes itself from the
workstation again.
The hard disk requirement on the installation server depends on the type and number of SAP front end
components that are added to an installation server. For example, SAP GUI for Windows requires approximately
800 MB with all SAP front end components installed.
As administrator, you can configure your own installation packages on the installation server with
NwSapSetupAdmin.exe .
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:
● If a user is logged on, the user is notified about the available update, and the update starts upon confirmation
by the user. The user is also notified about whether a reboot is required, and the reboot is executed only upon
confirmation by the user.
● If no user is logged on, the update and the reboot (if required) are started automatically.
Alternatively, you can apply patches on the installation server and then start the installation on your workstation to
apply the patch on the workstation. You can control the installation using the command line. You can perform
unattended installations with automatic patch installation on the workstation. To do so, insert the appropriate
command line in the logon script of the user. The logon script is a program that is executed when a user logs on.
Related Information
Installing and Configuring the Automatic Workstation Update Service [page 34]
4.2 Hardware and Software Requirements
This section describes the requirements your system needs to meet.
Front end workstations
For hard drive clones only:
If the operating systems of your workstations were generated by hard drive cloning, make sure that the domain is
set correctly. To do so, take the workstations out of the domain and then put them back in.
This is especially important if you intend to use LSH. More information: Configuring the Local Security Handling
[page 32].
SAPSetup Guide
Planning the Installation of SAP Front End Components P U B L I C 11](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-11-320.jpg)
![Computer for hosting the installation server
The following conditions have to be fulfilled:
● Windows server as operating system.
● .NET Framework 4.0 client profile has to be installed to run the administration tool.
● Read access for all users at all times, even after the installation is complete.
This is required for maintenance purposes such as the distribution of patches and updates.
● Broadband network connection for high throughput.
● Enough free disk space for all SAP front end components to be imported.
4.3 Use Case: Installation and Maintenance
This section describes a typical installation and maintenance use case for installing SAP front end components on
a workstation using an installation server.
1. You set up an installation server [page 15] and, if required, LSH.
The installation server contains the following:
○ Installation programs
○ Configuration information (for example, packages)
○ Service files (for LSH)
○ Front end components to be installed
2. You maintain installation packages [page 20] for different user groups.
Users can install multiple packages, and packages can share SAP front end components. You can configure
installation parameters, such as installation directories, for the components that a package contains.
3. Recommendation: You configure LSH [page 32].
Test the LSH by logging on to a user workstation as a user without local administrator privileges, and then
running NwSapSetup.exe from the installation server.
Note
Windows has local security mechanisms. Only users with local administrator privileges have write access to
parts of the system database and the file system. SAPSetup solves this problem with the distribution
service (DS) that resides on the server, and with the installation service (IS) that is installed on the
workstation temporarily. The IS starts a new instance of NwSapSetup.exe that runs with sufficient
privileges.
4. You install packages using the logon script [page 43] of your workstation or using other distribution
mechanisms.
5. You patch the installation server [page 31].
6. You update SAP front end components [page 41] on a workstation when a new release is available on the
installation server.
12 P U B L I C
SAPSetup Guide
Planning the Installation of SAP Front End Components](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-12-320.jpg)
![5 Setup and Administration of the
Installation Server
This section describes how to set up and maintain an installation server for the efficient distribution of SAP front
end components across workstations.
Features
The tool for administering the installation server is NwSapSetupAdmin.exe. You can find
NwSapSetupAdmin.exe in the installation server’s Setup directory after successful installation.
Note
NwSapSetupAdmin.exe requires .NET Framework 4, which you can download from the Microsoft Download
Center .
● Product Import
Use this feature to add new SAP front end components to an existing installation server for distribution over
the network.
More information: Adding SAP Front End Components to the Installation Server [page 18]
● Product Export
Use this feature to export SAP front end components available on one installation server to another.
More information: Updating Products on the Installation Server [page 19]
● Product Deletion
Use this feature to delete a SAP front end component from an installation server.
More information: Deleting Products from the Installation Server [page 20]
● Package Creation
Use this feature to create packages for deployment. Packages can contain multiple SAP front end
components, and their installation parameters can be customized.
More information: Creating an Installation Package [page 21]
● Single-File Installer Creation
Use this feature to create single-file installers.
More information: Creating and Deploying a Single-File Installer for Packages [page 29]
● Package Definition Files (PDF) Creation
Use this feature to 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 SAPSetup and
system management products such as Microsoft’s System Management Server.
More information: Creating a Package Definition File [page 30]
● Package Configuration
Use this feature to change the attributes or the content of your packages.
More information: Changing the Package Content [page 28]
● Installation Server Patch
Use this feature to patch SAP front end components that are available on the installation server.
SAPSetup Guide
Setup and Administration of the Installation Server P U B L I C 13](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-13-320.jpg)
![More information: Patching the Installation Server [page 31]
● Local Security Handling (LSH) Configuration
Using this feature, workstation users are allowed to install SAP front end components from the installation
server without requiring administrator privileges.
More information: Configuring the Local Security Handling [page 32]
● Automatic Workstation Update Configuration
Whenever the installation server is patched or the installed packages are updated, this service updates the
workstations and reboots them, if required. AWUS works regardless of whether a user is logged on.
○ If a user is logged on, he is informed of the availability of updates and the update is started upon
confirmation by the user. The user is also informed about whether a reboot is required (the reboot needs
to be confirmed as well by the user).
○ If no user is logged on, the system performs the update and the reboot (if required) automatically.
More information: Installing and Configuring the Automatic Workstation Update Service [page 34]
● Remote Workstation Control
This feature uses the Windows Management Instrumentation (WMI) to help you remotely access and control
workstations on which you have administrator privileges. You access this feature using the Remote menu,
where the following options are offered:
○ Collect Log Files
○ Execute Process Remotely
○ Remote Task Manager
More information: Controlling a Remote Workstation [page 36]
Tools
Note
The log files of all installation tools are stored in the following directory:
%ProgramFiles%SAPSapSetupLOGs (32bit Windows)
%ProgramFiles(x86)%SAPSapSetupLOGs (64bit Windows)
Each tool stores the last 20 log files.
Tool Description
NwCheckWorkstation.exe Verifies the integrity of installed SAP front end components on a workstation
Logfile: NwCheckWorkstation.log
NwCreateInstServer.exe Creates a new installation server
Logfile: NwCreateInstServer.log
NwSapSetup.exe Executes an installation, patch, update or uninstall
Logfile: NwSapSetup.log
14 P U B L I C
SAPSetup Guide
Setup and Administration of the Installation Server](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-14-320.jpg)
![Tool Description
NwSapSetupAdmin.exe Manages the installation server
Logfile: NwSapSetupAdmin.log
NwSapSetupIs.exe Runs as a Windows service on the workstation temporarily when using LSH
(Local Security Handling), never to be executed manually
Logfile: NwSapSetupIs.log
NwSapSetupOnRebootInstSvc.exe Carries out the necessary steps to complete the installation (or patch, up
date, uninstall) as a Windows service if a reboot is needed, never to be exe
cuted manually
Logfile: NwSapSetupOnRebootInstSvc.log
NwUpdateInstServer.exe ● Imports products into a freshly created installation server (called di
rectly by NwCreateInstServer.exe) initially
● Adds an additional product to an existing installation server
● Updates products on an installation server with a newer version
Logfile: NwUpdateInstServer.log
Procedure
1. You set up an installation server [page 15].
2. You add new SAP front end components to an existing installation [page 18], if required.
3. You update products on the installation server [page 19] with a newer version using a patch, if required.
4. You create and maintain installation packages [page 20], if required.
5. You patch the installation server [page 31], if required.
6. You configure LSH [page 32], if required.
5.1 Setting Up the Installation Server
This procedure helps you to distribute SAP front end software on multiple workstations across the network.
Prerequisites
To carry out the following task, you need to have local administrator privileges.
SAPSetup Guide
Setup and Administration of the Installation Server P U B L I C 15](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-15-320.jpg)
![Context
NwCreateInstServer is a wizard-driven tool that helps the administrator to create a new installation server. All
SAP front end components from the source are imported into the newly created installation server. The installation
server consists of a directory that is shared on the network. There is no background process running.
Procedure
1. If you have an installation medium, start NwCreateInstServer.exe from the Setup directory. If you have a
single file installer, open a command prompt and call it with the parameter /CreateServer. On the welcome
screen, choose Next.
You can choose Cancel at any stage to abort the process.
2. Choose the target directory, in which the installation server will be created.
a. Choose Browse to navigate to the directory in which you want to create the installation server. Ensure that
the directory is empty.
b. Choose Verify to ensure that the chosen directory meets the following prerequisites:
○ It must exist.
○ It must be accessible to the administrator with full access.
c. If you want to use one of the following features, choose Share to provide read access for the selected
directory to the users that shall install from this installation server:
○ AWUS [page 34]
○ LSH [page 32]
○ Distribution using logon scripts.
○ Installation and update on workstations using the network share.
○ Execute installations from the installation server on remote workstations (remote execution [page
37]).
Note
If you run NwCreateInstServer.exe with parameter /silent, the directory is automatically
configured as a NULL-session share and is accessible on the network for everyone to read. If you do
not require this automatic configuration, add the parameter /DontConfigureServerPath to the
command line. With the parameter /silent you also need to specify the parameter /
dest:<destination directory>, where <destination directory> is the directory in
which the installation server will be created.
d. Choose Next to continue.
Note
Processing is recorded in the file NwCreateInstServer.log located in the SAPSetup log file
directory.
If an error occurs, see Troubleshooting [page 52], sectionTroubleshooting on the Installation Server.
The wizard displays the progress of the server creation process and confirms the successful installation of the
installation server.
16 P U B L I C
SAPSetup Guide
Setup and Administration of the Installation Server](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-16-320.jpg)
![3. To update the installation server with SAP front end components, choose Next.
NwCreateInstServer.exe automatically calls NwUpdateInstServer.exe to import the SAP front end
components into your installation server.
The wizard displays the progress of the installation server update.
Note
Processing is recorded in the file NwUpdateInstServer.log located in the SAPSetup log file directory. If
an error occurs, see Troubleshooting [page 52], section Troubleshooting on the Installation Server.
NwUpdateInstServer.exe imports all SAP front end components available on the distribution medium into
the installation server.
After completing the update, the wizard confirms that you can use the installation server for installing SAP
front end components on workstations.
4. If you have installed .NET Framework version 4, you can choose that the administration tool for the
installation server will be started. To finish the update, choose Close.
Results
If you chose to start the administration tool for the installation server, NwSapSetupAdmin.exe is started
automatically from the installation server. You can start it manually from the Setup directory of the installation
server.
For more information, see Setup and Administration of the Installation Server [page 13].
Note
● If you require a copy of the installation server, you can replicate the server by entering the following
command:
InstallationServerShareSetupNwCreateInstServer.exe /
Dest=<ReplicationPath> /Nodlg
● If you want to copy the SAP front end components and packages of one installation server to another one,
enter the following command:
InstallationServerShareSetupNwUpdateInstServer.exe /
Dest=<DestinationServer>Setup /Nodlg
The settings for AWUS, LSH and share permissions are not copied. Existing packages on the destination
server will only be overwritten, if they have the same GUID. Avoid having two packages that have the same
command line name.
Recommendation
After setting up your installation server, we recommend that you look for the latest patches. Obtain the latest
SAPSetup version from SAP Note 1587566 . For more information, see Patching the Installation Server [page
31].
SAPSetup Guide
Setup and Administration of the Installation Server P U B L I C 17](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-17-320.jpg)
![○ Command window
○ Enter
UpdateSourceSetupNwUpdateInstServer.exe /dest=<installation server Setup
directory> /nodlg
or
UpdateSourceSetupNwUpdateInstServer.exe /dest=<installation server Setup
directory> /silent
Related Information
Command Line Parameters for the Installation Server [page 40]
5.4 Deleting Products from the Installation Server
This section describes how to delete SAP front end components from an installation server.
Procedure
1. Start NwSapSetupAdmin.exe from the Setup directory of the installation server from which you want to
delete a SAP front end component.
2. On the Products tab, select the SAP front end component to be deleted and choose Delete Product from the
context menu.
The SAP front end component deletion wizard is displayed.
3. To delete a SAP front end component, follow the deletion wizard instructions.
At the end of the deletion process, a message is displayed that informs you whether the deletion process has
completed successfully.
5.5 Installation Packages: Creation and Maintenance
After setting up an installation server, you can create packages using NwSapSetupAdmin.exe in the Setup
directory on the installation server.
A package consists of one or more SAP front end components that you want to install on the workstations. You can
preconfigure the installation parameters of the package, for example the installation target directory. You can
customize and extend the installation of packages by implementing script events.
20 P U B L I C
SAPSetup Guide
Setup and Administration of the Installation Server](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-20-320.jpg)
![5.5.1 Creating an Installation Package
Procedure
1. Start NwSapSetupAdmin.exe from the Setup directory of your installation server.
2. To start the Package Creation Wizard, choose New Package from the toolbar.
3. To continue, choose Next.
The wizard displays the SAP front end components available on the installation server.
4. Select the SAP front end components that you want to include in your package and choose Next.
A yellow dot indicates a change in the selection list. A green plus sign indicates the SAP front end components
to be installed.
Note
You can create packages that do not contain any SAP front end components. Such packages can be used to
execute event scripts on workstations, for example to distribute your own configuration files.
For more information, see Configuring Packages and Event Scripts [page 22] and Creating and Deploying a
Single-File Installer for Packages [page 29].
5. Enter a display name for the new package and choose Next.
6. Enter a command line name for the new package and choose Next.
This name is required when installing the package by calling NwSapSetup.exe on the command line with the
parameter /package. For more information, see Command Line Parameters for the Workstation [page 48]
The new package is created and a confirmation is displayed in the wizard.
7. Choose Close.
Results
The new package is displayed on the Packages tab. You can now configure the package to implement event scripts
and customize installation parameters, for example the installation target path.
Related Information
Configuring Packages and Event Scripts [page 22]
SAPSetup Guide
Setup and Administration of the Installation Server P U B L I C 21](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-21-320.jpg)
![Related Information
Package Event Script Samples [page 23]
Repairing Installed SAP Front End Components [page 47]
Changing the Package Content [page 28]
5.5.2.1 Package Event Script Samples
The following Visual Basic Script commands help you to customize your packages.
Tip
All script samples below are available directly in NwSapSetupAdmin.exe on the Configure Packages tab.
Add custom logging to the log file
NwEngine.Context.Log.Write "Event: On Installation Start"
Log an error
‘Adds an error log entry to NwSapSetup.log, SAPSetup will exit with
'return code different than 0
NwEngine.Context.Log.WriteError "Error in custom script: something failed!"
Get the value of an installation variable
srcFile = NwEngine.Variables.ResolveString(_
"%SapSrcDir%CustomerFilesTestFile.txt")srcDir =
NwEngine.Variables.ResolveString("%SapSrcDir%CustomerFiles")destDir = "C:temp
TestDir" destFile = "C:tempTestDirTestFile.txt" destFile1 =
NwEngine.Variables.ResolveString("%ProgramFiles%TestFile.txt") destFile2 =
NwEngine.Variables.ResolveString("%CommonProgramFiles%TestFile.txt") destFile3 =
NwEngine.Variables.ResolveString("%WinDir%TestFile.txt")
SAPSetup Guide
Setup and Administration of the Installation Server P U B L I C 23](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-23-320.jpg)
![your files into this directory. All files and directories in this direcctory will be included in every package single-
file installer. Use package event scripts to install your custom files.
For more information, see Package Event Script Samples [page 23].
Tip
The single-file installer can be executed on any workstation.
To run the single-file installer silently without user interaction, enter /silent in the command line. More
information: Command Line Parameters for the Installation Server [page 40].
Procedure
1. Start NwSapSetupAdmin.exe from the Setup directory of your installation server.
2. On the Packages tab page, select the package for which you want to create a single-file installer and choose
Compress to Single-File Installer from the context menu.
3. Follow the wizard instructions.
4. To deploy the single-file installer, follow the wizard instructions.
Results
You have created and deployed a single-file installer.
5.5.6 Creating a Package Definition File
This section describes how to create a package definition file (PDF) for an installation server package.
Context
PDF is a package description format that simplifies the interoperability and information exchange between
SAPSetup and system management products such as Microsoft’s Systems Management Server.
Procedure
1. Start NwSapSetupAdmin.exe from the Setup directory of your installation server.
2. On the Packages tab page, select the package for which you want to create a PDF file and choose Create
Package Definition File from the context menu.
30 P U B L I C
SAPSetup Guide
Setup and Administration of the Installation Server](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-30-320.jpg)
![3. In the upcoming window, choose the directory where you want to save the file, enter a file name, and save your
entries.
Results
NwSapSetupAdmin.exe creates a PDF and a Microsoft Systems Management Server (SMS) file in the specified
directory.
5.6 Patching the Installation Server
Patching SAP front end components on the installation server keeps them up to date with the most recent
correction and enhancements from SAP.
Context
Tip
You can configure the Automatic Workstation Update Service (AWUS). This service updates the workstations
and reboots them whenever the installation server is patched or the installed packages are updated, if
necessary. The AWUS also works if no user is logged on to the workstation.
More information: Installing and Configuring the Automatic Workstation Update Service [page 34]
Note
To ensure a successful patch and to prevent having to reboot after the patch, you can unshare the installation
server during the patch and share it again when the patch has finished.
Procedure
1. Start NwSapSetupAdmin.exe from the Setup directory of the installation server.
2. Choose Patch Server.
This starts the patch wizard.
3. To continue, choose Next.
4. Browse to the SAP patch file and choose Next.
NwSapSetupAdmin.exe validates the patch. If the patch is valid, you are prompted to proceed.
SAPSetup Guide
Setup and Administration of the Installation Server P U B L I C 31](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-31-320.jpg)
![Note
When the patch process starts, NwSapSetupAdmin.exe is closed. It restarts after the patch process has
completed. This ensures that the installation server is not modified during the patch process.
5. To continue, choose Next.
NwUpdateInstServer.exe starts patching the installation server. A log file is created in the SAPSetup log
file directory.
6. Follow the wizard instructions.
The wizard confirms the successful patch process. If an error occurs, see Troubleshooting [page 52].
7. Choose Close.
NwSapSetupAdmin.exe now restarts.
Results
Patching a SAP front end component (for example, SAP GUI for Windows 7.30) increases the version of each
package that contains this component.
5.7 Configuring the Local Security Handling
Local security handling (LSH) enables users to install SAP front end components on their workstations without
requiring administrator privileges. By configuring LSH, the distribution service is installed and started.
Prerequisites
● The installation server needs to be available and accessible via file sharing from the workstation.
● Server and workstations must be part of a Windows domain or active directory.
● Two domain user accounts are needed to run the installation service and the distribution service. The user for
the distribution service must have administrative privileges on each workstation. The user for the installation
service will get administrative privileges on the workstation temporarily, if he doesn’t have them anyway. You
can use the same user account for both services.
● It must be possible to control services via the remote service management on the workstations. Make sure to
configure the firewall accordingly.
Remember
To enable workstations that run Microsoft Windows Vista to use LSH, you have to change the default firewall
setting for remote service management:
1. Start the Control Panel.
2. Choose Windows Firewall Change Settings .
32 P U B L I C
SAPSetup Guide
Setup and Administration of the Installation Server](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-32-320.jpg)
![Option Result
Update check frequency The workstation will check for updates at this interval. The default value is 24 hours.
Enforce reboot With these options, you can control whether a reboot of the workstation should be
enforced after an update.
Enforce reboot if needed (recommended): A reboot will take place, if it is necessary
to complete the update.
Enforce reboot after every update: A reboot will be initiated after every update.
Don't enforce reboot : No reboot will be initiated.
In case a reboot is initiated and a user is logged on, the user will be notified. Reboot
will only be performed after getting his approval.
Additional update sources
(optional)
You can list additional installation servers. The AWUS will check the listed installa
tion servers for available updates in the given order. By default, the AWUS will al
ways check the installation server from which it had been installed itself.
Disable automatic workstation
updates
The AWUS on the workstation is disabled the next time it checks for updates. It will
not execute updates from this server, until you enable it again.
To permanently stop AWUS on a workstation, uninstall it from the workstation.
d. Save your entries and close the dialog.
2. Install the AWUS on the workstation:
a. Create a package containing the component SAP Automatic Workstation Update.
More information: Creating an Installation Package [page 21]
b. Deploy the package on the workstation.
More information: Installing Packages Configured by the Administrator [page 42]
Once the AWUS is installed, the following programs will run on the workstation in background mode:
○ NwSapSetupUserNotificationTool.exe
○ NwSapAutoWorkstationUpdateService.exe
Note
The AWUS checks for updates on the last 10 installation sources that are network paths.
Results
You have configured the AWUS and installed it on the workstation.
SAPSetup Guide
Setup and Administration of the Installation Server P U B L I C 35](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-35-320.jpg)
![5.9 Controlling a Remote Workstation
With the remote workstation control you can access and control workstations remotely on which you have
administrator privileges.
Prerequisites
● Check if the installation server is available.
● Enable the Windows Management Instrumentation (WMI).
● Check that WMI access is not blocked by the firewall.
● Check if you have either domain administrator privileges or local administrator privileges on the workstation.
Tip
Use the Microsoft tool wbemtest.exe to check the WMI connectivity to the remote workstation. Enter the
connection namespace as <WorkstationName>rootcimv2.
Features
With the remote workstation control you can:
● Collect log files from workstations.
More information: Collecting Log Files Remotely [page 36]
● Execute a process on the workstation.
More information: Executing a Process Remotely [page 37]
● Display a list of processes running on the workstation.
More information: Listing Remote Processes [page 39]
5.9.1 Collecting Log Files Remotely
This section describes how to collect log files from a workstation remotely.
Procedure
1. Start NwSapSetupAdmin.exe from the Setup directory of the installation server.
2. Choose Remote Collect Log Files (WMI) .
3. Enter the name of the workstation. If you want to collect log files from several workstations, separate the host
names with a comma.
36 P U B L I C
SAPSetup Guide
Setup and Administration of the Installation Server](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-36-320.jpg)
![2. Choose Remote Execute on Remote Workstation .
The Execute process on a remote computer dialog is displayed.
3. Choose the action that you want to execute:
○ Install: will install any selected product or package that is not yet installed on the remote workstation, and
it will update any selected product or package that is already installed on the remote workstation.
○ Update: will enable the item All, so that you can update all installed products on the remote computer with
the version on the installation server. If you select a product or package that is not yet installed on the
remote computer, it will be installed. No downgrade will be done.
○ Repair: will repair installed SAP front end components [page 47] on the remote computer.
○ Uninstall: will uninstall the selected SAP front end components from the remote workstation.
4. Choose the item that you want to be processed.
The available items depend on the action you chose. The options Install All and Repair Product are not
available.
Note
Repairing a package is useful to execute your package event scripts [page 23] again. Make sure to increase
the version of the package beforehand.
The command line [page 48] that will get executed is displayed at the bottom of the dialog, you can copy it.
5. Enter the name of the remote computer you want to execute the process on.
6. Choose if you want to execute the process as user LocalSystem or as a different user.
If your installation server is shared as a null session share, the process will run as user LocalSystem. Otherwise
you have to specify the credentials of a user that is local administrator on the remote workstation and has
access to the shared installation server.
More information: Microsoft support article about null sesstion share enablement
7. Choose Execute to run the process on the remote machine.
After choosing Execute, NwSapSetupAdmin waits for the remote process to start. A message box informs if
the start was successful. There is no feedback on the progress of the process, nor when it is finished. It runs
now independently from your actions. You can leave the dialog or start the next remote process.
8. To check if the process has finished, choose Remote Remote Task Manager (WMI) and check for the
process [page 39] NwSapSetup.exe.
9. To check the results, choose Remote Collect Log Files (WMI) and check the return code [page 54] of
the latest NwSapSetup.log file.
Note
If you encounter connection issues, see 1162270 .
38 P U B L I C
SAPSetup Guide
Setup and Administration of the Installation Server](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-38-320.jpg)
![5.9.3 Listing Remote Processes
This section describes how to display the list of processes running on the workstation.
Procedure
1. Start NwSapSetupAdmin.exe from the Setup directory of the installation server.
2. Choose Remote Remote Task Manager (WMI) .
3. Enter the name of the workstation and choose Display.
Note
If you want to terminate a process, select it and choose Terminate. Be aware that in this case, the user who
is working on the remote machine might lose unsaved data.
5.10 Removing the Installation Server
This section describes how to remove an installation server if it is no longer required.
Procedure
1. If the LSH [page 32] is configured, start NwSapSetupAdmin.exe and choose Services Stop Distribution
Service .
2. Unshare the directory of the installation server.
As a result the installation server is unavailable for workstations.
3. Delete the directory containing the installation server.
SAPSetup Guide
Setup and Administration of the Installation Server P U B L I C 39](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-39-320.jpg)
![5.11 Command Line Parameters for the Installation Server
This section provides command line parameters for installation servers. They are not case-sensitive.
Parameters for NwCreateInstServer.exe and NwUpdateInstServer.exe
Parameter Description
/dest Destination directory where you want to create your installation server.
Example
/dest="C:MyInstServerPath" /silent
/nodlg Shows only the progress dialog.
Displays no other user interface. You can use it instead of /silent, if you wish to
see the progress.
Note
If you use /nodlg, you have to supply the destination path with /
dest:<destination path>
/silent Does not display a user interface.
Note
If you use /silent, you have to supply the destination path with /
dest:<destination path>
/DontConfigureServerPath Disables the automatic configuration of the installation source directory (network
share creation and null-session accessibility) when creating an installation server with
the command line.
Parameter for NwSapSetupAdmin.exe
Parameter Description
/checkserver Verifies the integrity of the installation server in silent mode (see Troubleshooting
[page 52]).
Returns an error level greater than zero and writes an error file, if discrepancies are
found (see Log and Error Files [page 53]).
40 P U B L I C
SAPSetup Guide
Setup and Administration of the Installation Server](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-40-320.jpg)
![6 Installing and Administering SAP Front End
Components and Packages
This section describes how to install, update, repair, and remove SAP front end components and packages on a
workstation.
6.1 Installing SAP Front End Components
This section describes how to install SAP front end components from an installation server or a distribution
medium.
Prerequisites
SAP front end software applications should not be running during installation. If an application is running, the user
may be prompted to reboot afterwards to complete the installation. If the installation runs interactively, the user is
prompted to stop the applications. If he does so, no reboot is necessary.
Procedure
1. Choose one of the following scenarios:
○ Installing SAP front end components from an installation server
1. Check if the user logged on to the workstation has local administrator privileges. If not, LSH has to be
configured on the installation server.
More information: Configuring the Local Security Handling [page 32].
2. Start NwSapSetup.exe from the Setup directory on the installation server.
○ Installing SAP front end components on a single workstation from a distribution medium
1. Check if the user logged on to the workstation has local administrator privileges.
2. Start NwSapSetup.exe from your installation medium.
Example
On the SAP NetWeaver Presentation DVD, the setup executable is located at GUIWINDOWSWIN32.
The SAPSetup installation wizard starts and displays a list of components that are part of the product to be
installed.
SAPSetup Guide
Installing and Administering SAP Front End Components and Packages P U B L I C 41](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-41-320.jpg)
![Tip
Starting SetupAll.exe, you can install all SAP front end components available on the installation server or
distribution medium in one run.
2. On the SAPSetup installation wizard, choose Next.
The list of SAP front end component is displayed. Already installed components are preselected.
3. Select the SAP front end components that you want to install and then choose Next.
A green plus sign indicates that this SAP front end component will be installed on the workstation, or that it is
aready installed and will be updated.
Note
Changes in the selection list are indicated by yellow dots.
4. If some products ask for additional parameters during the installation, like the installation directory, enter the
required information and then choose Next,.
Results
Your SAP front end components are now successfully installed and ready to use on the workstation. Choose Finish
to exit the installer.
Note
Processing is recorded in the SAPSetup log file. For more information, see Troubleshooting [page 52] and Log
and Error Files [page 53].
6.2 Installing Packages Configured by the Administrator
This section describes how to install packages on the installation server that have been configured by the
administrator.
Prerequisites
Check if the user logged on to the workstation has local administrator privileges. If not, LSH has to be configured
on the installation server.
More information: Configuring the Local Security Handling [page 32]
42 P U B L I C
SAPSetup Guide
Installing and Administering SAP Front End Components and Packages](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-42-320.jpg)
![Procedure
1. Start NwSapSetup.exe from the Setup directory on the installation server or distribution medium, choose
Next on the welcome screen and then Predefined Packages. Alternatively, call NwSapSetup.exe /package
on the command line, and choose Next on the welcome screen.
You see all packages of the installation server in a list. Packages that have already been installed are
preselected.
2. Select the packages that you want to install.
A green plus sign indicates that this package will be installed on the workstation. A yellow dot indicates a
change in the selection list.
3. Choose Next.
SAPSetup now processes the packages and displays the completion status when finished.
Results
Your packages are now successfully installed and ready to use.
Note
Processing is recorded in the SAPSetup log file. For more information, see Troubleshooting [page 52] and Log
and Error Files [page 53].
6.3 Installing Using the Windows Logon Script
This section describes how to distribute SAP Front End components and packages on many workstations in an
automated way. Inserting a command line into the logon script of the users, the installation is started when the
user logs on.
Prerequisites
Check that SAP front end components (especially SAP GUI) are closed before you start the task. SAPSetup might
require a reboot to complete the installation if program files are in use.
Context
When you start the command on a workstation for the first time, SAPSetup installs the specified package.
SAPSetup will check for package updates on the installation server every following logon, and will install updates
automatically.
SAPSetup Guide
Installing and Administering SAP Front End Components and Packages P U B L I C 43](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-43-320.jpg)
![Note
You can find the command line name of a package or SAP front end component in the administrative console
NwSapSetupAdmin.exe. For more information on options, see Command Line Parameters for the Workstation
[page 48] and Return Codes [page 54].
Procedure
● To install SAP front end components, add the following command to the user’s logon script:
<server><shared directory>SetupNwSapSetup.exe
/product:"<product command line name>" /nodlg
● To install packages, add the following command to the user’s logon script:
<server><shared directory>SetupNwSapSetup.exe
/package:"<package command line name>" /nodlg
● Optional: To ensure that an installation runs only once on a workstation, add the following option: /
once:"<OnceTag>"
The tag <OnceTag> is stored in the Windows registry and is never deleted by SAPSetup. If an installation with
the same tag is started again, it does nothing and instantly returns 0. This can be useful for distributing a
correction to many workstations using event scripts in packages that contain no SAP front end components.
6.4 Updating SAP Front End Components
This section describes how to update the installed SAP front end components when a newer version is available as
a patch either on the installation server or on a distribution medium.
Prerequisites
Check that SAP front end components are closed before you start the task. SAPSetup might require a reboot to
complete the update if program files are in use.
Context
This procedure updates all products that have been installed without using packages.
44 P U B L I C
SAPSetup Guide
Installing and Administering SAP Front End Components and Packages](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-44-320.jpg)
![Note
If you make use of packages, call this command with adding the parameter /package. If you distribute software
both with and without packages, call this command twice, once with the parameter /package and once
without.
Procedure
● Updating a Workstation from an Installation Server
Updating SAP front end components on a workstation involves the same steps as an installation [page 41]. You
can choose to run the update unattended or automatically.
○ For an unattended update, use the following command line: <server_path>Setup
NwSapSetup.exe /update /silent.
Note
If you want to update a specific package or SAP front end component, add /package="package
command line name" or /product="product command line name". You can find the command
line name of the package or SAP front end component in the administrative console
NwSapSetupAdmin.exe.
○ For an automatic update, you use the AWUS [page 34]. Whenever the installation server is patched or the
installed packages are updated, this service updates the workstations and reboots them, if necessary. The
AWUS works regardless of whether a user is logged on.
○ If a user is logged on, the user is informed of the available update, and the update starts upon
confirmation by the user. The user is also informed about whether a reboot is required, and the reboot
is executed only upon confirmation by the user.
○ If no user is logged on, the update and the reboot (if necessary) are started automatically.
Depending on the chosen update method, the SAP front end components are updated with or without user
interaction. If the interactive update method is selected, the user simply has to choose Next to start the front
end update.
● Updating a Standalone Workstation
We recommend you to update a standalone workstation from an installation server [page 45] by means of the
automatic update mechanisms (AWUS or logon scripts) which ensures a fast and efficient update of all
workstations. However, you can update SAP front end components on standalone workstations by running a
patch on every single workstation. In this case, an update involves the same steps as an installation [page 41].
SAPSetup Guide
Installing and Administering SAP Front End Components and Packages P U B L I C 45](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-45-320.jpg)
![6.5 Uninstalling SAP Front End Components
This section describes how to remove SAP front end components from a workstation.
Prerequisites
SAP front end software applications should not be running during uninstallation. If an application is running, the
user gets a message to reboot the workstation.
Caution
You cannot remove a SAP front end component with a SAPSetup version less than 8.6 if the component was
installed with version 8.6 or higher. This will lead to an intentional termination of SAPSetup.
Procedure
1. On the workstation, choose Start Settings Control Panel Add or Remove Programs .
A list of the installed applications is displayed.
2. Select the SAP front end components to be removed and follow the instructions of the wizard.
If you want to perform a silent or unattended uninstallation, enter the following commands:
○ For silently uninstalling a certain product: NwSapSetup.exe /Product=”<product name>” /
Silent /Uninstall
○ For silently uninstalling all SAP front end components installed by SAPSetup: NwSapSetup.exe /all /
silent /uninstall
○ For an unattended uninstallation of all SAP front end components installed by SAPSetup:
NwSapSetup.exe /all /nodlg /uninstall
When the command line options include /uninstall /all, the event scripts defined for the events On
Uninstallation Start and On Uninstallation End will also be executed for all packages that are
being uninstalled.
For more command line options, see Command Line Parameters for the Workstation [page 48].
Results
The selected SAP front end components are removed from the workstation.
Note
Processing is recorded in the SAPSetup log file. For more information, see Troubleshooting [page 52] and Log
and Error Files [page 53].
46 P U B L I C
SAPSetup Guide
Installing and Administering SAP Front End Components and Packages](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-46-320.jpg)
![6.6 Repairing Installed SAP Front End Components
This section describes how to repair SAP front end components which are installed on a worksation and do not
work properly.
Prerequisites
● Check if the user logged on to the workstation has local administrator privileges. If not, LSH has to be
configured on the installation server.
More information: Configuring the Local Security Handling [page 32]
● SAP front end software applications should not be running during a repair. If an application is running, the user
might get a message to reboot the workstation. The repair process is completed after restart.
Context
If SAP front end components on a workstation are not working properly, start the repair process. This process
checks for discrepancies in files, services, registry-keys and other artifacts installed by SAPSetup, and performs a
re-install of differing artifacts. The repair process includes an update of SAP front end components on the
workstation with versions lower than on the installation server. If a package is installed, the package event scripts
[page 22] for updates are also executed during the repair.
Procedure
● To start the repair process, you execute program NwSapSetup with parameter repair from the Setup
directory either of the installation server, the distribution medium, or a single-file installer:
NwSapSetup.exe /repair
The repair process starts and a progress screen is displayed. Only those SAP front end components that are
available on the source can be repaired. The processing is recorded in the file NwSapSetup.log in the
SAPSetup log file directory.
The repair process includes an update of all SAP front end components. If the version of a component on the
installation server is higher than that of the component installed on the workstation, this component is
udpated.
If a package is installed, the package event scripts [page 22] for updates are executed during repair.
Note
If errors occur, see Troubleshooting [page 52].
SAPSetup Guide
Installing and Administering SAP Front End Components and Packages P U B L I C 47](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-47-320.jpg)
![Parameter Impact
/update Updates installed SAP front end components.
● To update all installed packages that are available on the installation server, add /
Package.
● To update a specific product or package, add /product="product command
line name" or respectively /package="package command line name".
Note
Without specifying /package, packages are ignored.
Note
Works only with /nodlg or /silent.
/skip=wtscheck Skips the check whether the WTS server is in installation mode. Only provide this if the check
does not work correctly. In this case, open a message on component BC-FES-INS for a bug
report.
/ForceWindowsRestart Forces a restart of the workstation after the installation is complete.
Use in combination with /package or /product after /silent or /nodlg.
Example: NwSapSetup.exe /silent /product="SAPGUI" /
ForceWindowsRestart
/SMS[:"<package cmd
name>"]
Creates a status file <package command line name>.MIF in the %TEMP% directory
that indicates the success or failure of the process.
Typically used by software distribution systems such as SMS to determine the success or fail
ure of a remote installation (advertised package installation).
/repair Repairs all installed SAP front end components.
When combined with /package:"pckg", only the specified package is repaired.
Ignores products specified with /product:"p".
More information: Repairing Installed SAP Front End Components [page 47]
/MaintenanceMode Usually, only those SAP front end components that are also available on the installation
source are displayed in the selection dialog. With this switch, all installed SAP front end com
ponents are displayed, even if they are not available on the installation source, and can be un
installed.
Parameter for Single-File Installer
Parameter Description
/? Provides help on command line parameters.
/extract:dest_dir Extracts the single-file installer into the dest_dir directory. If the directory does not
exist, it will be created. This works with single-file installers shipped by SAP as well as
with those created in NwSapSetupAdmin [page 29].
50 P U B L I C
SAPSetup Guide
Installing and Administering SAP Front End Components and Packages](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-50-320.jpg)
![Parameter Description
/CreateServer [/
dest="dest_dir"]
Creates a new installation server. The optional parameter /destspecifies the target
directory of the installation server. This directory must exist and should be empty. This
call is equivalent to extracting the single-file installer and then manually starting
SetupNwCreateInstServer.exe.
/UpdateServer [/
dest="dest_dir"]
Updates an existing installation server. The optional parameter /destspecifies the
target directory of the installation server that will be updated. This directory must exist.
This call is equivalent to extracting the single-file installer and then manually starting
SetupNwUpdateInstServer.exe.
/repair Repairs all installed SAP front end components.
More information: Repairing Installed SAP Front End Components [page 47]
/silent Installs all SAP front end components contained in the single file installer without dis
playing a user interface. Installed SAP front end components will be updated, if the sin
gle-file installer contains a newer version. Compatible with all other parameters ex
cept /?.
/nodlg Installs all SAP front end components contained in the single file installer showing only
the progress dialog. Installed SAP front end components will be updated, if the single-
file installer contains a newer version. Compatible with all other parameters except /?.
Parameter for NWCheckWorkstation.exe
Parameter Description
/silent Does not display a user interface. Returns the same return values as
NwSapSetup.exe. For more information, see Return Codes [page 54].
SAPSetup Guide
Installing and Administering SAP Front End Components and Packages P U B L I C 51](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-51-320.jpg)
![7 Troubleshooting
This section describes how to check the integrity of the installation server and the installed SAP front end
components on a workstation.
Procedure
● Troubleshooting on the Installation Server
○ Integrity check
1. Start NwSapSetupAdmin.exe from the Setup directory.
2. Choose Check Server and follow the wizard instructions.
This checks whether all required files are available and unchanged. If files are missing or if their hash
values are incorrect, the wizard displays a link to an error report.
3. To view the error report in a web browser, choose the provided link. Otherwise, choose Close to exit
the wizard.
This integrity check is helpful if you face problems with creating a single-file installer, for example. If the
integrity check reveals incorrect hash values, your server may be corrupt. You can have the hashes
recalculated by choosing Repair Metadata in NwSapSetupAdmin.exe only if you yourself have changed
the files on the installation server. For more information, see Log and Error Files [page 53].
○ On the Packages tab, the packages are displayed in the navigation pane on the left side of the screen. The
icon indicates that the package is incomplete. This occurs when you deleted a SAP front end
component contained in the package from the installation server. In this case, delete the package,
reimport the missing SAP front end component, or change the package content.
● Troubleshooting on the Workstation
NwCheckWorkstation.exe verifies the installation of SAP front end components by checking for
discrepancies in files, services, registry-keys, and other artifacts installed by SAPSetup. You do not require
administrator privileges to perform workstation checks. If there are discrepancies, a report is displayed.
The workstation check tool collects installation data and log files, and compresses them into a cabinet archive.
After the check is completed, Windows Explorer opens the directory containing this CAB file. When reporting
installation issues, you should forward the CAB file to SAP support for a quicker diagnosis.
To start the workstation check, proceed as follows:
1. Start NwCheckWorkstation.exe from the Setup directory either of the installation server or of the
workstation (%ProgramFiles%SAPSapSetupSetup on 32bit Windows or %ProgramFiles32%SAP
SapSetupSetup on 64bit Windows)
2. Follow the wizard instructions.
If an error occurs during processing, the wizard displays a link to an error report. Follow the link to view the
error report in a web browser.
52 P U B L I C
SAPSetup Guide
Troubleshooting](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-52-320.jpg)
![7.1 Log and Error Files
All the installation tools described in this document maintain an activity record in log files. Errors are saved in an
XML format in files that you can view in your web browser.
Log files
The log files are stored in the following directory:
● Windows 32bit: %ProgramFiles%SAPSapSetupLOGs
● Windows 64bit: %ProgramFiles(x86)%SAPSapSetupLOGs
Each tool stores the last 20 log files.
Error files
The error files are stored in the following directory:
● Windows 32bit: %ProgramFiles%SAPSapSetupErrors
● Windows 64bit: %ProgramFiles(x86)%SAPSapSetupErrors
Tool releated log and error files
Tool Log File Error File
NwCreateInstServer.exe NwCreateInstServer.log NwCreateInstServerErrors_<D
ateTime>.xml
NwUpdateInstServer.exe NwUpdateInstServer.log NwUpdateInstServerErrors_<D
ateTime>.xml
NwSapSetupAdmin.exe NwSapSetupAdmin.log NwSapSetupAdminErrors_<Date
Time>.xml
NwSapSetup.exe single-file installer NwSapSetup.log SAPSetupErrors_<DateTime>.x
ml
Creating a message
Use component BC-FES-INS to create a message and attach the relevant log files and error files.
If you run NwCheckWorkstation.exe on the workstation as described in section Troubleshooting [page 52],
attach the generated CAB file instead.
SAPSetup Guide
Troubleshooting P U B L I C 53](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-53-320.jpg)
![7.2 Return Codes
If you start NwSapSetup.exe from a batch file, the environment variable %ERRORLEVEL% contains the return
code.
Example
Example
start /wait <Path to installer source>SetupNwSapSetup.exe /package="<cmd line
name of your package>" /silent && echo %ERRORLEVEL%
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 The following reasons are possible:
● A prerequisite for the installation was not met and the installation was executed with /
silent or /nodlg.
● 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
Note
In event of return codes 144-146, check the Log and Error Files [page 53] for NwSapSetup.exe.
54 P U B L I C
SAPSetup Guide
Troubleshooting](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-54-320.jpg)
![8.1 NwEngine.Shell
NwEngine.Shell comprises methods to access and manipulate the file system and the Windows registry.
Methods for File System Access
Method Name Description
CopyDirectory(String
source, String target) [page
59]
Copies source directory to target directory with all content. Returns true if copying
was successful, else false.
CopyDirectoryEx(String
source, String target, Bool
failIfExists) [page 60]
Copies source directory to target directory with all content. If failIfExists is
set to true, existing files will not be overwritten. Returns true if copying was suc
cessful, else false.
CopyFile(String source,
String target) [page 61]
Copies source file to target file on the file system. Returns true if deletion was suc
cessful, else false.
CopyFileEx(String source,
String target, Bool
failIfExists) [page 61]
Copies source file to target file on the file system. If failIfExists is set to true,
an existing file will not be overwritten. Returns true if deletion was successful, else
false.
CreateDirectory(String
directory) [page 62]
Creates a directory. Returns true if creation was successful, else false.
CreateTempDirectory() [page
62]
Creates a temporary directory and returns the path as string.
DeleteDirectory(String
directory) [page 63]
Deletes a directory. Returns true if deletion was successful, else false.
DeleteFile(String file) [page
64]
Deletes a file. Returns true if deletion was successful, else false.
DirectoryExist(String path)
[page 65]
Returns true if the directory exists, else false.
FileExist(String file) [page
69]
Returns true if the file exists, else false.
GetDriveType(String drive)
[page 70]
Returns a value indicating the type of the drive as integer.
GetFileExt(String file) [page
70]
Returns the extension of a file name as string.
GetFileName(String path)
[page 71]
Returns the file name of the path as string.
SAPSetup Guide
Visual Basic Script Application Program Interfaces P U B L I C 57](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-57-320.jpg)
![Method Name Description
GetFileSize(String file)
[page 71]
Returns the size of the file in bytes as long.
GetFileVersion(String file)
[page 72]
Returns the version number of the file as string.
GetPath(String file) [page 72] Returns the path of a file as string.
GetShortPath(String file)
[page 73]
Returns the short path in 8.3 format of a file as string.
IsPathEqual(String path1,
String path2) [page 74]
Compares the pathes of two directories and returns true if they are identical, else
false.
Methods for Process and System Interaction
Method Name Description
Execute(String cmdline,
bool async) [page 67]
Executes a command line. Returns true if the process has finished, else false.
ExecuteEx(String cmdline,
bool async, bool visible)
[page 68]
Executes a command line, optinally without displaying a window. Returns true if the
process has finished, else false.
ExecuteRC(String cmdline,
bool async, bool visible)
[page 68]
Executes a command line, optinally without displaying a window. Returns the return
code of the process, if executed synchronously.
GetSystemUtcTime() [page 74] Returns the system UTC time as string.
IsExeRunning(String file)
[page 74]
Returns true if the file is a running executable, else false.
Sleep Number milliseconds
[page 77]
Make SAPSetup sleep for the specified time.
TerminateProcessInstances
String exeName [page 77]
Terminates all processes whose executable name is exeName.
Methods for Registry Access
Method Name Description
DeleteRegKey(String key) [page 64] Deletes a registry key and returns true if deletion was successful, else
false.
58 P U B L I C
SAPSetup Guide
Visual Basic Script Application Program Interfaces](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-58-320.jpg)
![Method Name Description
DeleteRegValue(String value) [page
65]
Deletes a registry value and returns true if deletion was successful, else
false.
EnumRegKeys(String path) [page 66] Returns a collection containing all keys below the given path.
EnumRegValues(String path) [page 66] Returns a collection containing all values below the given path.
GetRegValue(String value) [page 73] Returns the data of the registry value.
RegKeyExist(String key) [page 75] Returns true if registry key exists, else false.
RegValueExist(String value) [page 76] Returns true if registry value exists, else false.
SetRegValue(String valuePath,
String valueType, String value)
[page 76]
Sets a registry value.
Properties
Property Name Description
Use64BitHive [page 78] Gets or sets a flag indicating whether SAPSetup operates on the 64bit branch of the
Windows registry.
NwEngine.Shell.CopyDirectory
Copies source directory to target directory with all content.
Syntax
NwEngine.Shell.CopyDirectory(String sourceDir, String target)
Arguments
sourceDir required. The path to the directory to copy.
target required. If the target is a directory, the target file name is the same as the source file name. If the target
does not exist, or if it is a file, then this is the target file name.
Returns
Returns Bool: true if the directory copy was successful, else it returns Bool: false.
Remarks
Existing files will not be overwritten.
SAPSetup Guide
Visual Basic Script Application Program Interfaces P U B L I C 59](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-59-320.jpg)
![Sample Code
If NwEngine.Shell.CopyDirectory("%SapSrcDir%myfiles", "C:pathtoyourfiles")
Then
NwEngine.Context.Log.Write "Copying %SapSrcDir%myfiles to C:pathto
yourfiles was successful."
End if
Copies the directory %SapSrcDir%myfiles to C:pathtoyourfiles and writes a message to the log, if
the directory copy succeeded.
NwEngine.Shell.CopyDirectoryEx
Copies source directory to target directory with all content.
Syntax
NwEngine.Shell.CopyDirectoryEx(String sourceDir, String target, Bool noOverwrite)
Arguments
sourceDir required. The path to the directory to copy.
target required. If the target is a directory, the target file name is the same as the source file name. If the target
does not exist, or if it is a file, then this is the target file name.
noOverwrite required. If set to Bool: true, an existing file will not be overwritten. If set to Bool: false,
existing files will be overwritten.
Returns
Returns Bool: true if the directory copy was successful, else it returns Bool: false.
Remarks
Copies source directory to target directory with all content. When setting noOverwrite to Bool: true, this
method behaves like NwEngine.Shell.CopyDirectory(). This method is useful to update files copied from
CustomerFiles on the installation server (see Creating and Deploying a Single-File Installer for Packages [page
29]).
Sample Code
If NwEngine.Shell.CopyDirectoryEx("%SapSrcDir%CustomerFilesmyfiles", "C:pathto
yourfiles", vbFalse) Then
NwEngine.Context.Log.Write "Copying %SapSrcDir%CustomerFilesmyfiles to C:
pathtoyourfiles was successful."
End if
Copies the directory %SapSrcDir%myfiles to C:pathtoyourfiles, overwriting existing files, and
writes a message to the log, if the directory copy succeeded.
60 P U B L I C
SAPSetup Guide
Visual Basic Script Application Program Interfaces](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-60-320.jpg)
![Returns
Returns Bool: true if file copy was successful, else it returns Bool: false.
Remarks
When setting noOverwrite to Bool: true, this method behaves like NwEngine.Shell.CopyFile(). This
method is useful to update files copied from CustomerFiles on the installation server (see Creating and
Deploying a Single-File Installer for Packages [page 29].
Sample Code
If NwEngine.Shell.CopyFileEx("%SapSrcDir%setupnetstart.exe", "C:pathto
setup", false) Then
NwEngine.Context.Log.Write "Copying %SapSrcDir%setupnetstart.exe to C:path
tosetup was successful"
End if
Copies the file %SapSrcDir%setupnetstart.exe to directory C:pathtosetup and writes a message
to the log, if the file copy succeeded. If the file exists at the destination, it will be overwritten.
NwEngine.Shell.CreateDirectory
Creates a directory.
Syntax
NwEngine.Shell.CreateDirectory(String target)
Arguments
target required. Path to the directory to create.
Returns
Returns Bool: true if the creation was successful, else it returns Bool: false.
Sample Code
If Not NwEngine.Shell.CreateDirectory("C:pathtomyDir") Then
NwEngine.Context.Log.WriteError "Creating directory C:pathtomyDir failed."
End if
Tries to create directory C:pathtomyDir and writes the error message "Creating directory C:path
tomyDir failed." to the log, if the creation failed.
NwEngine.Shell.CreateTempDirectory
Creates a temporary directory.
62 P U B L I C
SAPSetup Guide
Visual Basic Script Application Program Interfaces](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-62-320.jpg)
![8.2 NwEngine.Context
NwEngine.Context provides access to properties to determine operating system, computer name, rights
elevation status, command line arguments and more.
Properties
Property Name Description
Args [page 79] Gets the command line arguments as a collection
Elevated [page 80] Gets a flag indicating whether the installation is executed with ele
vated rights
LCID [page 80] Gets the system locale identifier of the current workstation
ProductMode [page 81] Gets a flag indicating whether the installation is executed in product
or package mode
Reboot [page 81] Gets or sets a flag indicating whether the reboot flag should be set
Silent [page 81] Gets or sets a flag indicating whether the installation mode was
started in silent mode
WinVista [page 82] Gets a flag indicating whether running on a Windows Vista or Win
dows Server 2008 machine
Windows7 [page 82] Gets a flag indicating whether running on a Windows 7 or Windows
Server 2008 R2 machine
Windows8 [page 82] Gets a flag indicating whether running on a Windows 8 or Windows
Server 2012 machine
Windows81 [page 83] Gets a flag indicating whether running on a Windows 8.1 or Win
dows Server 2012 R2 machine
Windows10 [page 83] Gets a flag indicating whether running on a Windows 10 or Windows
Server machine
WkstaName [page 83] Gets the NetBIOS name of the current workstation
WTSClient [page 84] Gets a flag indicating whether running on a WTS Client
WTSServer [page 84] Gets a flag indicating whether running on a WTS Server
NwEngine.Context.Args
Gets the collection of command line arguments.
SAPSetup Guide
Visual Basic Script Application Program Interfaces P U B L I C 79](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-79-320.jpg)
![NwEngine.Context.WTSClient
Gets a flag indicating whether this installer instance is executed on a WTS Client.
Syntax
NwEngine.Context.WTSClient as Bool
Sample Code
If NwEngine.Context.WTSClient Then
NwEngine.Log.Write "We are running on Windows Terminal Service Client."
End If
Writes an entry to the log, if running on Windows Terminal Service Client.
NwEngine.Context.WTSServer
Gets a flag indicating whether this installer instance is executed on a WTS Server.
Syntax
NwEngine.Context.WTSServer as Bool
Sample Code
If NwEngine.Context.WTSServer Then
NwEngine.Log.Write "We are running on Windows Terminal Service Server."
End If
Writes an entry to the log, if running on Windows Terminal Service Server.
8.3 NwEngine.Context.Log
NwEngine.Context.Log writes information texts, warnings, or errors to the log.
Procedure Name Description
Write String message [page 85] Writes a message into the current log file
WriteError String errorMessage [page 85] Writes a message marked as error into the log file. Entry is
marked as "E". SAPSetup return code will be not 0.
Installation procedure will be handled as not successfully
finished.
84 P U B L I C
SAPSetup Guide
Visual Basic Script Application Program Interfaces](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-84-320.jpg)
![Procedure Name Description
WriteWarning String warningMessage [page 86] Writes a message marked as warning into the log file. Entry is
marked as "W".
NwEngine.Context.Log.Write
Writes a message to the log file. Entry is marked as "E". SAPSetup return code will be not 0. Installation procedure
will be handled as not successfully finished.
Syntax
NwEngine.Context.Log.Write String message
Arguments
message required. The message to write to the log file.
Remarks
As this method does not return anything, its parameters must not be enclosed by paranthesis.
Sample Code
NwEngine.Context.Log.Write "Hello World!"
Writes "Hello World!" to the log file.
NwEngine.Context.Log.WriteError
Write an error message to the log file. Entry is marked as "W".
Syntax
NwEngine.Context.Log.WriteError(String errorMessage)
Arguments
errorMessage required. The error message to write to the log file.
Remarks
As this method does not return anything, its parameters must not be enclosed by paranthesis. Writes a message
into the current log file as an error. Installation procedure will be handled as not successfully finished, and
SAPSetup will exit with a return code other than 0. This is useful to check prerequisites and make the installation
process fail if the prerequisites are not fulfilled, so that it can be run again.
SAPSetup Guide
Visual Basic Script Application Program Interfaces P U B L I C 85](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-85-320.jpg)
![structure. The directory %SapSrcDir%CustomerFiles is always included in every package. It is useful if you
want to distribute your custom files with packages.
The package configuration in NwSapSetupAdmin shows additional variables that are available in the package. You
can set the values of variables for packages there, and you can access these variables in package event scripts.
SAPSetup provides a comprehensive list of additional variables containing information, among others, about the
following:
● System directories
● Operating system
● Installed .NET runtimes
● Installed Java runtimes
● Installed Microsoft products
● Installed Adobe products
For the full list of all variables start SAPSetup and cancel it on the first dialog. Check the log file [page 53], look for
the line Log Variables Collection. Do this on a system where no SAPSetup products are installed, as
installing products persists some variables on the computer.
Methods for Variable Resolution
Method Name Description
GetValue(variableName) [page
87]
Returns the value of the variable.
ResolveString(StringToReso
lve) [page 88]
Resolves all variables contained in toResolve and returns the resolved string.
NwEngine.Variables.GetValue
Returns the value of a variable.
Syntax
NwEngine.Variables.GetValue(String variableName)
Arguments
variableName required. Name of the variable to get the value of.
Returns
The value of the variable.
Sample Code
dim windir
windir = NwEngine.Variables.GetValue("WOW64MODE")
NwEngine.Context.Log.Write "Value of variable WOW64MODE is " & windir & ". That
means this Windows is 64bit."
Gets the value of variable <WOW64MODE> and writes it to the log file.
SAPSetup Guide
Visual Basic Script Application Program Interfaces P U B L I C 87](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-87-320.jpg)
![NwEngine.Variables.ResolveString
Resolves all variables contained in toResolve and returns the resolved string.
Syntax
NwEngine.Variables.ResolveString(String stringToResolve)
Arguments
stringToResolve required. A text that may contain SAPSetup variables like <%variableName%>.
Returns
Returns the provided string with all SAPSetup variables replaced by their values.
Sample Code
dim toResolve, resolved
toResolve = "%WINSYSDIR%driversetchosts"
resolved = NwEngine.Variables.ResolveString(toResolve)
NwEngine.Context.Log.Write "Resolved string is " & resolved
Resolves the variable <WINSYSDIR> in the string and writes the resolved string to the log file.
8.5 NwSapSetupATLCommon.TextFileParser
NwSapSetupATLCommon.TextFileParser offers a method for reading and writing text files and searching and
modifing text in text files.
Properties
Property Name Description
FileName( ) [page 89] Returns the name of the parsed text file
Parse(string filename) [page 89] Reads a text file from disk. Returns true if file exists and can be
read or false if the file does not exist
ReplaceLine( string LineToReplace, string
Replacement) [page 90]
Replaces all occurrences of the lines that match
LineToReplace with the replacement string
ReplaceLineEx(string
StringToReplace,string Replacement) [page
89]
Replaces all lines that contain the given string by the given re
placement
DoesLineExist(string Line) [page 91] Returns true if one or more lines in the file completely match
the given value, else false
88 P U B L I C
SAPSetup Guide
Visual Basic Script Application Program Interfaces](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-88-320.jpg)
![Property Name Description
DoesStringExist(string bstrStringToSearch)
[page 92]
Returns true if one or more lines in the file contain the given
value, else false
Save(string FileToSaveAs) [page 92] Saves the file with the given file name. Returns true if the file
was saved successfully, else false
AppendLine(string NewLine) [page 93] Appends the given string at the end of the text file
NumLines() [page 93] Returns the number of lines in the file
Line(ULong LineIndex) [page 94] Returns the line with the given line index
RemoveLine(string LineToRemove) [page 95] Removes all lines from the text file that match the given line
NwSapSetupATLCommon.TextFileParser.FileName
Syntax
<objTextFileParser>.FileName()
Returns
Returns the name of the opened file.
Remarks
If no file was parsed FileName returns NULL.
Sample Code
Dim objTextFileParse;
set objTextFileParser = CreateObject("NwSapSetupATLCommon.TextFileParser")
objTextFileParse.Parse("C:WindowsSystem32driversetcservices")
dim filename
filename = objTextFileParse.FileName()
Returns the file name of a text file parser.
NwSapSetupATLCommon.TextFileParser.Parse
Reads a text file from disk
Syntax
<objTextFileParser>.Parse(String filename)
SAPSetup Guide
Visual Basic Script Application Program Interfaces P U B L I C 89](https://image.slidesharecdn.com/sapsetupguide-211203224344/85/Sap-setup-guide-89-320.jpg)
Ad
More Related Content
Similar to Sap setup guide (20)
Recently uploaded (20)
Ad
Sap setup guide
- 1. Administration Guide PUBLIC 2018-01-29 SAPSetup Guide SAPSetup 9.0
- 2. Content 1 Features at a Glance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2 Latest Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 3 Glossary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 4 Planning the Installation of SAP Front End Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 4.1 Installation Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 4.2 Hardware and Software Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 4.3 Use Case: Installation and Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 5 Setup and Administration of the Installation Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 5.1 Setting Up the Installation Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15 5.2 Adding SAP Front End Components to the Installation Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18 5.3 Updating Products on the Installation Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 5.4 Deleting Products from the Installation Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 5.5 Installation Packages: Creation and Maintenance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Creating an Installation Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Configuring Packages and Event Scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Changing the Package Content. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Deleting an Installation Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29 Creating and Deploying a Single-File Installer for Packages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Creating a Package Definition File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 5.6 Patching the Installation Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 5.7 Configuring the Local Security Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32 5.8 Installing and Configuring the Automatic Workstation Update Service. . . . . . . . . . . . . . . . . . . . . . . . . 34 5.9 Controlling a Remote Workstation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Collecting Log Files Remotely. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Executing a Process Remotely. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Listing Remote Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 5.10 Removing the Installation Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39 5.11 Command Line Parameters for the Installation Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40 6 Installing and Administering SAP Front End Components and Packages. . . . . . . . . . . . . . . . . . . . 41 6.1 Installing SAP Front End Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 6.2 Installing Packages Configured by the Administrator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42 6.3 Installing Using the Windows Logon Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 6.4 Updating SAP Front End Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 2 P U B L I C SAPSetup Guide Content
- 3. 6.5 Uninstalling SAP Front End Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 6.6 Repairing Installed SAP Front End Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 6.7 Command Line Parameters for the Workstation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 7 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 7.1 Log and Error Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 7.2 Return Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 8 Visual Basic Script Application Program Interfaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55 8.1 NwEngine.Shell. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 8.2 NwEngine.Context. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 8.3 NwEngine.Context.Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .84 8.4 NwEngine.Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 8.5 NwSapSetupATLCommon.TextFileParser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88 SAPSetup Guide Content P U B L I C 3
- 4. 1 Features at a Glance SAPSetup provides a fully featured lifecycle management for SAP front end components on Windows™ and an easy and reliable handling by using installation servers. Front end components are available from an installation server or a distribution medium such as a DVD. With SAPSetup you can: ● install new SAP front end components, uninstall existing ones, and update the remaining components in one cycle. ● 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. ● deploy multiple SAP front end components on workstations using a single command. ● manage easily the installation server using wizard-driven user interfaces. ● deploy SAP components on workstations without requiring administrative privileges on all machines, if you have configured Local Security Handling (LSH). ● automatically update the workstations and reboot them if necessary with the Automatic Workstation Update Service, whenever the installation server is patched, or the packages installed are updated. ● customize and extend the installation of packages (easier handling of multiple SAP front end components) using implemented script events. ● remotely access and control workstations on which you have administration privileges. You can collect remote log files, execute processes remotely, and list remote processes. ● automatically configure the directory for the creation of the installation server. By default, it is made NULL- session accessible. It can be shared automatically on the network for everyone to read. ● if the program executable NwSapSetup.exe is started from a batch file, you can catch the return code in an environment variable <%ErrorLevel%>. 4 P U B L I C SAPSetup Guide Features at a Glance
- 5. 2 Latest Information The SAP Notes contain the most recent information about SAPSetup 9.0. Make sure that you read the latest version of the following SAP Notes before your start the installation: SAP Note Number Description 1587566 Detailed release notes and known issues of SapSetup version 9.0. Description how to retrieve the latest version of SAPSetup. 1583967 General release information note for SAPSetup 9.0 1162270 Installing the DS installation service (analysis notes). Addi tional information on how to create and maintain an installa tion server to distribute the SAP Frontend Software for Win dows to client computers using Local Security Handling. 1177282 End of support for SAP releases using Microsoft products. You can find the SAP Notes in SAP Support Portal at https:/ /support.sap.com/notes . To check the latest version of this guide, see the SAP Support Portal athttps:/ /support.sap.com/sltoolset Front End Installation Guide for SAPSetup or the SAP Help Portal at https:/ /help.sap.com/sapsetup. History of Changes The following table provides an overview of new features and most important changes. Change History Features and Changes Availability Major redesign of the whole guide. Added documentation of the API of SAPSetup specific Visual Basic Script classes that can be used in package event scripts. SAPSetup 9.0.76 Explanation: Repair Metadata and hashes (see Troubleshooting [page 52]) SAPSetup 9.0.59 You can now start and stop the distribution service in the NwSapSetupAdmin tool (see Con figuring the Local Security Handling [page 32]). SAPSetup 9.0.57 You can now execute processes in the NwSapSetupAdmin tool remotely (see Executing a Process Remotely [page 37]). SAPSetup 9.0.56 SAPSetup Guide Latest Information P U B L I C 5
- 6. Features and Changes Availability Explanation: Updating the installation server using NwSapSetupAdmin requires the extrac tion of a single file installer first (see Updating Products on the Installation Server [page 19]). SAPSetup 9.0.55 6 P U B L I C SAPSetup Guide Latest Information
- 7. 3 Glossary See the table below for descriptions of terms and abbreviations used in this guide The are listed below. Term Description AWUS Automatic workstation update service. For more information, see Installing and Configuring the Automatic Workstation Update Service [page 34]. distribution medium Contains the installer for an SAP front end component. It is either a directory in the file system or a single-file installer. event script A Visual Basic script that extends a package with custom actions. Events are installation, update and uninstall of a package. Event scripts can be defined to run before or after an event. For more information, see Configuring Packages and Event Scripts [page 22]. installation server Central installation repository for distributing SAP front end components to many work stations. Prerequisite for packages, AWUS, and LSH. LSH Local security handling. For more information, see Configuring the Local Security Handling [page 32] package Selection of SAP front end components defined by the administrator of an installation server. Optionally contains configuration of installation parameters and event scripts. patch Single-file installer which contains only the parts of an SAP front end component that changed between two versions. A patch can be applied to a workstation or an installation server where the base version of the SAP front end component is already present. product Synonym for SAP front end component. SAP front end component SAP software that runs on a workstation and is installed and maintained with SAPSetup SAPSetup Tool suite for installing, updating, maintaining, and distributing software on Windows™. single-file installer Self-extracting executable that contains a package, a patch, or an installer for an SAP front end component. SAPSetup Guide Glossary P U B L I C 7
- 8. Term Description update Process of installing a newer version of an SAP front end component. upgrade Synonym for update. workstation Computer on which an SAP front end component is installed. The computer on which the installation server is running, is not considered as a worksta tion. 8 P U B L I C SAPSetup Guide Glossary
- 9. 4 Planning the Installation of SAP Front End Components This section describes how to plan the installation of SAP front end components. 1. You plan the installation scenario [page 9]. 2. You make sure that your system meets the hardware and software requirements [page 11]. 3. You review the installation and maintenance flow [page 12]. 4.1 Installation Scenarios You can install SAP front end components for Windows™ either from a distribution medium or from an installation server. Installation Scenario Description Installation from a distribution medium (for exam ple a DVD) The administrator takes the distribution medium from workstation to workstation. This is mainly for test purpose or for standalone workstations. Installation from an installation server The administrator sets up an installation server, where the installation of the SAP front end components on different clients is started remotely. All necessary files are copied from the server to the clients during installa tion. Tip We recommend you to use the scenario Installation from an installation server because of its greater flexibility and efficiency, especially if many workstations are involved. Installation from a Distribution Medium A local installation on workstations with a distribution medium such as a DVD is useful for installing SAP front end components on single machines (for example, laptops) that are not connected to a Local Area Network (LAN). You can also use it for test purposes. Restriction This installation scenario has the following restrictions: SAPSetup Guide Planning the Installation of SAP Front End Components P U B L I C 9
- 10. ● There are no packages available. ● If patches need to be applied, each workstation has to be patched separately. ● An automatic workstation update is not supported. ● Local security handling (LSH) is not supported. Installation from 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 patches are to be applied. 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 server-based installation works: 10 P U B L I C SAPSetup Guide Planning the Installation of SAP Front End Components
- 11. With an installation server, you as administrator can group various SAP front end components together as installation packages relevant for certain employee roles. You 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. In addition, you can configure the distribution service to add LSH functions to the installation server. With LSH, the installation can be started even by a user who is not a member of the local group of administrators. The distribution service then installs a service process on the client and starts NwSapSetup.exe in the context of this service. The user privileges are not altered. The installed service does not start other processes except NwSapSetup.exe from configured installation servers. Afterwards, the service removes itself from the workstation again. The hard disk requirement on the installation server depends on the type and number of SAP front end components that are added to an installation server. For example, SAP GUI for Windows requires approximately 800 MB with all SAP front end components installed. As administrator, you can configure your own installation packages on the installation server with NwSapSetupAdmin.exe . 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: ● If a user is logged on, the user is notified about the available update, and the update starts upon confirmation by the user. The user is also notified about whether a reboot is required, and the reboot is executed only upon confirmation by the user. ● If no user is logged on, the update and the reboot (if required) are started automatically. Alternatively, you can apply patches on the installation server and then start the installation on your workstation to apply the patch on the workstation. You can control the installation using the command line. You can perform unattended installations with automatic patch installation on the workstation. To do so, insert the appropriate command line in the logon script of the user. The logon script is a program that is executed when a user logs on. Related Information Installing and Configuring the Automatic Workstation Update Service [page 34] 4.2 Hardware and Software Requirements This section describes the requirements your system needs to meet. Front end workstations For hard drive clones only: If the operating systems of your workstations were generated by hard drive cloning, make sure that the domain is set correctly. To do so, take the workstations out of the domain and then put them back in. This is especially important if you intend to use LSH. More information: Configuring the Local Security Handling [page 32]. SAPSetup Guide Planning the Installation of SAP Front End Components P U B L I C 11
- 12. Computer for hosting the installation server The following conditions have to be fulfilled: ● Windows server as operating system. ● .NET Framework 4.0 client profile has to be installed to run the administration tool. ● Read access for all users at all times, even after the installation is complete. This is required for maintenance purposes such as the distribution of patches and updates. ● Broadband network connection for high throughput. ● Enough free disk space for all SAP front end components to be imported. 4.3 Use Case: Installation and Maintenance This section describes a typical installation and maintenance use case for installing SAP front end components on a workstation using an installation server. 1. You set up an installation server [page 15] and, if required, LSH. The installation server contains the following: ○ Installation programs ○ Configuration information (for example, packages) ○ Service files (for LSH) ○ Front end components to be installed 2. You maintain installation packages [page 20] for different user groups. Users can install multiple packages, and packages can share SAP front end components. You can configure installation parameters, such as installation directories, for the components that a package contains. 3. Recommendation: You configure LSH [page 32]. Test the LSH by logging on to a user workstation as a user without local administrator privileges, and then running NwSapSetup.exe from the installation server. Note Windows has local security mechanisms. Only users with local administrator privileges have write access to parts of the system database and the file system. SAPSetup solves this problem with the distribution service (DS) that resides on the server, and with the installation service (IS) that is installed on the workstation temporarily. The IS starts a new instance of NwSapSetup.exe that runs with sufficient privileges. 4. You install packages using the logon script [page 43] of your workstation or using other distribution mechanisms. 5. You patch the installation server [page 31]. 6. You update SAP front end components [page 41] on a workstation when a new release is available on the installation server. 12 P U B L I C SAPSetup Guide Planning the Installation of SAP Front End Components
- 13. 5 Setup and Administration of the Installation Server This section describes how to set up and maintain an installation server for the efficient distribution of SAP front end components across workstations. Features The tool for administering the installation server is NwSapSetupAdmin.exe. You can find NwSapSetupAdmin.exe in the installation server’s Setup directory after successful installation. Note NwSapSetupAdmin.exe requires .NET Framework 4, which you can download from the Microsoft Download Center . ● Product Import Use this feature to add new SAP front end components to an existing installation server for distribution over the network. More information: Adding SAP Front End Components to the Installation Server [page 18] ● Product Export Use this feature to export SAP front end components available on one installation server to another. More information: Updating Products on the Installation Server [page 19] ● Product Deletion Use this feature to delete a SAP front end component from an installation server. More information: Deleting Products from the Installation Server [page 20] ● Package Creation Use this feature to create packages for deployment. Packages can contain multiple SAP front end components, and their installation parameters can be customized. More information: Creating an Installation Package [page 21] ● Single-File Installer Creation Use this feature to create single-file installers. More information: Creating and Deploying a Single-File Installer for Packages [page 29] ● Package Definition Files (PDF) Creation Use this feature to 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 SAPSetup and system management products such as Microsoft’s System Management Server. More information: Creating a Package Definition File [page 30] ● Package Configuration Use this feature to change the attributes or the content of your packages. More information: Changing the Package Content [page 28] ● Installation Server Patch Use this feature to patch SAP front end components that are available on the installation server. SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 13
- 14. More information: Patching the Installation Server [page 31] ● Local Security Handling (LSH) Configuration Using this feature, workstation users are allowed to install SAP front end components from the installation server without requiring administrator privileges. More information: Configuring the Local Security Handling [page 32] ● Automatic Workstation Update Configuration Whenever the installation server is patched or the installed packages are updated, this service updates the workstations and reboots them, if required. AWUS works regardless of whether a user is logged on. ○ If a user is logged on, he is informed of the availability of updates and the update is started upon confirmation by the user. The user is also informed about whether a reboot is required (the reboot needs to be confirmed as well by the user). ○ If no user is logged on, the system performs the update and the reboot (if required) automatically. More information: Installing and Configuring the Automatic Workstation Update Service [page 34] ● Remote Workstation Control This feature uses the Windows Management Instrumentation (WMI) to help you remotely access and control workstations on which you have administrator privileges. You access this feature using the Remote menu, where the following options are offered: ○ Collect Log Files ○ Execute Process Remotely ○ Remote Task Manager More information: Controlling a Remote Workstation [page 36] Tools Note The log files of all installation tools are stored in the following directory: %ProgramFiles%SAPSapSetupLOGs (32bit Windows) %ProgramFiles(x86)%SAPSapSetupLOGs (64bit Windows) Each tool stores the last 20 log files. Tool Description NwCheckWorkstation.exe Verifies the integrity of installed SAP front end components on a workstation Logfile: NwCheckWorkstation.log NwCreateInstServer.exe Creates a new installation server Logfile: NwCreateInstServer.log NwSapSetup.exe Executes an installation, patch, update or uninstall Logfile: NwSapSetup.log 14 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 15. Tool Description NwSapSetupAdmin.exe Manages the installation server Logfile: NwSapSetupAdmin.log NwSapSetupIs.exe Runs as a Windows service on the workstation temporarily when using LSH (Local Security Handling), never to be executed manually Logfile: NwSapSetupIs.log NwSapSetupOnRebootInstSvc.exe Carries out the necessary steps to complete the installation (or patch, up date, uninstall) as a Windows service if a reboot is needed, never to be exe cuted manually Logfile: NwSapSetupOnRebootInstSvc.log NwUpdateInstServer.exe ● Imports products into a freshly created installation server (called di rectly by NwCreateInstServer.exe) initially ● Adds an additional product to an existing installation server ● Updates products on an installation server with a newer version Logfile: NwUpdateInstServer.log Procedure 1. You set up an installation server [page 15]. 2. You add new SAP front end components to an existing installation [page 18], if required. 3. You update products on the installation server [page 19] with a newer version using a patch, if required. 4. You create and maintain installation packages [page 20], if required. 5. You patch the installation server [page 31], if required. 6. You configure LSH [page 32], if required. 5.1 Setting Up the Installation Server This procedure helps you to distribute SAP front end software on multiple workstations across the network. Prerequisites To carry out the following task, you need to have local administrator privileges. SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 15
- 16. Context NwCreateInstServer is a wizard-driven tool that helps the administrator to create a new installation server. All SAP front end components from the source are imported into the newly created installation server. The installation server consists of a directory that is shared on the network. There is no background process running. Procedure 1. If you have an installation medium, start NwCreateInstServer.exe from the Setup directory. If you have a single file installer, open a command prompt and call it with the parameter /CreateServer. On the welcome screen, choose Next. You can choose Cancel at any stage to abort the process. 2. Choose the target directory, in which the installation server will be created. a. Choose Browse to navigate to the directory in which you want to create the installation server. Ensure that the directory is empty. b. Choose Verify to ensure that the chosen directory meets the following prerequisites: ○ It must exist. ○ It must be accessible to the administrator with full access. c. If you want to use one of the following features, choose Share to provide read access for the selected directory to the users that shall install from this installation server: ○ AWUS [page 34] ○ LSH [page 32] ○ Distribution using logon scripts. ○ Installation and update on workstations using the network share. ○ Execute installations from the installation server on remote workstations (remote execution [page 37]). Note If you run NwCreateInstServer.exe with parameter /silent, the directory is automatically configured as a NULL-session share and is accessible on the network for everyone to read. If you do not require this automatic configuration, add the parameter /DontConfigureServerPath to the command line. With the parameter /silent you also need to specify the parameter / dest:<destination directory>, where <destination directory> is the directory in which the installation server will be created. d. Choose Next to continue. Note Processing is recorded in the file NwCreateInstServer.log located in the SAPSetup log file directory. If an error occurs, see Troubleshooting [page 52], sectionTroubleshooting on the Installation Server. The wizard displays the progress of the server creation process and confirms the successful installation of the installation server. 16 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 17. 3. To update the installation server with SAP front end components, choose Next. NwCreateInstServer.exe automatically calls NwUpdateInstServer.exe to import the SAP front end components into your installation server. The wizard displays the progress of the installation server update. Note Processing is recorded in the file NwUpdateInstServer.log located in the SAPSetup log file directory. If an error occurs, see Troubleshooting [page 52], section Troubleshooting on the Installation Server. NwUpdateInstServer.exe imports all SAP front end components available on the distribution medium into the installation server. After completing the update, the wizard confirms that you can use the installation server for installing SAP front end components on workstations. 4. If you have installed .NET Framework version 4, you can choose that the administration tool for the installation server will be started. To finish the update, choose Close. Results If you chose to start the administration tool for the installation server, NwSapSetupAdmin.exe is started automatically from the installation server. You can start it manually from the Setup directory of the installation server. For more information, see Setup and Administration of the Installation Server [page 13]. Note ● If you require a copy of the installation server, you can replicate the server by entering the following command: InstallationServerShareSetupNwCreateInstServer.exe / Dest=<ReplicationPath> /Nodlg ● If you want to copy the SAP front end components and packages of one installation server to another one, enter the following command: InstallationServerShareSetupNwUpdateInstServer.exe / Dest=<DestinationServer>Setup /Nodlg The settings for AWUS, LSH and share permissions are not copied. Existing packages on the destination server will only be overwritten, if they have the same GUID. Avoid having two packages that have the same command line name. Recommendation After setting up your installation server, we recommend that you look for the latest patches. Obtain the latest SAPSetup version from SAP Note 1587566 . For more information, see Patching the Installation Server [page 31]. SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 17
- 18. 5.2 Adding SAP Front End Components to the Installation Server This procedure describes how to transfer new SAP front end components from a distribution medium to your installation server. From there, you can deploy the components to workstations on the network. Prerequisites ● Check the disk space upfront. ● Ensure that the installation server is not in use during processing. If you are in doubt, you can remove the network share before starting this process, and create it again afterwards. ● If the components were downloaded as a single-file installer it must be extracted beforehand. Execute it on the command line with parameter /extract:dest_dir in order to extract it to directory dest_dir. If the directory does not exist, it will be created. Choose the directory dest_dir in the Product Import wizard. Context You can add SAP front end components using either NwUpdateInstServer.exe or NwSapSetupAdmin.exe (using the Product Import wizard). You can find these executables in the Setup directory of the source medium. Procedure To add SAP front end components to the installation server using: ○ NwUpdateInstServer.exe 1. Start NwUpdateInstServer.exe from the Setup directory of the distribution medium or the installation server that contains the SAP front end component you want to add. 2. Supply the path to the installation server that you want to update. 3. Follow the wizard instructions to update the server with SAP front end components that are available on the distribution medium. ○ NwSAPSetupAdmin.exe 1. Start NwSAPSetupAdmin.exe from the Setup directory of the installation server that you want to update with the new SAP front end components. 2. In the toolbar, choose Import Products. 3. Follow the wizard instructions and supply the path to the distribution medium or installation server containing the SAP front end component you want to add. Example You can add the Adobe LiveCycle Designer to the installation server. The Adobe LiveCycle Designer is delivered on the same DVD as SAP GUI for Windows. Start the program <DVD Drive>:ADOBE_LC_<release>Setup 18 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 19. NwUpdateInstServer.exe. After the welcome page, you are asked for the path to the installation server that you want to update. Navigate to the path of your installation server. Choose Next and wait until the process is completed. Afterwards, the installation server administration tool NwSapSetupAdmin.exe starts. The added SAP front end component Adobe LiveCycle Designer is displayed on the Products tab. You can now install Adobe LiveCycle Designer by starting <installation_server_share>SetupAll.exe and selecting the SAP front end component to be installed, in this case the Adobe LiveCycle Designer. 5.3 Updating Products on the Installation Server This sections describes how to update your installation server if you require a new release of SAP front end components. Prerequisites ● Check the disk space upfront. ● Ensure that the installation server is not in use during processing the update. If you are in doubt, disable the network share before starting this process, and enable it again afterwards. ● A single-file installer must be extracted beforehand. Execute it on the command line with parameter / extract:dest_dir in order to extract it to directory dest_dir. If the directory does not exist, it will be created. Choose the directory dest_dir in the Product Import Wizard. Context Start NwUpdateInstServer.exe from the Setup directory of your distribution medium and follow the wizard instructions. You can update SAP front end components using either NwUpdateInstServer.exe (the Product Import Wizard) or the command window. Procedure To update SAP front end components on the installation server using: ○ NwUpdateInstServer.exe 1. Start NwUpdateInstServer.exe from the Setup directory of the distribution medium. 2. Follow the wizard instructions. SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 19
- 20. ○ Command window ○ Enter UpdateSourceSetupNwUpdateInstServer.exe /dest=<installation server Setup directory> /nodlg or UpdateSourceSetupNwUpdateInstServer.exe /dest=<installation server Setup directory> /silent Related Information Command Line Parameters for the Installation Server [page 40] 5.4 Deleting Products from the Installation Server This section describes how to delete SAP front end components from an installation server. Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of the installation server from which you want to delete a SAP front end component. 2. On the Products tab, select the SAP front end component to be deleted and choose Delete Product from the context menu. The SAP front end component deletion wizard is displayed. 3. To delete a SAP front end component, follow the deletion wizard instructions. At the end of the deletion process, a message is displayed that informs you whether the deletion process has completed successfully. 5.5 Installation Packages: Creation and Maintenance After setting up an installation server, you can create packages using NwSapSetupAdmin.exe in the Setup directory on the installation server. A package consists of one or more SAP front end components that you want to install on the workstations. You can preconfigure the installation parameters of the package, for example the installation target directory. You can customize and extend the installation of packages by implementing script events. 20 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 21. 5.5.1 Creating an Installation Package Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of your installation server. 2. To start the Package Creation Wizard, choose New Package from the toolbar. 3. To continue, choose Next. The wizard displays the SAP front end components available on the installation server. 4. Select the SAP front end components that you want to include in your package and choose Next. A yellow dot indicates a change in the selection list. A green plus sign indicates the SAP front end components to be installed. Note You can create packages that do not contain any SAP front end components. Such packages can be used to execute event scripts on workstations, for example to distribute your own configuration files. For more information, see Configuring Packages and Event Scripts [page 22] and Creating and Deploying a Single-File Installer for Packages [page 29]. 5. Enter a display name for the new package and choose Next. 6. Enter a command line name for the new package and choose Next. This name is required when installing the package by calling NwSapSetup.exe on the command line with the parameter /package. For more information, see Command Line Parameters for the Workstation [page 48] The new package is created and a confirmation is displayed in the wizard. 7. Choose Close. Results The new package is displayed on the Packages tab. You can now configure the package to implement event scripts and customize installation parameters, for example the installation target path. Related Information Configuring Packages and Event Scripts [page 22] SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 21
- 22. 5.5.2 Configuring Packages and Event Scripts This section describes how to define a description, how to change the attributes of a package (for example, the name) and how to customize the installation of the package by adding scripts that are executed during events in its lifecycle. Prerequisites ● An installation server is available. ● Packages are available. Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of the installation server. 2. Choose the Packages tab page. The existing packages are displayed on the left side of the screen. 3. Select the package that you want to customize. You can change its name, add a description, or implement script events. Note The end user will see name and description when he installs the package. Therefore, specify a name and a description that enables the end user to identify the correct packages. 4. Optional: To perform custom actions on the user’s workstation during the installation of the package (for example, copying additional files), add event scripts. Select the Configure Packages tab and choose Insert Script. You can insert package event script samples delivered by SAP with the Insert Script function and adapt them according to your needs. The scripts are executed at the following events: ○ On Installation Start: executed before the installation of a package ○ On Installation End: executed after the installation of a package ○ On Uninstallation Start: executed before the uninstallation of a package ○ On Uninstallation End: executed after the uninstallation of a package ○ On Update Start: executed before the update and the repair of a package ○ On Update End: executed after the update and the repair of a package Note When uninstalling with the command line options /uninstall /all, the event scripts defined for the events On Uninstallation Start and On Uninstallation End will also be executed for all packages that are being uninstalled. 5. Choose Save. 22 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 23. Related Information Package Event Script Samples [page 23] Repairing Installed SAP Front End Components [page 47] Changing the Package Content [page 28] 5.5.2.1 Package Event Script Samples The following Visual Basic Script commands help you to customize your packages. Tip All script samples below are available directly in NwSapSetupAdmin.exe on the Configure Packages tab. Add custom logging to the log file NwEngine.Context.Log.Write "Event: On Installation Start" Log an error ‘Adds an error log entry to NwSapSetup.log, SAPSetup will exit with 'return code different than 0 NwEngine.Context.Log.WriteError "Error in custom script: something failed!" Get the value of an installation variable srcFile = NwEngine.Variables.ResolveString(_ "%SapSrcDir%CustomerFilesTestFile.txt")srcDir = NwEngine.Variables.ResolveString("%SapSrcDir%CustomerFiles")destDir = "C:temp TestDir" destFile = "C:tempTestDirTestFile.txt" destFile1 = NwEngine.Variables.ResolveString("%ProgramFiles%TestFile.txt") destFile2 = NwEngine.Variables.ResolveString("%CommonProgramFiles%TestFile.txt") destFile3 = NwEngine.Variables.ResolveString("%WinDir%TestFile.txt") SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 23
- 24. Check whether a file exists If NwEngine.Shell.FileExist( strSrcFile ) Then 'Do something End If Copy a file 'Copy a file. If the target file exists already, it will not be overwritten NwEngine.Shell.CopyFile(srcFile, destFile) 'enforce overwriting an existing file NwEngine.Shell.CopyFileEx(srcFile, destFile, vbTrue) Delete a file NwEngine.Shell.DeleteFile(destFile) Copy a directory recursively NwEngine.Shell.CopyDirectory(srcDir, destDir) 'enforce overwriting existing directories NwEngine.Shell.CopyDirectoryEx(srcDir, destDir, vbTrue) Create a directory NwEngine.Shell.CreateDirectory(destDir) Delete a directory NwEngine.Shell.DeleteDirectory(destDir) 24 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 25. Check whether a registry key exists If NwEngine.Shell.RegKeyExist("HKCUSOFTWARESAPTestKey") Then 'Do something End If Set or create a registry value NwEngine.Shell.SetRegValue("HKCUSOFTWARESAPTestKeyTestString", _ "REG_SZ", "TestValue") NwEngine.Shell.SetRegValue("HKCUSOFTWARESAPTestKeyTestDWord", _ "REG_DWORD", "65536") Read a value from the registry regValue = _ NWEngine.Shell.GetRegValue("HKCUSOFTWARESAPTestKeyTestString") Execute another application ‘child processes will have administrative rights on the current computercmdLine = NwEngine.Variables.ResolveString("%WinDir%NotePad.exe") noWaiting = vbFalse 'This means: Wait for the started process NwEngine.Shell.ExecutecmdLine, noWaiting) visible = vbFalse 'This means: Do not display the UI of the started process NwEngine.Shell.ExecuteEx(cmdLine, noWaiting, visible) 5.5.2.2 Customizing Your SAP GUI Packages - Examples Example Copying a customized SapLogon.ini and services file 'This script can be added to the “On Installation End” section of a SAP GUI 710 package event script. 'It distributes your special version of the “SapLogon.ini” and services file 'given these files exist inside a directory “CustomerFiles” on your installation server share. NwEngine.Context.Log.Write "Event: Copying customized SapLogon.ini" SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 25
- 26. strSrcFile = NwEngine.Variables.ResolveString("%SapSrcDir%CustomerFiles SapLogon.ini") strDstFile = NwEngine.Variables.ResolveString("%WinDir%SapLogon.ini") If NwEngine.Shell.FileExist( strSrcFile ) Then NwEngine.Shell.CopyFile strSrcFile, strDstFile End If NwEngine.Context.Log.Write "Event: Copying customized services file" If NwEngine.Shell.FileExist("%SAPSrcDir%CustomerFilesservices") Then NwEngine.Shell.CopyFile "%SAPSrcDir%CustomerFilesservices", "%WinSysDir% driversetcservices" End If Example Setting registry values to configure auto-update settings for SAP Logon 'This script can be added to the “On Installation End” section of a 'SAP GUI 710 package event script to configure the auto update settings for SAP Logon. NwEngine.Context.Log.Write "Event: Setting the auto update registry key for SAP Logon"strRegUpdate =_ "HKLMSOFTWARESAPSAPsetupSAPstartAutoUpdateSAPLogon.exeUpdateMode" strRegProb = "HKLMSOFTWARESAPSAPsetupSAPstartAutoUpdateSAPLogon.exeProb" 'Option 1: Update Mode is switched on with update frequency = 10. The user is not allowed to configure.' NwEngine.Shell.SetRegValue strRegUpdate, "REG_SZ", "ForceOn" NwEngine.Shell.SetRegValue strRegProb, "REG_DWORD", "10" 'Option 2: Update Mode is switched off. The user is not allowed to switch it on.' NwEngine.Shell.SetRegValue strRegUpdate, "REG_SZ", "ForceOff" 'Option 3: Update Mode is switched on with update frequency = 10. The user is allowed 'to change the configuration.' NwEngine.Shell.SetRegValue strRegUpdate, "REG_SZ", "On" NwEngine.Shell.SetRegValue strRegProb, "REG_DWORD", "10" 'Option 4: Update Mode is switched off. The user is allowed to change the configuration.' NwEngine.Shell.SetRegValue strRegUpdate, "REG_SZ", "Off" 'The same settings can be applied to the registry values for 'SAPLgPad.exe': ' strRegUpdate = "HKLMSOFTWARESAPSAPsetupSAPstartAutoUpdateSAPLgPad.exe UpdateMode"'_ strRegProb = "HKLMSOFTWARESAPSAPsetupSAPstartAutoUpdateSAPLgPad.exeProb" Example Replacing a line inside a text file 'This script can be added to the "On Installation End" section of a 'SAP GUI 710 package event script. ' 'It replaces the default line ' Cmd="" 'with the line ' Cmd=" /ini_file="C:tempsaplogon.ini"" 'inside the file "%ProgramFiles%SAPSapSetupsetupSALSapLogon.sal" ' 'You can redirect “SAPLogon.exe” to the INI-file "C:tempsaplogon.ini". NwEngine.Context.Log.Write "Event: Editing SAPLogon.sal" strSalFile = NwEngine.Variables.ResolveString( _ "%ProgramFiles%SAPSapSetupsetupSALSapLogon.sal" ) Set objTextFile = CreateObject("NwSapSetupATLCommon.TextFileParser") If objTextFile.Parse( strSalFile ) Then NwEngine.Context.Log.Write "Event: Open and modify the file " & Chr(34) & _ strSalFile & Chr(34) szOldLine = "Cmd=" & Chr(34) & Chr(34) 26 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 27. szNewLine = "Cmd=" & Chr(34) & "/ini_file=" & Chr(34) & _ "C:tempsaplogon.ini" & Chr(34) & Chr(34) objTextFile.ReplaceLineEx szOldLine, szNewLine _ objTextFile.Save( strSalFile ) Else NwEngine.Context.Log.WriteWarning "Event: Could not open the file " & _ Chr(34) & strSalFile & Chr(34) End If Example Modifying the services file during installation 'This script can be added to the "On Installation End" section of a SAP GUI 710 package event script. 'It checks whether a line containing the string "Alpha" exists. 'If so, it replaces that line with "Alpha 1901/tcp" 'Otherwise it simply appends the new line to the end of the services file. NwEngine.Context.Log.Write "Event: Appending or replacing _ lines in the services file" strFile = NwEngine.Variables.ResolveString(_ "%WinSysDir%driversetcservices" ) Set objTextFile = CreateObject("NwSapSetupATLCommon.TextFileParser") If objTextFile.Parse( strFile ) Then NwEngine.Context.Log.Write "Event: Modify the file " & Chr(34) & strFile & Chr(34) If objTextFile. Does String Exist ( "Alpha" ) Then objTextFile.ReplaceLineEx "Alpha", "Alpha 1901/tcp" Else objTextFile.AppendLine "Alpha 1901/tcp" End If objTextFile.Save( strFile ) Else NWEngine.Context.Log.WriteWarning "Event: Could not open the file "_ & Chr(34) & strSalFile & Chr(34) End If Example Modifying the services file after uninstallation ' This script can be added to the "On Installation End" section ' of a SAP GUI 710 package event script. ' It removes a line from the services file which was set in the last Example #4. NwEngine.Context.Log.Write "Event: Removing a line from the services file" strFile = NwEngine.Variables.ResolveString(_ "%WinSysDir%driversetcservices" ) Set objTextFile = CreateObject("NwSapSetupATLCommon.TextFileParser") If objTextFile.Parse( strFile ) Then NwEngine.Context.Log.Write "Event: Modify the file " & Chr(34)_ & strFile & Chr(34) objTextFile.RemoveLine "Alpha 1901/tcp" objTextFile.Save( strFile ) Else NWEngine.Context.Log.WriteWarning "Event: Could not open the file "_ & Chr(34) & strSalFile & Chr(34) End If SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 27
- 28. 5.5.3 Changing the Package Content You can modify the package content by adding or removing SAP front end components to be installed with the package. You can also add event scripts that are executed before or after the update process. Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of your installation server. 2. Select the Package Configuration tab page. The packages are displayed on the left side of the screen. 3. Select the package whose content you want to update and choose Change Package Content. You can change the selection of SAP front end components. The added components are installed on the workstations. Removed components are uninstalled from the workstations if they are not part of any other package marked for installation. When updating a package, the package parameters are also refreshed. They now include new variables and no longer include those that belong to SAP front end components that are no longer part of this package. 4. Optional: Add event scripts to perform custom actions on the user’s workstation during the update of the package. You can insert script samples delivered by SAP choosing Insert Script Sample and adapt them to your requirements. The scripts are executed before or after the update: ○ On Update Start: executed before the update of a package ○ On Update End: executed after the update of a package 5. Choose Save. Results Saving the package increases the version number and the package is marked for update on the workstation. When the package installation is updated on the workstation, the package components that have been added or removed by the administrator are automatically installed or uninstalled. Note If you updated package event scripts or files copied by event scripts, choose Mark for Update on the Configure Packages tab to increase the package version. Choose Save. The installer now recognizes the package as updated, and the modifications are transferred to the workstations during the update with the event scripts. 28 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 29. 5.5.4 Deleting an Installation Package This section describes how to remove and delete packages permanently. Prerequisites Caution The package and its event scripts are permanently deleted without an option for recovery. ● An installation server is available. ● Packages are available. Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of your installation server. 2. On the Packages tab page, select the package to be deleted and choose Delete Package from the context menu. Results The package is deleted and removed from the list on the Packages tab page. 5.5.5 Creating and Deploying a Single-File Installer for Packages The single-file installer for a package contains only those files of the SAP front end components that are a part of the package. This reduces the network load if you have to copy the distribution medium to the workstation before installing. Prerequisites ● An installation server is available. ● Packages are available. ● Optional: If you want to distribute configuration files like the saplogon.ini together with the single-file installer, create a directory named CustomerFiles in the root directory of your installation server and copy SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 29
- 30. your files into this directory. All files and directories in this direcctory will be included in every package single- file installer. Use package event scripts to install your custom files. For more information, see Package Event Script Samples [page 23]. Tip The single-file installer can be executed on any workstation. To run the single-file installer silently without user interaction, enter /silent in the command line. More information: Command Line Parameters for the Installation Server [page 40]. Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of your installation server. 2. On the Packages tab page, select the package for which you want to create a single-file installer and choose Compress to Single-File Installer from the context menu. 3. Follow the wizard instructions. 4. To deploy the single-file installer, follow the wizard instructions. Results You have created and deployed a single-file installer. 5.5.6 Creating a Package Definition File This section describes how to create a package definition file (PDF) for an installation server package. Context PDF is a package description format that simplifies the interoperability and information exchange between SAPSetup and system management products such as Microsoft’s Systems Management Server. Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of your installation server. 2. On the Packages tab page, select the package for which you want to create a PDF file and choose Create Package Definition File from the context menu. 30 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 31. 3. In the upcoming window, choose the directory where you want to save the file, enter a file name, and save your entries. Results NwSapSetupAdmin.exe creates a PDF and a Microsoft Systems Management Server (SMS) file in the specified directory. 5.6 Patching the Installation Server Patching SAP front end components on the installation server keeps them up to date with the most recent correction and enhancements from SAP. Context Tip You can configure the Automatic Workstation Update Service (AWUS). This service updates the workstations and reboots them whenever the installation server is patched or the installed packages are updated, if necessary. The AWUS also works if no user is logged on to the workstation. More information: Installing and Configuring the Automatic Workstation Update Service [page 34] Note To ensure a successful patch and to prevent having to reboot after the patch, you can unshare the installation server during the patch and share it again when the patch has finished. Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of the installation server. 2. Choose Patch Server. This starts the patch wizard. 3. To continue, choose Next. 4. Browse to the SAP patch file and choose Next. NwSapSetupAdmin.exe validates the patch. If the patch is valid, you are prompted to proceed. SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 31
- 32. Note When the patch process starts, NwSapSetupAdmin.exe is closed. It restarts after the patch process has completed. This ensures that the installation server is not modified during the patch process. 5. To continue, choose Next. NwUpdateInstServer.exe starts patching the installation server. A log file is created in the SAPSetup log file directory. 6. Follow the wizard instructions. The wizard confirms the successful patch process. If an error occurs, see Troubleshooting [page 52]. 7. Choose Close. NwSapSetupAdmin.exe now restarts. Results Patching a SAP front end component (for example, SAP GUI for Windows 7.30) increases the version of each package that contains this component. 5.7 Configuring the Local Security Handling Local security handling (LSH) enables users to install SAP front end components on their workstations without requiring administrator privileges. By configuring LSH, the distribution service is installed and started. Prerequisites ● The installation server needs to be available and accessible via file sharing from the workstation. ● Server and workstations must be part of a Windows domain or active directory. ● Two domain user accounts are needed to run the installation service and the distribution service. The user for the distribution service must have administrative privileges on each workstation. The user for the installation service will get administrative privileges on the workstation temporarily, if he doesn’t have them anyway. You can use the same user account for both services. ● It must be possible to control services via the remote service management on the workstations. Make sure to configure the firewall accordingly. Remember To enable workstations that run Microsoft Windows Vista to use LSH, you have to change the default firewall setting for remote service management: 1. Start the Control Panel. 2. Choose Windows Firewall Change Settings . 32 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 33. 3. Select the Exceptions tab page. 4. Select Remote Service Management and choose OK. Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of the installation server. You need administrator privileges on the installation server. 2. Choose Services and select Maintain Local Security Handling Configure Local Security Handling . The LSH configuration wizard starts. 3. Choose Next. The wizard prompts you for the credentials of an account that has administrator privileges on all workstations on the network. The distribution service will run with these credentials. 4. Enter the account name with domain qualifiers like domainuser, enter the password twice, and choose Verify. Credentials are not validated. Verification only confirms that the password supplied matches its repetition. 5. Choose Next. 6. Enter the details for the installation service account and choose Verify. 7. To complete the process, choose Next. The wizard indicates whether LSH has been configured successfully. In this case the state of the distribution service is displayed as Active in the status bar at the bottom of NwSapSetupAdmin.exe. 8. Test the LSH on a workstation as a user without administrator privileges by starting NwSapSetup.exe from this installation server. Results The configuration is successful if the front end installer starts and is able to install SAP front end components which are available on the installation server. The status bar shows the state of the distribution service. If the configuration was not successfull, you have to reconfigure LSH. For more information, see also 11622270 . Note ● To temporarily disable LSH, choose Services Maintain Local Security Handling Stop Distribution Service . Enable LSH again by choosing Start Distribution Service in the same menu. ● To permamently disable LSH, choose Services Maintain Local Security Handling Uninstall Distribution Service . If the service is not configured, these menu entries are disabled. SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 33
- 34. 5.8 Installing and Configuring the Automatic Workstation Update Service If the automatic workstation update service (AWUS) is configured, the service updates the workstation and reboots it, if required. This happens whenever the installation server is updated or patched, or installed packages are updated. Prerequisites ● The installation server was created and configured with NwCreateInstServer.exe. ● The installation server should be hosted on a machine that can work as a file server and serve numerous network sessions. ● Windows server as operating system with the following local security policy: ○ Accounts: Guest account status = Enabled ○ Network access: Let ‘Everyone’ permissions apply to anonymous users = Enabled ○ Share is NULL-session accessible ● The workstation needs network access to the installation server. Context The AWUS is shipped with most SAP front end products and works only when installed on workstation as decribed below. During installation, the installation server from where the installation has been started is stored as source location for updates. The service is updated automatically whenever a patch is available. The AWUS works regardless of whether a user is logged on or not. ● If a user is logged on, he is informed of the availability of an update. The update starts only on the user's assent. The user is also informed about whether a reboot is required, and the reboot is executed only upon confirmation by the user. ● If no user is logged on, the update and the reboot (if necessary) are started automatically. Procedure 1. Configure the AWUS: a. Start NwSapSetupAdmin.exe from the Setup directory of the installation server. b. Choose Services and select Configure Autmatic Workstation Update. The dialog for configuring the AWUS is displayed. c. Define the AWUS configuration settings: 34 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 35. Option Result Update check frequency The workstation will check for updates at this interval. The default value is 24 hours. Enforce reboot With these options, you can control whether a reboot of the workstation should be enforced after an update. Enforce reboot if needed (recommended): A reboot will take place, if it is necessary to complete the update. Enforce reboot after every update: A reboot will be initiated after every update. Don't enforce reboot : No reboot will be initiated. In case a reboot is initiated and a user is logged on, the user will be notified. Reboot will only be performed after getting his approval. Additional update sources (optional) You can list additional installation servers. The AWUS will check the listed installa tion servers for available updates in the given order. By default, the AWUS will al ways check the installation server from which it had been installed itself. Disable automatic workstation updates The AWUS on the workstation is disabled the next time it checks for updates. It will not execute updates from this server, until you enable it again. To permanently stop AWUS on a workstation, uninstall it from the workstation. d. Save your entries and close the dialog. 2. Install the AWUS on the workstation: a. Create a package containing the component SAP Automatic Workstation Update. More information: Creating an Installation Package [page 21] b. Deploy the package on the workstation. More information: Installing Packages Configured by the Administrator [page 42] Once the AWUS is installed, the following programs will run on the workstation in background mode: ○ NwSapSetupUserNotificationTool.exe ○ NwSapAutoWorkstationUpdateService.exe Note The AWUS checks for updates on the last 10 installation sources that are network paths. Results You have configured the AWUS and installed it on the workstation. SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 35
- 36. 5.9 Controlling a Remote Workstation With the remote workstation control you can access and control workstations remotely on which you have administrator privileges. Prerequisites ● Check if the installation server is available. ● Enable the Windows Management Instrumentation (WMI). ● Check that WMI access is not blocked by the firewall. ● Check if you have either domain administrator privileges or local administrator privileges on the workstation. Tip Use the Microsoft tool wbemtest.exe to check the WMI connectivity to the remote workstation. Enter the connection namespace as <WorkstationName>rootcimv2. Features With the remote workstation control you can: ● Collect log files from workstations. More information: Collecting Log Files Remotely [page 36] ● Execute a process on the workstation. More information: Executing a Process Remotely [page 37] ● Display a list of processes running on the workstation. More information: Listing Remote Processes [page 39] 5.9.1 Collecting Log Files Remotely This section describes how to collect log files from a workstation remotely. Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of the installation server. 2. Choose Remote Collect Log Files (WMI) . 3. Enter the name of the workstation. If you want to collect log files from several workstations, separate the host names with a comma. 36 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 37. Tip If your current user has no administrator privileges on the remote workstation, enter the credentials of a user with administrator privileges on the remote workstation in screen area Administrative Credentials. This data will not be saved. 4. Choose Collect Logs to start the collection of log files from the remote workstation. Note If you want to stop the collection process, choose Abort. The files from the workstation are copied to directory %temp% SAPRemoteWksta. Once the file collection has completed, the directory is opened. 5.9.2 Executing a Process Remotely This section describes how to execute a process on the workstation remotely. Prerequisites ● The installation server has to be shared. ● NwSapSetupAdmin.exe has to be started as a user that is local administrator on the remote workstation on which you want to execute the process. ● If you want to start an installation on the remote workstation from the installation server, you have to activate the delegation function for the workstation. For more information, see the Microsoft TechNet article , question #10. Context You can execute installs, updates, repairs, and uninstalls remotely on a single remote workstation. NwSapSetup.exe is started from the installation server and runs on a remote computer. This is useful to provide quick help to a user in trouble, or to deploy new software for tests on a small number of computers. NwSapSetup.exe will be installed as a Windows service that removes itself after the process is complete. The Windows service will always be removed, even if an installation error occurs, so that no artefact is left. Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of the installation server. SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 37
- 38. 2. Choose Remote Execute on Remote Workstation . The Execute process on a remote computer dialog is displayed. 3. Choose the action that you want to execute: ○ Install: will install any selected product or package that is not yet installed on the remote workstation, and it will update any selected product or package that is already installed on the remote workstation. ○ Update: will enable the item All, so that you can update all installed products on the remote computer with the version on the installation server. If you select a product or package that is not yet installed on the remote computer, it will be installed. No downgrade will be done. ○ Repair: will repair installed SAP front end components [page 47] on the remote computer. ○ Uninstall: will uninstall the selected SAP front end components from the remote workstation. 4. Choose the item that you want to be processed. The available items depend on the action you chose. The options Install All and Repair Product are not available. Note Repairing a package is useful to execute your package event scripts [page 23] again. Make sure to increase the version of the package beforehand. The command line [page 48] that will get executed is displayed at the bottom of the dialog, you can copy it. 5. Enter the name of the remote computer you want to execute the process on. 6. Choose if you want to execute the process as user LocalSystem or as a different user. If your installation server is shared as a null session share, the process will run as user LocalSystem. Otherwise you have to specify the credentials of a user that is local administrator on the remote workstation and has access to the shared installation server. More information: Microsoft support article about null sesstion share enablement 7. Choose Execute to run the process on the remote machine. After choosing Execute, NwSapSetupAdmin waits for the remote process to start. A message box informs if the start was successful. There is no feedback on the progress of the process, nor when it is finished. It runs now independently from your actions. You can leave the dialog or start the next remote process. 8. To check if the process has finished, choose Remote Remote Task Manager (WMI) and check for the process [page 39] NwSapSetup.exe. 9. To check the results, choose Remote Collect Log Files (WMI) and check the return code [page 54] of the latest NwSapSetup.log file. Note If you encounter connection issues, see 1162270 . 38 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 39. 5.9.3 Listing Remote Processes This section describes how to display the list of processes running on the workstation. Procedure 1. Start NwSapSetupAdmin.exe from the Setup directory of the installation server. 2. Choose Remote Remote Task Manager (WMI) . 3. Enter the name of the workstation and choose Display. Note If you want to terminate a process, select it and choose Terminate. Be aware that in this case, the user who is working on the remote machine might lose unsaved data. 5.10 Removing the Installation Server This section describes how to remove an installation server if it is no longer required. Procedure 1. If the LSH [page 32] is configured, start NwSapSetupAdmin.exe and choose Services Stop Distribution Service . 2. Unshare the directory of the installation server. As a result the installation server is unavailable for workstations. 3. Delete the directory containing the installation server. SAPSetup Guide Setup and Administration of the Installation Server P U B L I C 39
- 40. 5.11 Command Line Parameters for the Installation Server This section provides command line parameters for installation servers. They are not case-sensitive. Parameters for NwCreateInstServer.exe and NwUpdateInstServer.exe Parameter Description /dest Destination directory where you want to create your installation server. Example /dest="C:MyInstServerPath" /silent /nodlg Shows only the progress dialog. Displays no other user interface. You can use it instead of /silent, if you wish to see the progress. Note If you use /nodlg, you have to supply the destination path with / dest:<destination path> /silent Does not display a user interface. Note If you use /silent, you have to supply the destination path with / dest:<destination path> /DontConfigureServerPath Disables the automatic configuration of the installation source directory (network share creation and null-session accessibility) when creating an installation server with the command line. Parameter for NwSapSetupAdmin.exe Parameter Description /checkserver Verifies the integrity of the installation server in silent mode (see Troubleshooting [page 52]). Returns an error level greater than zero and writes an error file, if discrepancies are found (see Log and Error Files [page 53]). 40 P U B L I C SAPSetup Guide Setup and Administration of the Installation Server
- 41. 6 Installing and Administering SAP Front End Components and Packages This section describes how to install, update, repair, and remove SAP front end components and packages on a workstation. 6.1 Installing SAP Front End Components This section describes how to install SAP front end components from an installation server or a distribution medium. Prerequisites SAP front end software applications should not be running during installation. If an application is running, the user may be prompted to reboot afterwards to complete the installation. If the installation runs interactively, the user is prompted to stop the applications. If he does so, no reboot is necessary. Procedure 1. Choose one of the following scenarios: ○ Installing SAP front end components from an installation server 1. Check if the user logged on to the workstation has local administrator privileges. If not, LSH has to be configured on the installation server. More information: Configuring the Local Security Handling [page 32]. 2. Start NwSapSetup.exe from the Setup directory on the installation server. ○ Installing SAP front end components on a single workstation from a distribution medium 1. Check if the user logged on to the workstation has local administrator privileges. 2. Start NwSapSetup.exe from your installation medium. Example On the SAP NetWeaver Presentation DVD, the setup executable is located at GUIWINDOWSWIN32. The SAPSetup installation wizard starts and displays a list of components that are part of the product to be installed. SAPSetup Guide Installing and Administering SAP Front End Components and Packages P U B L I C 41
- 42. Tip Starting SetupAll.exe, you can install all SAP front end components available on the installation server or distribution medium in one run. 2. On the SAPSetup installation wizard, choose Next. The list of SAP front end component is displayed. Already installed components are preselected. 3. Select the SAP front end components that you want to install and then choose Next. A green plus sign indicates that this SAP front end component will be installed on the workstation, or that it is aready installed and will be updated. Note Changes in the selection list are indicated by yellow dots. 4. If some products ask for additional parameters during the installation, like the installation directory, enter the required information and then choose Next,. Results Your SAP front end components are now successfully installed and ready to use on the workstation. Choose Finish to exit the installer. Note Processing is recorded in the SAPSetup log file. For more information, see Troubleshooting [page 52] and Log and Error Files [page 53]. 6.2 Installing Packages Configured by the Administrator This section describes how to install packages on the installation server that have been configured by the administrator. Prerequisites Check if the user logged on to the workstation has local administrator privileges. If not, LSH has to be configured on the installation server. More information: Configuring the Local Security Handling [page 32] 42 P U B L I C SAPSetup Guide Installing and Administering SAP Front End Components and Packages
- 43. Procedure 1. Start NwSapSetup.exe from the Setup directory on the installation server or distribution medium, choose Next on the welcome screen and then Predefined Packages. Alternatively, call NwSapSetup.exe /package on the command line, and choose Next on the welcome screen. You see all packages of the installation server in a list. Packages that have already been installed are preselected. 2. Select the packages that you want to install. A green plus sign indicates that this package will be installed on the workstation. A yellow dot indicates a change in the selection list. 3. Choose Next. SAPSetup now processes the packages and displays the completion status when finished. Results Your packages are now successfully installed and ready to use. Note Processing is recorded in the SAPSetup log file. For more information, see Troubleshooting [page 52] and Log and Error Files [page 53]. 6.3 Installing Using the Windows Logon Script This section describes how to distribute SAP Front End components and packages on many workstations in an automated way. Inserting a command line into the logon script of the users, the installation is started when the user logs on. Prerequisites Check that SAP front end components (especially SAP GUI) are closed before you start the task. SAPSetup might require a reboot to complete the installation if program files are in use. Context When you start the command on a workstation for the first time, SAPSetup installs the specified package. SAPSetup will check for package updates on the installation server every following logon, and will install updates automatically. SAPSetup Guide Installing and Administering SAP Front End Components and Packages P U B L I C 43
- 44. Note You can find the command line name of a package or SAP front end component in the administrative console NwSapSetupAdmin.exe. For more information on options, see Command Line Parameters for the Workstation [page 48] and Return Codes [page 54]. Procedure ● To install SAP front end components, add the following command to the user’s logon script: <server><shared directory>SetupNwSapSetup.exe /product:"<product command line name>" /nodlg ● To install packages, add the following command to the user’s logon script: <server><shared directory>SetupNwSapSetup.exe /package:"<package command line name>" /nodlg ● Optional: To ensure that an installation runs only once on a workstation, add the following option: / once:"<OnceTag>" The tag <OnceTag> is stored in the Windows registry and is never deleted by SAPSetup. If an installation with the same tag is started again, it does nothing and instantly returns 0. This can be useful for distributing a correction to many workstations using event scripts in packages that contain no SAP front end components. 6.4 Updating SAP Front End Components This section describes how to update the installed SAP front end components when a newer version is available as a patch either on the installation server or on a distribution medium. Prerequisites Check that SAP front end components are closed before you start the task. SAPSetup might require a reboot to complete the update if program files are in use. Context This procedure updates all products that have been installed without using packages. 44 P U B L I C SAPSetup Guide Installing and Administering SAP Front End Components and Packages
- 45. Note If you make use of packages, call this command with adding the parameter /package. If you distribute software both with and without packages, call this command twice, once with the parameter /package and once without. Procedure ● Updating a Workstation from an Installation Server Updating SAP front end components on a workstation involves the same steps as an installation [page 41]. You can choose to run the update unattended or automatically. ○ For an unattended update, use the following command line: <server_path>Setup NwSapSetup.exe /update /silent. Note If you want to update a specific package or SAP front end component, add /package="package command line name" or /product="product command line name". You can find the command line name of the package or SAP front end component in the administrative console NwSapSetupAdmin.exe. ○ For an automatic update, you use the AWUS [page 34]. Whenever the installation server is patched or the installed packages are updated, this service updates the workstations and reboots them, if necessary. The AWUS works regardless of whether a user is logged on. ○ If a user is logged on, the user is informed of the available update, and the update starts upon confirmation by the user. The user is also informed about whether a reboot is required, and the reboot is executed only upon confirmation by the user. ○ If no user is logged on, the update and the reboot (if necessary) are started automatically. Depending on the chosen update method, the SAP front end components are updated with or without user interaction. If the interactive update method is selected, the user simply has to choose Next to start the front end update. ● Updating a Standalone Workstation We recommend you to update a standalone workstation from an installation server [page 45] by means of the automatic update mechanisms (AWUS or logon scripts) which ensures a fast and efficient update of all workstations. However, you can update SAP front end components on standalone workstations by running a patch on every single workstation. In this case, an update involves the same steps as an installation [page 41]. SAPSetup Guide Installing and Administering SAP Front End Components and Packages P U B L I C 45
- 46. 6.5 Uninstalling SAP Front End Components This section describes how to remove SAP front end components from a workstation. Prerequisites SAP front end software applications should not be running during uninstallation. If an application is running, the user gets a message to reboot the workstation. Caution You cannot remove a SAP front end component with a SAPSetup version less than 8.6 if the component was installed with version 8.6 or higher. This will lead to an intentional termination of SAPSetup. Procedure 1. On the workstation, choose Start Settings Control Panel Add or Remove Programs . A list of the installed applications is displayed. 2. Select the SAP front end components to be removed and follow the instructions of the wizard. If you want to perform a silent or unattended uninstallation, enter the following commands: ○ For silently uninstalling a certain product: NwSapSetup.exe /Product=”<product name>” / Silent /Uninstall ○ For silently uninstalling all SAP front end components installed by SAPSetup: NwSapSetup.exe /all / silent /uninstall ○ For an unattended uninstallation of all SAP front end components installed by SAPSetup: NwSapSetup.exe /all /nodlg /uninstall When the command line options include /uninstall /all, the event scripts defined for the events On Uninstallation Start and On Uninstallation End will also be executed for all packages that are being uninstalled. For more command line options, see Command Line Parameters for the Workstation [page 48]. Results The selected SAP front end components are removed from the workstation. Note Processing is recorded in the SAPSetup log file. For more information, see Troubleshooting [page 52] and Log and Error Files [page 53]. 46 P U B L I C SAPSetup Guide Installing and Administering SAP Front End Components and Packages
- 47. 6.6 Repairing Installed SAP Front End Components This section describes how to repair SAP front end components which are installed on a worksation and do not work properly. Prerequisites ● Check if the user logged on to the workstation has local administrator privileges. If not, LSH has to be configured on the installation server. More information: Configuring the Local Security Handling [page 32] ● SAP front end software applications should not be running during a repair. If an application is running, the user might get a message to reboot the workstation. The repair process is completed after restart. Context If SAP front end components on a workstation are not working properly, start the repair process. This process checks for discrepancies in files, services, registry-keys and other artifacts installed by SAPSetup, and performs a re-install of differing artifacts. The repair process includes an update of SAP front end components on the workstation with versions lower than on the installation server. If a package is installed, the package event scripts [page 22] for updates are also executed during the repair. Procedure ● To start the repair process, you execute program NwSapSetup with parameter repair from the Setup directory either of the installation server, the distribution medium, or a single-file installer: NwSapSetup.exe /repair The repair process starts and a progress screen is displayed. Only those SAP front end components that are available on the source can be repaired. The processing is recorded in the file NwSapSetup.log in the SAPSetup log file directory. The repair process includes an update of all SAP front end components. If the version of a component on the installation server is higher than that of the component installed on the workstation, this component is udpated. If a package is installed, the package event scripts [page 22] for updates are executed during repair. Note If errors occur, see Troubleshooting [page 52]. SAPSetup Guide Installing and Administering SAP Front End Components and Packages P U B L I C 47
- 48. Results Your SAP front end components are now successfully repaired and ready to use on the workstation. 6.7 Command Line Parameters for the Workstation This section provides command line parameters for the workstation. When using the command line, consider the following rules: ● Parameter names and values are not case-sensitive. ● Specify parameter names either by /param or -param. ● Separate parameter name and value either by : or =. ● Surround parameter values that contain spaces either by " or '. ● Some Parameters can take multiple values. Separate them either by + or ,. Example NwSapSetup.exe /uninstall /all NwSapSetup.exe -repair - package="myPackage" NwSapSetup.exe -product:SAPGUI710 NwSapSetup.exe /uninstall /package:'my sap gui package,my nwbc package' Parameters for NwSapSetup.exe Parameter Impact /silent SAPSetup does not display a user interface. A splash screen is also not shown. Note When using /silent, you have to specify a product name, a package name, or / update. /nodlg SAPSetup only shows the progress dialog. It does not display any other user interface. You can use it instead of /silent. Note When using /nodlg, you have to specify a product name, a package name, or /update. /nosplash SAPSetup does not display a splash screen at startup. 48 P U B L I C SAPSetup Guide Installing and Administering SAP Front End Components and Packages
- 49. Parameter Impact /force SAPSetup overwrites all files, registry keys, and other artifacts installed by earlier runs of SAPSetup, regardless whether they exist or not. Even files with a newer file version are over written. When used for uninstall, SAP files are uninstalled even if their shared DLL counter is not zero. Superdeeded by /repair. /once:"<OnceTag>" Makes sure that an installation with the <OnceTag> tag runs exactly once on a workstation. The <OnceTag> tag is stored in the Windows registry and never deleted by SAPSetup. If an installation with the same tag is started again, it will do nothing and return 0 instantly. /uninstall Uninstalls SAP front end components installed by SAPSetup. ● To uninstall all SAP front end components, add /all. ● To uninstall a specific product or package instead, add /product="product command line name" or respectively / package="package command line name" Note Works only with /nodlg or /silent. /product SAPSetup runs the installer in product mode. You cannot switch to Package View. /package SAPSetup runs the installer in package mode. You cannot switch to Product View. /product:"<product cmd name>" Only the specified product is processed. Other products are not displayed on the selection di alog. You can specify several products by concatenating their names with a plus sign (+) or a comma (,). Ignored when /repair is specified, as due to possible dependencies only all products can be repaired . /package:"<package cmd name>" Only the specified package is processed. Other packages are not displayed on the selection dialog. You can specify several packages by concatenating their names with a plus sign (+) or a comma (,). When /repair is specified, only the specified packages are repaired. SAPSetup Guide Installing and Administering SAP Front End Components and Packages P U B L I C 49
- 50. Parameter Impact /update Updates installed SAP front end components. ● To update all installed packages that are available on the installation server, add / Package. ● To update a specific product or package, add /product="product command line name" or respectively /package="package command line name". Note Without specifying /package, packages are ignored. Note Works only with /nodlg or /silent. /skip=wtscheck Skips the check whether the WTS server is in installation mode. Only provide this if the check does not work correctly. In this case, open a message on component BC-FES-INS for a bug report. /ForceWindowsRestart Forces a restart of the workstation after the installation is complete. Use in combination with /package or /product after /silent or /nodlg. Example: NwSapSetup.exe /silent /product="SAPGUI" / ForceWindowsRestart /SMS[:"<package cmd name>"] Creates a status file <package command line name>.MIF in the %TEMP% directory that indicates the success or failure of the process. Typically used by software distribution systems such as SMS to determine the success or fail ure of a remote installation (advertised package installation). /repair Repairs all installed SAP front end components. When combined with /package:"pckg", only the specified package is repaired. Ignores products specified with /product:"p". More information: Repairing Installed SAP Front End Components [page 47] /MaintenanceMode Usually, only those SAP front end components that are also available on the installation source are displayed in the selection dialog. With this switch, all installed SAP front end com ponents are displayed, even if they are not available on the installation source, and can be un installed. Parameter for Single-File Installer Parameter Description /? Provides help on command line parameters. /extract:dest_dir Extracts the single-file installer into the dest_dir directory. If the directory does not exist, it will be created. This works with single-file installers shipped by SAP as well as with those created in NwSapSetupAdmin [page 29]. 50 P U B L I C SAPSetup Guide Installing and Administering SAP Front End Components and Packages
- 51. Parameter Description /CreateServer [/ dest="dest_dir"] Creates a new installation server. The optional parameter /destspecifies the target directory of the installation server. This directory must exist and should be empty. This call is equivalent to extracting the single-file installer and then manually starting SetupNwCreateInstServer.exe. /UpdateServer [/ dest="dest_dir"] Updates an existing installation server. The optional parameter /destspecifies the target directory of the installation server that will be updated. This directory must exist. This call is equivalent to extracting the single-file installer and then manually starting SetupNwUpdateInstServer.exe. /repair Repairs all installed SAP front end components. More information: Repairing Installed SAP Front End Components [page 47] /silent Installs all SAP front end components contained in the single file installer without dis playing a user interface. Installed SAP front end components will be updated, if the sin gle-file installer contains a newer version. Compatible with all other parameters ex cept /?. /nodlg Installs all SAP front end components contained in the single file installer showing only the progress dialog. Installed SAP front end components will be updated, if the single- file installer contains a newer version. Compatible with all other parameters except /?. Parameter for NWCheckWorkstation.exe Parameter Description /silent Does not display a user interface. Returns the same return values as NwSapSetup.exe. For more information, see Return Codes [page 54]. SAPSetup Guide Installing and Administering SAP Front End Components and Packages P U B L I C 51
- 52. 7 Troubleshooting This section describes how to check the integrity of the installation server and the installed SAP front end components on a workstation. Procedure ● Troubleshooting on the Installation Server ○ Integrity check 1. Start NwSapSetupAdmin.exe from the Setup directory. 2. Choose Check Server and follow the wizard instructions. This checks whether all required files are available and unchanged. If files are missing or if their hash values are incorrect, the wizard displays a link to an error report. 3. To view the error report in a web browser, choose the provided link. Otherwise, choose Close to exit the wizard. This integrity check is helpful if you face problems with creating a single-file installer, for example. If the integrity check reveals incorrect hash values, your server may be corrupt. You can have the hashes recalculated by choosing Repair Metadata in NwSapSetupAdmin.exe only if you yourself have changed the files on the installation server. For more information, see Log and Error Files [page 53]. ○ On the Packages tab, the packages are displayed in the navigation pane on the left side of the screen. The icon indicates that the package is incomplete. This occurs when you deleted a SAP front end component contained in the package from the installation server. In this case, delete the package, reimport the missing SAP front end component, or change the package content. ● Troubleshooting on the Workstation NwCheckWorkstation.exe verifies the installation of SAP front end components by checking for discrepancies in files, services, registry-keys, and other artifacts installed by SAPSetup. You do not require administrator privileges to perform workstation checks. If there are discrepancies, a report is displayed. The workstation check tool collects installation data and log files, and compresses them into a cabinet archive. After the check is completed, Windows Explorer opens the directory containing this CAB file. When reporting installation issues, you should forward the CAB file to SAP support for a quicker diagnosis. To start the workstation check, proceed as follows: 1. Start NwCheckWorkstation.exe from the Setup directory either of the installation server or of the workstation (%ProgramFiles%SAPSapSetupSetup on 32bit Windows or %ProgramFiles32%SAP SapSetupSetup on 64bit Windows) 2. Follow the wizard instructions. If an error occurs during processing, the wizard displays a link to an error report. Follow the link to view the error report in a web browser. 52 P U B L I C SAPSetup Guide Troubleshooting
- 53. 7.1 Log and Error Files All the installation tools described in this document maintain an activity record in log files. Errors are saved in an XML format in files that you can view in your web browser. Log files The log files are stored in the following directory: ● Windows 32bit: %ProgramFiles%SAPSapSetupLOGs ● Windows 64bit: %ProgramFiles(x86)%SAPSapSetupLOGs Each tool stores the last 20 log files. Error files The error files are stored in the following directory: ● Windows 32bit: %ProgramFiles%SAPSapSetupErrors ● Windows 64bit: %ProgramFiles(x86)%SAPSapSetupErrors Tool releated log and error files Tool Log File Error File NwCreateInstServer.exe NwCreateInstServer.log NwCreateInstServerErrors_<D ateTime>.xml NwUpdateInstServer.exe NwUpdateInstServer.log NwUpdateInstServerErrors_<D ateTime>.xml NwSapSetupAdmin.exe NwSapSetupAdmin.log NwSapSetupAdminErrors_<Date Time>.xml NwSapSetup.exe single-file installer NwSapSetup.log SAPSetupErrors_<DateTime>.x ml Creating a message Use component BC-FES-INS to create a message and attach the relevant log files and error files. If you run NwCheckWorkstation.exe on the workstation as described in section Troubleshooting [page 52], attach the generated CAB file instead. SAPSetup Guide Troubleshooting P U B L I C 53
- 54. 7.2 Return Codes If you start NwSapSetup.exe from a batch file, the environment variable %ERRORLEVEL% contains the return code. Example Example start /wait <Path to installer source>SetupNwSapSetup.exe /package="<cmd line name of your package>" /silent && echo %ERRORLEVEL% 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 The following reasons are possible: ● A prerequisite for the installation was not met and the installation was executed with / silent or /nodlg. ● 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 Note In event of return codes 144-146, check the Log and Error Files [page 53] for NwSapSetup.exe. 54 P U B L I C SAPSetup Guide Troubleshooting
- 55. 8 Visual Basic Script Application Program Interfaces Packages can be extended by package event scripts. These are written in Visual Basic Script. SAPSetup provides Visual Basic Script objects for easy scripting: ● NwEngine.Shell Handling of files and directories, Windows registry entries, Executing and controlling processes ● NwEngine.Context Checking the context of the installation, like Windows version, hostname, command line arguments ● NwEngine.Context.Log Writing log file entries ● NwEngine.Variables Getting values of SAPSetup variables All package information, including package event scripts, is stored in the file Setup/SapPackageSetup.xml. Make sure to backup your installation server and especially this file, as SAPSetup does not provide a history of package versions. Thus when you change a package, the previous version is gone. When you change or delete a package event script, the previous version is gone. For basics on Visual Basic Script check out ● VBScript Language Reference on MSDN at https:/ /msdn.microsoft.com ● VBScript Fundamentals on MSDN at https:/ /msdn.microsoft.com Testing scripts Make sure to test your scripts. Try out how it behaves if a network path is not available or some file is not there as expected. Test all life cycle steps: install, update and uninstall. Have your script fail gracefully. Several methods return a success indication, so you can react on it. Writing an error to the log file will make SAPSetup return a value other than 0. Thus you can make your infrastructure react accordingly, like have the installation, update or uninstall repeated. Include custom files in packages Additional files can be included in packages. Create a directory named CustomerFiles in the root directory of your installation server and copy your files into this directory. All files and directories in this directory will be included in every package single-file installer. Use package event scripts to install your custom files. Sample Code 'Use this in package event script "On Installation End" SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 55
- 56. NwEngine.Shell.CopyFile("%SapSrcDir%CustomerFilesmyFile.txt", "%COMMONPROGRAMFILES64%myProduct") 'Use this in package event script "On Update End" 'when you do something during installation of the pacakge, always consider what should happen when updating the package. NwEngine.Shell.CopyFileEx("%SapSrcDir%CustomerFilesmyFile.txt", "%COMMONPROGRAMFILES64%myProduct", vbFalse) 'Use this in package event script "On Uninstallation End" 'when you install something, clean up during uninstall. NwEngine.Shell.DeleteFile("%COMMONPROGRAMFILES64%myProductmyFile.txt") Installs the file myFile.txt into directory %COMMONPROGRAMFILES64%myProduct. When the package is updated, this file will be updated as well, overwriting the existing file. During uninstall of the package, the file will be deleted. Procedures Versus Functions Visual Basic script distinguishes procedures and functions. Procedures do not return a value, and their parameters must not be enclosed by parantheses. Functions do return a value, and their parameters must be enclosed by parantheses. Almost all methods of NwEngine are functions, except those for logging and very few others. Sample Code 'Call a procedure 'Leave the parameters without paranthesis, else the script will fail with syntax error. NwEngine.Context.Log "Some text" 'Call a function 'Enclose the parameters with paranthesis. NwEngine.Shell.CopyFile("%SapSrcDir%CustomerFilesmyFile.txt", "%COMMONPROGRAMFILES64%myProduct") Line Wrapping and Text Concatenation Long lines can be wrapped, and strings concatenated. Sample Code 'Without Wrapping Dim Text Text = "This is a very long line. It is to long to fit in an editor window so you must scroll horizontal to see all the content" 'With Wrapping and Concatenation Text = "This is a very long line. It is to long to fit in an editor" & _ " window so you must scroll horizontal to see all the content" 'With the "_" character you can wrap all code lines If NwEngine.Context.Windows8 = vbFalse And _ NwEngine.Context.Windows81 = vbFalse Then ' Do something End If 56 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 57. 8.1 NwEngine.Shell NwEngine.Shell comprises methods to access and manipulate the file system and the Windows registry. Methods for File System Access Method Name Description CopyDirectory(String source, String target) [page 59] Copies source directory to target directory with all content. Returns true if copying was successful, else false. CopyDirectoryEx(String source, String target, Bool failIfExists) [page 60] Copies source directory to target directory with all content. If failIfExists is set to true, existing files will not be overwritten. Returns true if copying was suc cessful, else false. CopyFile(String source, String target) [page 61] Copies source file to target file on the file system. Returns true if deletion was suc cessful, else false. CopyFileEx(String source, String target, Bool failIfExists) [page 61] Copies source file to target file on the file system. If failIfExists is set to true, an existing file will not be overwritten. Returns true if deletion was successful, else false. CreateDirectory(String directory) [page 62] Creates a directory. Returns true if creation was successful, else false. CreateTempDirectory() [page 62] Creates a temporary directory and returns the path as string. DeleteDirectory(String directory) [page 63] Deletes a directory. Returns true if deletion was successful, else false. DeleteFile(String file) [page 64] Deletes a file. Returns true if deletion was successful, else false. DirectoryExist(String path) [page 65] Returns true if the directory exists, else false. FileExist(String file) [page 69] Returns true if the file exists, else false. GetDriveType(String drive) [page 70] Returns a value indicating the type of the drive as integer. GetFileExt(String file) [page 70] Returns the extension of a file name as string. GetFileName(String path) [page 71] Returns the file name of the path as string. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 57
- 58. Method Name Description GetFileSize(String file) [page 71] Returns the size of the file in bytes as long. GetFileVersion(String file) [page 72] Returns the version number of the file as string. GetPath(String file) [page 72] Returns the path of a file as string. GetShortPath(String file) [page 73] Returns the short path in 8.3 format of a file as string. IsPathEqual(String path1, String path2) [page 74] Compares the pathes of two directories and returns true if they are identical, else false. Methods for Process and System Interaction Method Name Description Execute(String cmdline, bool async) [page 67] Executes a command line. Returns true if the process has finished, else false. ExecuteEx(String cmdline, bool async, bool visible) [page 68] Executes a command line, optinally without displaying a window. Returns true if the process has finished, else false. ExecuteRC(String cmdline, bool async, bool visible) [page 68] Executes a command line, optinally without displaying a window. Returns the return code of the process, if executed synchronously. GetSystemUtcTime() [page 74] Returns the system UTC time as string. IsExeRunning(String file) [page 74] Returns true if the file is a running executable, else false. Sleep Number milliseconds [page 77] Make SAPSetup sleep for the specified time. TerminateProcessInstances String exeName [page 77] Terminates all processes whose executable name is exeName. Methods for Registry Access Method Name Description DeleteRegKey(String key) [page 64] Deletes a registry key and returns true if deletion was successful, else false. 58 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 59. Method Name Description DeleteRegValue(String value) [page 65] Deletes a registry value and returns true if deletion was successful, else false. EnumRegKeys(String path) [page 66] Returns a collection containing all keys below the given path. EnumRegValues(String path) [page 66] Returns a collection containing all values below the given path. GetRegValue(String value) [page 73] Returns the data of the registry value. RegKeyExist(String key) [page 75] Returns true if registry key exists, else false. RegValueExist(String value) [page 76] Returns true if registry value exists, else false. SetRegValue(String valuePath, String valueType, String value) [page 76] Sets a registry value. Properties Property Name Description Use64BitHive [page 78] Gets or sets a flag indicating whether SAPSetup operates on the 64bit branch of the Windows registry. NwEngine.Shell.CopyDirectory Copies source directory to target directory with all content. Syntax NwEngine.Shell.CopyDirectory(String sourceDir, String target) Arguments sourceDir required. The path to the directory to copy. target required. If the target is a directory, the target file name is the same as the source file name. If the target does not exist, or if it is a file, then this is the target file name. Returns Returns Bool: true if the directory copy was successful, else it returns Bool: false. Remarks Existing files will not be overwritten. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 59
- 60. Sample Code If NwEngine.Shell.CopyDirectory("%SapSrcDir%myfiles", "C:pathtoyourfiles") Then NwEngine.Context.Log.Write "Copying %SapSrcDir%myfiles to C:pathto yourfiles was successful." End if Copies the directory %SapSrcDir%myfiles to C:pathtoyourfiles and writes a message to the log, if the directory copy succeeded. NwEngine.Shell.CopyDirectoryEx Copies source directory to target directory with all content. Syntax NwEngine.Shell.CopyDirectoryEx(String sourceDir, String target, Bool noOverwrite) Arguments sourceDir required. The path to the directory to copy. target required. If the target is a directory, the target file name is the same as the source file name. If the target does not exist, or if it is a file, then this is the target file name. noOverwrite required. If set to Bool: true, an existing file will not be overwritten. If set to Bool: false, existing files will be overwritten. Returns Returns Bool: true if the directory copy was successful, else it returns Bool: false. Remarks Copies source directory to target directory with all content. When setting noOverwrite to Bool: true, this method behaves like NwEngine.Shell.CopyDirectory(). This method is useful to update files copied from CustomerFiles on the installation server (see Creating and Deploying a Single-File Installer for Packages [page 29]). Sample Code If NwEngine.Shell.CopyDirectoryEx("%SapSrcDir%CustomerFilesmyfiles", "C:pathto yourfiles", vbFalse) Then NwEngine.Context.Log.Write "Copying %SapSrcDir%CustomerFilesmyfiles to C: pathtoyourfiles was successful." End if Copies the directory %SapSrcDir%myfiles to C:pathtoyourfiles, overwriting existing files, and writes a message to the log, if the directory copy succeeded. 60 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 61. NwEngine.Shell.CopyFile Copies source file to target file on the file system. Syntax NwEngine.Shell.CopyFile(String sourceFile, String target) Arguments sourceFile required. The name of the file to copy. target required. If the target is a directory, the target file name is the same as the source file name. If the target does not exist, or if it is a file, then this is the target file name. Returns Returns Bool: true if file copy was successful, else it returns Bool: false. Remarks Existing files will not be overwritten. Sample Code If NwEngine.Shell.CopyFile("%SapSrcDir%setupnetstart.exe", "C:pathtosetup") Then NwEngine.Context.Log.Write "Copying %SapSrcDir%setupnetstart.exe to C:path tosetup was successful" End if Copies the file %SapSrcDir%setupnetstart.exe to directory C:pathtosetup and writes a message to the log, if the file copy succeeded. NwEngine.Shell.CopyFileEx Copies source file to target file on the file system. Syntax NwEngine.Shell.CopyFileEx(String sourceFile, String target, Bool noOverwrite) Arguments sourceFile required. The name of the file to copy. target required. If the target is a directory, the target file name is the same as the source file name. If the target does not exist, or if it is a file, then this is the target file name. noOverwrite required. If set to Bool: true, an existing file will not be overwritten. If set to Bool: false, existing files will be overwritten. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 61
- 62. Returns Returns Bool: true if file copy was successful, else it returns Bool: false. Remarks When setting noOverwrite to Bool: true, this method behaves like NwEngine.Shell.CopyFile(). This method is useful to update files copied from CustomerFiles on the installation server (see Creating and Deploying a Single-File Installer for Packages [page 29]. Sample Code If NwEngine.Shell.CopyFileEx("%SapSrcDir%setupnetstart.exe", "C:pathto setup", false) Then NwEngine.Context.Log.Write "Copying %SapSrcDir%setupnetstart.exe to C:path tosetup was successful" End if Copies the file %SapSrcDir%setupnetstart.exe to directory C:pathtosetup and writes a message to the log, if the file copy succeeded. If the file exists at the destination, it will be overwritten. NwEngine.Shell.CreateDirectory Creates a directory. Syntax NwEngine.Shell.CreateDirectory(String target) Arguments target required. Path to the directory to create. Returns Returns Bool: true if the creation was successful, else it returns Bool: false. Sample Code If Not NwEngine.Shell.CreateDirectory("C:pathtomyDir") Then NwEngine.Context.Log.WriteError "Creating directory C:pathtomyDir failed." End if Tries to create directory C:pathtomyDir and writes the error message "Creating directory C:path tomyDir failed." to the log, if the creation failed. NwEngine.Shell.CreateTempDirectory Creates a temporary directory. 62 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 63. Syntax NwEngine.Shell.CreateTempDirectory() Returns Returns the path of the created directory as String. Remarks The temporary directory is created in %TEMP%. This is useful for more complex file operations that should not be done within the destination directory of the installation. Sample Code Dim tempPath tempPath = NwEngine.Shell.CreateTempDirectory() 'Do some file operations there NwEngine.Shell.DeleteDirectory(tempPath) Creates a directory in %TEMP% and finally deletes it again. NwEngine.Shell.DeleteDirectory Deletes a directory. Syntax NwEngine.Shell.DeleteDirectory(String target) Arguments target required. Path to the directory to delete. Returns Returns Bool: true if the deletion was successful, else it returns Bool: false. Remarks Caution All content of the directory will be deleted. Use with great care. Sample Code Dim tempPath tempPath = NwEngine.Shell.CreateTempDirectory() 'Do stuff in the temporary directory, then clean it up. NwEngine.Shell.DeleteDirectory(tempPath) Creates a directory in %TEMP% and returns the path to it. Afterwards the temporary directory is deleted. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 63
- 64. NwEngine.Shell.DeleteFile Deletes a file. Syntax NwEngine.Shell.DeleteFile(String target) Arguments target required. Path to the file to delete. Returns Returns Bool: true if the deletion was successful, else it returns Bool: false. Sample Code Dim someFile someFile = "C:pathtomyFile.ext" NwEngine.Shell.DeleteFile(someFile) Deletes the file C:pathtomyFile.ext. NwEngine.Shell.DeleteRegKey Deletes a registry key. Syntax NwEngine.Shell.DeleteRegKey(String key) Arguments key required. Path to the registry key to delete. Returns Returns Bool: true if the deletion was successful, else it returns Bool: false. Sample Code Dim key1, key2 key1 = "Internet ExplorerActiveX Compatibility{C0A63B86-4B21-11D3-BD95- D426EF2C7949}" key2 = "Internet ExplorerActiveX Compatibility{C0A63B86-4B21-11D3-BD95- D426EF2C7949}" NwEngine.Context.Log.Write "Removing the killbit for vsflex7l.ocx." If NwEngine.Shell.RegKeyExist("HKLMSOFTWAREMicrosoft" & key1) Then If Not NwEngine.Shell.DeleteRegKey("HKLMSOFTWAREMicrosoft" & key2) Then NwEngine.Context.Log.Write "Deleting the killbit for vsflex7l.ocx has failed." Else NwEngine.Context.Log.Write "Deleting the killbit for vsflex7l.ocx has succeeded." 64 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 65. End If End If Removes the killbit of vsflex71.ocx by deleting the corresponding registry key. Writes appropriate messages to the log file. NwEngine.Shell.DeleteRegValue Deletes a registry value. Syntax NwEngine.Shell.DeleteRegValue(String value) Arguments value required. Path to the registry value to delete. Returns Returns Bool: true if the deletion was successful, else it returns Bool: false. Sample Code Dim value value = "HKLMSOFTWAREMicrosoftWindowsCurrentVersionRunSunJavaUpdateSched" NwEngine.Context.Log.Write "Removing autostart of Java Update Scheduler." If Not NwEngine.Shell.DeleteRegValue(value) Then NwEngine.Context.Log.Write "Deleting the autostart of Java Update Scheduler has failed." Else NwEngine.Context.Log.Write "Deleting the autostart of Java Update Scheduler has succeeded." End If Removes the autostart of Java Update Scheduler by deleting the corresponding registry value. Writes appropriate messages to the log file. NwEngine.Shell.DirectoryExist Checks if a directory exists. Syntax NwEngine.Shell.DirectoryExist(String target) Arguments target required. Path to the directory to check for existence. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 65
- 66. Returns Returns Bool: true if the directory exists, else it returns Bool: false. Sample Code Dim someDir someDir = "C:pathtomyDir" If NwEngine.Shell.DirectoryExist(someDir) Then NwEngine.Context.Log.Write "File " & someDir & " exists." End If Writes a line to the log if the file C:pathtomyDir exists. NwEngine.Shell.EnumRegKeys Returns a collection containing all keys below a specified registry path. Syntax NwEngine.Shell.EnumRegKeys(String path) Arguments path required. Path to the registry key to enumerate. Returns Returns a collection of the registry keys that are direct children of the specified path. Does not return the whole tree below the specified path recursively. Sample Code Dim jre8Version If NwEngine.Shell.RegKeyExist("HKLMSOFTWAREJavaSoftJava Runtime Environment 1.8") Then For Each jre8Key in NwEngine.Shell.EnumRegKeys("HKLMSOFTWAREJavaSoftJava Runtime Environment") If Left(jre8Key, 5) = "1.8.0" Then jre8Version = jre8Key End If Next End If NwEngine.Shell.EnumRegValues Returns a collection containing all values below a specified registry path. Syntax NwEngine.Shell.EnumRegValues(String path) 66 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 67. Arguments path required. Path to the registry key to enumerate. Returns Returns a collection of the registry values that are direct children of the specified path. Does not return the whole tree below the specified path recursively. Sample Code Dim autoRunPath32, autoRunPath64 autoRunPath32 = "HKLMSOFTWAREMicrosoftWindowsCurrentVersionRun" autoRunPath64 = "HKLMSOFTWAREWow6432NodeMicrosoftWindowsCurrentVersionRun" For Each autoRunValue in NwEngine.Shell.EnumRegValues(autoRunPath32) 'Do some check or change Next 'Do not forget the 64 bit registry hive NwEngine.Shell.Use64BitHive = vbTrue For Each autoRunValue in NwEngine.Shell.EnumRegValues(autoRunPath64) 'Do some check or change Next 'Always reset to the 32bit registry hive NwEngine.Shell.Use64BitHive = vbfalse Enumerates all registry values in HKLMSOFTWAREMicrosoftWindowsCurrentVersionRun in both, the 32bit hive and the 64bit hive. Finally resets the registry mode back to 32bit hive. NwEngine.Shell.Execute Executes a command line. Syntax NwEngine.Shell.Execute(String cmdline, Bool async) Arguments cmdline required. Command line to execute. async required. If async is set to Bool: true, the process will be started asynchronously. If async is set to Bool: false, SAPSetup waits for the process to finish. Returns Returns Bool: truetrue if the process has finished, else Bool: false. Sample Code Dim cmdline cmdline = "%WINWORDEXE% C:pathtoreadme.doc" If NwEngine.Variables.GetValue("WINWORDEXIST") = "YES" AND _ NOT NwEngine.Context.Silent Then NwEngine.Context.Log.Write "Showing readme file." NwEngine.Shell.Execute(cmdline, vbTrue) SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 67
- 68. End If If Microsoft Word is installed, and SAPSetup is not running silently, then it is called to show the file C:pathto readme.doc exists. Microsoft Word is started asynchronously, so that the installation can finish. Before calling command lines that require interaction, check if SAPSetup is running interactively. NwEngine.Shell.ExecuteEx Executes a command line, optinally without displaying a window. Syntax NwEngine.Shell.ExecuteEx(String cmdline, async, Bool visible) Arguments cmdline required. Command line to execute. async required. If async is set to true, the process will be started asynchronously. If async is set to false, SAPSetup waits for the process to finish. visible required. If visible is set to false, no window will be shown. This is especially useful for executing batch processes. Returns Returns Bool: truetrue if the process has finished, else Bool: false. Sample Code Dim cmdline cmdline = "%SapSrcDir%CustomerFilesmybatch.cmd" NwEngine.Context.Log.Write "Executing mybatch.cmd ..." NwEngine.Shell.ExecuteEx(cmdline, vbFalse, vbTrue) Executes %SapSrcDir%CustomerFilesmybatch.cmd without showing the command prompt window. Waits for the execution before continuing. NwEngine.Shell.ExecuteRc Executes a command line, optinally without displaying a window. Syntax NwEngine.Shell.ExecuteRC(String cmdline, Bool async, Bool visible) Arguments cmdline required. Command line to execute. 68 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 69. async required. If async is set to true, the process will be started asynchronously. If async is set to false, SAPSetup waits for the process to finish. visible required. If visible is set to false, no window will be shown. This is especially useful for executing batch processes. Returns Returns the return code of the executed command as String. When setting async to Bool: true, then SAPSetup cannot receive the return code and 0 is returned. Sample Code Dim cmdline, returnCode cmdline = "%SapSrcDir%CustomerFilesmybatch.cmd" NwEngine.Context.Log.Write "Executing mybatch.cmd ..." returnCode = NwEngine.Shell.ExecuteRC(cmdline, vbFalse, vbTrue) NwEngine.Context.Log.Write "Executing mybatch.cmd finished with " & returnCode Executes %SapSrcDir%CustomerFilesmybatch.cmd without showing the command prompt window. Waits for the execution before continuing, and prints the return code of the executed command to the log file. NwEngine.Shell.FileExist Checks if a file exists. Syntax NwEngine.Shell.FileExist(String target) Arguments target required. Path to the file to check for existence. Returns Returns Bool: true if the file exists, else it returns Bool: false. Sample Code Dim someFile someFile = "C:pathtomyFile.ext" If NwEngine.Shell.FileExist(someFile) Then NwEngine.Context.Log.Write "File " & someFile & " exists." End If Writes a line to the log if the file C:pathtomyFile.ext exists. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 69
- 70. NwEngine.Shell.GetDriveType Returns the type of a drive. Syntax NwEngine.Shell.GetDriveType(String drive) Arguments drive required. Path to the drive to check. Returns Returns a Number indicating the drive type: ● 0: DriveTypeFixed (e.g. HDD) ● 1: DriveTypeRemovable (e.g. floppy) ● 2: DriveTypeRemote (e.g. network drive) ● 3: DriveTypeCDROM (e.g. DVD-ROM) ● 64: DriveTypeUnknown Sample Code NwEngine.Context.Log.Write "Type of drive C: is: " & NwEngine.Shell.GetDriveType("C:") Writes the numeric type of drive C: to the log. NwEngine.Shell.GetFileExt Returns the extension of a file name. Syntax NwEngine.Shell.GetFileExt(String file) Arguments file required. File to get the extension of. Returns Returns the file extension of a file as String. Sample Code NwEngine.Context.Log.Write "Extension of file " & someFile & " is "& NwEngine.Shell.GetFileExt(someFile) Writes the file extension of file someFile to the log. 70 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 71. NwEngine.Shell.GetFileName Returns the file extension of a file. Syntax NwEngine.Shell.GetFileName(String path) Arguments path required. Path to get the filename of. Returns Returns the file name of a path as String. Sample Code dim apsetup sapsetup = NwEngine.Variables.ResolveString("%SAPSRCDIR%SetupNwSapSetup.exe") NwEngine.Context.Log.Write "Filename of SAPSetup is " & NwEngine.Shell.GetFileName(apsetup) Writes the file name of the SAPSetup executable to the log. NwEngine.Shell.GetFileSize Returns the size of a file in bytes. Syntax NwEngine.Shell.GetFileSize(String file) Arguments file required. File to get the size of. Returns Returns the size of a file as Number in bytes. Sample Code Dim myfile, size myfile = NwEngine.Variables.ResolveString("%SapSrcDir%CustomerFilesmyfile.txt") size = NwEngine.Shell.GetFileSize(myfile) If size = 0 Then NwEngine.Context.Log.Write "myfile.txt is empty" End If Checks the size of file %SapSrcDir%CustomerFilesmyfile.txt and writes an info to the log, if the file has size 0. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 71
- 72. NwEngine.Shell.GetFileVersion Returns the file version of a file. Syntax NwEngine.Shell.GetFileVersion(String file) Arguments file required. File to get the version of. Returns Returns the file version of a file as String. Sample Code Dim cmdExe cmdExe = NwEngine.Variables.ResolveString("%WINSYSDIR64%cmd.exe") NwEngine.Context.Log.Write "Version of cmd.exe is " & NwEngine.Shell.GetFileVersion(cmdExe) Resolves the path to the 64bit cmd.exe . Writes the file version of file cmd.exe to the log. NwEngine.Shell.GetPath Returns the path of a file. Syntax NwEngine.Shell.GetPath(String file) Arguments file required. File to get the path of. Returns Returns the path to a file as String. Sample Code Dim cmdExe cmdExe = NwEngine.Variables.ResolveString("%WINSYSDIR64%cmd.exe") NwEngine.Context.Log.Write "Path to cmd.exe is " & NwEngine.Shell.GetPath(cmdExe) Resolves the path to the 64bit cmd.exe. Writes the path to file cmd.exe to the log. 72 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 73. NwEngine.Shell.GetRegValue Returns the value of a registry key. Syntax NwEngine.Shell.GetRegValue(String key) Arguments key required. Registry key to get the value of. Returns Returns the value of a registry key as String. Sample Code If NwEngine.Shell.RegKeyExist("HKLMSOFTWARESAPSAPGUIStartSaplogon") Then Dim RegVal RegVal = NwEngine.Shell.GetRegValue("HKLMSOFTWARESAPSAPGUIStartSaplogon") NwEngine.Context.Log.Write "Registry value of " & _ "HKLMSOFTWARESAPSAPGUIStartSaplogon is: " & RegVal End if If the key HKLMSOFTWARESAPSAPGUIStartSaplogon exists, its value is written to the log. NwEngine.Shell.GetShortPath Returns the short path in 8.3 notation of a path. Syntax NwEngine.Shell.GetShortPath(String path) Arguments path required. Path to get the short path of. Returns Returns the short path in 8.3 notation of a path as String. Sample Code Dim customerfiles customerfiles = NwEngine.Variables.ResolveString("%SapSrcDir%CustomerFiles") NwEngine.Context.Log.Write "Short path to CustomerFiles is " & NwEngine.Shell.GetShortPath(customerfiles) Resolves the path to the directory CustomerFiles on the installation server. Writes the path to it to the log. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 73
- 74. NwEngine.Shell.GetSystemUtcTime Returns the system UTC time. Syntax NwEngine.Shell.GetSystemUtcTime() Returns Returns the system UTC time as String. Sample Code NwEngine.Context.Log.Write "Current UTC time is " & NwEngine.Shell.GetSystemUtcTime() Writes the current system UTC time to the log. NwEngine.Shell.IsExeRunning Checks if a specific executable is running. Syntax NwEngine.Shell.IsExeRunning(String filename) Arguments filename required. File that is checked if it is running as executable. Returns Returns Bool: true if the file is running as executable. Sample Code If NwEngine.Shell.IsExeRunning("saplogon.exe") Then NwEngine.Context.Log.Write "SAPlogon is still running." End If Writes a line to the log if saplogon.exe is running. NwEngine.Shell.IsPathEqual Compares two pathes for equality. 74 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 75. Syntax NwEngine.Shell.IsPathEqual(String path1, String path2) Arguments path1 required. First path to compare. path2 required. Second path to compare. Returns Returns Bool: true if the two pathes point to the same location, otherwise returns Bool: false. Remarks This method is helpful to compare ● paths to the network ● paths that contain environment variables ● absolute and relative paths Sample Code Dim pathFromRegistry, pathOnDisk pathFromRegistry = NWEngine.Shell.GetRegValue("HKCUSOFTWAREMySoftwareMyKey MyPath") pathOnDisk = "%ProgramFiles%MySoftwareMyFile.ext" If NwEngine.Shell.IsPathEqual(pathFromRegistry, pathOnDisk) Then NwEngine.Context.Log.Write "Path in registry is same as " & NwEngine.Variables.ResolveString(pathOnDisk) End If Retrieves the value HKCUSOFTWAREMySoftwareMyKeyMyPath from the Windows registry and compares it to the path %ProgramFiles%MySoftwareMyFile.ext. If the two paths point to the same location, writes an entry to the log. NwEngine.Shell.RegKeyExist Checks if a registry key exists. Syntax NwEngine.Shell.RegKeyExist(String key) Arguments key required. Path to the registry key to check. Returns Returns Bool: true if the registry key exists, else it returns Bool: false. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 75
- 76. Sample Code If NwEngine.Shell.RegKeyExist("HKLMSOFTWARESAP") Then NwEngine.Context.Log.Write "Registry key HKLMSOFTWARESAP exists" End if Writes a line to the log if registry key HKLMSOFTWARESAP exists. NwEngine.Shell.RegValueExist Checks if a registry value exists. Syntax NwEngine.Shell.RegValueExist(String value) Arguments value required. Path to the registry value to check. Returns Returns Bool: true if the registry value exists, else it returns Bool: false. Sample Code If NwEngine.Shell.RegValueExist("HKLMSOFTWARESAPSAPGUIStartSaplogon") Then NwEngine.Context.Log.Write "Registry value HKLMSOFTWARESAPSAPGUI StartSaplogon exists" End if Writes a line to the log if registry value HKLMSOFTWARESAPSAPGUIStartSaplogon exists. NwEngine.Shell.SetRegValue Sets a registry value. Syntax NwEngine.Shell.SetRegValue(String valuePath, String valueType, String value) Arguments valuePath required. Path to the registry value to set. valueType required. Type of the registry value to set. Must be one of "REG_SZ", "REG_EXPAND_SZ", "REG_MULTI_SZ", "REG_BINARY", "REG_DWORD". value required. Value to set. 76 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 77. Returns Returns Bool: true if the registry value was set successfully, else it returns Bool: false. Sample Code NwEngine.Shell.SetRegValue("HKLMSOFTWARESAPSAPGUIStartSaplogon", "REG_DWORD", "1") Sets the registry value HKLMSOFTWARESAPSAPGUIStartSaplogon to type REG_DWORD and value 1. NwEngine.Shell.Sleep Makes SAPSetup sleep for a specified time. Syntax NwEngine.Shell.Sleep Number milliseconds Arguments milliseconds required. Number of milliseconds SAPSetup shall sleep. Remarks This is useful when the script does something that has side effects, like shutting down a Windows service, which needs a few seconds, and there's no possibility to wait for it. As this method does not return anything, its parameters must not be enclosed by paranthesis. Sample Code NwEngine.Shell.Sleep 5000 Makes SAPSetup sleep for 5 seconds. NwEngine.Shell.TerminateProcessInstances Terminates all running processes with a specific executable. Syntax NwEngine.Shell.TerminateProcessInstances String filename Arguments filename required. Name of the executable to terminate. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 77
- 78. Remarks This call will terminate all processes that run with the specified executable. Useful if there is definitely no other way to shut down a running process in a controlled way. Use with great care. As this method does not return anything, its parameters must not be enclosed by paranthesis. Sample Code If NwEngine.Shell.IsExeRunning("saplogon.exe") Then NwEngine.Context.Log.Write "SAPlogon is still running. Killing all instances of it." NwEngine.Shell.TerminateProcessInstances "saplogon.exe" End If Writes a line to the log if saplogon.exe is running. NwEngine.Shell.Use64BitHive Gets or sets a flag indicating whether SAPSetup operates on the 64bit branch of the Windows registry. Syntax NwEngine.Shell.Use64BitHive as Bool Remarks SAPSetup is a 32bit application. By default all operations on the Windows registry are done on the 32bit hive. Use this propertey to access the 64bit hive. When use64bit is set to true, following registry operations will be done on the 64bit branch of the registry. When use64bit is set to false, following registry operations will be done on the 32bit branch of the registry. Note Always reset to 32bit hive afterwards. Sample Code NwEngine.Shell.Use64BitHive = vbTrue 'Here be operations on the 64bit hive of the registry 'Always reset to 32bit hive! NwEngine.Shell.Use64BitHive = vbfalse Set the registry mode so that SAPSetup operates on the 64bit hive, and resets it again to the 32bit hive. 78 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 79. 8.2 NwEngine.Context NwEngine.Context provides access to properties to determine operating system, computer name, rights elevation status, command line arguments and more. Properties Property Name Description Args [page 79] Gets the command line arguments as a collection Elevated [page 80] Gets a flag indicating whether the installation is executed with ele vated rights LCID [page 80] Gets the system locale identifier of the current workstation ProductMode [page 81] Gets a flag indicating whether the installation is executed in product or package mode Reboot [page 81] Gets or sets a flag indicating whether the reboot flag should be set Silent [page 81] Gets or sets a flag indicating whether the installation mode was started in silent mode WinVista [page 82] Gets a flag indicating whether running on a Windows Vista or Win dows Server 2008 machine Windows7 [page 82] Gets a flag indicating whether running on a Windows 7 or Windows Server 2008 R2 machine Windows8 [page 82] Gets a flag indicating whether running on a Windows 8 or Windows Server 2012 machine Windows81 [page 83] Gets a flag indicating whether running on a Windows 8.1 or Win dows Server 2012 R2 machine Windows10 [page 83] Gets a flag indicating whether running on a Windows 10 or Windows Server machine WkstaName [page 83] Gets the NetBIOS name of the current workstation WTSClient [page 84] Gets a flag indicating whether running on a WTS Client WTSServer [page 84] Gets a flag indicating whether running on a WTS Server NwEngine.Context.Args Gets the collection of command line arguments. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 79
- 80. Syntax NwEngine.Context.Args as Collection Sample Code For Each arg in NwEngine.Context.Args NwEngine.Log.Write "Running with parameters " & arg Next Writes all command line parameters to the log file. NwEngine.Context.Elevated Gets a flag indicating whether this installer instance is executed with elevated rights. Syntax NwEngine.Context.Elevated as Bool Sample Code If NwEngine.Context.Elevated Then NwEngine.Log.Write "We are running with elevation." End If Writes an entry to the log, if running elevated. NwEngine.Context.LCID Gets the hosting workstation's system locale identifier. Syntax NwEngine.Context.LCID as String Sample Code NwEngine.Log.Write "System locale identifier is " & NwEngine.Context.LCID Writes the system locale identifier to the log. 80 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 81. NwEngine.Context.ProductMode Gets a flag indicating whether this installer instance is executed in product or package mode. Product mode means that no package event scripts will be executed. Syntax NwEngine.Context.ProductMode as Bool Sample Code If NwEngine.Context.ProductMode Then NwEngine.Log.Write "We are running in product mode, not package mode." End If Writes an entry to the log, if running in product mode. NwEngine.Context.Reboot Gets or sets a flag indicating whether the engine's reboot flag should be set. Syntax NwEngine.Context.Reboot as Bool Sample Code NwEngine.Context.Reboot = vbTrue NwEngine.Log.Write "Reboot will be required." The procedure will require a reboot after it has finished. Writes an according entry to the log. NwEngine.Context.Silent Gets or sets a value indicating whether this installation mode was started in silent mode. Syntax NwEngine.Context.Silent as Bool Sample Code If NwEngine.Context.Silent Then NwEngine.Log.Write "We are running in silent mode, showing no dialogs." End If Writes an entry to the log, if running in silent mode. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 81
- 82. NwEngine.Context.WinVista Gets a flag indicating whether running on a Windows Vista or Windows Server 2008 machine. Syntax NwEngine.Context.WinVista as Bool Sample Code If NwEngine.Context.WinVista Then NwEngine.Log.Write "We are running on Windows Vista or Windows Server 2008." End If Writes an entry to the log, if running on Windows Vista or Windows Server 2008. NwEngine.Context.Windows7 Gets a flag indicating whether running on a Windows 7 or Windows Server 2008 R2 machine. Syntax NwEngine.Context.Windows7 as Bool Sample Code If NwEngine.Context.Windows7 Then NwEngine.Log.Write "We are running on Windows 7 or Windows Server 2008 R2." End If Writes an entry to the log, if running on Windows 7 or Windows Server 2008 R2. NwEngine.Context.Windows8 Gets a flag indicating whether running on a Windows 8 or Windows Server 2012 machine. Syntax NwEngine.Context.Windows8 as Bool Sample Code If NwEngine.Context.Windows8 Then NwEngine.Log.Write "We are running on Windows 8 or Windows Server 2012." End If Writes an entry to the log, if running on Windows 8 or Windows Server 2012. 82 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 83. NwEngine.Context.Windows81 Gets a flag indicating whether running on a Windows 8.1 or Windows Server 2012 R2 machine. Syntax NwEngine.Context.Windows81 as Bool Sample Code If NwEngine.Context.Windows81 Then NwEngine.Log.Write "We are running on Windows 8.1 or Windows Server 2012 R2." End If Writes an entry to the log, if running on Windows 8.1 or Windows Server 2012 R2. NwEngine.Context.Windows10 Gets a flag indicating whether running on a Windows 10 or Windows Server machine. Syntax NwEngine.Context.Windows10 as Bool Sample Code If NwEngine.Context.Windows10 Then NwEngine.Log.Write "We are running on Windows 10 or Windows Server." End If Writes an entry to the log, if running on Windows 10 or Windows Server. NwEngine.Context.WkstaName Gets the NetBIOS name of the current workstation. Syntax NwEngine.Context.WkstaName as String Sample Code Dim workstationName workstationName = NwEngine.Context.WkstaName NwEngine.Log.Write "Name of this workstation: " & workstationName Writes Name of this workstation: <workstation Name> into the log file. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 83
- 84. NwEngine.Context.WTSClient Gets a flag indicating whether this installer instance is executed on a WTS Client. Syntax NwEngine.Context.WTSClient as Bool Sample Code If NwEngine.Context.WTSClient Then NwEngine.Log.Write "We are running on Windows Terminal Service Client." End If Writes an entry to the log, if running on Windows Terminal Service Client. NwEngine.Context.WTSServer Gets a flag indicating whether this installer instance is executed on a WTS Server. Syntax NwEngine.Context.WTSServer as Bool Sample Code If NwEngine.Context.WTSServer Then NwEngine.Log.Write "We are running on Windows Terminal Service Server." End If Writes an entry to the log, if running on Windows Terminal Service Server. 8.3 NwEngine.Context.Log NwEngine.Context.Log writes information texts, warnings, or errors to the log. Procedure Name Description Write String message [page 85] Writes a message into the current log file WriteError String errorMessage [page 85] Writes a message marked as error into the log file. Entry is marked as "E". SAPSetup return code will be not 0. Installation procedure will be handled as not successfully finished. 84 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 85. Procedure Name Description WriteWarning String warningMessage [page 86] Writes a message marked as warning into the log file. Entry is marked as "W". NwEngine.Context.Log.Write Writes a message to the log file. Entry is marked as "E". SAPSetup return code will be not 0. Installation procedure will be handled as not successfully finished. Syntax NwEngine.Context.Log.Write String message Arguments message required. The message to write to the log file. Remarks As this method does not return anything, its parameters must not be enclosed by paranthesis. Sample Code NwEngine.Context.Log.Write "Hello World!" Writes "Hello World!" to the log file. NwEngine.Context.Log.WriteError Write an error message to the log file. Entry is marked as "W". Syntax NwEngine.Context.Log.WriteError(String errorMessage) Arguments errorMessage required. The error message to write to the log file. Remarks As this method does not return anything, its parameters must not be enclosed by paranthesis. Writes a message into the current log file as an error. Installation procedure will be handled as not successfully finished, and SAPSetup will exit with a return code other than 0. This is useful to check prerequisites and make the installation process fail if the prerequisites are not fulfilled, so that it can be run again. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 85
- 86. Sample Code If somethingIsWrong Then NwEngine.Context.Log.WriteError "We will fail!" End If Writes "We will fail!" to the log file, marked as error with "E". NwEngine.Context.Log.WriteWarning Write a warning message to the log file. Syntax NwEngine.Context.Log.WriteWarning(String warningMessage) Arguments warningMessage required. The warning message to write to the log file. Remarks As this method does not return anything, its parameters must not be enclosed by paranthesis. Writes a message into the current log file as a warning. This does not change the return code of SAPSetup. This is useful if you want to note important things down during the installation, and later analyze the log file of SAPSetup. End users will never see this message. Sample Code If somethingIsStrange Then NwEngine.Context.Log.WriteWarning "We might fail!" End If Writes "We might fail!" to the log file, marked as warning with "W". 8.4 NwEngine.Variables NwEngine.Variables comprises methods to access variable values and resolve strings that contain variables. Remarks The variable <%SapSrcDir%> points to the root directory of the current installation source. Regardless if it is an installation server or a single-file installer of a package, below <%SapSrcDir%> you find the same directory 86 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 87. structure. The directory %SapSrcDir%CustomerFiles is always included in every package. It is useful if you want to distribute your custom files with packages. The package configuration in NwSapSetupAdmin shows additional variables that are available in the package. You can set the values of variables for packages there, and you can access these variables in package event scripts. SAPSetup provides a comprehensive list of additional variables containing information, among others, about the following: ● System directories ● Operating system ● Installed .NET runtimes ● Installed Java runtimes ● Installed Microsoft products ● Installed Adobe products For the full list of all variables start SAPSetup and cancel it on the first dialog. Check the log file [page 53], look for the line Log Variables Collection. Do this on a system where no SAPSetup products are installed, as installing products persists some variables on the computer. Methods for Variable Resolution Method Name Description GetValue(variableName) [page 87] Returns the value of the variable. ResolveString(StringToReso lve) [page 88] Resolves all variables contained in toResolve and returns the resolved string. NwEngine.Variables.GetValue Returns the value of a variable. Syntax NwEngine.Variables.GetValue(String variableName) Arguments variableName required. Name of the variable to get the value of. Returns The value of the variable. Sample Code dim windir windir = NwEngine.Variables.GetValue("WOW64MODE") NwEngine.Context.Log.Write "Value of variable WOW64MODE is " & windir & ". That means this Windows is 64bit." Gets the value of variable <WOW64MODE> and writes it to the log file. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 87
- 88. NwEngine.Variables.ResolveString Resolves all variables contained in toResolve and returns the resolved string. Syntax NwEngine.Variables.ResolveString(String stringToResolve) Arguments stringToResolve required. A text that may contain SAPSetup variables like <%variableName%>. Returns Returns the provided string with all SAPSetup variables replaced by their values. Sample Code dim toResolve, resolved toResolve = "%WINSYSDIR%driversetchosts" resolved = NwEngine.Variables.ResolveString(toResolve) NwEngine.Context.Log.Write "Resolved string is " & resolved Resolves the variable <WINSYSDIR> in the string and writes the resolved string to the log file. 8.5 NwSapSetupATLCommon.TextFileParser NwSapSetupATLCommon.TextFileParser offers a method for reading and writing text files and searching and modifing text in text files. Properties Property Name Description FileName( ) [page 89] Returns the name of the parsed text file Parse(string filename) [page 89] Reads a text file from disk. Returns true if file exists and can be read or false if the file does not exist ReplaceLine( string LineToReplace, string Replacement) [page 90] Replaces all occurrences of the lines that match LineToReplace with the replacement string ReplaceLineEx(string StringToReplace,string Replacement) [page 89] Replaces all lines that contain the given string by the given re placement DoesLineExist(string Line) [page 91] Returns true if one or more lines in the file completely match the given value, else false 88 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 89. Property Name Description DoesStringExist(string bstrStringToSearch) [page 92] Returns true if one or more lines in the file contain the given value, else false Save(string FileToSaveAs) [page 92] Saves the file with the given file name. Returns true if the file was saved successfully, else false AppendLine(string NewLine) [page 93] Appends the given string at the end of the text file NumLines() [page 93] Returns the number of lines in the file Line(ULong LineIndex) [page 94] Returns the line with the given line index RemoveLine(string LineToRemove) [page 95] Removes all lines from the text file that match the given line NwSapSetupATLCommon.TextFileParser.FileName Syntax <objTextFileParser>.FileName() Returns Returns the name of the opened file. Remarks If no file was parsed FileName returns NULL. Sample Code Dim objTextFileParse; set objTextFileParser = CreateObject("NwSapSetupATLCommon.TextFileParser") objTextFileParse.Parse("C:WindowsSystem32driversetcservices") dim filename filename = objTextFileParse.FileName() Returns the file name of a text file parser. NwSapSetupATLCommon.TextFileParser.Parse Reads a text file from disk Syntax <objTextFileParser>.Parse(String filename) SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 89
- 90. Arguments filename required. Path to the text file to read. Returns Returns Bool: true true if file could be successfully red, Bool: false if not. Sample Code Dim objTextFileParse set objTextFileParser = CreateObject("NwSapSetupATLCommon.TextFileParser") if (objTextFileParse.Parse("C:WindowsSystem32driversetcservices")) msgbox("Services file successfully parsed.") end if Parse a file from disk NwSapSetupATLCommon.TextFileParser.ReplaceLine Replace all occurrences of the lines that match LineToReplace with the replacement string. Syntax <objTextFileParser>.ReplaceLine(String oldLine, String newLine) Arguments oldLine required. Line that match this text will be replaced. newLine required. New content of the matching lines. Remarks The whole line is compared to the parameter oldLine. Use ReplaceLineEx if you want to match parts of the lines. If more than one line matches the given value all lines are replaced. Sample Code Dim objTextFileParse set objTextFileParser = CreateObject("NwSapSetupATLCommon.TextFileParser") if (objTextFileParse.Parse("C:WindowsSystem32driversetcservices")) if (objTextFileParse.ReplaceLine("sappcd 3500/tcp","sappcd 3500/udp #this line is changed")) msgbox("Services file successfully modified.") end if end if Replace line by its content 90 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 91. NwSapSetupATLCommon.TextFileParser.ReplaceLineEx Replace all occurrences of the lines where a part of the content matches the search criteria with the replacement string. Syntax <objTextFileParser>.ReplaceLineEx(String searchString, String newLine) Arguments searchString required. Search criteria that contain this text will be replaced. newLine required. New content of the replaced lines. Remarks All lines that contain the search criteria will be replaced by the given value. Sample Code Dim objTextFileParse set objTextFileParser = CreateObject("NwSapSetupATLCommon.TextFileParser") if (objTextFileParse.Parse("C:WindowsSystem32driversetcservices")) if (objTextFileParse.ReplaceLineEx("3500/tcp","sappcd 3500/upd #this line is changed")) msgbox("Services file successfully modified.") end if end if Replace line by part of its content NwSapSetupATLCommon.TextFileParser.DoesLineExist Checks the existence of a line. Syntax <objTextFileParser>.DoesLineExist(String searchCriteria) Arguments searchCriteria required. Content of line to be verified. Returns Returns Bool: True if line could be found, else Bool:false. Sample Code Dim objTextFileParse set objTextFileParser = CreateObject("NwSapSetupATLCommon.TextFileParser") if (objTextFileParse.Parse("C:WindowsSystem32driversetcservices")) if (objTextFileParse.DoesLineExist("login 513/ tcp #Remote Login")) SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 91
- 92. msgbox("Line for Remote login service found") end if end if Check existence of a line by comparing complete content of line. NwSapSetupATLCommon.TextFileParser.DoesStringExist Checks whether the given string exists in the file. Syntax <objTextFileParser>.DoesStringExist(String searchCriteria) Arguments searchCriteria required. String to be searched for. Returns Returns Bool: True if string could be found, else Bool:false. Sample Code Dim objTextFileParse set objTextFileParser = CreateObject("NwSapSetupATLCommon.TextFileParser") if (objTextFileParse.Parse("C:WindowsSystem32driversetcservices")) if (objTextFileParse.DoesStringExist("513/tpc")) msgbox("Line for Remote login service found") end if end if Check existence of a line by a search string. NwSapSetupATLCommon.TextFileParser.Save Saves the data of the TextFileParser object to a file. Syntax <objTextFileParser>.Save(String filename) Arguments filename required: Name of the file where the TextFileParser stores its data. Returns Returns Bool: true if successfully save, else Bool:false. 92 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 93. Remarks If the file to be saved already exists the existing file will be deleted before the new content is saved. All data in the existing file is deleted. Sample Code if (objTextFileParse.Save("C:WindowsSystem32driversetcservices")) msgbox("Services file successfully save.") end if Save buffer of TextFileParser object to disk NwSapSetupATLCommon.TextFileParser.AppendLine Appends a line to the text buffer of the TextFileParser object. Syntax <objTextFileParser>.AppendLine(String line) Arguments line required: Text to be appended to the buffer. Remarks AppendLine appends the text to the internal buffer of the TextFileParser. If you want to append an existing file you have to parse it in the first step. Sample Code Dim objTextFileParse set objTextFileParser = CreateObject("NwSapSetupATLCommon.TextFileParser") if (objTextFileParse.Parse("C:WindowsSystem32driversetcservices")) objTextFileParse.AppendLine("sapmsXYZ 75988/tcp") end if Append a line at the end of the file. NwSapSetupATLCommon.TextFileParser.NumLines Returns the number of lines in the text buffer of the TextFileParser object. Syntax <objTextFileParser>.NumLines() SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 93
- 94. Returns Returns Long: number of lines in the buffer. Remarks If a file was parsed NumLines returns the number of lines red from the file. If no file was parsed NumLines return 0 Sample Code Dim objTextFileParse set objTextFileParser = CreateObject("NwSapSetupATLCommon.TextFileParser") if (objTextFileParse.Parse("C:WindowsSystem32driversetcservices")) msgbox("Services file has " + objTextFileParse.NumLines() + " lines") end if Check number of lines in buffer and save to disk. NwSapSetupATLCommon.TextFileParser.Line Returns the line indicated by the given index. Syntax <objTextFileParser>.Line(Long index) Returns Return String: content of the line indicated by the given index. Arguments index required: Number of the line in the buffer. Remarks The first line of the buffer is indeicat by 1. The function fails if a line outside the buffer is accessed. Use NumLines in the first step to get the number of lines in the buffer. Sample Code Dim objTextFileParse Dim line; set objTextFileParser = CreateObject("NwSapSetupATLCommon.TextFileParser") if (bjTextFileParse.Parse("C:WindowsSystem32driversetcservices") and (objTextFileParse.NumLines() > 0)) line = objTextFileParse.Line(1) end if Parse a file and return first line if it exists 94 P U B L I C SAPSetup Guide Visual Basic Script Application Program Interfaces
- 95. NwSapSetupATLCommon.TextFileParser.RemoveLine Removes a line from the text buffer of the TextFileParser object. Syntax <objTextFileParser>.RemoveLine(String line) Arguments line required: Text to be removed from the buffer. Remarks RemoveLine removes text from the internal buffer of the TextFileParser. Sample Code Dim objTextFileParse set objTextFileParser = CreateObject("NwSapSetupATLCommon.TextFileParser") if (objTextFileParse.Parse("C:WindowsSystem32driversetcservices") and objTextFileParse.NumLines() > 0) if objTextFileParser.DoesLineExist("sapmsXYZ 75988/tcp") objTextFileParse.RemoveLine("sapmsXYZ 75988/tcp") end if end if Remove first line from the buffer. SAPSetup Guide Visual Basic Script Application Program Interfaces P U B L I C 95
- 96. Important Disclaimers and Legal Information Coding Samples Any software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP intentionally or by SAP's gross negligence. Gender-Neutral Language As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible. Internet Hyperlinks The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for transparency (see: https:/ /help.sap.com/viewer/disclaimer). 96 P U B L I C SAPSetup Guide Important Disclaimers and Legal Information
- 97. SAPSetup Guide Important Disclaimers and Legal Information P U B L I C 97
- 98. go.sap.com/registration/ contact.html © 2018 SAP SE or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company. The information contained herein may be changed without prior notice. Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies. Please see https:/ /www.sap.com/corporate/en/legal/copyright.html for additional trademark information and notices.