Auto-Configuration Tool User Guide AGS Global CoE Technology, updated July 23, 2015

Auto-Configuration Tool User Guide ............................................................................ 1 Introduction ............................................................................................................ 3 Architecture ........................................................................................................... 4 Pre-requisites ......................................................................................................... 5 Change Log ............................................................................................................ 5

BOE Step by step ................................................................................................... 7 Install or package unpack................................................................................... 7

Structure of file tree ........................................................................................... 8

conf/boe.properties Preparation ......................................................................... 8

Step 16 Tomcat SSL (https) support .................................................................. 9

Windows boe.properties simplification ............................................................. 9

Password input for secured stdin input ............................................................ 10

Run actool with interactive user input ............................................................. 10

Silent, or automation launch ............................................................................ 11

Result checking ................................................................................................ 11

Interactive mode........................................................................................... 11

Automation mode......................................................................................... 11

All steps managed system impact and how to check ....................................... 12

Run actool for automation ................................................................................... 12 UNIX with output redirected ........................................................................... 12

Windows .......................................................................................................... 13

Data Services ....................................................................................................... 13

All steps managed system impact and how to check ....................................... 14

Repeated invocations ........................................................................................... 14 UNIX platforms ............................................................................................... 14

BOE and Tomcat variation support ..................................................................... 14 BOE only (products_boe.xml) ......................................................................... 15

IPS aka minBOE only (products_miniboe.xml) .............................................. 15

Tomcat only (products_tomcat.xml) ................................................................ 15

Standalone Tomcat installation support ........................................................... 15

adapt run_actool.sh[bat] ............................................................................... 15

Mandatory parameters to adapt (boe.properties) ......................................... 15

Two new parameters to take care ................................................................. 16

No SolMan (BOLight) RCA support (products_bolight.xml) ......................... 16

Mandatory parameters to adapt (boe.properties) ......................................... 16

AIX IBM JDK GC support .................................................................................. 17

Supported platforms and products ................................................................. 17

Constraint............................................................................................................ 17

Single user support ........................................................................................... 17

Distributed systems (e.g. multiple hosts involved in a BOE cluster) .............. 17

BOE and Tomcat restart option ....................................................................... 17

Potential NCS port conflict .............................................................................. 17

Step 18 runtime Windows service ................................................................... 18

Component ID ...................................................................................................... 18

Bug reporting ....................................................................................................... 18 More references ................................................................................................... 18

Introduction

Background:

When working on SAP Note 1653689/1817324/1852508, a lot of complicated SolMan

BOE/DS setups bring up to build this configuration tool in a central and automatic way to make easier those steps.

Goal:

The goal of the ACTool is to provide a reliable way to configure BOE/DS as SolMan

managed system: 1) Provide at first a list of the steps necessary for BOE/DS to be setup as SolMan

managed system;

2) Avoid manual error for applying SAP Note 1653689. 3) Automation and/or repeated invocations such as HEC LVM integration, any SAP

product SolMan installation and configuration integration like BI4 and Data Services.

Architecture

Managing/managed systems operations

Pre-requisites

1. SAP SMD Agent 720 or higher has been installed and configured to a valid SolMan; 2. Managed system (BOE, Tomcat, Data Service server or IPS) is running on host;

Change Log

1. 2015.02.11 First release for version 2.0.0 1. HEC silent or automation operations on BOE/Tomcat/DS success;

2. HEC repeated invocations success.

2. 2015.02.20 Release for version 2.0.1 1. implement new argument -

boe.password/sld.server.password/jmx.password/jvmmond.password 2. Enable DS Saposcol process monitoring, i.c. install SAP_DS4_*_procmon.ini;

3. Enable DS NCS, i.c. DSConfig.txt + ncs.conf configuration; 4. Remove registry.jar as Third Party usage; use Windows reg;

5. Disable BOE embedded Wily agent if enabled for BOE Step 12.

6. BUG fixed: slddest.cfg/key not copied to DS sldreg folder; 7. BUG fixed : Step 16 When sldDataSupplierTomcat file or folder is locked by

Tomcat, sldDSTomcat setup failed; 8. BUG fixed: Windows Tomcat non-service (cmd console catalina.bat) does not

work;

