Registration

Dear SAP Community Member,
In order to fully benefit from what the SAP Community has to offer, please register at:
http://scn.sap.com
Thank you,
The SAP Community team.
Skip to end of metadata
Go to start of metadata

Using the Parameters

When dealing with the End-User Experience Monitoring scenario, it is possible to define a set of parameters to take effect over a script execution. These parameters can be set in the editor or in the Solution Manager system directly.

 

Setting the Parameters in the Script Editor

When editting the scripts inside the EEMEditor, it is possible to set parameters and test them before uploading the script to the Solution Manager. For this, click on the button “Script Configuration”.

Then navigate through “Advanced” -> “Parameters”. Here you’ll be able to add the parameters under the section “Configuration Parameters”.

The scope in which you’ll be setting/editting the parameters can be selected on the top left corner of the screen, under the drop menu named “Configuration Scope”.

Setting the Parameters in the Solution Manager System

When the script has already been uploaded to the solution manager and properly assigned to a scenario, it is possible to set/edit parameters directly through the Solution Manager. For this, access the SOLMAN_SETUP and navigate through “Technical Monitoring” -> “End-User Experience” -> step 4 “Monitoring”.

List of Parameters

Parameter

Type

Category

Function

Example

abort.result.status

Integer

Common

Result status of messages that triggers termination of the script

 

4= failed

3= protocol error

2= response check failed

 

 

 

editor.disablemultiexecutionview

Boolean

Common

Disable multiple execution windows

 

Set this parameter to true will make sure you will only get one execution view window

 

editor.expertmode

Boolean

Common

Run the editor in expert mode

 

Expert mode enables you to upload script to agents directly and check the status of agents right in the editor. A restart of the editor is required to make this property take effect.

 

http.certificateWarningPeriodDays

Integer

HTTP / Network

warning period for certificates about to expire

 

server certificates that are about to expire within the given number of days lead to a PROTOCOL_ERROR

 

http.checkForStaleConnections

Boolean

HTTP

Check for stale connections

 

Check if a http connection is stale before sending a request. A connection is stale if it was closed by the server. By default this is not detected in the http client and may lead to a response like "server not responding". Checking for stale connections may impose an overhead in the response time of about 1ms per request.

 

http.cookiepolicy

String

HTTP / Network

Cookie policy for all requests

 

The cookie policy which will apply to all http requests. Accepted value are: compatibility, netscape, rfc2109, ignoreCookies, unlimited. Default is unlimited.

 

http.decodeResponse

Boolean

HTTP

Decode response

 

Decode http response before processing searches and checks on it. This is necessary to cope with additional encoding that is done to prevent XSS (cross site scripting)

 

http.ignoreCertificate

Boolean

HTTP / Network

Ignore Certificate

 

Dont't verify certificates from server side

 

http.preemptiveAuthentication

Boolean

HTTP

Preemptive authentication

 

Directly send authentication with the first call of credentials are already available in the script instead of first receiving a 401 response

 

http.proxy.enable

Boolean

HTTP / Network

Enable Http Proxy for all Requests

 

http.proxy.exceptions

String

HTTP / Network

Requested hosts that will bypass Http Proxy for all Requests

 

http.proxy.host

String

HTTP / Network

Host for the Http Proxy

 

http.proxy.port

Integer

HTTP / Network

Port for the Http Proxy

 

http.proxy.user

String

HTTP / Network

User for the Http Proxy

 

http.timeout.connect

Integer

HTTP / Network

Timeout for Http Connections [seconds]

 

The maximum time to wait when trying to establish a network connection to the Http server.

 

http.timeout.so

Integer

HTTP / Network

HTTP socket read timeout [seconds]

 

Sets the timeout for reading HTTP responses: waiting for a HTTP response will be terminated if there is no data after reaching this timeout.

 

left.variable.boundary

String

Common

Left boundary for variable references

 

log.content

Boolean

Common / Logs

Logging of full content, e.g., for troubleshooting in a protocol-specific way. For HTTP this means logging of all request and response bodies in addition to the content of the BusinessTransaction.xml.

 

log.on.error

Boolean

Common / Logs

Generate additional log files if an error occurs during execution

 

log.redirect.to.temp

Boolean

Common / Logs

Redirect agent logs to temp directory

 

Redirect agent logs for a particular execution to the temp directory.

 

password.

String

 

Prefix for password maintained in Editor scope

 

rfc.connections

String

Common / RFC

