SAP Fiori: My Inbox - Troubleshooting + FAQ

If you are facing issues setting up or using My Inbox, this document can help you.

Frequently, issues faced in My Inbox are due to missing or incorrect configurations or improper set-up of SAP Gateway and backend systems. In case of any issues, it is advised to check the browser console and the SAP Gateway error logs. Mostly, the error mentioned could help solve the issue.

How to view error details in browser console

1. In the browser, press F12 key to open browser developer tool
2. Click on tab ‘Console’ to view the error details
3. If error in browser console is not helpful and a URL is mentioned as part of the error
   
   1. Click on the URL, which opens the tab ‘Network’
   2. Click on the highlighted URL marked in red, which displays preview of the error in the newly displayed right pane
   3. Expand the displayed error nodes to view the error message

How to access SAP Gateway error logs

1. Login to SAP Gateway system
2. Go to transaction /IWFND/ERROR_LOG
3. Double-click relevant entry based on timestamp and user to view details in the bottom panel

1. SAP Fiori Launchpad does not display any content

Detection Activity: On launching SAP Fiori Launchpad, following symptoms occur.

• • No content is displayed or
  • Popup with error ‘Failure - Unable to load groups’ is displayed

Solution: Assign role with Launchpad start authorizations to end user in the frontend system as mentioned here. Further details on creating and assigning roles are mentioned here.

2. No catalogs found in SAP Fiori Launchpad

Detection Activity: On editing Home Page within SAP Fiori Launchpad and clicking on ‘+’ button to add a Fiori app, no catalog or apps are displayed. Message ‘No catalogs found’ is displayed in the page.

Solution: Assign My Inbox specific roles 'SAP_FND_BCR_MANAGER_T' and 'SAP_FND_TCR_T' to the user in the frontend system. In case these roles are not available, configure roles for tile catalogs as mentioned here with catalogs 'SAP_FND_BC_MANAGER_T' and 'SAP_FND_TC_T'.

3. No tasks are displayed in My Inbox

There could be several reasons to this, which are explained in the below mentioned sub-topics.

3.1. Software component IW_PGW is not installed

Detection Activity:

• • Error ‘No service found for namespace /IWPGW/, name TASKPROCESSING, version 0002’ is seen in SAP Gateway error log
  • Software component ‘IW_PGW’ is not displayed within list displayed by accessing menu item ‘System’ -> ‘Status’ -> ‘Product Version Details’ (button below ‘Product Version’ field) for SAP_BASIS 750 and lower versions

Solution: Install IW_PGW 100 in relevant SAP Gateway system based on compatibility matrix mentioned within SAP note 1942072

3.2. Task Gateway service (/IWPGW/TASKPROCESSING) is not active

Detection Activity: Error ‘No service found for namespace /IWPGW/, name TASKPROCESSING, version 0002’ is raised in SAP Gateway error log

Solution: Activate Task Gateway service based on steps mentioned at Task Gateway Service Configuration - SAP Gateway - SAP Library

3.3. No authorization to access Task Gateway Service

Detection Activity:

• • My Inbox app is displayed with text ‘Error’ instead of the task count
  • Error “No authorization to access Service 'ZTASKPROCESSING_0002’” is raised in SAP Gateway error log

Solution: Assign user with role based on role template '/IWPGW/RT_WF_USR'. Ensure that authorization object 'S_SERVICE' is maintained with object type ‘IWSG’ and name ‘ZTASKPROCESSING_0002’. Further details on creating role based on template and assigning roles are mentioned here.

3.4. Incorrect system alias is used or incorrect software version is maintained within system alias

Detection Activity:

• • Error ‘Data Provider implementation 'ZTM_TGW_SVC_MODEL_0002_BE' '01' 'DEFAULT' does not exist’ is seen in SAP Gateway error log
  • No inheritance hierarchy defined for model 'ZTM_TGW_SVC_MODEL_0002_BE'

Solution: Create new system alias or update existing system alias as mentioned in Creating a System Alias - SAP Gateway - SAP Library. Ensure that relevant software version is used – for example, if SAP Business Workflow tasks are expected, then use ‘/IWPGW/BWF’. Create additional system aliases, if required, as mentioned at Adding Additional System Aliases - SAP Gateway - SAP Library.

3.5. Data provider is not assigned to Task Gateway model

Detection Activity:

• • Error ‘Data Provider implementation 'ZTM_TGW_SVC_MODEL_0002_BE' '01' '/IWPGW/BWF' does not exist’ is seen in SAP Gateway error log
  • System alias is maintained correctly

Solution: Assign data provider to Task Gateway mode as mentioned at Assigning a Software Version to Service - SAP Gateway - SAP Library

3.6. Improper setup of SAP Gateway or backend systems