3. 2015.02.27 Release for version 2.0.2 1. As actool tomcat configuration, change touch from catalina.sh[bat] to

setenv.sh[bat] to align tomcat environment change standard; 2. Changed build&release from japro/p4 to LeanDI/Git;

3. 70 bugs checked by LeanDI code checker fixed: 0 error; 0 bug. 4. 2015.03.18 Release for version 2.1.0

1. All Fortify low level (228) issues fixes;

2. Bug fixed: step 16 some Tomcat installation reading server.xml to get tomcat port failed by openSource jdom;

3. Bug fixed: cannot capture run_actool.sh output in a variable, see section “Run actool with output redirected”;

4. Bug fixed: step 1 when password is not given in boe.properties, actool is locked

by sldreg; 5. Bug fixed: unnecessary access to X11 on UNIX platform;

6. Bug fixed: Tomcat doesn't shutdown after actool step 13 JMX enabled. 7. Bug fixed: step 13 JMX files jmxremote.password and jmxremote.access owner,

group and access bits have been lost;

8. Bug fixed: Tomcat steps 14, 15 option duplication in setenv.sh when repeating invocations;

9. New feature: Tomcat standalone installation support available (see section Standalone Tomcat installation support).

5. 2015.03.20 Release for version 2.2.0 (=2.1.1) 1. Bug fixed: boe.properties breaks Windows startup;

2. Bug fixed: in some unknown circumstance step 13 JMX password file could not

be set restriction for actool runner user; 3. Bug fixed: password input restriction by actool;

4. Bug fixed: sldreg password is printed out in logs (regression of v2.1.0). 6. 2015.03.22 Release for version 2.3.0

1. Bug fixed: Windows service loggc registry not added;

2. Bug fixed: run_actool.bat debug option enabled using port 8000; 3. Run_actool.sh missed comment “For Standalone Tomcat…”.

7. 2015.03.31 Release for version 2.4.0 1. Improvement: -silentCheckBOE and/or -silentCheckDS for automation

checking;

2. Improvement: Step 18 Windows service is started after its creation;

3. Product standard requirement: jdom aligned to SAP openSource requirement from 1.1.1 to 2.0.6;

4. Improvement: DS VirtualHost implementation; 5. Improvement: UNIX root user is no more mandatory see detail on “All steps

managed system impact and how to check”;

6. Bug fixed: typo on products*.xml on “availibility” (code changed as well to “availability”);

7. Bug fixed: step 10 hard coded for CR Processing and Cache servers as “Dcom.sap.vm.tag=crcache_vmw4731.CrystalReportsCacheServer”;

8. Bug fixed: step 10 BOE JobServer VM parameter “Dcom.sap.vm.tag=” wrongly added; 9. Bug fixed: DS DSConfig.txt updated with root as owner; 10. Bug fixed: tomcat steps tomcat/bin/setenv.sh changed its original file properties; 11. Bug fixed: step 9 wily/IntroscopeAgent_CSJNI.profile duplication definition for Wily

EM host name and port; 12. Bug fixed: step 16 failed when folder sap.com~TomcatSLDDataSupplierWEB

cannot be deleted;

13. New feature: Sun Solaris Sparc (sun_64) is supported by actool.

8. 2015.04.09 Release for version 2.5.0 1. Bug fixed: Windows console mode locking at the end when

boe.tomcat.restart=true, awaiting Tomcat restart; 2. Bug fixed: UNIX tomcat not restarted when boe.tomcat.restart=true if any

process other than tomcat in system running with pattern “tomcat” in its command line;

3. Improvement: remove not significant ERROR/WARN in log and align DS final

result pattern Successfully/Failed to BOE SUCCESS/FAILURE; 4. Improvement: step 18 Windows automation available;

5. Improvement: step 13 Windows Tomcat start blocked by jmxremote.password auth trouble: see new parameter

tomcat.console.users_to_remove in boe.properties;

6. Improvement: step 14 IBM JDK compatible GC option, see section “AIX IBM JDK GC support”;

7. Improvement: change log file from “by day” to “by actool session” with timestamps as format ac_yyyy-MM-dd-HH-mm-ss.log;

8. Improvement: no SolMan RCA support with products_bolight.xml, see section