RFC connection identifiers

 

Comma-separated list of identifiers that point to connection labels

 

rfc.paramReady

Boolean

Common / RFC

Parameters available?

 

Indicates whether parameters have already been generated for the script.

 

rfc.tracelevel

Integer

Common / RFC

RFC trace level

 

RFC and JCO trace level. 0 means no trace, 1 means full trace.

 

right.variable.boundary

String

Common

Right boundary for variable references

 

sapgui.attach

Boolean

SAPGUI

Try to attach to existing SAPGUI instead of creating one.

 

If set to true, the execution engine will try to connect to an existing SAPGUI instance. Only if this fails, a new one will be created.

 

sapgui.componenttrace

Boolean

SAPGUI

Create a dump of the complete tree of UI elements

 

Calculating the complete tree of all UI elements after each dialog step is quite expensive. For this reason, this option should not be active when scripts are deployed. It should only be used for troubleshooting.

 

sapgui.hardcopy

Boolean

SAPGUI

Create hardcopy images of SAPGUI screens after each message

 

This option is currently only available in the Editor - not in the SMDAgent.

 

sapgui.suppressbackendpopups

Boolean

SAPGUI

Suppress popups from SAPGUI backend.

 

Avoids popups about failed connections that would block script execution on robot side. By default popups are always suppressed on robot, but not in the editor. Unfortunately no error message is available if the popup is suppressed.

 

sapgui.theme

String

SAPGUI

Set the SAPGUI theme for rendering.

 

Supported values are Classic, Enjoy, Signature, and empty. Note that the titl UI element is not available in the classic theme.

 

sapgui.timeout

Integer

SAPGUI

Timeout (sec)

 

If a SAPGUI round trip has not come back after this timeout the current execution of the script will be terminated.

 

schedule.absolute.offset

Boolean

Common / Schedule

Decide whether offset should be aligned to the system clock on robots.

 

schedule.iterations

Integer

Common / Schedule

Iterations of script within a single execution

 

The script can be iterated multiple times within a single scheduling time slot.

 

schedule.min.autotrace.period

Integer

Common / Schedule

Minimum delay between two automatic executions with trace (seconds)

 

Automatically trigger additional execution with trace if no execution with trace was done within the given period. 0 means never trigger an automatic execution. Recommended minimum value: 3600 (once per hour).

Automatic Trace run

schedule.offset.seconds

Integer

Common / Schedule

Specifies a start delay with which you can specify an EEMon robot start sequence. You must specify a start sequence for EEMon scripts that, when executed, lock the relevant business process for other users, for example, changing database entries when booking a flight. A start sequence can prevent the EEMon robots from executing an EEMon script simultaneously and blocking each other.

 

The start delay must be at least the time it takes to execute the EEMon script. Typically it will be a factor of several times the runtime.

You have several robots with the same script, which runs for about 40 seconds. Retain the default setting “0” for the EEMon robot that is to be run first. To delay the next EEMon robot for 300 seconds, enter the value 300. The third EEMon robot is assigned the value 600, and so on.

schedule.period.seconds

Integer

Common / Schedule

The measurement interval, that is, how often an EEMon robot is to run an EEMon script.

 

To prevent EEMon robots from blocking each other, the measurement interval must be longer than the duration of all executions of the EEMon script by all EEMon robots.

You specify that you monitor a business process which runs on a particularly sensitive system, more frequently than the default interval of 600 seconds. The EEMon script runs for one minute. It is executed by five EEMon robots. You specify an interval of at least 300 seconds.

schedule.startTime

String

Common / Schedule

Specifies a fixed starting time for EEMon robots. You specify the local time of the host. The accuracy depends on the accuracy of the host's system clock.

 

Enter the time in the format HHMM, 1530, for example.

You know the time at which a specified business process is performed. You can, for example, with a default measurement interval of 10 minutes, start the EEMon robot five minutes earlier to compare the behavior of the systems five minutes before and after starting the business process.

semaphore.define.

Integer

Common / Schedule

Number of Concurrent Scripts Allowed per Agent

 

This setting defines the number of scripts that may be active concurrently.

 

semaphore.define.default

Integer

Common / Schedule

Number of Concurrent Scripts Allowed per Agent

 

This setting defines the number of scripts that may be active concurrently. If the schedule would launch more scripts concurrently, the execution of the scripts will be queued. A value of 1 means all scripts are executed sequentially on the robot.

 

semaphore.define.sapgui_openconnection

