Calling SAP Function Modules

const rfcInputs = {
    INT2_FIELD: 2, // or "2" (as a string)
    ACCP_FIELD: "202202", // for 2nd period of 2022
    TIMS_FIELD: "11:33:21",
    CLNT_FIELD: "001",
    DEC_FIELD: 22.121,
    CURR_FIELD: 27.5,
    INT1_FIELD: 1, // or "1" (as a string)
    UNIT_FIELD: "EA",
    FLTP_FIELD: 23.4413212321,
    INT4_FIELD: 4, // or "4" (as a string)
    RAW_FIELD: [10, 82, 57, -49, -32, 106, 30, -25, -118, -99, 26, 121, -86, 94, 8, 106],
    QUAN_FIELD: 100.123,
    CHAR_FIELD: "character field",
    PREC_FIELD: 123, // or "123" (as a string)
    DATS_FIELD: "20220224", // for 24th February 2022
    LANG_FIELD: "E",
    CUKY_FIELD: "GBP",
    NUMC_FIELD: "0123"
}

bapiXmiLogin(interfaceName: string, version: string): boolean

rfcConnection.bapiXmiLogin("XBP", "3.0");
// your RFC calls here
rfcConnection.bapiXmiLogoff("XBP");

bapiXmiLogin(extcompany: string, extproduct: string, interfaceName: string, version: string): boolean

rfcConnection.bapiXmiLogin("your_company_name", "your_product_name", "XBP", "3.0");
// your RFC calls here
rfcConnection.bapiXmiLogoff("XBP");

bapiXmiLogoff(interfaceName: string): void

beginContext(): void

endContext(): void

getFunction(rfcFunctionName: string): RFCJCOFunction

execute(): RFCJCOFunction

result(parameterName: string): any

const func = rfcConnection.getFunction('Z_TEST_FM')
         // Supply any parameters needed here
         .execute();

const myValue = func.result("EV_VALUE");
// Where EV_VALUE is an exporting parameter on function module Z_TEST_FM

const changingValue = func.result("CV_VALUE");
// Where CV_VALUE is a changing parameter on function module Z_TEST_FM

const table = func.result("T_VALUE")
// where T_VALUE is a table parameter on function module Z_TEST_FM
table.length; // Provides number of rows
table[0].COLUMN; // Retrieves 1st records' value of field COLUMN

const { COLUMN: aValue } = func.result("ES_STRUCT");
// where ES_STRUCT is an exporting structure of function module Z_TEST_FM
// aValue is then the same value as `func.result("ES_STRUCT").COLUMN`

results(): object

const func = rfcConnection.getFunction('Z_TEST_FM')
         // Supply any parameters needed here
         .execute();

const allResults = func.results();
// Returns all the 'outputted' values from executing a function module (exporting, changing & table parameters)

const changingValue = allResults.CV_VALUE;  // Same as func.getResult("CV_VALUE")
// Where CV_VALUE is a changing parameter on function module Z_TEST_FM

// The benefit of func.results() is to utilise Javascript destructuring, e.g.
const { CV_VALUE: changingValue, T_VALUE: tableValue } = func.results()
// where T_VALUE is a table parameter on function module Z_TEST_FM
// This gives you the same as func.result("CV_VALUE") and func.result("T_VALUE") in one line

table.length; // Provides number of rows
table[0].COLUMN; // Retrieves 1st records' value of field COLUMN

withParameter(parameterName: string, value: any): RFCJCOFunction

const func = rfcConnection.getFunction('Z_TEST_FM')
         // Primitive domain type importing parameter
         .withParameter("IV_PARAM", "TEST")
         // Flat table type importing parameter
         .withParameter("IT_PARAM", [
                 "ITEM 1",
                 "ITEM 2"
         ])
         // Table of structured importing parameter
         .withParameter("IT_PARAM_T", [
                 {
                     COLUMN_1: "VALUE"
                 }
         ])
         // Structured changing parameter
         .withParameter("CS_INPUT", {
             FIELD1: "TEST",
             FIELD2: 21.11,
             FIELD3: "X"
         }),
         // Tables parameter T_TAB with 2 records
         .withParameter("T_TAB", [
             // Row 1
             {
                 VALUE1: "TEST",
                 // ... other fields
             },
             // ROW 2
             {
                 VALUE1: "TEST2",
                 // other fields
             }
         ]);

withParameters(parameters: object): RFCJCOFunction

const func = rfcConnection.getFunction('Z_TEST_FM')
         .withParameters({
             // Primitive domain type importing parameter
             IV_PARAM: "TEST",
             // Flat table type importing parameter
             IT_PARAM: [
                 "ITEM 1",
                 "ITEM 2"
             ],
             // Table of structured importing parameter
             IT_PARAM_T: [
                 {
                     COLUMN_1: "VALUE"
                 }
             ],
             // Structured changing parameter
             CS_INPUT: {
                 FIELD1: "TEST",
                 FIELD2: 21.11,
                 FIELD3: "X"
             },
             // Tables parameter T_TAB with 2 records
             T_TAB: [
                 // Row 1
                 {
                     VALUE1: "TEST",
                     // ... other fields
                 },
                 // ROW 2
                 {
                     VALUE1: "TEST2",
                     // other fields
                 }
             ]
         });

getClients(): string[]

// Call a function module (Z_TEST_FM) on each client in the system
sap.clients.forEach(client => {
  const func = sap.login(client).getFunction('Z_TEST_FM')
           // Supply any parameters needed here
           .execute();

  // Do something with the function module results
});

getSid(): string

isRemote(): boolean

isSapControlAvailable(): boolean

login(client: string): RFCHost

const func = sap.login("100").getFunction('Z_TEST_FM')
         // Supply any parameters needed here
         .execute();

// Do something with the function module results

loginWith(credentials: any): RFCHost

const func = sap.loginWith("namespace.userx").getFunction('Z_TEST_FM')
         // Supply any parameters needed here
         .execute();

// Do something with the function module results

readonly clients: string[]

// Call a function module (Z_TEST_FM) on each client in the system
sap.clients.forEach(client => {
  const func = sap.login(client).getFunction('Z_TEST_FM')
           // Supply any parameters needed here
           .execute();

  // Do something with the function module results
});

readonly remote: boolean

readonly sapControlAvailable: boolean

readonly sid: string