“BOE and Tomcat variation support”. 9. 2015.04.15 Release for version 2.6.0

1. Bug fixed: unavailable step could still be run if its step number is input; 2. Bug fixed: interactive mode multiple-selections does not work;

3. Bug fixed: step 16 result status instability based on tomcat log files, changed to requesting HTTP SLDDS configuration;

4. Bug fixed: Solaris tomcat restart instability;

5. Bug fixed: BOLight step 19 does not work on UNIX in reason of double-quotes on ‘smdsetup.sh hostagentconf emhost:"XXXXX" emport:"YYYY"’;

6. Bug fixed: Step 4 Windows restart SMDAgent cannot not trigger MonitoredProcesses if both registry SAP_DIR_PERF and shared folder

\\%COMPUTERNAME%\saploc\PRFCLOG not found;

7. Improvement: remove inconsistent hard-coded product step names, aligning unique products*.xml.

10. 2015.04.30 Release for version 2.7.0 1. Improvement: code refactoring and cleanup all waiting loop variations to a

central, unique one for better user friendly output and easier maintenance; 2. Improvement: ds.properties and User Guide clarification on DS master name;

3. Improvement: Windows properties file accepts now single ‘\’ as file separator

so user could now copy/past paths from file system. 11. 2015.05.18 Release for version 2.8.0

1. Improvement: Windows registry detecting BOE and Tomcat enabled, reduced

the parameters to minimum, see section “BOE Step by step/Windows boe.properties simplication”;

2. Improvement: code refactoring and cleanup to consolidate duplicated codes on sldreg to an unique function for both BOE and Tomcat;

3. Improvement: step 16 Tomcat SSL (https) support, see section “SSL (https)

support”; 4. Improvement: upgrade Third Party library aspectrt to BOE standard release

1.6.5-BI41-SP_REL-SP05-RC6. 12. 2015.05.28 Release for version 2.9.0

1. Improvement: “ACTool User Guide” (this document) updated for XI4 release in Collaterals.

13. 2015.06.15 Release for version 2.10.0

1. Improvement: BOlight SMDAgent host name aligned to lowercase and/or virtualHostName;

2. Improvement: step 9 host name aligned to lowercase and/or virtualHostName. See section Step by step boe.properties/virtualHostName.

14. 2015.07.15 Release for version 2.11.0

1. Bug fixed: NullPointerException Step 2 check before execute when parameter <introscope.agent.hostName> is not in IntroscopeAgent.template;

2. Bug fixed: NullPointerException step 3 when parameter boe.home is wrongly provided;

3. Improvement: step 2 check print more detail when ERROR.

15. 2015.07.24 Release for version 2.12.0

1. Bug fixed: Step 16 error “java.io.IOException: HTTPS hostname wrong: should be <...>“;

2. Bug fixed: Manual Step 13 for Tomcat standalone service install,

NullPointerException caused actool crashed;

3. Improvement: Step 13 JMX file jmxremote.password user auth removing parameter tomcat.console.users_to_remove applied on Tomcat service;

4. Improvement: Step 4 Saposcol process Windows updated for XI4.0 and XI4.1

as tomcat*.exe;

5. Improvement: Step 13 JMX stops as ERROR if jmxremote.password can’t be deleted;

6. Improvement: Step 13 JMX removes all users on jmxremote.password, from a list got from Windows OS command icacls keeping only the mandatory one.

BOE Step by step

Install or package unpack

Locate sap_actool-x.x.x-bin.zip from the Collaterals under the following folder “Tools\sap_actool\”

unzip to a clean folder, i.c.

unzip sap_actool*.zip

Structure of file tree

Under folder downloads, actool embeds

Wily agent 9.15.3.1 which will be installed as Tomcat Wily agent;

TomcatSLDDataSupplierWEB 710.10.0 which will be deployed in Tomcat for sld

registration.

conf/boe.properties Preparation

boe.properties is used for both BOE and/or Tomcat configuration. This step is mandatory and the one file you need to prepare. All input information should be

filled in this property file before launching sap_actool.sh[bat].

Check carefully one by one for indication “# Mandatory” to provide correct input parameters.

You could ignore what is indicated as “# Default not to touch” in general situation.

