Call 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 Function activity

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

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the SAP Integration tab.

    Open SAP Integration
  3. On the SAP Integration tab, drag the Call Function activity onto your process.

    Drag Call Function

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 Function Call SAP Function icon.
  3. Complete the fields on the SAP Configuration screen.
  4. (Optional) Click Advanced Advanced icon > Email Notifications E-mail Notifications icon.

    For more information, refer to Email Notifications screen (Process Activities).

General Configuration

Specifies the basic settings for the Call Function activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Transaction Name

Description:
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.

Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No

Call Function Configuration screen

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

Figure: Call Function Configuration > Input tab

Call Function Configuration Input tab

Fields

Field NameDefinition

SAP

Description:
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 runtime app user credentials.

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

Create 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

Description:
Specifies the name of the BAPI method.
Allowed 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 Variables:
No
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Input Mapping

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

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

Default Value:
None
Example:
Refer to:

Output Mapping

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

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

Default Value:
None
Example:
Refer to:

Use end user credentials from secure credential store

Description:
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 runtime app user must have an SAP user account.

To Open this Field:
  1. On the SAP Configuration screen, click the Advanced Configuration tab.
Allowed 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

Description:
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.
Allowed Values:
Default Value:
None
Accepts Variables:
Yes

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

Description:
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.
Allowed 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