Solution: Ensure all relevant SAP notes mentioned within Release Information Note for My Inbox are applied to relevant systems. For My Inbox 1.0, refer to SAP note 2106212 . For My Inbox 2.0, refer to SAP note 2221151.

4. Cannot open My Inbox app

Detection Activity: Clicking ‘My Inbox – All Items’ app displays error ‘Could not open app. Try again later.’

Solution: Check the Gateway error log based on user and time stamp. In case there is no relevant entry, check the authorizations assigned to the user. Ensure that roles SAP_FND_BCR_MANAGER_T and SAP_FND_TCR_T are assigned to the user in the frontend system. In case these roles are not available, configure roles for tile catalogs as mentioned here with catalogs SAP_FND_BC_MANAGER_T and SAP_FND_TC_T.

5. Incorrect translation for user decision text

Detection Activity: User decision text is always displayed in one language, irrespective of the login language., For example, approve action is displayed in English even though user has logged in Greek.

Solution:

1. Login to SAP Gateway system
2. Go to transaction SM59
3. Click on button 'Search'
4. Enter relevant RFC destination and then enter '3' in field 'Connection Type'
5. Click on button 'Start Search'
6. Double-click the relevant entry
7. Go to tab 'Logon & Security'
8. Maintain empty value in field 'Language'

6. Attachments cannot be uploaded

Solution:

1. Go to transaction /IWFND/VIRUS_SCAN
2. Ensure field 'Virus Scan Profile' is empty
3. Set flag 'Virus Scan Switched Off'
4. Click on button 'Execute' or press F8 key

7. Deletion of attachment is not possible

Explanation:

• • Deletion of only own attachment is possible, whether created in Fiori or in backend – deletion is disabled for attachments created by other users and this is done for security reasons
  • Attachment in workflow container is technically different from attachment on application business object. Only attachments in workflow container are displayed in My Inbox

8. Custom attributes Issues

8.1. Custom attributes are not displayed

Detection Activity: Expected task context information maintained within the work item container is not displayed, either

• • along with task description in the information tab of the detail pane OR
  • in the list view/pane

Solution: Implement SAP note 2323669. In case task context information is required in the master list, ensure that custom attributes are created with relevant predefined names from following list.

• • CustomTaskTitle
  • CustomNumberValue
  • CustomNumberUnitValue
  • CustomObjectAttributeValue

8.2. Duplicate Custom attributes

Detection Activity: The selected task displays duplicate custom attributes in the detail description of the task.

Solution: Implement SAP note 2330483.

9. Error in My Inbox after upgrade of component IW_PGW

Solution: Ensure that software components in SAP Gateway and backend systems are compatible as mentioned in SAP note 1942072.

10. How to create custom data provider for Task Gateway service

Solution: Refer to How to create a custom data provider for Task Gateway

11. Navigation Issue from Manage My Substitute screen

Detection Activity: On clicking on Manage My Substitute option , you are navigated to the Manage My substitute screen and then you are navigated back to the work item list. You are not able to view the Manage My Substitute screen.

Solution: Implement SAP note 2364710 .

12. Back button is not visible in Detail View when My Inbox is launched on mobile

Detection Activity: If you launch My Inbox using mobile device and select a work item . The back button is not visible to navigate back to the work item list.

Solution: Implement SAP note 2364710 .

13. Extension point extHookChangeFooterButtons does not work

Detection Activity: After upgrading to 2.1.1 My Inbox version, you are not able to use extHookChengeFooterButtons to modify the Send Email or Share button settings in the footer.

Solution: Implement SAP note 2364710 .

14. Decisions Buttons not visible for the selected task

Detection Activity: After upgrading to 2.0 SP03 My Inbox version, you are not able to view Decision buttons like Approve/Reject for the selected task which has been configured with intents.

Solution: Implement SAP note 2365275 .

15. Other issues

In case of issues that are not mentioned here, consider the following points.

• • Ensure that all relevant SAP notes mentioned within Release Information Note for My Inbox are applied to relevant systems. For My Inbox 1.0, refer to SAP note 2106212. For My Inbox 2.0, refer to SAP note 2221151
  • Ensure that SAP Gateway and backend systems have compatible software components based on compatibility matrix mentioned within SAP note 1942072
  • For My Inbox related issues, raise a ticket to component CA-INB-FIO
  • For Task Gateway service related issues, raise a ticket to component OPU-BSC-TGW

SAP Diagnostics Agent Maintenance Procedures

Introduction

July 2014: This article consolidates the information on Diagnostics Agent Maintenance Procedures, that was previously accessible via several Diagnostics Agent related SAP Notes and Guides.

General Information on Diagnostics Agents

See to the "General Information" section here: Diagnostics Agents.

Diagnostics Agent Installations

Finding Previously Installed Diagnostics Agents

To double check if a Diagnostics Agent is installed you should have a look at all existing / installed SAP systems that are operational at (logical) host level.