As this is the default recommended NCS configuration. “Virtual Host Name” as a new parameter in boe.properties, it could be different than that of

physic/logic host name, when host load-balancing is used. To enable this,

virtualHostName = <virHost> ACTool will take this as host name for following configurations:

1. Tomcat Wily agent name (<virHost>_8005); 2. Tomcat Wily host name;

3. Tomcat sld registration payload host name; 4. XI4 Java servers host name;

5. XI4 WebI launched JVM process for HANA jdbc access (step 9);

6. XI4 BOLight SMDAgent host name (step 19); 7. DS sld registration payload host name

Step 16 Tomcat SSL (https) support

When Tomcat is setup as SSL, i.c. aceess by https, beginning from actool v2.8.0, a new

parameter tomcat.http is introduced to distinguish http and https: default is http, to adapt to https for SSL.

Actool is using a by-pass certificate mechanism to do a “--no-check-certificate” equivalent operation to avoid implementing complicated but not significant as Browser behavior for such

an actool one time server time configuration. The validated JDK for this feature is sapjvm 1.6 (installed and using by XI4.x). Standard SDK

1.6 and 1.7 could experience issue with error “handshake_failure”, with known as limited

strength issue, see Oracle document: https://blogs.oracle.com/java-platform-group/entry/diagnosing_tls_ssl_and_https

Windows boe.properties simplification

Since v2.8.0, an improvement effort for Windows to reduce the manual parameters to

minimum, only few are mandatory: BOE

boe.system boe.user

sld.server.host sld.server.port

sld.server.user

boe.cmc.introscope.host (Wily EM)

Tomcat wily.javaagent.installfolder (absent or not touched c:\usr\sap\ccms)

wily.EM.host (Wily EM to set a same as boe.cmc.introscope.host)

sld.system.longSID = <$SID>_WAS

All passwords: boe.password

sld.server.password jvmmond.password (you provide it and used in SolMan configuration)

jmx.password (you provide it and used in SolMan configuration)

Password input for secured stdin input

If one, some or all of following arguments

-boe.password -sld.server.password -jmx.password -jvmmond.password are indicated when launching run_actool.sh[bat], the user is invited to fill that or those

password from stdin console. This could avoid write down them into properties file and not to be seen in actool process command line.

A typical all BOE and DS silent automatic actool run could be realized by run_actool.sh[bat] -silentDS -silentBOE -boe.password -sld.server.password -jmx.password -jvmmond.password

In this case, the user needs to input manually one by one of all those 4 passwords on running console command line before actool processing its silent DS and BOE executions.

Run actool with interactive user input

For all steps, you need to run it as root user or sudo on UNIX, while Windows with

administrator role. UNIX ‘./run_actool.sh’

Windows ‘run_actool.bat’ Select Product, BOE as example

Select Execute to get the list of steps

There are 18 steps. By default step 6, 7 and 11 are disabled as they only make sense for BI

<= XI4.0 SP3. This enable/disable could be done by conf/products.xml. Note on JDK used run_actool.sh[bat] is calling “java com.sap.ac.entry.ConsoleModeLauncher” which is a class inside

sap_actool.jar, while sap_actool.jar is built with JDK 1.6. So the JDK to use is expected 1.6 or

higher. In BOE installed system, the script run_actool.sh[bat] will find BOE’s sapjvm (1.6) to use so no any manual touch necessary. BOEJVMBIN is taken from boe.properties variable

“jvmmond.install.path” if it is indicated.

Silent, or automation launch

UNIX: as root or sudo ‘./run_actool.sh -silentBOE’

Windows: ‘run_actool.bat -silentBOE’

This will execute all available (in products.xml) steps without any user input. Expected result:

Result checking

Checking actool result by actool is no more mandatory for root user on UNIX.

We recommend realizing the checking by BOE/DS/Tomcat user.

The checks are validated for actool touched managed system configuration, such as CMS repository data, system file, registry etc. However the check are not valid for the final result

check, which should be done manually step by step described by section “All steps managed system impact and how to check” in BOE and DS.

Interactive mode

Select Check after selected product, then step by step or return for all steps checking.

Automation mode

Use -silentCheckBOE and/or -silentCheckDS

