Technical Operation Guide ( PDF)
Total Page:16
File Type:pdf, Size:1020Kb
Technical Operations Guide CUSTOMER SAP API Management, On-Premise Edition 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. CUSTOMER © 2014 SAP SE or an SAP affiliate company. SAP API Management, On-Premise Edition 2 All rights reserved. Typographic Conventions Document History Version Date Change 1.0 <2014-08-01> Document Creation 1.1 <2016-04-28> Document aligned with SP04 release 1.2 <2016-06-21> Document aligned with SP05 release 1.3 <2016-10-14> Document aligned with SP06 release 1.4 <2017-05-03> Document aligned with SP07 release 1.5 <2017-11-21> Document aligned with SP08 release CUSTOMER SAP API Management, On-Premise Edition © 2014 SAP SE or an SAP affiliate company. Document History All rights reserved. 3 Table of Contents Data Protection and Privacy ............................................................................................................. 10 1 Overview .................................................................................................................................. 11 2 Architectural Overview .......................................................................................................... 12 2.1 Component Description ....................................................................................................................... 12 2.1.1 Critical API Processing Components ................................................................................. 12 2.1.2 Non-Critical API Processing Components ......................................................................... 13 3 About Planets, Regions, Pods, Organizations, Environments and Virtual Hosts............... 14 3.1 About Planets........................................................................................................................................ 15 3.2 About Regions ....................................................................................................................................... 15 3.3 About Pods ............................................................................................................................................ 17 3.4 About Organizations.............................................................................................................................19 3.5 About Environments............................................................................................................................ 20 3.6 About Virtual Hosts .............................................................................................................................. 21 3.7 Creating your first organization, environment, and virtual host ..................................................... 22 4 Installation File System .........................................................................................................23 4.1 Installation Directory ........................................................................................................................... 23 4.2 File System Structure.......................................................................................................................... 23 4.3 Important Data to Remember from the Installation Process .......................................................... 24 5 How to Configure SAP API Management Edge ....................................................................25 5.1 How to use .properties files ................................................................................................................ 25 5.2 Location of .properties files ................................................................................................................ 26 5.3 Determining the current value of a token .......................................................................................... 26 5.4 Setting tokens in .properties files....................................................................................................... 27 5.5 Setting a token that takes multiple values ........................................................................................ 27 5.6 Locating a token .................................................................................................................................. 28 5.7 Setting a token that is currently commented out ............................................................................. 28 6 Using the apigee-adminapi.sh utility ................................................................................... 30 6.1 Installing apigee-adminapi.sh ............................................................................................................. 30 6.2 apigee-adminapi.sh syntax ................................................................................................................. 30 6.3 Setting parameters using command-line switches and environment variables ............................ 31 6.4 Passing a file to the apigee-adminapi.sh utility ................................................................................. 32 6.5 Displaying debug and API information .............................................................................................. 33 7 Post Installation Tasks ..........................................................................................................35 7.1 Reset Passwords ................................................................................................................................. 35 7.1.1 Resetting SAP API Management Edge Password ............................................................ 35 7.1.2 Resetting SAP API Management BaaS Passwords .......................................................... 43 7.1.3 Managing the Default LDAP Password Policy for API Management .............................. 44 CUSTOMER © 2014 SAP SE or an SAP affiliate company. SAP API Management, On-Premise Edition 4 All rights reserved. Table of Contents 7.2 Configure Email and SMTP servers.................................................................................................... 48 7.2.1 Customizing SAP API Management Email Templates ..................................................... 48 7.2.2 Configuring the SAP API Management Edge SMTP server .............................................49 7.2.3 Configuring SMTP for the SAP API Management BaaS SMTP Server ...........................50 7.2.4 Set the expiration time for user activation links in activation emails .............................50 7.3 Configure Logging................................................................................................................................ 51 7.3.1 Setting the log level for a SAP API Management Edge component ................................ 51 7.3.2 Setting log file location ........................................................................................................ 52 7.4 Configure the SAP API Management Edge UI ................................................................................... 52 7.4.1 Setting the Session Timeout in the SAP API Management Edge UI ............................... 52 7.4.2 Setting the port number of the SAP API Management Edge UI ...................................... 53 7.4.3 Enabling the consent banner .............................................................................................. 53 7.4.4 Setting the URL of the Developer Services portal ............................................................ 54 7.4.5 Allowing the SAP API Management UI Access to Local IP addresses ............................ 55 7.4.6 Allow custom reports longer than 14 days in the SAP API Management Edge UI ......... 57 7.4.7 Setting the password hint text in the SAP API Management Edge UI ............................ 57 7.4.8 Configure rules used to auto generate SAP API Management Edge UI passwords ...... 58 7.4.9 Configure the SAP API Management Edge UI to store session information in memory ............................................................................................................................................... 59 7.5 Configure Router and Message Processor ....................................................................................... 60 7.5.1 Enabling/Disabling Server (Message Processor/Router) Reachability ....................... 60 7.5.2 Setting HTTP request/response header limits ................................................................ 61 7.5.3 Configuring the Router to retry connections to a Message Processor .......................... 62 7.5.4 Configure