The Diagnostics Agents are in general identifiable by a System ID, as follows:

• For agents shipped with / for SAP NetWeaver 7.1 EhP1 and higher, the Diagnostics Agent System ID is usually: DA? (DAA, DAB, etc.)
• For agents based on older versions, the Diagnostics Agent System ID is usually: SMD

Diagnostics Agent Installer

Use the latest SWPM 1.0 Support Package (and associated Patch Level), when installing a new or an additional Diagnostics Agent. See SAP note 1833501 for the latest Diagnostics Agent Installation & Setup Guide.

SAP NetWeaver System Rename

SWPM based System Rename is not supported for the Diagnostics Agent. Instead, the below described Diagnostics Agent Replacement procedure must be used.

SAP NetWeaver System Copy

SWPM based System Copy is not supported and not relevant for the Diagnostics Agent. Instead, perform a fresh Diagnostics Agent installation on the target system.

Have Up-To-Date SAP Host Agents

Checking the SAP Host Agent Version

• Solution Manager 7.1 currently requires to have at least SAP Host Agents 7.20 SP147 in the Managed system landscape.
• However, when using Solution Manager 7.1 SP10 or higher and Agents On-the-fly, deploy SAP Host Agents 7.20 SP163, at least on High Available/Fail-Over hosts. With this version the logical hostname switches are detected faster.
• Consider using the SAP Host Agents 7.20 SP179, in case you encounter errors related to the connectivity with the SAP Host Agent. See also: SAP Host Agent troubleshooting.
• Further below you find more details, including hints to find out the version of existing SAP Host Agents or how to upgrade a SAP Host Agent.

Installing SAP Host Agent

• Install one SAP Host Agent, per physical host, if not yet installed. See SAP note 1031096.

Upgrading SAP Host Agent

• Upgrading the SAP Host Agent according to SAP note 1031096, if the version is not sufficient
  • Check the version at OS level (search in the output for "SAPHOSTAGENT information"):
    • For Windows: "%ProgramFiles%"\SAP\hostctrl\exe\saphostctrl -function ExecuteOperation -name versioninfo
    • For Unix: /usr/sap/hostctrl/exe/saphostctrl -function ExecuteOperation -name versioninfo
  • The currently installed SAP Host Agent version is also visible under the host details, if “Managed System Configuration” has been performed with solman_setup
    • Navigate to Solution Manager Administration work center → Landscape → Hosts → → Host Operations → → Status
• Implement automatic upgrade process (especially if you plan SAP Host Agent related changes)
  • SAP note 1473974 describes ways to centrally and automatically upgrade running SAP Host Agents

Diagnostics Agent Upgrade

• There is no need to upgrade Diagnostics Agents (business logic) explicitly.
• Diagnostics Agents update their business logic (coding) from the SAP Solution Manager system to which they are connected. All connected Diagnostics Agents that are running in the landscape, are centrally patched, when deploying an LM-SERVICE Java Software Component Archive (SCA) on the SAP Solution Manager system.
  • Diagnostics Agents installed with Software Provisioning Manager 1.0 SP3, SP4, SP5 and SP6, initially have a version like 7.10.8.xxxxxx
  • When connecting to a SAP Solution Manager system 7.10 SP5, the freshly installed agent will downgrade to a version like 7.10.5.xxxxxx
  • When connecting to a SAP Solution Manager system 7.10 SP10, the freshly installed agent will upgrade to a version like 7.10.10.xxxxxx
• Diagnostics Agent installation SAP notes document procedures to resolve known issues. Alternatively, you can use the below Diagnostics Agent Replacement procedure.

SAP Solution Manager 7.2:

• Diagnostics Agents which were previously connected against a SAP Solution Manager 7.1 system, and which have been migrated/reconnected to a SAP Solution Manager 7.2 system, will also automatically update their business logic (coding) from the SAP Solution Manager system to which they are connected.

Diagnostics Agent Kernel Patch

If you have problems with the SAP Kernel which is used by the Diagostics Agent, you may need to apply a SAP Kernel patch for the Diagnostics Agent. The procedure for Linux/Unix and for Windows is described in SAP note 2147092.

Diagnostics Agent Kernel Upgrade

In rare cases you may be asked to upgrade the SAP Kernel used by the Diagnostics Agent (see SAP note 1707141).

The same can be achieved, by applying the below Diagnostics Agent Replacement procedure.

Diagnostics Agent JVM Upgrade

In rare cases you may be asked to upgrade the SAP JVM used by the Diagnostics Agent

When upgrading a SAP JVM 6.1 or SAP JVM 8.1, refer to Upgrade the Diagnostics Agent's JVM.

When upgrading a SAP JVM 4 or SAP JVM 5, refer to SAP note 1774669.

The same can be achieved, by applying the below Diagnostics Agent Replacement procedure.

