Installing an SAP System Using SAPinst

Objective

After completing this lesson, you will be able to start the installation tool SAPinst

Starting SAPinst

Steps to Start SAPinst

To start SAPinst for Windows on a single host, proceed as follows:

  1. Log on to your host as a user who is a member of the local administration group.
  2. Start SAPinst from the root directory of the uncompressed archive from SWPM.
Start SAPinst on Windows, Using Options

Caution

Do not use the user <sid>adm for installation procedures.

SAPinst creates the installation directory sapinst_instdir where it keeps the log files and that is located directly in the Program Files directory. If SAPinst is not able to create sapinst_instdir in the Program Files directory, SAPinst tries to create sapinst_instdir in the directory defined by the environment variable TEMP. SAPinst creates a subdirectory for each installation service.

Note

We recommend that you keep all the installation directories until the system is completely and correctly installed.

The SAPinst Self-Extractor extracts the executables to a temporary directory (TEMP, TMP, TMPDIR, or SystemRoot). These executables are deleted after SAPinst has stopped running. Directories, which are called as sapinst_exe.xxxxxx.xxxx, sometimes remain in the temporary directory. You can safely delete the temporary directories.

The temporary directory also contains the SAPinst Self-Extractor log file dev_selfex.out, which may be useful if an error occurs. To terminate SAPinst and the SAPinst Self-Extractor, press CTRL + C.

Hint

If SAPinst cannot find a temporary directory, the installation terminates with the error FCO-00058.

To terminate SAPinst and the SAPinst Self-Extractor, right-click the icon for the SAPinst  output view located in the Windows tray and choose Exit. Alternatively, you can choose the icon for the SAPinst output view located in the Windows tray and then choose FileExit.

To start SAPinst on Unix, proceed as follows:

  1. Log on to your host as user root.
  2. Start SAPinst from the root directory of the uncompressed archive for SWPM.

Caution

Make sure that the root user has not set any environment variables for a different SAP system or database.

SAPinst creates the installation directory sapinst_instdir directly below the temporary directory. SAPinst finds the temporary directory by checking the value of the environment variables TEMP, TMP, or TMPDIR. If no value is set for these variables, SAPinst uses /tmp as default installation directory. Make sure that the temporary directory has the permissions 777.

Caution

Make sure that your operating system does not delete the contents of the temporary directory /tmp. It must also not delete the contents of the directories to which the variables TEMP, TMP, or TMPDIR point, for example, by using a crontab (third party tool) entry.

Communication Ports Used During SAP System Installation

SAPinst includes an SAPinst GUI and the GUI server, both of which use a Java Runtime Environment (JRE).

In a standard installation, SAPinst, SAPinst GUI, and the GUI server run on the same host. If required, you can instead perform a remote installation with SAPinst, where SAPinst GUI runs on a separate host from SAPinst and the GUI server.

When you start SAPinst, SAPinst GUI and the GUI server also start. SAPinst GUI connects to the GUI server using a Secure Socket Layer (SSL) connection and the GUI server connects to SAPinst.

During installation, the default ports 21200, 21212, and 4239 are used for communication between SAPinst, GUI server, SAPinst GUI, and HTTP server.

Default Communication Ports

  • SAPinst communicates with the GUI server through port 21200.
  • The GUI server communicates with SAPinst GUI through port 21212.
  • The HTTP server port is 4239, which is a part of the GUI server.

You receive an error notification if one of these ports is already in use by another service. In this case, start SAPinst with the command line parameters.

SAPinst Command Line Parameters

  • SAPINST_DIALOG_PORT=<free_port_number_sapinst_gui_to_gui_server>
  • GUISERVER_DIALOG_PORT=<free_port_number_gui_server_to_sapinst_gui>
  • GUISERVER_HTTP_PORT=<free_port_number_http_server>

For a list of all available SAPinst properties, start SAPinst with the parameter -p, as follows:

  • For Windows: sapinst.exe -p
  • For Linux and UNIX: sapinst -p

Troubleshooting with SAPinst

SAPinst Troubleshooting

If an error occurs, SAPinst stops the installation and displays a dialog box informing you about the error. In this case, you can view the log file by choosing the View Log button. If you can manually solve the error, leave the SAPinst in open state. Fix the error, and then choose the Retry button to continue the installation.

Hint

There are some known error situations where you can choose the Retry button and SAPinst continues without any error.

All the installation information is logged in several log files.

Special SAPinst options

sapinst -p
Using this option, you receive a list of more common SAPinst command line options.
SAPINST_USE_HOSTNAME

Using this parameter, you can use virtual host names for the installation of your SAP system. The use of virtual host names requires additional OS-dependent work.

