Panel
Table of Contents

Anchor
1154647 1154647

Syntax

execsap host={host-name|destination} type={event|generic} [eventid=event-id] [parm=event-parm] [client=client] [user=userid] [pwd=password] [codepage=codepage] [file=filename | xfile=filename [key=key]] [mergelog=yes|no] [trace=yes|no]

Anchor
1154654 1154654

Description

Anchor
1154655 1154655

The execsap command executes SAP events if you have a licensed version of the Universal Connector (version 3.1.1 or later) on the same system with the UDM Manager.

Note
title Note
UDM does not support the execsap command for IBM i and Windows.

Anchor
1154657 1154657

The first parameter of the execsap command is either:

• Host parameter with an SAP destination entry
• Name of a destination in your SAP RFC file

Anchor
1154660 1154660

The type parameter specifies the type of action being performed. A specified type of event requires that an SAP event ID be specified with the eventid parameter.

Note
title Note
For Agent 5.2.0 and later, the only valid type is event, which triggers an SAP event.

Anchor
1154662 1154662

An event parameter can be passed to the SAP event using the parm parameter. The client parameter specifies the SAP client.

Anchor
1154663 1154663

UDM must authenticate a user SAP in order to execute an SAP action. The user id and password can be specified with the user and pwd parameters, respectively.

Anchor
1154664 1154664

The codepage value is inherited from the UDM Manager's configuration file unless overridden explicitly in the call to the execsap command. codepage specifies to which codepage the output of the remote command is translated.

Anchor
1154666 1154666

The user, pwd, and codepage parameters can be stored in an external file instead of being specified explicitly in the execsap command syntax.

• If a plain text file is used, the file parameter specifies the name of this file.
• If the file was encrypted with Universal Encrypt, the xfile parameter specifies the name of this file.

Anchor
1154669 1154669

If an encryption key other than Universal Encrypt's default was used, that key can be specified with the key parameter.

Anchor
1154670 1154670

These options and the format of the file containing these options work exactly like the corresponding option in the open command.

Anchor
1154671 1154671

Two streams of data come back from the SAP execution. By default, output from standard out and standard error is written to standard out and standard error by the UDM Manager (SYSPRINT and SYSOUT, respectively, under z/OS). The mergelog parameter can be set to yes if you want both output streams written to the UDM transaction log (standard out under UNIX, Windows, and IBM i; SYSPRINT under z/OS).

Anchor
1154672 1154672

By default, if the UDM Manager is invoked with tracing turned on, tracing will be turned on in Universal Connector when UDM invokes it via the execsap command. Likewise, if trace is turned off in the UDM Manager, Universal Connector is invoked with tracing turned off. You can override this behavior for Universal Connector invocation by setting the trace option in the call to the execsap command.

Anchor
1154673 1154673

Parameters

HTML Table
cellspacing 0 style text-align: left; width: 100%; class Table_with_Header
Table Row (tr) Table Cell (td) style background-color: #F0F0F0; border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: middle; width: 144pt; Anchor 1154677 1154677 Parameter Table Cell (td) style background-color: #F0F0F0; border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: middle; width: 360pt; Anchor 1154679 1154679 Description Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154681 1154681 host=hostname | destination Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154683 1154683 SAP destination entry or, if host=hostname format is used, the name of a destination in your SAP RFC file. Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154685 1154685 type=event | generic Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154687 1154687 Type of action (event is the only type supported under UDM 5.2.0). Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154689 1154689 eventid=event-id Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154691 1154691 ID of the SAP event to trigger. Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154693 1154693 parm=event-parm Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154695 1154695 Passes an event parameter to the SAP event. Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154697 1154697 client=client Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154699 1154699 SAP client for which to perform the action. Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154701 1154701 user=user-id Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154703 1154703 User ID (user) and password (pwd) are inherited from the same parameters specified in the open command for that logical name. These values can be overridden by specifying them explicitly in the execsap command. Note title Note If a host name is used (instead of a logical name), a user ID and password must be specified explicitly in the execsap command. Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154706 1154706 pwd=password Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154708 1154708 User ID (user) and password (pwd) are inherited from the same parameters specified in the open command for that logical name. These values can be overridden by specifying them explicitly in the execsap command. Note title Note If a host name is used (instead of a logical name), a user ID and password must be specified explicitly in the execsap command. Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154711 1154711 codepage=codepage Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154713 1154713 Codepage to which the remote command output is translated. The codepage is inherited from the UDM Manager's configuration file unless overridden explicitly in the call to the execsap command. Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154715 1154715 file=filename Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154717 1154717 Plain text file containing the values for the remote execution server: user, pwd, and codepage Anchor 1154718 1154718 These values override any corresponding values specified for the transfer server in the open command. Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154720 1154720 xfile=filename Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154722 1154722 Universal Encrypted text file containing the values for the remote execution server: port, user, pwd, and codepage. These values override any corresponding values specified for the transfer server in the open command. Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154724 1154724 key=key Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154726 1154726 Key used to decrypt the file specified by the xfile parameter. If this parameter is not present, the default key for Universal Encrypt is used. Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154728 1154728 mergelog=yes | no Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154730 1154730 Specification for whether or not to merge the two streams of data that come back from the remote command to the UDM transaction log (SYSOUT under UNIX, Windows, and IBM i; SYSPRINT under z/OS). Anchor 1154731 1154731 By default, output from standard out and standard error of the remote command are written to standard out and standard error by the UDM Manager (SYSPRINT and SYSOUT, respectively, under z/OS). Anchor 1154732 1154732 Default is no. Table Row (tr) Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154734 1154734 trace=yes | no Table Cell (td) style border-bottom-color: #E8E8E8; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #E8E8E8; border-left-style: solid; border-left-width: 1px; border-right-color: #E8E8E8; border-right-style: solid; border-right-width: 1px; border-top-color: #E8E8E8; border-top-style: solid; border-top-width: 1px; padding-bottom: 3pt; padding-left: 4pt; padding-right: 4pt; padding-top: 4pt; vertical-align: top; Anchor 1154736 1154736 Overrides the trace behavior of the Universal Command Manager when invoked via the execsap command. Anchor 1154737 1154737 Default is trace value of the UDM Manager.

Anchor
1042420 1042420

execsap Command Example

Anchor
1042422 1042422

The following is an example of executing an SAP event using the execsap command:

Panel
execsap sapdest type=event eventid=MYEVENT parm=MYPARM + user=me pwd=mypwd

Additional Information and Examples

For additional execsap command information and examples, see Universal Data Mover - Remote Execution for SAP Systems.