Diagnostics Agent Replacement

To replace a Diagnostics Agent, install a new Diagnostics Agent, and uninstall the previous Diagnostics Agent. This procedure can be relevant in the following scenarios:

• Replace a Diagnostics Agent, which has problems that cannot be easily resolved.
• “Upgrade” a Diagnostics Agent system, e.g.
• install a new Diagnostics Agent using a newer installer and a newer kernel, and get a Diagnostics Agent that has a new SAP JVM and a new SAP Kernel.
• uninstall the previous Diagnostics Agent

Follow the following procedure:

Reset server name Login to the SAP Solution Manager system to which the agent to be replaced is connected Navigate to the Agent Administration and note the server name of the previous Diagnostics Agent Reset the server name using the context menu of the Diagnostics Agent Stop the Diagnostics Agent Install new Diagnostics Agent using a different SID Assign the same server name to the new Diagnostics Agent, using the smdsetup script. For smdsetup script usage, see the latest Diagnostics Agent Installation & Setup Guide, accessible via SAP note 1833501. Java based Managed Systems require important additional actions (see next section) Uninstall the previous Diagnostics Agent using SWPM.

This procudure will:

• Provide you with a newly installed Diagnostics Agent
• The Diagnostics Agent SAP Kernel will have been upgraded to the version that you have provided
• The Diagnostics Agent SAP JVM will have been upgraded to the version that you have provided via the SAP Kernel media
• The SAP Host Agent on your system will have been upgraded to a more recent version, if a more recent version was provided via the SAP Kernel media

Diagnostics Agent Replacement in the context of a Java Managed System

This procedure updates the Managed System JVM parameters so that the Introscope Byte Code Adapter binaries are no longer taken from the previous Diagnostics Agent directory structure.

