Skip to main content
Feedback

Create a Function Module

When you have found the Function Module you want to expose as a service, drag and drop it onto the canvas or double-click it. When unsupported FMs are dragged onto the canvas, they are highlighted to distinguish them from supported FMs.

If you choose the wrong Function Module, you can click on the correct one and drag and drop it again. The former Module will disappear and be replaced with the new Module.

Function Module dragged onto canvas for service creation

Click the Document icon next to the FM's name to open its documentation in PDF format.

Configure Service This section explains the Function Module elements used to create a service. The JSON schema definition adds a pre-pending letter indicating which kind of parameter is related. The highlighted text shows these:

Import - "I_": Input parameters

Export - "E_": Output parameters

Changing - "C_": Changing parameters

Tables - "T_" Tables are both in and out, and change depending on the individual Module. Technically, tables can be viewed as changing, with "out" and "evolving" representing different data types. Tables will always be tables.

note

The request does not include mandatory tables; Boomi for SAP Core will automatically insert a null array when communicating with SAP. Add a null array to the corresponding key in the input Function Module JSON document to include optional tables in the output. For example, "T_table_name": null or "T_table_name": [].

Exceptions Exceptions indicate which errors the modules have specified as possible errors. Take the possible exceptions into account when developing Boomi processes. The exceptions can be class-based. The figure below shows an example of a Function Module that does not contain exception classes but includes two expected errors when calling the function.

Function Module exception classes and expected errors

The Import, Export, Changing, or Tables Function Module elements contain the following parameters:

  • Parameter name: Name of the parameter included in the import of the Function Module

  • Mandatory: The checkbox marks the parameter as required.

  • Type: The type indicates the technical details of the parameter. If a description exists, This page will also display it. To view the details, hover over the colored circles.

  • Default value: Information provided by SAP. The system will default to sending the value if a default value is defined.

  • Documentation: This feature displays the available documentation. Documentation is not available in all cases.

  • Associated type: This section will illustrate the related type if a parameter defines an object type.

Function Module parameters including type and default values

Available parameters

The availability of Changing and Table parameters of FM services in the response is based on if you select the Mandatory checkbox.

  • If selected: the parameter is added to the response by default even if not mentioned in Input payload.
  • If left blank: the parameter is added to the response only if mentioned in Input payload.

If you choose to make the parameters Optional, the Changing and Tables parameters will need to be added to the input of FM services, along with existing importing parameters. There are two methods to achieve this:

  • Passing parameters through connector parameters (current approach)
  • Passing parameters through JSON payload string (available with version 1.7 and higher).
note

Passing parameters through JSON payload string is recommended for future implementations of Boomi for SAP.

Demonstration through Connector parameter with example : BAPI_PRODORD_GET_DETAIL

  • Add the required tables parameter in the connector parameters and set any default value for any parameter field. It ensures Tables parameter is passed to Payload.

    This adds a record in Tables Parameter.

    T_HEADER-BATCH is passed as A. T_POSITION-BATCH is passed as A.

    BATCH (IMPORT/Object/T_HEADER/Array/items1/Object/BATCH)

    FM connector parameter with table and batch values FM connector parameter example for BAPI PRODORD GET DETAIL

During the execution if the Table/Changing parameter gets overwritten in the function module, the Extracted Table data will be available in export payload.

If the Table/Changing parameter is appended, the extracted Table data along with import record (Record passed at Connector parameter) will be available in export payload.

Demonstration through input payload as JSON string with example : BAPI_PRODORD_GET_DETAIL

  • We have to include Required optional Table parameters and Changing parameters along with importing parameters in the Input payload as JSON string and pass through the message component instead of Connector Parameters.

FM JSON string input payload passed via message component

Prepare the importing parameters with required optional Changing and Tables in JSON format based on the Request Profile of operation.

FM message component with JSON payload and table parameters

Example Payload: Adding T_HEADER, T_POSITION, and T_SEQUENCE will include Table parameters in the response payload. This works similarly for all other Function modules.

'{
  "I_NUMBER": "000060003845",
  "I_ORDER_OBJECTS": {
    "HEADER": "X",
    "POSITIONS": "X",
    "SEQUENCES": "X",
    "OPERATIONS": "X",
    "COMPONENTS": "X",
    "PROD_REL_TOOLS": "X",
    "TRIGGER_POINTS": "X",
    "SUBOPERATIONS": "X"
  },
  "T_HEADER": [],
  "T_POSITION": [],
  "T_SEQUENCE": []
}’

Test a Function Module

Before you finalize a service, you can test a Function Module (FM) directly in Boomi for SAP — similar to running SE37 in the SAP GUI.

  1. Select TEST in the upper right corner of the Function Module canvas to open the test dialog.
  2. Select the FM you'd like to test from the Select a function module* dropdown box.
  3. Once you select a module, the dialog only shows relevant available parameters for that FM. It is common for FMs to use a combination of parameters instead of requiring them all.

Import Parameters tab showing missing required fields

  1. Populate each parameter tab based on their data type:
    • Scalar (string or numeric): Enter the value directly in the input field.
    • Structure (object): Click Edit Structure to open the Structure Editor, where each field in the structure is listed with its type, length, and validation pattern. Each field in the structure is listed on the left with its type and constraints; enter values in the corresponding input on the right. Click Clear to reset all fields, or use the back arrow to save your entries and return to the main dialog. If any entries fail validation, the editor blocks the save and scrolls to the first error.
    • Table (array): Click Edit Table to open the Table Editor, where you can add, edit, and remove rows. Each row is displayed as its own column (Entry 1, Entry 2, and so on), so you can scroll horizontally to review or edit large datasets. Use Add Entry to append a new row, and the X in a column header to remove a row (the first entry can't be deleted). Clear resets all rows.
  2. Once all the required fields are filled in, select TEST. If validation fails, Boomi for SAP blocks the run and highlights what's missing — the test doesn't execute until all required Import, Table, and Changing fields have values.
  3. A successful test run returns a confirmation message. An Export Parameters section also the FMs output:
  • Scalar results display as plain text.
  • Structure results include a View Structure link to inspect the returned fields (read-only).
  • Table results include a View Table link to inspect the returned rows (read-only).

Successful test execution with Export Parameters

Once the test is complete, the Import, Table, and Changing sections become read-only — this preserves the exact inputs that produced the result you're reviewing. From here you can:

  • Reset: Clear the current module's inputs and results to test it again from scratch.
  • Test Another: Select a different Function Module. The form and lock state reset automatically.
  • Close: Exit the test dialog and return to the canvas.
On this Page