Integer

Common / Schedule

Number of Concurrent SAPGUI Connection Attempts Allowed per Agent

 

This setting defines the number of scripts that may try to open SAPGUI connections concurrently. If the schedule would launch more scripts concurrently, the execution of the scripts will be queued. The queue time will not be added to the response time of the message. A value of 1 means all scripts are executed sequentially on the robot. This semaphore is used to address the SAPGUI limitation that concurrent attempts to open a SAPGUI connection may lock each other.

 

semaphore.use.

Boolean

Common / Schedule

Decide Whether Script Serialization Should be Used

 

This parameter decides on the participation in script serialization. If set to true, the scripts will be serialized and at most semaphore.define.default scripts may be active in parallel. This property can be set on a per-script level, allowing to exclude some scripts from serialization.

 

semaphore.use.default

Boolean

Common / Schedule

Decide Whether Script Serialization Should be Used

 

This parameter decides on the participation in script serialization. If set to true, the scripts will be serialized and at most semaphore.define.default scripts may be active in parallel. This property can be set on a per-script level, allowing to exclude some scripts from serialization.

 

solman.client

String

Common

Solution Manager User for EEM Repository (Client)

 

solman.host

String

Common

Solution Manager User Host Name

 

solman.password

String

Common

Solution Manager User for EEM Repository (Password)

 

solman.port

String

Common

Solution Manager Http(s) Port for Web Service Calls

 

solman.secure

Boolean

Common

Secure connection to Solution Manager

 

Decides about protocol for Solution Manager connection (http or https)

 

solman.user

String

Common

Solution Manager User for EEM Repository (User Account)

 

User account on Solution Manager for accessing the repository.

 

success.required.steps

Integer

Common

Number of required successful steps to consider the script as successful

 

technical.scenario.name

String

Common

Technical Scenario Name

 

threshold.Step-4

 

 

 

 

thresholdYtoR.Step-4

 

 

 

 

trace.dynamic.server.selection

Boolean

Common / Logs

Decide whether system time selection is done dynamically

 

In some cases the system selection during system time/trace collection cannot be done dynamically. For example when a script is calling an action from ABAP to JAVA or if a proxy deletes some cookies from http request.

 

trace.e2etracelevel

Integer

Common / Logs

Specifies the resolution of the trace data logged by an EEMon robot.

 

The resolution value is coded as a four-digit number.

 

To generate this type of code for a specific trace level, you can use the administration dialog box in EEMon monitoring and copy the code manually. For more information about generating the code, see Changing Parameters Temporarily for Error Analysis.

You can, for example, choose the trace level Medium for a performance trace. For more information about the meaning of the various trace levels, see Trace Analysis.

 

 

trace.retain.period.hours

Integer

Common / Logs

Trace retention period (hours)

 

This is the minimum period of time during which BusinessTransaction.xml files are kept on the agent. Since this is also the frequency of the periodic housekeeping task, the actual maximum file age is twice this period.

 

truststore.password

Secure

HTTP

trust store password

 

The trust store contains additional certificates that should be accepted as trusted from the server. By default, all trusted root certificates of the Java VM installation (cacerts file) are considered as trusted.

 

workmode.

String

 

Workmode settings

 

workmode.current

String

 

Current work mode of a robot

 

workmode.enabled.

Boolean

 

Decide whether script reacts on work mode

 

Decide whether a script should be active for the given work mode. False=script will be stopped if the given work mode is active.

 

wsnotify.enable

Boolean

Common

Enable notifications about completed scripts from SMDAgent to Solution Manager

 

wsnotify.factory

String

Common

Factory for sending result notifications

 

Currently the only supported value is SOAP

 

wsnotify.password

String

Common

Password of the account for notifications on ABAP stack.

 

wsnotify.proxy.enable

Boolean

Common

Indicate whether a proxy should be used for notifications.

 

wsnotify.proxy.host

String

Common

Proxy host for notifications.

 

wsnotify.proxy.password

Secure

Common

Proxy password for notifications.

 

wsnotify.proxy.port

Integer

Common

Proxy port for notifications.

 

wsnotify.proxy.user

String

Common

Proxy user for notifications.

 

wsnotify.socket.timeout

Integer

Common

Socket timeout for notification calls (unit: ms).

 

wsnotify.url

String

Common

Complete URL for notifications.

 

wsnotify.user

String

Common

User account for notifications on ABAP stack.

 

 

  • No labels