Call SAP Function activity

An activity that calls a function in an SAP database. This activity can be used alone to call a single function, or with other Call SAP Function activities, and Begin and End SAP Transaction activities, to create a more complex transaction.


Call SAP Function activity

Configure the Call SAP Function activity

To configure the Call SAP Function activity, do the procedure in this topic.

Prerequisites

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the SAP Integration SAP Integration icon tab.
      2. On the SAP Integration SAP Integration icon tab, drag the Call SAP Function Call SAP Function icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a SAP Activity.

  2. Click Call SAP Function Call SAP Function icon.
  3. Complete the fields on the SAP Configuration screen.
  4. (Optional) Click Advanced Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Call SAP Function activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Transaction Name

Function:
Specifies a name for the SAP transaction.

If you use a Begin Transaction activity, a session starts with the transaction name and in End Transaction activity if you give the same name, the session is closed. Between these two activities, you can use one or more Call SAP Function activities with or without transaction names. If you give the same transaction name as in Begin Transaction activity, it will use the same session. If not, it will create a new session. In this way, you can use the same session for all SAP calls.

Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No

SAP Configuration

Configures the SAP connection and maps the SAP data to your schema.

Figure: SAP Configuration > Input tab

SAP Configuration Input tab

Fields

Field Name Definition

SAP

Function:
Specifies the access token that connects to your SAP system.

If the Connection Mode specified in your access token is User, you can configure the Advanced Configuration tab to connect to the SAP database with the form user credentials.

Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None
Accepts Process Data Variables:
No

Add Token Add Token icon

Opens this Screen:
Access Token for SAP
Function of this Screen:
Configure an access token to connect to SAP.

BAPI Method Name

Function:
Specifies the name of the BAPI method.
Accepted Values:
A valid BAPI method name.

Click the Schema Mapping Schema Mapping icon button to open the BAPI Method Search Results screen and select a method.

Default Value:
None
Accepts Process Data Variables:
No

Input Mapping

Function:
Connects the SAP API input parameter to your schema.
To Open this Field:
  1. On the SAP Configuration screen, click the Input tab.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the input to the data model for your process.

Default Value:
None

Output Mapping

Function:
Connects the SAP API output parameter to your schema.
To Open this Field:
  1. On the SAP Configuration screen, click the Output tab.
Accepted Values:
Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

Use this screen to connect the output to the data model for your process.

Default Value:
None

Use end user credentials from secure credential store

Function:
Specifies to connect to the SAP database with the credentials of the user who completes the eForm.

This improves the security and traceability of an SAP transaction.

The form user must have an SAP user account.

To Open this Field:
  1. On the SAP Configuration screen, click the Advanced Configuration tab.
Accepted Values:
  • Selected - Lets you use the credentials of the specified user to connect to SAP database.
  • Deselected - Does not let you use the credentials of the specified user.
Default Value:
Deselected

User Name

Function:
Specifies the user name of the person whose credentials are used to connect the SAP database.
To Open this Field:
    1. On the SAP Configuration screen, click the Advanced Configuration tab.
    2. Click User Name.
Accepted Values:
Default Value:
None
Accepts Process Data Variables:
Yes

Clear SAP credentials secure credential store after successful completion of the task

Function:
Deletes the SAP user password in the AgilePoint database after the task is complete.

By default, the password is encrypted when it is stored in the AgilePoint database, and is deleted when the process instance is complete.

To Open this Field:
On the SAP Configuration screen, click the Advanced Configuration tab.
Accepted Values:
  • Selected - Deletes the user password from the AgilePoint database after the task is complete.
  • Deselected - Deletes the password when the process instance is complete.
Default Value:
Deselected