SAPINST_STACK_XML

This parameter shows SAPinst provides the location of a Stack-XML file that should be used during the installation. The installation options will be different from an installation without that file.

SAPINST_CWD

On Windows, this parameter allows to define a directory that SAPinst will use for logging its activities. Such a directory can only be used for one single installation run. Create an individual log directory for each installation run.

Up-To-Date Installation
Use the Maintenance Planner to plan the installation and update procedure for your SAP system to be installed. With the help of this Stack-XML file you can start SAPinst, which will then offer some additional options during the installation, like setting up a minimum TMS configuration, importing a SPAM/SAINT update and importing additional languages. Also, you can prepare the subsequent start of Software Update Manager (SUM) to update the newly installed SAP system to the SP level determined within Maintenance Planner. Find more information here https://blogs.sap.com/2016/10/21/up-to-date-installation-2/.

Note

In this training we won’t execute an up-to-date installation. In general, there might be several obstacles using this option, like: The system to be installed should belong to a transport group that already exists (then the automatic setup of TMS will fail), the update procedure requires (e.g.) the database software to be patched BEFORE the update will be started or it requires the application of some SAP Notes BEFORE the update starts and similar. In this training, we will start the update separately.

Primary SAPinst Log Files

  • sapinst.log

    Information on the installation progress

  • sapinst_dev.log

    Records in detail all of the notifications of every installation step

You can find the log files sapinst.log and sapinst_dev.log in the current installation directory.

Additional log files may be written during the installation process. The additional logs are referenced in sapinst.log and sapinst_dev.log.

Location of SAPinst GUI and the GUI Server Log Files

  • Windows: %userprofile%\.stdgui
  • UNIX: <user_home>/.stdgui

If SAPinst GUI does not start, check the sdtstart.err file in the current %userprofile% (Windows) or <user_home> (Linux) directory.

SAPinst is controlled by the XML files described in the following table.

SAPinst XML Files

File NameDescription
dialog.xmlContains all the dialogs (services) used in the installation
keydb.xmlContains the installation progress and user input information that is recorded by SAPinst
messages.xmlContains all the notifications used in the installation
control.xmlContains the component definition used by SAPinst
packages.xmlUsed for software package administration

SAPinst GUI Handling

Within the SAPinst GUI, several functions are available on various SAPinst GUI dialogs. These dialogs are input views, installation progress view, and notification boxes.

SAP GUI Dialog Functions

FunctionDescription
F1

Displays detailed information about each input parameter.

Back

Displays the previous dialog box for editing.

Next

Displays the next dialog box for editing.

Cancel

During the installation, the cancel function provides the following options:

  • Stop

    Stops the installation without further changing the installation files. You can restart SAPinst to continue the installation later.

  • Continue

    Continues the installation.

Log Off

Stops SAPinst GUI, but SAPinst and the GUI server continue running. You can later reconnect to the same SAPinst installation from the same or another host by starting SAPinst GUI separately.

View Log

Displays the content of the SAPinst.log file during the installation.

Retry

Allows you to perform an installation step again (if an error has occurred).

Stop

Stops the installation without further changing the installation files. You can continue the installation later from this stopping point.

Continue

Allows you to continue with the option you previously selected.

Special options for SAPinst

Installation using a Stack XML file

The following explains how to proceed with SAPinst, using a Stack XML file for installation, also called Up-to-date installation (UDI).

How to

To use SAPinst with a Stack XML file, you can call SAPinst like this:sapinst SAPINST_STACK_XML=<path to Stack XML file>. This option can be combined with other options, like, e.g. SAPINST_USE_HOSTNAME.

Advantages

Using a Stack XML file allows for further operations during the installation, like, e.g. automated basic setup of TMS, import of additional languages, ...

Changes

SAPinst might not offer a prerequisites check (depending on SAPinst version), the SID of the SAP system is already pre-filled, additional options become available during the installation.

More information

See SAP Note 2277574 - Central Note for Up-To-Date Installation using Maintenance Planner, Software Provisioning Manager and succeeding update tools

Executing an unattended installation using inifile.params

The following explains how to execute an unattended installation with SAPinst.

How to

From a previous installation run, that you would like to replicate, take the file named inifile.params from the working directory of SAPinst.

Follow the information found in SAP Note 2230669 - System Provisioning Using a Parameter Input File.

Advantages

You can re-run installation procedures in "Observer mode" or "Non-Observer mode". Most typing activity can be saved.

Changes

SAPinst might run repeated, identical installations with far less interaction.

More information

See SAP Note 2609804 - SWPM Unattended Installation: password handling.

Log in to track your progress & complete quizzes