All steps managed system impact and how to check

Please note that root user could be avoided if the user has necessary read/write on

corresponding folders and files.

Run actool for automation

When automation (-silent*), it is recommended to check the result in folder logs/*, each -

silent* run has its own log file, with all manual output plus more debug information. You can disable all console output by setting console.verbose = false.

UNIX with output redirected

Initial request is to capture run_actool.sh output in a variable like lv_log=$(./run_actool.sh -silentBOE 2>&1)

Step No Description Operations on managed system

user root

mandatory Final result check

1

BOE - BI 4.0 Note 1653689 Step 6.1 - Enable SLD support for

BO cluster

create connect.key, run sldreg,

per BOE node

No, if user has

write access on

/usr/sap/hostctrl/

exe

sld server Technical

Systems/Other

2

BOE - BI 4.0 Note 1653689 Step 8 - Enable Introscope for

Java components

CMS repository supportability

records, per BOE cluster No

Wily: SAP HostAgent Process|SAP

HostAgent SMDAXX|SBOP

ENTERPRISE

3

BOE - BI 4.0 Note 1653689 Step 9 - Enable Introscope for C++

components

CMS repository supportability

records, per BOE cluster

No, if user has

write access on

/usr/sap/tmp/pro

cmon

Wily:SBOP

ENTERPRISE\$host_$CMSport|

4

BOE - BI 4.0 Note 1653689 Step 10 - Enable Saposcol process

monitoring

SAP_BOE4_*_procmon.ini

under Win:

c:\usr\sap\PRFCLOG\procmon;U

NIX:/usr/sap/tmp/procmon, per

BOE node host No

Wily:SAP HostAgent Process|SAP

HostAgent SMDAXX|SAP

OsCol|MonitoredProcesses|*boe

_cmsd*

5

BOE - BI 4.0 Note 1653689 Step 11 - Configure step of BOE

4.0(SP level lower than SP3)

update KPIScript.jar,

coarsgrains.jar in BOE java/lib,

per BOE node No

6 BOE - BI 4.0 Note 1653689 Step 12 - Replace cms.lst for BOE4 conf/lst/cms.lst, per BOE node No

7

BOE - BI 4.0 Note 1558756 Step 4 - Required Software on

Business Intelligence 4.X system

agelet

bobjnormaljar_for_SPx.zip

update, per BOE node host No

8 BOE - Enable CSJNI - Update configurations of cs.cfg update cs.cfg, per BOE node No

Wily:SBOP

ENTERPRISE\$host_$CMSport|CSJ

NIEngine

9

BOE - Enable CSJNI - Update configurations of

IntroscopeAgent_CSJNI.profile

Update

IntroscopeAgent_CSJNI.profile,

per BOE node No

Wily:SBOP

ENTERPRISE\$host_$CMSport|CSJ

NIEngine

10 BOE - Enable TDA service(BOE node need to be restarted.)

CMS repository records, per

BOE cluster No

CMC/Java option:-

Dcom.sap.vm.tag=<prefix>_<BOES

ERVERNAME>

11 Tomcat - pre-check the agent dll file version

Win only for wily agent dll

version check, per Tomcat

instance No

12

Tomcat Wiki Step 3 (BI 4.0 Note 1653689 Step 7)- Install

Introscope Agent (Tomcat restart needed)

create wily agent

/usr/sap/ccms/wily, per Tomcat

instance No

Wily:Tomcat|$host_$TomcatShut

downPort

13

Tomcat Wiki Step 4.1 - Configure JMX (Tomcat restart

needed)

Tomcat Java options,

conf/jmxremote.access,jmxrem

ote.password, per Tomcat

instance No Tomcat Java options

14

Tomcat Wiki Step 4.2 - Configure JVM GC log (Tomcat

restart needed)

Tomcat Java options, per

Tomcat instance No Tomcat Java options

15

Tomcat Wiki Step 4.3 - Check Tomcat logging (Tomcat

restart needed)

Tomcat Java options, per

Tomcat instance No Tomcat Java options

16

Tomcat Wiki Step 5 (BI 4.0 Note 1653689 Step 6.2) - Install

and run SLD Data Supplier

tomcat

sap.com~TomcatSLDDataSuppli

erWEB deployment; run sldreg

for tomcat, per Tomcat instance

No, if user has

write access on

/usr/sap/hostctrl/

exe

sld server Technical

Systems/Other

17 Tomcat - Enable TDA for Tomcat

Tomcat Java option, per Tomcat

instance No

Tomcat Java option:-

Dcom.sap.vm.tag=tomcat_<TOMC

ATSERVERNAME>

18 TDA - Start Jvmmond.exe as OS service

create service UNIX

jvmServiceByACTool;

Win:JvmmondACTool, per

Tomcat instance(s) host

No, if user has

UNIX boot service

creation right, i.c.

/etc/init.d, rc*.d

UNIX process jvmmond;Windows

service JvmmondByACTool

and then do echo $lv_log to get all output.

Solution (for HEC LVM) could be: lv_log=$(unset -v DISPLAY;rm -f logs/*;./run_actool.sh -silentBOE 2>&1;cat logs/*)

Windows

Windows console output cannot be redirected. Please use above general

recommendation, i.c. checking logs/* as output, eventually disable console output.

Data Services

conf/ds.properties is used for Data Service configuration.

The silent configuration could be realized by argument -silentDS, same way as BOE -

silentBOE.

There are 5 steps for Data Services configuration; the 5th one is conditioned or will be done

automatically, so is not shown as a step.

1. Enable SLD support

This step creates slddest.cfg and slddest.cfg.key under <saphostagent.install.path>;

It will send one time sld registration with previous DS JobService starting generated sld_data_services.xml only if <product.host.master.name> and <sld.system.id> has

not been defined or empty in ds.properties file.

2. Update DSConfig.txt for Data Services Cluster This step updateDSConfig with section [AL_JobService] CentralHostForSLD = <product.host.master.name> SystemIDForSLD = <sld.system.id>

This will be used when generating a new sld_data_services.xml for sld registration by

DS server restart. product.host.master.name= <host name> (for Data services cluster scenario, this

parameter should be the central server's <host name>, please refer to the Note 1852508)

3. Enable Saposcol process monitoring

Configure SAP_DS4_${platform}_procmon.ini 4. Enable DS NCS

Configure DSConfig.txt and ncs.conf for NCS on Wily metrics 5. Restart Data Services server (UNIX) or service (Windows) will be mandatory if

<product.host.master.name> or <sld.system.id> has been defined, in order to take

them into account from newly generated sld_data_services.xml by this restart. This could be realized by ds.properties parameter “ds.restart = true” by actool in an

automatic way. In case this is not allowed by actool runner, Data Services server should be restarted manually by authorized user in a second time.

All steps managed system impact and how to check

Repeated invocations

It is supported to repeat same operations multiple times in case of updating input information from boe.properties.

Since v2.0.2, we will no more touch Tomcat console launcher catalina.sh[bat] but

update setenv.sh[bat] to align Tomcat runtime environment customization standard. For Tomcat instance previously configured by actool < v2.0.2, you need to copy

catalina.sh[bat].copy to catalina.sh[bat] for a clean actool run. After this change you

can afterward repeat run_actool.sh[bat].

UNIX platforms

On UNIX system, when Tomcat is running with Wily agent already configured, e.g.

/usr/sap/ccms/wily/ folder exist with lock by Tomcat process. In order to update Wily agent

configuration for this running Tomcat, actool will rename the old folder to oldFolder_$timestamps like

wily_1423321449983. To cleanup those no used files after Tomcat restart, you can run the UNIX shell by

./actool_cleanup_after_tomcat_restart.sh. Please remind that you could only launch it after your Tomcat restarted after actool run, else

you could cause damage to running Tomcat.

BOE and Tomcat variation support

Under folder conf/, the file products.xml is used by actool to enable/disable products/steps.

There are some customized products_*.xml for BOE and Tomcat variations that you could copy it to products.xml before your operation with sap_actool.sh[bat]. For customized usage

that is not found among those variations, you could enable/disable for values True/False in

Product and Step levels as following. Product level

Step level

Step No Description Operations on managed system user root mandatory Final result check

1 DS Enable SLD support for Data Service

sld registration: slddest.cfg and

slddest.cfg.key creation and copy to DS No

sld server Technical

Systems/Other

2 DS - Update DSConfig.txt for Data Service Cluster Configure DSConfig.txt, per DS instance No Configure DSConfig.txt

3

DS - Enable Saposcol process monitoring

Configure

SAP_DS4_${platform}_procmon.ini, per

DS node host

No, if access write on

/usr/sap/tmp/procmo

n

Wily:SAP HostAgent

Process|SAP HostAgent

SMDAXX|SAP

OsCol|MonitoredProcess

es|AL_JobService*

4 DS - Enable NCS

Configure DSConfig.txt and ncs.conf for

Wily metrics, per DS instance No

Wily:SAP HostAgent

Process|SAP HostAgent

SMDAXX|BODS|SAP_DS|$

host|Status|$host_JobSer

ver_$host_$jobsPort|Hea

rtbeat

BOE only (products_boe.xml)

Copy conf/products_boe.xml to conf/products.xml before run run_actool.sh[bat].

IPS aka minBOE only (products_miniboe.xml)

Copy conf/products_miniboe.xml to conf/products.xml before run run_actool.sh[bat].

The BOE steps 8 and 9 have no sense for an IPS mini-BOE installation as they are about

WebI HANA access Wily agent configuration.

Tomcat only (products_tomcat.xml)

Copy conf/products_tomcat.xml to conf/products.xml before run run_actool.sh[bat]. Only support BOE installed Tomcat (Install type: Web Tier). This means the variable in

boe.properties boe.home pointed folder and tomcats*.sh scripts exist. JDK 1.6 could be provided by boe.properties variable jvmmond.install.path=<JDK_BIN>.

Standalone Tomcat installation support

Standalone Tomcat with/without all BOE *.war deployed is supported since v2.1.0.

products_tomcat.xml is used for steps; boe.properties is used for input parameters.

adapt run_actool.sh[bat]

see comment on line “For Standalone Tomcat, uncomment below line and adapt your JDK”

Mandatory parameters to adapt (boe.properties) boe.os.user = (used as Tomcat user) unix.shell = (sh or bash shell absolute path for UNIX only) sld.connectkey.replace = true sld.server.host = sld.server.port = sld.server.user = sld.server.password = sld.server.https = n tomcat.service.port = 8080

tomcat.startup.path = fullPathForTomcatStart like $yourTomcatInstDir/bin/startup.sh tomcat.shutdown.path = fullPathForTomcatStop like $yourTomcatInstDir/bin/shutdown.sh tomcat.home = tomcat.running.mode.WindowsService = false wily.EM.host = wily.EM.port = 6001 jvmmond.install.path =$JAVA_HOME/bin jvmmond.port = 1099 jvmmond.password =

Other parameters could be left as default.

Two new parameters to take care

tomcat.startup.path and tomcat.shutdown.path are 2 new parameters specific for standalone Tomcat. On UNIX or Windows console mode, be sure that environment variable JAVA_HOME is defined in Tomcat user shell startup for these 2 script shell could work properly with a new Tomcat user (defined by boe.os.user) session. If this is not the case, you need to define it to at the beginning of setenv.sh[bat] as Tomcat pre-requisites.

No SolMan (BOLight) RCA support (products_bolight.xml)

For customer not yet aligned to SAP SolMan infrastructure RCA:

products_ bolight.xml is used for steps; boe.properties is used for input parameters.

The step 19 is added especially for BOE NCS configuration on the SMDAgent, installed with

argument SMD_INSTALLATION_SCENARIO=ishub, i.c. no SolMan reporting. You don’t need to be root user to run actool on UNIX, however you need to check you have

enough (read/write) rights on Step 4 on /usr/sap/tmp/procmon/

Step 19 on SMDAgent folder /usr/sap/DXX/SMDAXX/.

Mandatory parameters to adapt (boe.properties) #BOE NCS part boe.system = boe.user = boe.password boe.os.user = (used as BOE user) unix.shell = (sh or bash shell absolute path for UNIX only) boe.cmc.introscope.enable = true boe.cmc.introscope.host = boe.cmc.introscope.port = 6001 boe.cmc.introscope.type = TCP boe.cmc.ncs.level = 10 boe.cmc.smdagent.host = localhost boe.cmc.smdagent.port = 6404 smdagent.path = smdagent.windows.servicename = smdagent.restart = true #BO Tomcat (Web Tier) part wily.javaagent.install = true wily.javaagent.installfolder = wily.EM.host = wily.EM.port = 6001

Other parameters could be left as default.

AIX IBM JDK GC support

When using IBM JDK 6 or 7 IBM J9 VM (build 2.4, JRE 1.6.0 IBM J9 2.4 AIX ppc64-64 jvmap6460sr8ifx-20100609_59383 (JIT enabled, AOT enabled) IBM J9 VM (build 2.6, JRE 1.7.0 AIX ppc64-64 20120322_106209 (JIT enabled, AOT enabled)

The step 14 added option -Xloggc is not compatible with IBM JVM. When Tomcat starts, it

produced error: “JVMJ9VM007E Command-line option unrecognised: -Xloggc:… Error: Could not create the Java Virtual Machine.”

This prevents Tomcat from starting.

To make GC work with IBM JVM powered Tomcat, you need to uncomment the line in

boe.properties #tomcat.ibmjdk.loggc=verbosegclog. This will add in setenv.sh -Xverbosegclog, instaed of -Xloggc.

Supported platforms and products

Constraint

Single user support

Only single user operation on one host is supported; or concurrent users on one host will not

be supported.

Distributed systems (e.g. multiple hosts involved in a BOE cluster)

You need to execute actool for each node host.

BOE and Tomcat restart option

The principle of actool is to add/update managed system landscape information on operating

system, registry, CMS DB, sld DS file before sending etc. Some of them need BOE and/or

Tomcat to restart to take into account those parameters. We recommend to start BOE and/or Tomcat at the end of silent (-silentBOE) run. This is

realized by 2 parameters in boe.properties: boe.node.restart and boe.tomcat.restart. However in most of customer production, that restart is required in second step or by

administrator of BOE and/or Tomcat. In this reason those 2 parameters are set by default to “false”. To enable this automatically restart possibility by actool, set them to “true”.

Potential NCS port conflict

Script 3. BOE - BI 4.x Note 1653689 Step 9 - Enable Introscope for C++ components

At an already configured BOE host, the NCS port (default 6404) could be used. Actool will still configure it with some warnings in logs as [WARN]: Port is being used. Port checking status shows that the port is being used. Please double-check whether this is the port that BOE is using.

More details for updating BO servers' port you can refer to the Admin GUID of BIP :

BIP admin Guide (e.g. sbo41sp2_bip_admin_en.pdf) -- Server Administration -- Configuring server network settings -- Configuring port numbers

More details for NCS port define you can refer to the WIKI : https://service.sap.com/sap/support/notes/1975394

Change Node dewdftvi2094p => NCSInstrumentLevelThreshold to 10

actool PAM BI XI4.x Data Services 4.x

XI4.x installed Tomcat

(Web Tier)

Standalone Tomcat

(BOE.war deployed)

Windows ntamd64 Yes Yes Yes Yes

Linux x86_64 Yes Yes Yes Yes

AIX rs6000_64 Yes Yes Yes Yes

SUN Solaris SPARC 64 Yes Yes Yes Yes

If this happens at your first actool run time, you need to choose another port for NCS;

If you are in repeated invocation, you just ignore it: you could use the same as previous run or update to another port number.

Step 18 runtime Windows service

The Windows service created by step 18 “JvmmondByACTool” is dependent of a bat file under actool root_dir\toolkit\startService.bat, which is defined in

file %windir%\jvmmonService\path.txt.

This implies that the folder root_dir\toolkit should not be removed after actool usage.

Component ID

Component ID for Incident: SV-SMG-DIA (SAP Note 1653689)

Bug reporting

Customer Incident or Internal Incident thru CCS with above component ID. To create a .zip file including log files under folder “logs/*”, which is to be attached to

incident for support investigation. Sap note for actool is 2137275.

More references

actool steps (from 12 to 18) referenced as “Tomcat Wiki”:

http://wiki.scn.sap.com/wiki/display/SMSETUP/Managed+System+Setup+of+Apache

+Tomcat+System+in+Solman+7.1 TDA reference: SAP note 1608714