• In case the “Deploy Byte Code Adapter under Managed System Instance(s)” option was not used in the past (before 7.1 SP12 this option was called "Ensure HA virtualization compatibility"):
  • • Again configure the Wily Introscope Agent (Byte Code Adapter Installation) via transaction solman_setup → Managed System Configuration → Configure Automatically
      • • Pre-requisite since Solution Manager 7.1 SP05:
          • • Additionally mark the option "Deploy Byte Code Adapter under Managed System Instance(s)" within step "Enter System Parameters". SAP recommends to provide a relative path name like ByteCodeAdapter for the "Introscope BC Adapter deployment path" field, in order to locate the Byte Code Adapter binaries and configuration files inside the Managed system directory structure (/usr/sap//).
            • The Diagnostics Agent OS user must have write permissions for this Managed System path location. For details see SAP note 1163751.
    • Restart the Java Managed System

If you experience problems with the Byte Code Adapter (Managed System does not restart), please check Introscope Troubleshooting (search for "uninstall").

Diagnostics Agent Removal

To remove a Diagnostics Agent instance installed for a specific host name:

• In case the solman_setup “Deploy Byte Code Adapter under Managed System Instance(s)” option was used in the past to set up the Byte Code Adapter of the Java Managed System(s) running on the host (before 7.1 SP12 this option was called "Ensure HA virtualization compatibility"):
• • Optionally: Also uninstall the Byte Code Adapter by removing the JVM parameters listed in the relevant Instroscope Setup Guide from Introscope Home → Documentation.
• Else, take the following actions (in case the solman_setup “Deploy Byte Code Adapter under Managed System Instance(s)” option was not used in the past during the Managed System Configuration):
• • IMPORTANT: Remove the JVM parameters used to start/run the Introscope Byte Code Adapter from the Java Managed System. These parameters listed in the relevant Instroscope Setup Guide from Introscope Home → Documentation.
  • NOTE: The Managed System JVM parameters (to be removed) show that the Introscope Byte Code Adapter executed by the Java Managed System uses files from the Diagnostics Agent directory structure, e.g.:
    • • Xbootclasspath/p:D:/usr/sap/DAA/SMDA98/SMDAgent/applications.config/com.sap.smd.agent.application.wily/BytecodeAgent/ISAGENT.xxxxxxxxxx/wily/connectors/AutoProbeConnector.jar; D:/usr/sap/DAA/SMDA98/SMDAgent/applications.config/com.sap.smd.agent.application.wily/BytecodeAgent/ISAGENT.xxxxxxxxxx/wily/Agent.jar 
  • Restart the Java Managed system to no longer run the Introscope Byte Code Agent.
• Run the Diagnostics Agent installer SWPM, to uninstall the Diagnostics Agent

If you experience problems with the Byte Code Adapter (Managed System does not restart), please check Introscope Troubleshooting (search for "uninstall").

After the Diagnostics Agent has been uninstalled, apply the option "Delete Offline Agent Entry" in the Agent Administration.

Related Information

• Diagnostics Agent and HA Support SCN Wiki Article
• Managed System Decommissioning Information (see Delete Managed System)

Reporting an Incident

• If you must report an incident related to the here described procedures, first check for a relevent component in the respecitve SAP Notes or Guides that you are working with.
• If those documents should not provide an appropriate componet for reporting the incident, you may report an incident at SV-SMG-DIA-SRV-AGT.

SAP Diagnostics Agent and HA Support

Scope

Solution Manager 7.1 SP05 and higher

Terminology

• The term 'host' does NOT designate a network alias. Hosts must have their own IP addresses.
• A 'Virtual host' designates a simulated host running for example on top of a VMware.
• A 'Logical host' designates a network/host configuration which associates a physical host with one or more additional host names and dedicated IP addresses. This is used, for example, to be able to move systems from one physical host to another.
  N.B.: To find the host name of an ABAP system, use transaction sm51, and for Java systems refer to the System Info Web page.

Introduction

Solution Manager 7.1 SP05 introduced a so called Diagnostics Agents On-the-fly feature. It offers a built-in infrastructure/principle to put in place appropriate Diagnostics Agent landscapes in the context of High Availability environments, where SAP Systems or DB switch/fail-overs are occurring. With this Solution Manager built-in feature there is no more need to configure for example some proprietary High Availability Managers or to adapt failover scripts.

Note that the Agents On-the-fly feature could also be useful in the context of Physical/Virtual hosts running a high number of Logical hosts.

Existing Diagnostics Agent installations, which are already operational, should remain in place and no further action is required (from an Agent installation/configuration point of view).

However, SAP recommends to consider the usage of the Agents On-the-fly feature, at the time NEW or ADDITIONAL Systems are being or planned to be managed in ONE given Solution Manager system, and ONLY IN CASE these Managed Systems are operated in a High Availability environment, or running on Physical or Virtual hosts having a high number of Logical hosts.

You will find in the following two tables a check list of all important actions and possible pinpoints to take care of. In case you will put in place Agents On-the-fly, you need to evaluate the Managed system environment : "High Availability" and/or "Physical/Virtual hosts running a high number of Logical hosts". Depending on this environment use either the recommendations of the first table or the second below table.

Prerequisite

In case Managed Systems run with hostnames that are "simple" network hostname aliases (meaning not logical hostnames with dedicated IP addresses, like described in the above Terminology), the presently documented Agents On-the-fly feature will not work.
Further details on how to declare (fully qualified) logical hostnames with dedicated IP addresses could be found in SAP note 962955. (N.B.: For the Agents On-the-fly, do NOT consider item 4 in the procedure described in that SAP note.)
In case of doubts feel free to execute the following command on the Physical or Virtual Host to double check whether the (Logical) hostnames used by the Managed systems are listed.

• On Windows:
  "C:\Program Files\SAP\hostctrl\exe\saphostctrl.exe" -function GetComputerSystem
• On Unix:
  /usr/sap/hostctrl/exe/saphostctrl -function GetComputerSystem
• Output example, showing under entry ITSAMComputerSystem, that 5 hostnames are currently known/operated by this host, where the command is executed.
  Having a closer look, we see 4 logical hostnames: db6lparci.wdf.sap.corp (IP 10.xxx.xxx.33), db6lparascs.wdf.sap.corp (IP 10.xxx.xxx.253), db6lpardb.wdf.sap.corp (IP 10.xxx.xxx.99), db6lparers.wdf.sap.corp (IP 10.xxx.xxx.153), and the underlying PhysicalHostA.wdf.sap.corp (IP 10.xxx.xxx.217):
  *********************************************************
  CreationClassName , String , ITSAMComputerSystem
  Name , String , PhysicalHostA
  Hostnames , String[] sep=; , PhysicalHostA.wdf.sap.corp;db6lparci.wdf.sap.corp;db6lparascs.wdf.sap.corp;db6lpardb.wdf.sap.corp;db6lparers.wdf.sap.corp;localhost;
  IPAdresses , String[] sep=; , 10.xxx.xxx.217;10.xxx.xxx.33;10.xxx.xxx.253;10.xxx.xxx.99;10.xxx.xxx.153;127.0.0.1;
  *********************************************************
  [...]

It is recommended - as indicated in the following tables - to install "clean/fresh" Diagnostics Agents. Use the latest Diagnostics Agent installation package that is available on SMP (for information on the latest installer refer to SAP note 1833501). This will bring latest fixes and improvements for Installer, Kernel and JVM. The Agents must be installed at Physical or Virtual host level.
The Diagnostics Agents are also SAP systems, they have a System ID (SID) like DAA and an Instance-ID like SMDA97.
Do NOT use the possibility to install additional Diagnostics Agent instances for a given Diagnostics Agent SID (like DAA). In the context of the Agents On-the-fly feature, this type of Agent organization (same SID with multiple instances like 98, 97, etc.) is NOT allowed. For instance, when installing the Diagnostics Agents on shared/clustered file systems (/usr/sap), pay attention to use distinct SIDs.
Also consider SAP note 1365123 and the there attached document.

Note that all Diagnostics Agents/Agents On-the-fly, at Physical/Virtual or Logical host level, by default perform Outside Discovery. Specifically the Database and IIS discovery processing shall be switched off for Agents On-the-fly (running at Logical host level), as this data is already collected by the Diagnostics Agent (Physical/Virtual host level). Therefore consider the performance improvement related recommendations from SAP note 1611483.

Remark for Physical/Virtual Hosts running Windows 2003
As indicated in SAP note 1108852, check that the saploc share - if it exists - points to local drive.
If it points to the shared drive, delete the saploc share, before installing the Diagnostics Agent.

Remark related to MS SQL
As indicated in SAP note 1458291, make sure that at the time you are installing the Diagnostics Agent you choose one of the domain options, as the Agent has to run under a domain login, in order to avoid having potentially a high number of SQL Server Error Logs (related to login errors).

How to proceed in case Diagnostics Agents are already installed for the Managed Systems?

You will find in the following two tables a check list of all important actions and possible pinpoints to take care of. In case you will put in place Agents On-the-fly, you need to evaluate the Managed system environment : "High Availability" and/or "Physical/Virtual hosts running a high number of Logical hosts". Depending on this environment, either use the recommendations of the first table, or the second below table.

Note that SAP recommends removing any existing Diagnostics Agents on the underlying hosts.

Refer to the Diagnostics Agent Removal procedure described in Diagnostics Agent Maintenance Procedures.

Diagnostics Agent installation/deployment strategy in the context of Agents On-the-fly

Installation Strategy in an High Availability context (system switch over)

Where ?	Preparation	Installation	Setup	Remark
On ALL Physical or Virtual Hosts participating in a given switch/fail-over (switch between Host A & B)	Uninstall ALL Diagnostics Agents previously existing on these Physical or Virtual Hosts. Especially pay attention to the Diagnostics Agent Removal and the Byte Code Adapter aspects in the context of Java Managed Systems, as described in Diagnostics Agent Maintenance Procedures.	Install on ALL Physical or Virtual Hosts (part of the group) one Diagnostics Agent (latest version, see prerequisites section) without specifying any Logical hostname in SWPM. Also see SAP note 1365123.	Run for EACH Physical or Virtual Managed host the solman_setup -> Managed System Configuration -> Host to enable the Agents On-the-fly feature in step "Enter System Parameters"	The "Display resulting host list" button in step "Enter System Parameters" is showing the list of logical hostnames for which an Agent On-the-fly will be created only at the time these logical hostnames are associated to the presently configured Physical or Virtual Host. N.B.: After having clicked on the "Display resulting host list" button, you have to additionally click on the "Show" link in the setup logs to see the resulting hostname list.
Logical Hosts (for example L1, L2, L3)	Uninstall any Diagnostics Agents which might have been installed in earlier times with a Logical hostname L1, L2 or L3. Especially pay attention to the Diagnostics Agent Removal and the Byte Code Adapter aspects in the context of Java Managed Systems, as described in Diagnostics Agent Maintenance Procedures.	Install no further Diagnostics Agent (other than those mentioned in the above table line).	In case one or several Managed Systems (including SCS instances in the context of SolMan 7.1 SP08 and higher) are installed with these L1, L2, L3 Logical hostnames, run also as usual the Managed System Configuration (in solman_setup transaction) for each of them. See also below chapter "Important remark concerning Java Managed systems on logical hosts".	In case no Diagnostics Agent is available in solman_setup -> Managed System Configuration -> "Assign Diagnostics Agent" for the Managed system, double check the "Remark" of above two table lines

• N.B.: The above situation description applies in the context of one Solution Manager system. In case the Managed systems/hosts should be visible in one additional Solution Manager system, one additional Diagnostics Agent has to be installed using a new different System-ID. And this new additional Agent will then be configured in the solman_setup of that additional Solution Manager system, like described above.
• N.B.: The "Display resulting host list" button in step "Enter System Parameters" shows the list of logical hostnames for which an Agent On-the-fly will be created (only at moments where these logical hostnames are associated to underlying Physical or Virtual Host). Also note that the displayed hostname list is computed based on the Hostnames attribute returned by the following SAP HOST Agent command. It therefore does NOT include any network hostname alias. In case of doubts feel free to execute that command on the Physical or Virtual Host.
  • On Windows:
     "C:\Program Files\SAP\hostctrl\exe\saphostctrl.exe" -function GetComputerSystem
  • On Unix:
    /usr/sap/hostctrl/exe/saphostctrl -function GetComputerSystem

Installation Strategy outside any High Availability context (system switch over)

Environment	Preparation	Installation	Setup	Remark
No logical hostname is used on Physical or Virtual Host A	N/A	Like with earlier Solution Manager Support Packages install on Host A - if not already done - one Diagnostics Agent (latest version, see prerequisites section) without specifying any Logical hostname in SWPM. Also see SAP note 1365123.	Only run (like with earlier Solution Manager Support Packages) the Managed System Configuration for each Managed System running on this host in solman_setup	In case no Diagnostics Agent is available in solman_setup -> Managed System Configuration -> "Assign Diagnostics Agent" for the Managed system, double check whether the installed Diagnostics Agent is connected to Solution Manager using the Agent Administration UI
Low amount of Logical hosts running on Physical or Virtual Host A	N/A	Like with earlier Solution Manager Support Packages install on Host A one Diagnostics Agent (latest version, see prerequisites section) per Logical hostname - if not already done - and take care to specify each time the relevant Logical hostname in SWPM. Also see SAP note 1365123.	Only run (like with earlier Solution Manager Support Packages) the Managed System Configuration for each Managed System running on these logical hosts in solman_setup	In case no Diagnostics Agent is available in solman_setup -> Managed System Configuration -> "Assign Diagnostics Agent" for the Managed system, double check whether the installed Diagnostics Agent is connected to Solution Manager using the Agent Administration UI
High amount of Logical hosts running on Physical or Virtual Host A	Uninstall all Diagnostics Agents previously existing on Host A. Especially pay attention to the Diagnostics Agent Removal and the Byte Code Adapter aspects in the context of Java Managed Systems, as described in Diagnostics Agent Maintenance Procedures.	Install one Diagnostics Agent (latest version, see prerequisites section) on the underlying Physical or Virtual Host A, without specifying any Logical hostname in SWPM. Also see SAP note 1365123.	First run solman_setup -> Managed System Configuration -> Host for Managed Host A to enable the Agents On-the-fly feature in step "Enter System Parameters". In a second phase run like usual the Managed System Configuration for each Managed System running on the logical hosts in solman_setup. See also below chapter "Important remark concerning Java Managed systems on logical hosts".	The "Display resulting host list" button in step "Enter System Parameters" is showing the list of logical hostnames for which an Agent On-the-fly will be created only at the time these logical hostnames are associated to Host A. N.B.: After having clicked on the "Display resulting host list" button, you have to additionally click on the "Show" link in the setup logs to see the resulting hostname list.

• N.B.: The above situation description applies in the context of one Solution Manager system. In case the Managed systems/hosts should be visible in one additional Solution Manager system, one additional Diagnostics Agent has to be installed using a new different System-ID. And this new additional Agent will then be configured in the solman_setup of that additional Solution Manager system, like described above.
• N.B.: The "Display resulting host list" button in step "Enter System Parameters" shows the list of logical hostnames for which an Agent On-the-fly will be created (only at moments where these logical hostnames are associated to underlying Physical or Virtual Host). Also note that the displayed hostname list is computed based on the Hostnames attribute returned by the following SAP HOST Agent command. It therefore does NOT include any network hostname alias. In case of doubts feel free to execute that command on the Physical or Virtual Host.
  • On Windows:
    "C:\Program Files\SAP\hostctrl\exe\saphostctrl.exe" -function GetComputerSystem
  • On Unix:
    /usr/sap/hostctrl/exe/saphostctrl -function GetComputerSystem

Important remark concerning Java Managed systems on logical hosts

For NW AS Java based Managed Systems do NOT forget to mark the option "Deploy Byte Code Adapter under Managed System Instance(s)" within "Enter System Parameters" under Managed System Configuration / Technical Systems or Technical Scenarios (before 7.1 SP12 this option was called "Ensure HA virtualization compatibility").
Also provide a relative path, like "ByteCodeAdapter", for the "Introscope BC Adapter deployment path" field, in order to locate the BC Adapter binaries and configuration files inside the Managed system directory structure (/usr/sap///ByteCodeAdapter). Note that the Diagnostics Agent OS user (member of the SAPSYS OS group) must therefore also have write permissions at this Managed System path location.

Remark: Note that it is just necessary to provide the folder name. The Introscope BC Adapter files will be placed under the managed system instance path((/usr/sap///) plus the folder name provided.

Agents On-the-fly concept

Concept

When for a given Diagnostics Agent (installed for a Physical or Virtual host) the Agents On-the-fly feature is enabled, this Agent can potentially run additional Diagnostics Agent processes (Agents On-the-fly), under his SID and Instance Number. These additional processes are considered as being Diagnostics Agents On-the-fly or "Nodes".
The rule for having additional or less of these Agents On-the-fly at a given point in time is as follow. Whenever a new (Logical) hostname is visible on the underlying (Physical or Virtual) host, the Diagnostics Agent (installed initially), will automatically create one additional Agent On-the-fly. However when this Logical hostname is no longer associated with that underlying (Physical or Virtual) host, the Diagnostics Agent will stop and remove again the associated Agent On-the-fly.

N.B.:

• With this approach, the number of Diagnostics Agent instances (allocated Instance Number) on a Physical or Virtual, is also independent of the number of Managed Systems/Logical Hosts.
• Two Agents On-the-fly will have the same memory footprint as two "standard" Diagnostics Agents. However, note that the Diagnostics Agent installed on the underlying (Physical or Virtual) host has to be additionally considered for the overall memory footprint. At disk space level the Agents footprint will be less given that the SAPJVM & Kernel binaries are shared.
• Remember that network hostname aliases will not be considered. For further details refer also to the below "Enable the Agents On-the-fly feature" item description in the Setup storyboard.

Example

Landscape components

Hostname layout

Failover scenario

1. Cluster Manager detects/triggers a DB failover
2. Logical Host/IP is moved to failover cluster node
3. DB instance is started on failover cluster node
4. Diagnostics Agent (DAA) detects a change in the Logical Host allocation
5. Agent On-the-fly on DAA is stopped/removed and created/started on DAB, according to the new cluster layout
6. Normal operation can continue transparently

Setup storyboard

solman_setup transaction entrance

N.B.: The values P,V or L in the column "Host Type" mean respectively Physical, Virtual or Logical host. See also the initially presented terminology.

Assign Diagnostics Agent installed on Physical or Virtual Host level

Enable the Agents On-the-fly feature

N.B.: The "Display resulting host list" button in step "Enter System Parameters" shows the list of logical hostnames for which an Agent On-the-fly will be created (only at moments where these logical hostnames are associated to underlying Physical or Virtual Host). Also note that the displayed hostname list is computed based on the Hostnames attribute returned by the following SAP HOST Agent command. It therefore does NOT include any network hostname alias. In case of doubts feel free to execute that command on the Physical or Virtual Host.

• On Windows:
  "C:\Program Files\SAP\hostctrl\exe\saphostctrl.exe" -function GetComputerSystem
• On Unix:
  /usr/sap/hostctrl/exe/saphostctrl -function GetComputerSystem

Finally, with SAP Solution Manager 7.1 SP10 or higher, remind to start the "Agent On-the-fly Administration" UI, in order to double check whether the expected Agents On-the-fly are created and connected. It is accessible via the "Advanced Settings" tab, within the Agent Administration UI.

Or, prior to SAP Solution Manager 7.1 SP10, double check in the "Agent Administration" UI.
N.B.: Use the SID/InstanceID to understand for each Agent On-the-fly by which Diagnostics Agent is has been created. Note that the Agent On-the-fly Instance ID includes the Logical hostname.

Frequently Asked Questions (FAQ)

Q: First actions in case an Agent On-the-fly does not seem to react on a Logical Hostname switch-over (from Physical/Virtual Host A to B)

• On Physical/Virtual Host A and Host B execute each time the following command to double check whether the Logical hostname move occurred as you expect at OS level and is seen by the SAP Host Agent.
  • For Windows:
    C:\Program Files\SAP\hostctrl\exe\saphostctrl.exe -function GetComputerSystem
  • For Unix:
    /usr/sap/hostctrl/exe/saphostctrl -function GetComputerSystem
• Additionally, perform on each Physical/Virtual Host (A and B) the ping command.
  • ping -a
• In case the SAP Host Agent reflects correctly the hostname topology proceed as follow:
  1. Go to solman_setup -> Managed System Configuration -> Host for Host A
     1. Navigate to step "Enter System Parameters" / field "Local exclusion filter" and write down the currently provided value
     2. Provide now a new filter (regular expression) to temporarily exlude the concerned Logical hostname
     3. Press "Save"
     4. Wait one minute
     5. In step "Enter System Parameters" / field "Local exclusion filter" provide again the initial value (you written down).
     6. Press "Save"
     7. Wait one minute
  2. Proceed as explained above also for Host B
  3. In case the problem persists (Agent On-the-fly not moving) kindly open a message on component SV-SMG-DIA-SRV-AGT.

• In case the SAP Host Agent does not see the Logical hostname as you expect, please open a message on component BC-CCM-HAG.

Q: What actions to take when saving a wrong value in the "Local exclusion filter"

1. In the "Local exclusion filter" field from step "Enter System Parameters" correct previously provided (exclusion) pattern
2. Press "Save"
3. Wait one minute
4. In case the previously defined pattern was wrong and had as a consequence that too many Agents On-the-fly were created, also remind to delete from LMDB the not relevant hostnames.
   1. Therefore start LMDB transaction
   2. In "Host" tab delete the no longer relevant hosts, which have been created by the outside discovery process run by the Agents On-the-fly