Upload
srinivas-rentala
View
226
Download
0
Embed Size (px)
Citation preview
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 1/31
Update Guide CUSTOMER
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Document Version: 1.0 - 2013-07-15
Near-Zero Downtime Maintenance 1.0 for SAPNetWeaver PortalFor SAP NetWeaver Portal Systems on UNIX and Linux
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 2/31
Table of Contents
1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1 About This Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 Document History. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2 Preparation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.1 Supported Releases and SPS Level Ranges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.2 Administrator Rights and Creating Users for nZDM for Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Creating a Dedicated nZDM for Portal User for SAP NetWeaver 7.0 EHP2 SPS14. . . . . . . . . . . .7
2.3 Target System and Database Parameter Recommendations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.4 Planning Aspects for the Portal in EP Core (EPC). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.5 Planning Aspects for Knowledge Management and Collaboration (KMC). . . . . . . . . . . . . . . . . . . . . . . . 8
2.6 Planning Aspects for the User Management Engine (UME) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3 Performing the nZDM for Portal Procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
3.1 Downloading and Deploying nZDM for Portal Infrastructure Applications. . . . . . . . . . . . . . . . . . . . . . . 10
3.2 Downloading and Running the nZDM for Portal GUI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
3.3 Switching On the Accessibility Mode of the nZDM for Portal GUI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.4 Connecting to the Source System and Starting the Recording. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.5 Removing Freeze Triggers from Third-Party Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.6 Creating the Target System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.7 Configuring the Connectivity of the Target System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3.8 Performing Maintenance or Test Activities in the Target System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Applying Support Package Stacks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Applying Single Component Updates and Patches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Test Activities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.9 Connecting to the Target System and Starting the Replication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 6
3.10 Finishing the nZDM for Portal Procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.11 Switching the Target System to Become the New Production System. . . . . . . . . . . . . . . . . . . . . . . . . .18
4 Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204.1 Additional Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.1.1 Downloading and Using Software Update Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.1.2 Downloading and Using SAPCAR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.2 The nZDM for Portal Reference Scenario. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.2.1 SAP NetWeaver Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.2.2 SAP Web Dispatcher. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.2.3 System Copy Functionality of Software Provisioning Manager 1.0. . . . . . . . . . . . . . . . . . . . . 22
4.2.4 The nZDM for Portal Procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.2.5 Switching From the Source System to the Target System. . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.2.6 Switching the Application Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
2C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Table of Contents
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 3/31
4.2.7 Reconfiguring the SAP Web Dispatcher. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.3 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.3.1 Reconnecting the nZDM for Portal GUI to the Source or Target System. . . . . . . . . . . . . . . . . 24
4.3.2 Restarting the Source System Host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
4.3.3 Checking the nZDM for Portal Status and Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.3.4 Resetting the nZDM for Portal Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.3.5 Reactivating the Source System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.3.6 Correcting Replication Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.4 PDF Typographic Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.5 DITA Typographic Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Table of Contents
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 3
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 4/31
1 Introduction
This chapter contains introductory information about the near-Zero Downtime Maintenance for SAP NetWeaverPortal tool.
1.1 About This Document
This document describes how to apply Support Package Stacks (SPS), single component updates and patches,
and testing activities using near-Zero Downtime Maintenance for SAP NetWeaver Portal (nZDM for Portal) to
systems running SAP NetWeaver Portal with almost no downtime.
You can apply Support Packages Stacks on Portal systems based on the following SAP NetWeaver releases:
● SAP NetWeaver 7.0 including enhancement package 2
● SAP NetWeaver 7.3
● SAP NetWeaver 7.3 including enhancement package 1
● SAP NetWeaver 7.4
To use the nZDM for Portal tool, you must copy your productive SAP NetWeaver Portal system (also referred to
as 'source system') and apply the Support Package Stacks in the copied system (also referred to as 'target
system') while the source system is still running on the original version. While you update the target system with
Support Packages, the applications in the source system either run in read-only mode and users are notified that
they cannot make data changes to these applications while the system is in update mode, or in recording mode -
meaning that nZDM for Portal records all data changes to the applications.
The following applications run in read-only mode:
● Knowledge Management and Collaboration (KMC)
The following applications run in recording mode:
● User Management Engine (UME)
● Core Portal segment of usage type EPC (EP Core)
After the update process is completed, the data changes are transferred from the source system and replicated
to the updated target system. After the replication has finished, the source system is stopped and the target
system serves as the new production system. The downtime occurs when the system switch takes place between
the source and the target system.
The following graphic illustrates the workflow:
4C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Introduction
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 5/31
For additional information about the procedure, required software and troubleshooting, see SAP Note 1813484.
To find the latest version of this document, see SAP Service Marketplace at http://service.sap.com/sltoolset.
1.2 Document History
Caution
Before you start implementation, make sure you have the latest version of this document. You can find the
latest version at the following location: http://service.sap.com/sltoolset
The following table provides an overview of the most important document changes.
Version Date Description
1.0 2013-07-15 Initial version
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Introduction
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 5
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 6/31
2 Preparation
This section describes the activities you need to perform to prepare for the near-Zero Downtime Maintenance forPortal procedure.
2.1 Supported Releases and SPS Level Ranges
The nZDM for Portal supports the following SAP NetWeaver releases with minimum Support Package Stack (SPS)
level:
● SAP NetWeaver 7.0 including enhancement package 2 (7.0 EHP2) SPS11
● SAP NetWeaver 7.3 SPS07
● SAP NetWeaver 7.3 including enhancement package 1 (7.3 EHP 1) SPS02
● SAP NetWeaver 7.4 SPS02
Note
Some nZDM for Portal steps, operations, or extensions are mandatory for a specific range of SPS levels. For
example, creating a dedicated technical user is required for SAP NetWeaver 7.0 EHP2 SPS11 to SPS14.
2.2 Administrator Rights and Creating Users for nZDM forPortal
Context
The user executing the nZDM for Portal procedure must have specific technical rights in the system to operate
nZDM for Portal. These technical rights are automatically assigned to the existing Administrator user during the
initial deployment of nZDM for Portal for the supported SAP NetWeaver releases with SPS level higher than the
listed below. Alternatively, you can create a dedicated technical user to operate nZDM for Portal.
Note
The following procedure is mandatory for the following nZDM-supported releases and the according SP level
ranges:
● SAP NetWeaver 7.0 including enhancement package 2 with SPS11 to SPS13
● SAP NetWeaver 7.3 SPS07 to SPS09
● SAP NetWeaver 7.3 including enhancement package 1 SPS02 to SPS07
● SAP NetWeaver 7.4 SPS02
Proceed as follows:
6C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Preparation
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 7/31
Procedure
1 In the source system, go to the User Management Engine application.2 Create a new user. Choose a user name, for example NZDMTU (nZDM technical user).
3 Fill in all required fields and set the security policy to Technical User.
4 Assign the role SAP_NZDM_ADMINISTRATOR to the user and save your entry.
5 Assign the action Destination_Service_Write_Permission to the role SAP_NZDM_ADMINISTRATOR.
This step is not necessary for SAP NetWeaver 7.0 including enhancement package 2
For more information about creating a technical user, see http://help.sap.com SAP NetWeaver
SAPNetweaver 7.<version> Function-Oriented View SAP NetWeaver by ... Security Identity
Management User Management of Application Server Java Administration of Users and Roles Creating a
Technical User .
Creating a Dedicated nZDM for Portal User for SAP NetWeaver7.0 EHP2 SPS14
Procedure
1 In the source system, go to the User Management application.
2 Create a new user group named NZDMAdministrators.
3 Assign the role SAP_NZDM_ADMINISTRATOR to the new user group.
4 Create a new user. Choose a user name, for example NZDMTU (nZDM technical user).
5 Fill in all required fields and set the security policy to Technical User.
6 Assign the new user to the group. This grants the new user rights to operate the nZDM for Portal procedure.
7 In the source system, go to the Visual Administrator. Navigate to the Security Provider service configuration.
8 Add the NZDMAdministrators group to the administrator server role.
2.3 Target System and Database ParameterRecommendations
Although not mandatory, the following recommendations will minimize the execution effort. Changing the
parameters during the procedure might significantly increase the time required to perform it.
During the copying of the source system, consider changing the following parameters:
● You can set the SID and hostname of the new system (the target system) to match the ones of the original
productive system. This ensures that external connections and Single Sign-On will work without additional
adjustments after the nZDM for Portal procedure has finished.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Preparation
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 7
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 8/31
● You can set the database SID to match the database SID of the original productive system. This ensures that
the database scripts and br_tools will run correctly after the nZDM for Portal procedure has finished.
● You can set the IP address of the new system to match the IP of the original productive system. This ensures
that load balancing is functional after the nZDM for Portal procedure has finished.
2.4 Planning Aspects for the Portal in EP Core (EPC)
SAP NetWeaver Portal (specifically, the components of usage type EP Core) implements both change recording
and read-only modes during the nZDM for Portal procedure. The mode used depends on the specific Portal
application. Where recording mode is in effect, changes are recorded from the source system and replicated to
the target system; where read-only mode is in effect, the application rejects changes and notifies users that
changes cannot be made in read-only mode.
Note the following exceptions and effects:
● Caches - All caches are cleared and no data cached on the source system is replicated to the target system.
● Activity Data Collector (ADC) - If the ADC is activated, the data collected after the creation of the target
system is lost.
● Admin Tools - Changes made while recording is active are not transferred to the target system and must be
performed again manually in the target system.
● Job Scheduler - Jobs cannot be maintained while recording is active. Planned jobs will be executed both on
the source and target systems.
● Federated Portal Network (FPN) - If the system that is updated is part of a Federated Portal Network
implementation, you must be aware that trust relationships and configurations between consumer andproducer portals need to be manually reestablished after switching to the target system.
2.5 Planning Aspects for Knowledge Management andCollaboration (KMC)
Knowledge Management and Collaboration (KMC) operates in read-only mode during the nZDM for Portal
procedure. This means that all user actions that require data changes, such as configuration changes, CMrepository modifications, collaboration room content modifications, are disabled.
You must consider the following aspects when the read-only mode is initiated:
● Long-running tasks, such as re-indexing, are suspended and resumed after the replication to the target
system is completed.
● Short-running tasks, such as index deletion, which are active when the read-only mode is initiated, are
executed only after the completion of other short running tasks when KMC system switches to read-only
mode. Therefore, it might take a few minutes before KMC enters read-only mode.
● Content exchange - The Information and Content Exchange (ICE) service completes the transfer of the
currently distributed resource, and then terminates all active content transfers without completing the
transfer of the whole package. While the application is in read-only mode, no new transfers are executed.
After the application exits the read-only mode, the content exchange continues as scheduled.
8C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Preparation
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 9/31
● Transport of KMC content - The system completes the exports or imports of KMC content that have already
been started before switching read-only mode. While the application is in read-only mode, no new transports
can be started.
2.6 Planning Aspects for the User Management Engine (UME)
The User Management Engine (UME) supports change recording during the nZDM for Portal procedure. This
means that changes to UME principals, such as users, roles and groups, stored in the regular UME database are
recorded on the source system and are replicated to the target system.
Note that the following exceptions apply:
● Changes to the UME configuration are disabled while the Portal system is running in recording mode. Since
changes to the UME configuration can lead to errors when they are recorded and replicated to the target
system, administrators cannot perform such changes immediately after the change recording is started on
the source system. Administrators trying to change the UME configuration receive an error message
informing them that the system is being updated and that no changes can be made.
● If UME principals are stored in an LDAP directory or in an ABAP system, changes to these are not recorded. In
such cases, you must use the same LDAP directory or ABAP system for the source system and for the target
system. This ensures that changes to the LDAP directory or to the ABAP system are available in the target
system as soon as the target system has been set up, even if the source system is still in recording mode.
Do not perform any UME activities in the target system while the source system is in recording mode. This
can lead to inconsistencies after the replication to the target system if there are complex relationships
between the UME database and the data stored in the LDAP directory or the ABAP system.
● Personalization information of the Portal Content Directory (PCD) can be appended to UME users. Deleting
users that contain PCD personalization information is disabled while the system is in recording mode.
● SAP NetWeaver releases lower than 7.3 SPS07 do not support change recording of J2EE roles. All changes
and assignments done to J2EE roles in the source system while the system is in recording mode are not
transferred. You must use the UME GUI of the target system to manually implement the required changes
after the target system has started production operation.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Preparation
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 9
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 10/31
3 Performing the nZDM for Portal Procedure
This chapter provides information about performing the nZDM for Portal procedure. The complete procedureincludes all required actions before, during, and after using the nZDM for Portal tool.
Caution
Make sure you do not run nZDM for Portal during daylight saving time shifts. Otherwise, the procedure might
result in errors.
3.1 Downloading and Deploying nZDM for PortalInfrastructure Applications
The nZDM for Portal infrastructure applications are part of the following SAP NetWeaver releases and SPS levels:
● SAP NetWeaver 7.0 including enhancement package 2 with SPS014 and higher
● SAP NetWeaver 7.3 with SPS09 and higher
● SAP NetWeaver 7.3 including enhancement package 1 SPS07 and higher
● SAP NetWeaver 7.4 with SPS level SPS02 and higher
For the nZDM for Portal supported releases lower than the ones listed above, you must download the nZDM for
Portal software archive (including the infrastructure applications) relevant for your release and SPS level from
SAP Note 1831724. Afterwards, deploy the archive using the Software Update Manager (SUM) SP07 and higher.
Related Links
Downloading and Using Software Update Manager [page 20]
3.2 Downloading and Running the nZDM for Portal GUI
Prerequisites
You have SAPCAR on the host where the GUI is started.
Context
By using the nZDM for Portal GUI, you can configure the source and target systems and monitor the progress of
the nZDM recording and replication. After connecting to the systems, you can start or stop the recording on the
source system, or the replication to the target system. Also, you can monitor the current recording and replication
status, as well as the number of recorded and replicated entries. The nZDM for Portal GUI is extracted to a
destination directory named NZDM_EP. After the archive is extracted, this destination directory contains java and
10C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Performing the nZDM for Portal Procedure
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 11/31
jvm folders, executable startup files, and the Microsoft Visual C++ runtime environment (vcredist_x64.msi
package required only for Windows-based systems).
The GUI uses the Java 6 virtual machine contained in the jvm folder of the nZDM for Portal GUI destination
directory. It can be extracted and started on any Windows- or Linux-based computer that can connect to the
source and target systems, for example a client PC.
Procedure
1 Download the nZDM for Portal GUI. To do this, go to http://service.sap.com/sltoolset Software Logistics
Toolset 1.0 table with the Software Logistics tools near-Zero Downtime Maintenance for SAP NetWeaver
Portal <version> .2 Open a command prompt.
3 Extract the nZDM for Portal GUI archive by using the following command:SAPCAR –xvf <download
directory>/<path>/<Archive>.SAR -R <destination_directory> .
4 Start the nZDM for Portal GUI by executing the STARTUP file located in the nZDM destination directory.
5 (Optional) For every further start of the nZDM for Portal GUI, execute the STARTUP file located in the
destination directory.
Related Links
Downloading and Using SAPCAR [page 20]
3.3 Switching On the Accessibility Mode of the nZDM forPortal GUI
Prerequisites
● The nZDM for Portal GUI is extracted.
Context
You can run nZDM for Portal in accessibility mode. This allows the GUI to adopt various display properties, for
example custom font (DPI) settings, or high-contrast color schemes. In accessibility mode you can also use
keyboard access, that is, executing commands by using shortcut keys.
Note
The operating system display properties must be adjusted prior to using the nZDM for Portal GUI.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Performing the nZDM for Portal Procedure
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 11
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 12/31
Procedure
1 Open a command prompt.2 Navigate to the directory in which you have extracted the nZDM for Portal GUI.
3 Start the nZDM for Portal GUI by entering the following command: .
startup.bat "guimode=accessible"
3.4 Connecting to the Source System and Starting theRecording
Prerequisites
The nZDM for Portal GUI must be started. For more information, see section “Downloading and Running the
nZDM for Portal GUI".
Context
Before you start recording for the first time, you must connect to the source system. Proceed as follows:
Procedure
1 Choose Source System Connect .
2 In the Connect dialog, enter the connection values tand the logon credentials that you have configured in the
source system:
a) Host - the host name or IP address of the source systemb) Port Number – the HTTP port of the source system, for example 5<instance_number>00, or HTTPs
port of the source system, for example 5<instance_number>01.
c) User and Password - the credentials of the user for the nZDM for Portal procedure. This can be the
Administrator user or the nZDM for Portal technical user.
d) Enable HTTPs - Leave this checkbox enabled if you are entering an HTTPs port, or disable it if you are
entering an HTTP port. Note that to use the capability of HTTPs communication it is necessary that
HTTPs is enabled in your SAP NetWeaver system.
3 Choose Apply to confirm your entries.
4 Choose Start Recording on the Source System part of the nZDM for Portal GUI.
5 In the Enter source system host dialog, enter the IP address or hostname of the source system database host
that is reachable from the target system.
12C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Performing the nZDM for Portal Procedure
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 13/31
Results
All data changes to important business data managed by applications running in recording mode that occur in thesource system will be recorded. To avoid any deployment in the source system after the recording has started,
the system is locked for deployments.
Related Links
Downloading and Running the nZDM for Portal GUI [page 10]
3.5 Removing Freeze Triggers from Third-Party Software
Note
This section is relevant only if you have third-party software in the system.
If you are running third-party software in the SAP NetWeaver Portal system that use own database tables to store
data, be aware that freeze triggers are created in these tables, preventing write access to them. To restore write
access to these tables, you must manually remove all triggers with the prefix TRG_NZD* from the relevant tables.
The triggers can be removed by means of a standard database client connected to your SAP system. They can be
removed from the relevant tables individually or fully via an update statement.
Note
Applications using the Portal Content Directory (PCD) persistence layer are not affected, because PCD will
implicitly implement change recording for the data.
3.6 Creating the Target System
Prerequisites
The recording in the source system must be started before creating the target system.
Context
To apply Support Package Stacks without stopping productive use of your SAP NetWeaver Portal system, you
must create an exact copy or clone of your source system and database. For performing the system copy or
cloning, you can use any procedure and tool of your preference.
Note
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Performing the nZDM for Portal Procedure
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 13
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 14/31
If you want to use the system copy functionality of the software provisioning manager 1.0 provided by SAP,
explicitly use the homogeneous database-specific option.
For more information about system copy, see:
● General information on the system copy procedure in the SAP Developer Network at: https://
www.sdn.sap.com/irj/sdn/systemcopy
● The software provisioning manager 1.0 documentation: http://service.sap.com/instguidesnw
When using the system copy functionality of the software provisioning manager 1.0, consider the following
recommendations and additional steps:
● Perform a database-specific homogeneous system copy, since only this system copy method allows you to
copy your system without additional downtime.
● When specifying the parameters of the target system, make sure that all parameters such as SID, instance
numbers, ports, and passwords exactly match the equivalent parameters of the source system.
● After restoring the database backup of the target system database, and before continuing with the system
copy, manually remove all database triggers with the prefix TRG_NZD* from the relevant tables. The triggers
can be removed by means of a standard database client connected to your SAP system. They can be
removed from the relevant tables individually or fully by using an update statement.
Caution
It is important that you verify all target system licenses. In case the target system was created using the
system copy functionality of the software provisioning manager 1.0, you must apply again all relevant licenses,
including a maintenance license. In case you have created the system copy using other means, is possible that
the hardware key becomes invalid and you need to re-apply all relevant licenses, including a maintenance
license. For more information about when hardware key changes occur, see SAP Note 174911.
Related Links
Removing Freeze Triggers from Third-Party Software [page 13]
System Copy Functionality of Software Provisioning Manager 1.0 [page 22]
3.7 Configuring the Connectivity of the Target System
Configuring the target system connectivity is crucial for the successful execution of the nZDM for Portal
procedure.
The target system must be isolated from the productive network to avoid interference with the source system.
This can be done by means of an appropriately configured firewall, or in case of using virtualization technology, by
means of adequate network interface configurations (for example, subnetting). At the end of the procedure, the
source system is stopped and the connectivity to the target system (the new productive system) must be re-
established. This is done by removing the isolation before switching to the target system.
Specific connections must be available while the nZDM procedure is running and both systems are online:
● From the target system to its own the database by using Java Database Connectivity (JDBC)
● From the target system to the source system database by using JDBC
● From the target system to the source system by using HTTP or HTTPs
14C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Performing the nZDM for Portal Procedure
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 15/31
● From the target system to an external UME persistence storage, usually done by using Lightweight Directory
Access Protocol (LDAP), if such connection exists
● From the nZDM for Portal GUI to the target system by using HTTP or HTTPs
● OS remote access to the target system host from administrator computers
An overview picture of all communication channels can be found at http://help.sap.com/saphelp_nw70ehp1/
helpdata/en/46/875b4243fadc54e10000000a155106/content.htm.
3.8 Performing Maintenance or Test Activities in the TargetSystem
You can perform the following activities to the target system using nZDM for Portal:
● Applying Support Package Stacks
● Single component updates, including kernel and JVM patches
● Database or OS maintenance activities, such as applying updates
● Test activities
Applying Support Package Stacks
Apply Support Package Stacks by using the Software Update Manager (SUM) SP08 and higher. The procedure is
described in detail in chapters "Preparation", "Running the Software Update Manager", and "Follow-Up Activities"
of the SUM guide.
For more information about applying Support Package Stacks on systems with EP Core and Enterprise
Portal usage types, see the Update and Upgrade Guide relevant for your SAP NetWeaver release at http://
service.sap.com/instguides SAP NetWeaver SAP NetWeaver <release> Maintenance .
Related Links
Downloading and Using Software Update Manager [page 20]
Applying Single Component Updates and Patches
Apply single component updates and patches using the Software Update Manager (SUM). Proceed as described
in chapter "Applying Single Component Updates and Patches Using a Manually Prepared Directory" of the
"Update of SAP Systems Using Software Update Manager <version> <SP level>". To download the SUM guide, go
to http://service.sap.com/sltoolset.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Performing the nZDM for Portal Procedure
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 15
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 16/31
Test Activities
At a point of the nZDM for Portal procedure before it has been finished, you may want to perform testing in thetarget system to verify that the SP stack or other maintenance activity you performed previously has been applied
correctly and all major production scenarios are still operational. You can perform these activities in the target
system without affecting currently active production operation in the source system. You need to take the
following considerations into account:
● Make sure that the replication is stopped while test activities are being performed. If you have already started
the replication, choose Pause Replication to temporarily suspend it before you start testing. After you have
finished testing, choose Continue Replication to resume the replication.
● Data created during testing could interfere with the replication. To avoid such issues, we recommend that you
create a complete backup of the target system database before you start testing. Restore the backup after
you finish testing, and before you start or continue the replication.
3.9 Connecting to the Target System and Starting theReplication
Prerequisites
You have started the nZDM for Portal GUI. For more information, see section "Downloading and Running the
nZDM for Portal GUI ".
Context
Once the target system is set up, you must enter the connection data for the target system in the nZDM for Portal
GUI. The target system also requires a connection to the source system remote database and HTTP access point.
Proceed as follows:
Procedure
1 Configure the target system. Choose Target System Connect .
2 Enter the connection data and the logon credentials of the target system.
○ Host name - host name or IP address of the target system
○ Port Number - HTTP port of the target system, for example5<instance_number>00), or HTTPs port of
the target system, for example (5<instance_number>01)
○ User and Password - the credentials of the authorized user for the nZDM for Portal procedure. This is
either the Administrator user or the nZDM technical user.
16C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Performing the nZDM for Portal Procedure
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 17/31
○ Enable HTTPs - Leave this checkbox enabled if you are entering an HTTPs port, or disable it if you are
entering an HTTP port. Be aware that to use the capability of HTTPs communication, it is necessary that
HTTPs is enabled in you SAP NetWeaver system.
3 Choose Apply to confirm your entries.
4 Choose Start Replication in the Target System part of the nZDM for Portal GUI.
Results
All recorded data changes in the source system are replicated to the target system. Any deployments on the
target system are locked until the Finished status is reached.
Note
To lock deployment in SAP NetWeaver 7.02 systems, you can disable the SDM server.
● You can pause or resume the replication at any time by choosing Pause Replication and Resume Replication in
the Target System part of the nZDM for Portal GUI.
● To abort the procedure after the process has been started, first you must choose Pause Replication and then
abort the recording. After the procedure has been aborted, you must reset the source system. The target
system cannot be used any further. In such cases you must start the procedure from scratch.
3.10 Finishing the nZDM for Portal Procedure
Context
The downtime begins after the nZDM for Portal entry replication is completed and the source system has been
stopped. During the source system stop, users still logged in the system are disconnected.
Note
● Initiate the nZDM process finalization at a time when almost all or all changes have been replicated.
● We recommend that all users are logged off from the source system. Notify all active users to log off in
order to avoid data loss.
Caution
Do not stop the source system database, as the target system requires access to this database.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Performing the nZDM for Portal Procedure
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 17
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 18/31
Procedure
1 To complete the procedure, choose Finish nZDM for Portal. The Finish nZDM for Portal dialog box appears.
2 Confirm that you wish to finalize the procedure.
3 Ensure that the source system is stopped, so that no active users can generate new change entries.
Note
○ For SAP NetWeaver 7.0 including enhancement package 2 systems only - you must manually stop
the source system before you continue with the procedure finalization.
○ For SAP NetWeaver 7.3 systems only - In some cases, stopping the source system automatically may
not be possible or it may fail. In such cases, you must manually stop the source system before you
continue with the nZDM for Portal procedure.
4 Verify that the database of the source system is online.
5 On the subsequent Finish nZDM for Portal dialog box, confirm that you have completed the preparation
activities for the shutdown of the source system. At this point in time, nZDM for Portal is set to status “phase
out”, that is, the procedure is ready to be finished.
For SAP NetWeaver 7.3 systems only - Before confirming, verify that the source system has been stopped,
and that the database of the source system is still running.
6 To replicate the recorded changes and finish the nZDM for Portal procedure, choose Confirm.
Results
After the replication is completed, you are notified that nZDM for Portal is ready to clean up the target system.
The cleanup removes service data that is required during the execution of the nZDM for portal procedure. To start
the cleanup, choose OK. After the cleanup has finished, the target system is ready for use.
After the nZDM for Portal GUI reverts to its initial state, you can close the tool.
3.11 Switching the Target System to Become the New
Production System
Context
To perform the switch between the source system and the target system, you must first ensure that all data has
been replicated. Then you can proceed with switching the target system into the new production system by
means of your system landscape. Consider the following before starting the switch:
● To reduce the downtime to a minimum, carefully plan the system switch beforehand. Depending on the
technical setup of your system landscape (for example, you are using multiple application servers for one
system or load balancing), this might include a gradual switch of application servers to the new production
system.
18C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Performing the nZDM for Portal Procedure
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 19/31
● Do not stop the database of the source system before the target system shows the status Finished.
● Make the target system accessible for the entire system landscape.
Procedure
1 Monitor the replication progress in the target system using the nZDM for Portal GUI. When the entry
replication has finished, you can start switching the systems.
2 Prepare the target system for its use as the new production system.
3 Notify users that they can log on to the new production system.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Performing the nZDM for Portal Procedure
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 19
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 20/31
4 Appendix
This chapter contains additional information about the nZDM for Portal process.
4.1 Additional Tools
4.1.1 Downloading and Using Software Update Manager
The Software Update Manager (SUM) is a multi-purpose tool that supports various processes, such as performing
a release upgrade, installing enhancement packages, applying Support Package Stacks or updating single
components.
Note
Use SUM SP08 and higher to deploy the nZDM for Portal components.
You can download the latest version of the Software Update Manager from SAP Service Marketplace at: http://
service.sap.com/sltoolset Software Logistics Toolset 1.0 <table with the Software Logistics tools> Software
Update Manager <version> <download link> .
You can find the latest version of the "Update Guide - Update of SAP Systems Using Software Update Manager
<version>" on SAP Service Marketplace at http://service.sap.com/sltoolset.
4.1.2 Downloading and Using SAPCAR
Context
SAPCAR is used to extract SAR archives. It is installed with each SAP NetWeaver AS in the kernel directory and its
patches are delivered with the SAP KERNEL package (SAPEXE.SAR). If you are running the nZDM for Portal GUI
from a remote host that does not have SAP NetWeaver, you can download the unpacked version of the SAPCAR
tool at http://service.sap.com/swdc Support Packages and Patches A-Z index S SAPCAR .
To use SAPCAR, proceed as follows:
20C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Appendix
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 21/31
Procedure
1 Navigate to the directory in which you have downloaded or copied the archives.
2 Use the following command to start SAPCAR and extract the archive to the current directory:
○ <path to SAPCAR>/sapcar –xvf <file name>.SAR
○ Instead of using the current directory as a target directory, you can use the option –R to specify a
particular target directory. For example:sapcar –xvf <SAR file> -R <target directory>.
○ Folders in the archive will be created as subdirectories of the target directory by keeping the directory
structure of the archive.
4.2 The nZDM for Portal Reference Scenario
The reference scenario is only used as an example to facilitate the usage of near-Zero Downtime Maintenance for
SAP NetWeaver Portal. It solely relies on SAP components, while still exhibiting the characteristics of a real
customer landscape. In this chapter, the scenario and various special steps of the nZDM for Portal procedure are
described.
Note
It is not mandatory that you use the tools from the reference scenario in your SAP landscape. You may use
other tools for copying or cloning a system, load balancing or landscape virtualization.
In this particular case of an SAP NetWeaver Portal system SPS update, the key tools are the SAP Web Dispatcher
and the system copy procedure of the software provisioning manager 1.0 tool.
4.2.1 SAP NetWeaver Portal
The typical setup of a Portal system is described elsewhere in more detail. This section briefly summarizes the
option of a 'Distributed Installation'.
The Portal system consists of a database, a SAP Central Services (SCS) instance and several Java instances.
According to naming conventions, in SAP NetWeaver 7.0 including enhancement package 2 the primary Java
instance is called a central instance (CI), while the other instances are called dialog instances (DI). For SAP
NetWeaver 7.1 and higher, the central instance is called 'primary application server instance' (primary instance -
PI), and the dialog instances are called 'additional application server instances'.
A typical customer installation distributes these instances over various hosts:
● a database host
● a central instance host in SAP NetWeaver 7.0 EHP2 or primary application server host in SAP NetWeaver 7.10
and higher, respectively
● various additional application server hosts.
The CI or PI hosts contain the SAP Central Service and CI or PI instances. Dialog instance hosts typically contain a
single dialog instance. It is also possible to install some of these instances on one common host.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Appendix
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 21
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 22/31
4.2.2 SAP Web Dispatcher
The SAP Web Dispatcher serves as a central entry point and load balancer for HTTP or HTTPs requests to SAPapplication servers. In the reference scenario, it is configured to run against the message server of the SCS
instance of the portal.
For more information about the SAP Web Dispatcher, see http://help.sap.com SAP NetWeaver SAP
NetWeaver <release> System Administration and Maintenance Information Technical Operations for SAP
NetWeaver Technical Operations for SAP Web Dispatcher .
4.2.3 System Copy Functionality of Software ProvisioningManager 1.0
In the reference scenario, the target system is created using the system copy functionality of software
provisioning manager 1.0. The tool is operating system and database-specific.
Consider the following recommendations and additional steps:
● Perform a database-specific homogeneous system copy, since only this system copy method allows you to
copy your system without additional downtime.
● When specifying the parameters of the target system make sure that all parameters, such as SID, instance
numbers, ports, and passwords, exactly match the same parameters of the source system.
● After restoring the database backup of the target system database and before continuing with the system
copy, manually remove all database triggers with the prefix TRG_NZD* from the relevant tables. The triggers
can be removed by means of a standard database client connected to your SAP system. They can be
removed from the relevant tables individually or fully via an update statement.
● To have a completely identical target system, copy the kernel and JVM files from the source system to the
target system after the system copy has finished.
You must create a homogeneous system copy of your source system, that is, you must create a database-specific
system copy.
To download the user guide for software provisioning manager 1.0, go to http://service.sap.com/instguidesnw.
See http://scn.sap.com/docs/DOC-8324 for general information about system copy.
4.2.4 The nZDM for Portal Procedure
The nZDM for Portal procedure is carried out as described in chapter "Running nZDM for Portal" of this document,
except for the system switch, which is described in the following sections.
Related Links
Performing the nZDM for Portal Procedure [page 10]
22C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Appendix
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 23/31
4.2.5 Switching From the Source System to the TargetSystem
The switch from the original production system to the copied system consists of the following steps:
1 Initial switch of application servers - one or several application server instances are taken offline, that is,
disconnected from production operation, in order to free resources for the copied system with application
servers
2 Switch of central entry point to application servers - the system enters the downtime, and the central entry
point (in the reference scenario, the SAP Web Dispatcher) is switched to the new system.
3 Final switch of the application servers - at this moment the switch of the remaining application servers to the
new system takes place.
4.2.6 Switching the Application Servers
Switching the application servers can be done by uninstalling the application server and installing a new one
running against the new system on the dialog instance/additional application server instance host. This switch is
straightforward to implement, but might lead to unnecessary overhead, particularly in landscapes with a large
number of application servers.
4.2.7 Reconfiguring the SAP Web Dispatcher
Context
In the reference scenario the central entry point to the Portal is the SAP Web Dispatcher. It connects to the Portal
system via its message server. For switching to the new system it is sufficient to shutdown the dispatcher and
adapt the profile entries.
Procedure
1 Adapt the profile entries as described in the example below and according to the connection data of the
copied system:
#-----------------------------------------------------------------------# Accessibility of Message Server#--------------------------------------------------------------------------------rdisp/mshost = <message server host>ms/http_port = <message server port>
Note that sessions held by connected users are shut down during this process.
2 Start SAP Web Dispatcher.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Appendix
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 23
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 24/31
4.3 Troubleshooting
This part of the document contains additional information about correcting known problems that have occurred
during the nZDM for Portal procedure.
4.3.1 Reconnecting the nZDM for Portal GUI to the Source orTarget System
In case the nZDM for Portal GUI loses connection to the source or target systems, you must restart the GUI.
Use the Connect function for the corresponding system to reestablish the connection. If the GUI loses connection
during the finalization of the procedure, that is, after you have triggered the shutdown of the source system, you
must enter the same connection data for the source system as afterwards for the target system.
4.3.2 Restarting the Source System Host
Context
Use the following procedure if you have stopped the source system host and the system is unable to start. To
restore all connections and continue, proceed as follows:
Procedure
1 Connect remotely to the source system host.
2 (Optional) Start the source system database if it has been stopped.
3 Open the Java offline configuration editor (offlinecfgeditor), located in the configtool directory of the
Java instance.
4 Edit the RecorderDB.url property located at:
a) For SAP NetWeaver 7.3 - cluster_config/globals/clusternode_config/workernode/services/
tc~lm~nzdm~crrsrv/properties .
a) For SAP NetWeaver 7.0 EHP2 - cluster_data/server/cfg/services/tc~lm~nzdm~crrsrv .
In the property, replace the hostname or IP address f the source system database host you have specified
earlier with the hostname or IP address of the source system database host as reachable from the source
system.
5 Start the source system.
6 Connect to the source system and start the recording as described in section ”Connecting to the Source
System and Starting the Recording”.
Related Links
24C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Appendix
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 25/31
Connecting to the Source System and Starting the Recording [page 12]
4.3.3 Checking the nZDM for Portal Status and Errors
To analyze error messages and to check the recorded entries, you can access the databases of your source and
target systems. The following tables contain important information:
● BC_NZDM_STATE - This table contains information about the current status of the recording in the source
system and the replication in the target system. Also, it may contain information about status change errors.
● BC_NZDM_CHANGE_LOG - This table contains the recorded changes in the source system. Through the data
contained in it you can monitor how entries are recorded and in which order, and also the transaction
sequence of entries.
● BC_NZDM_ERROR_LOG - This table contains replication errors. Check this table in the target system if the
replication has stopped because of errors.
4.3.4 Resetting the nZDM for Portal Procedure
Context
If you need to reset the nZDM for Portal procedure, proceed as follows:
Procedure
1 Connect the nZDM for Portal GUI to your source system.
2 (Optional) If the recording is started, abort the recording by choosing Abort.
3 Reset the nZDM for portal procedure by choosing Reset nZDM.
4 Reset the nZDM for Portal GUI and start with the procedure from the beginning.
4.3.5 Reactivating the Source System
Note
Be advised that the nZDM for Portal procedure guarantees production operation without data loss only in the
new production system (target system). The following procedure should be applied only in case you want to
investigate problems that existed in the source system.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Appendix
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 25
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 26/31
If you need to reactivate the source system after it has reached status “phase-out” or the nZDM for Portal
procedure has finished, connect to the database with the user SAP<SID>ADM and execute the following SQL
statement:
UPDATE BC_NZDM_STATESET NZDM_VALUE = 'x'WHERE NZDM_KEY = 'Overall_Rec_State'
Now you should be able to start the system. If you need to restart the procedure, follow the procedure described
in section "Resetting the nZDM for Portal Procedure".
Related Links
Resetting the nZDM for Portal Procedure [page 25]
4.3.6 Correcting Replication Issues
When starting the replication, if you receive an error with a message stating that no data is maintained for the
remote database connection, see SAP Note 1825684.
4.4 PDF Typographic Conventions
Type Style Description
Example Words or characters quoted from the screen. These include field names, screen titles,
pushbuttons labels, menu names, menu paths, and menu options. Textual cross-references
to other documents.
Example Emphasized words or expressions.
EXAMPLE Technical names of system objects. These include report names, program names,
transaction codes, table names, and key concepts of a programming language when they are
surrounded by body text, for example, SELECT and INCLUDE.
Example Output on the screen. This includes file and directory names and their paths, messages,
names of variables and parameters, source text, and names of installation, upgrade and
database tools.
Example Exact user entry. These are words or characters that you enter in the system exactly as they
appear in the documentation.
<Example> Variable user entry. Angle brackets indicate that you replace these words and characters with
appropriate entries to make entries in the system.
Example Keys on the keyboard, for example, F2 or ENTER .
26C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Appendix
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 27/31
4.5 DITA Typographic Conventions
Short reference description.
Product names and product terminology
Text type DIT tag to use Comments Output
Product names <pname> Replaces <tm> BusinessObjects™ product
Product terminology /glossary entries
<term> The quotation marks aregenerated
universe
Software user interface and keyboard actions
Text type DIT tag to use Comments Output
Menu commands <uicontrol> In bold only when in a <step> File
Dialog controls (buttons,options, text box labels)
<uicontrol>
Icons <uicontrol>
Nested menu commands <menucascade> The ">" character is
generated. In bold only when
in a <step>
File New...
Dialog titles <wintitle> The quotation marks are
generated
Dialog Name
Window titles <wintitle>
Keyboard action (single) <key> Example: <key>Enter<key> Enter
Keyboard action
(combination)
<keys><key>1st key</
key><key>2nd key</
key><keys>
Example:
<keys><key>CTRL</
key><key>C</key><keys>
CTRL + C
Menu Navigation <menucascade> <menucascade><uicontrol>F
ile</
uicontrol><uicontrol>Save</
uicontrol><menucascade>
File Save
Area label <uilabel> Same as <wintitle>. Used for
an area.
Show
Area, button, etc with no label <uinolabel> Used when a UI element such
as a button or an area has no
labels.
The intensity toolbar.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Appendix
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 27
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 28/31
Text type DIT tag to use Comments Output
Dimension, universe,
container structure
<structure> Specialized <varname> <dimensionName>
Element in a structure <field> Specialized <varname> <field>
Other words that require
emphasis
<keyword output> Use when the software
expects or requires a certain
word, but that word is not
explicitly a part of the
software UI.
To be specialized
Code
Text type DIT tag to use Comments Output
Class, procedure, function,
and method names that are
followed by parenthises.
<apiname> Software reserved words
Bold in title, codblock and
codeph
Figure 1: DITAway
DITAway()
DITAway()
DITAway()
Parameter names <parmname> Software reserved words
Bold in title, codblock and
codeph
Figure 2: width
DITAway(True)
DITAway(True)
DITAway(True)
Command name <cmdname> Software reserved words Figure 3: DO
SAVE
Variable <varname> Italicized.
translated
Structure and field are
specialized varname
Figure 4: <User name>
DITAway( <product> )
DITAway( <product> )
DITAway( <product> )
Named value <varname> Italicized.
translated
Structure and field are
specialized varname
DITAway(" <product
name> ")
DITAway(" <productname> ")
DITAway(" <product
name> ")
28C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Appendix
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 29/31
Text type DIT tag to use Comments Output
Value <ph> translated DITAway("Titan")
DITAway("Titan")
DITAway("Titan")
Comments <ph>translated 'Before you begin
'Before you begin
Optional parameter <ph> importance="optional"
used in <codeblock> and
<codeph>
generates brackets
DITAway("Titan",
<reviewer name> )
DITAway("Titan", <reviewer name> )
DITAway("Titan", <rev
iewer name> )
Optional quoted parameter <ph> importance="optional"
used in <codeblock> and
<codeph>
generates brackets, used as a
container
DITAway("Titan",
" <reviewer
name> ","Dwight")
DITAway("Titan"," <reviewername> ","Dwight")
DITAway("Titan"," <re
viewername> ","Dwight")
Required parameter <ph>
<varname>
importance="required"
used in <codeblock> and
<codeph>
bold
DITAway("Titan",
<reviewer name> )
DITAway("Titan", <reviewer name> )
DITAway("Titan", <rev
iewer name> )
Software message <msgph>
<msgblock>
Figure 5: Turn off yourcomputer when you
are done.
Turn off your
computer when you
are done.
Turn off your computer when
you are done.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Appendix
C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved. 29
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 30/31
Comments
Text type DIT tag to use Comments Output
Draft-comments <draft-comment>
Localisation instructions <loc-comment>
XML comments XMetaL F8 User for personal comments
that will not be reviewed or
published. Will be deleted at
branching.
<!-- This is marketing bs -->
Other text categories
Text type DIT tag to use Comments Output
File names and folder paths <filepath> $INSTALLDIR
\deployment
Code examples <codeph> or <codeblock> Use <codeph> for code
fragments within body text,
use <codeblock> for stand-
alone code blocks.
Code phrase example
Code blockexample
Book titles <cite> The content is italicized. Style Guide
Quotation <q> Quotation marks aregenerated.
“I need my quotes”
Long quotation <lq> Quotation marks are
generated and the content is
presented as a block.
I need my quotes
Syntax
object . property = trueorfalse
Prop name Prop value
30C U S T O M E R© 2013 SAP AG or an SAP affiliate company. All rights reserved.
Near-Zero Downtime Maintenance 1.0 for SAP NetWeaver Portal
Appendix
7/22/2019 Nzdm Portal Unix En
http://slidepdf.com/reader/full/nzdm-portal-unix-en 31/31
www.sap.com/contactsap
© 2013 SAP AG 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 AG.
The information contained herein may be changed without prior
notice.
Some software products marketed by SAP AG and its distributors
contain proprietary software components of other software
vendors. National product specifications may vary.
These materials are provided by SAP AG and its affiliated
companies ("SAP Group") for informational purposes only, without
representation or warranty of any kind, and SAP Group shall not be
liable for errors or omissions with respect to the materials. The only
warranties for SAP Group 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 asconstituting an additional warranty.
SAP and other SAP products and services mentioned herein as well