sap/fundamental-tools

Web applications with ABAP, done simple.

Fundamental Library for ABAP

Build powerful on-premise and cloud extensions of any ABAP system, with minimum coding efforts and maximum performance.

This repository provides two NPM packages

• abap-api-tools design-time CLI, to enrich your ui componebts with ABAP metadata: data type, length, data binding, user defaults, Value Helps ...
• abap-value-help run-time API for generic ABAP Value Helps

used to build cloud extensions of ABAP backend systems, using

• Popular web frameworks and design systems:
  • Angular, React, Vue etc. with SAP design system
  • Angular, React, Vue etc. with Microsoft design system
  • UI5 web components, UI5 web components for React
• and any server framework
  • SAP Cloud SDK for JavaScript
  • SAP Cloud Applications Programming Model
  • express, NestJS, Flask, Koa, Spark, Jooby, Django, Pyramid, Tornado ...

The web frameworks "etc" under means practically any web framework because configurable by developer.

Few pre-configured docker containers with RFC connectivity are provided in docker folder

Content

• SAP Community: blog
• Prerequisites
• Download and installation
• Usage
• Deployment
• Known Issues
• Getting Support
• Contributing
• Code of Conduct

Prerequisites

• Backend: ABAP system on-premise or in the cloud (like SAP S/4HANA Cloud or Steampunk)
• Frontend: Web app built using above mentioned frameworks
• No run-time dependencies. Check respective web and server frameworks, mentioned above, for their dependencies and prerequisites
• Web components "understanding" custom attributes for ABAP metadata and Value Helps are currently implemented using Aurelia web framework and can be ported to other web frameworks with much reuse.

Download and installation

npm install -g abap-api-tools

More info: abap-api-tools/README.md#download-and-installation

Usage

• Cloud extension example
• abap-api-tools CLI usage

Deployment

Check Deployment options section in Powerful web applications with old and new ABAP systems

Known Issues

Click here to view the current issues.

Getting Support

If you encounter an issue, you can create a ticket.

Contributing

If you want to contribute, please check the CONTRIBUTING.md documentation for contribution guidelines.

Code of Conduct

See Code of Conduct

fundamental-tools's Issues

Possibility to provide abap system details in command instead of reading from config/system.yaml & sapnwrfc.ini

Hi,

Currently using sapnwrfc.ini that contains the required system details that abap-api-tools utilizes to call the BAPI function.
At present only able to use abap executable from '\node_modules.bin" (same path used inside node js script) & it tries to look for sapnwrfc.ini in the same directory.

But since due to permission issue not able to write sapnwrfc.ini in the '\node_modules.bin" & manually creation of same gets removed on every execution of SDK (due to fresh installation of npm packages)

So Is it possible to provide system details as parameters in command itself instead of checking the existence of config/system.yaml file & system details in it so the same command can be used in node script file directly.

(Like : abap get dest:QKX lang:EN user:abc passwd:abc sysnr:00 client:014 ashost:abc QKX STFC_STRUCTURE).

Or is there any way that abap tool doesn't look for sapnwrfc.ini file in the same directory but can read from other directory

Regards
Hari

[rl-reuse_tool-4] Violation against OSS Rules of Play

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-4
Explanation: Is it compliant with REUSE rules? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

rfmcall error when called without arguments

When called without any argument, the end of rfmcall output is corrupted:

$ rfmcall
TypeError:

Usage: rfmcall <abap system> <rfm name> [<option>]

where <option> can be:
-h    quick help on rfmcall
-s    save RFM call template to local .js file
-c    cache the metadata into params.json and fields.json
-q    quiet mode, no console echo
-stat echo the number of variables, structures and tables

    at Object.<anonymous> (/home/www-admin/src/NG-APPS/test/node_modules/rfmcall/dist/index.js:16:19)
    at Object.<anonymous> (/home/www-admin/src/NG-APPS/test/node_modules/rfmcall/dist/index.js:56:4)
    at Module._compile (internal/modules/cjs/loader.js:1085:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1114:10)
    at Module.load (internal/modules/cjs/loader.js:950:32)
    at Function.Module._load (internal/modules/cjs/loader.js:791:14)
    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:72:12)
    at internal/main/run_main_module.js:17:47

rfmcall does not handle the RAW type properly

The RAW type initialization value is undefined:

$ node dist/index.js MME BAPI_USER_GET_DETAIL | grep undefined
  VALITYINFO                       : undefined, // RAW (16) Validity Information for External ID of a User

Error during handling ABAP function modules w/o parameters

Describe the bug

abap call fails when called for ABAP function module which does not have parameters.

To Reproduce

abap call MME RFC_PING

 MME (en) 

Error: ENOENT: no such file or directory, open 'yaml/parameters.yaml'
    at Object.openSync (node:fs:582:3)
    at Object.readFileSync (node:fs:450:35)
    at Object.fileLoad (/Users/d037732/.nvm/versions/node/v16.6.2/lib/node_modules/abap-api-tools/dist/utils.js:23:34)
    at Object.annotations_read (/Users/d037732/.nvm/versions/node/v16.6.2/lib/node_modules/abap-api-tools/dist/backend.js:645:29)
    at new Frontend (/Users/d037732/.nvm/versions/node/v16.6.2/lib/node_modules/abap-api-tools/dist/frontend.js:34:39)
    at CliHandler.run (/Users/d037732/.nvm/versions/node/v16.6.2/lib/node_modules/abap-api-tools/dist/abap.js:74:38) {
  errno: -2,
  syscall: 'open',
  code: 'ENOENT',
  path: 'yaml/parameters.yaml'
}

[rl-reuse_tool-4] Violation against OSS Rules of Play

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-4
Explanation: Is it compliant with REUSE rules? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

rfmcall parameters` initialisers should be set to default value for optional parameters

[rl-reuse_tool-2] Violation against OSS Rules of Play

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-2
Explanation: Does it have LICENSES directory with licenses? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

rfmcall Quotation marks missing for ABAP fields with empty defaults

Example:

rfmcall MME /COE/RBP_FE_DATATYPES2
//
// /COE/RBP_FE_DATATYPES2
//

let params = {

  // IMPORT PARAMETERS

  //IV_DECF16                      :     , // DECFLOAT16 
  //IV_DECF34                      :     , // DECFLOAT34 
  //IV_INT2                        :    2, // INT2 (5) 
  //IV_INT4                        :    4, // INT4 (10) 
  //IV_INT8                        :    8, // INT8 
};

result = await client.call("/COE/RBP_FE_DATATYPES2", params);

paths_fix.sh

Describe the bug
script is trying to open non-existing files, also an "not a Mach-0 file" error thrown

To Reproduce
Describe the steps to reproduce the behavior, including:

1. Console command or API call parameters

/usr/local/sap/nwrfcsdk
❯ sh paths_fix.sh
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: can't open file: *.dylib (No such file or directory)
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: can't open file: *.dylib (No such file or directory)
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: can't open file: libicui18n.50.dylib (No such file or directory)
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: can't open file: libicui18n.50.dylib (No such file or directory)
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: can't open file: libicuuc.50.dylib (No such file or directory)
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: input file: rfcexec is not a Mach-O file
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: input file: rfcexec is not a Mach-O file
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: input file: rfcexec is not a Mach-O file
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: input file: rfcexec is not a Mach-O file
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: input file: startrfc is not a Mach-O file
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: input file: startrfc is not a Mach-O file
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: input file: startrfc is not a Mach-O file
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: input file: startrfc is not a Mach-O file
error: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/install_name_tool: input file: ./startrfc is not a Mach-O file
2. Custom configuration, if used
no custom config

Screenshots
See point 1 above

Environment

• OS: macos 14.1.1 (Sonoma)
• abap --version output
  ❯ abap --version
  zsh: command not found: abap

Additional context
Not sure if abab is a requirement. I am following instructions on for mac.

Help is much appreciated!

rfmcall installation error : No valid versions available for rfmcall

Hi ,

Need to check if I can get information regarding the rfmcall installation error as it seems the module has been unpublished (link : https://developer.aliyun.com/mirror/npm/package/rfmcall).

As we had implementation with node-rfc & rfmcall , so need to check if there would be any updated release of rfmcall or it has been permanently unpublished.

Thanks

Exception raised if config folder not found in local working folder

Looking for custom ui configurations on CLI startup, the exception is raised if the config folder not found in local worjing folder.

Version: 1.2.1

Local configuration is optional, no exception needed here.

Binary strings initialised with `bytes()`, n/a in NodeJS

should be changed to Buffer

Add ARG common_source to nodejs.Dockerfile and python.Dockerfile

Is your feature request related to a problem? Please describe.
Add ARG common_source to nodejs.Dockerfile and python.Dockerfile similar the ARG sap_source in saplibs.Dockerfile

Describe the solution you'd like
In nodejs.Dockerfile replace:
COPY --chown=${adminuser}:${adminuser} /common/bashrc_nvm.sh /tmp
by:
ARG common_source=/common
COPY --chown=${adminuser}:${adminuser} ${common_source}/bashrc_nvm.sh /tmp

In python.Dockerfile replace:
COPY --chown=${adminuser}:${adminuser} /common/bashrc_pyenv.sh /tmp/
by:
ARG common_source=/common
COPY --chown=${adminuser}:${adminuser} ${common_source}/bashrc_pyenv.sh /tmp/

RFMs with lowercase names in input catalog not found in ABAP backend

Only uppercase names work as expected, shall be fixed.

Conversion Exit annotation missing for ABAP RFC parameter of ABAP Variable type.

Conversion Exit annotations are listed only for ABAP structures and tables RFM parameters, missing for ABAP variables, in alpha.yaml

Value Helps: helpOption indentation shall be fixed

helpOption indentation shall be fixed:

const helpSign = [{ id: 'I', name: 'Include' }, { id: 'E', name: 'Exclude' }];
  const helpOption = [
  { id: 'EQ', name: 'is' },
  { id: 'NE', name: 'is not' },
  { id: 'GT', name: 'greater than' },
  { id: 'LT', name: 'less than' },
  { id: 'GE', name: 'not less' },
  { id: 'LE', name: 'not greater' },
  { id: 'BT', name: 'between' },
  { id: 'NB', name: 'not between' },
  { id: 'CP', name: 'with pattern' },
  { id: 'NP', name: 'w/o pattern' }
  ];

TypeError raised if search help api not maintained in `systems.yaml`

TypeError: "Cannot convert undefined or null to object" is raised if search_help_api is not maintained in systems.yaml for the destination.

Version: 1.2.1

No need for exception here because using search help api is not mandatory.

rfmcall parameter field level initialisers required only for structures and tables

abap GET results without Value Helps

Value Helps are not determined when running abap get command, despite correct confoguration. No error message returned.

[rl-reuse_tool-4] Violation against OSS Rules of Play

A violation against the OSS Rules of Play has been detected.

Rule ID: rl-reuse_tool-4
Explanation: Is it compliant with REUSE rules? No

Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html

abap make: html element `number` not found for react and vue elements

TypeError: L.map is not a function

raised in case of malformed input catalog yaml file, like:

serviceOrder:
  - /COE/RBP_PAM_SERVICE_ORD_CREAT # Create one instance of Service Order object
  - /COE/RBP_PAM_SERV_ORD_CREAT_N # Create Service Order from Notification
  - /COE/RBP_PAM_SERVICE_ORD_GET # Get details of one Service Order object
  - /COE/RBP_PAM_SERVICE_ORD_CC # Calculate costs of one instance of Service Order object
  - /COE/RBP_PAM_SERVICE_ORD_GETL # Get a Service Orders' list
  - /COE/RBP_PAM_SERVICE_ORD_CHANG # Change one instance of Service Order object

/COE/RBP_PAM_SERVICE_ORD_GET:
  header:
    - EV_COST_SUM #

The error message should be fixed, yaml schema validation added

abap get timeout when retrieving value help descriptors

Example: BAPI_ALM_CONF_GETDETAIL parameter FAILEDGMOVES of type BAPI_CORU_FGM, with SH T100F4

abap-api-tools: Table and struct js initialisers use the same name

Like CT_TABLE here:

// /COE/RBP_T_FE_RFM_TABLE_TYPE  
const CT_TABLE= [];

// prettier-ignore
const CT_TABLE= {
  COUNTER                          :    0, // INT4 (10) Natural number
  ZACCP                            :   "", // ACCP (6) No field text
  ZCHAR                            :   "", // CHAR (10) No field text

Getting error Unknown Instruction : INCLUDE+

Hi,

Environment :
OS : ubuntu 18.04
Docker Version : Docker 20.10.7
Environment variable is set DOCKER_BUILDKIT=1 and COMPOSE_DOCKER_CLI_BUILD=1

I am trying to create docker image for node-rfc https://github.com/sap/node-rfc.

https://github.com/SAP/fundamental-tools/tree/main/docker

Command : $docker build -f ubuntu-qa.Dockerfile .
when I try to create docker image using ubuntu dockerfile. Getting error Unknown Instruction : INCLUDE+

Thanks,
Rajesh

Catching ABAP metadata processing exceptions

Describe the bug

Exceptions from ABAP metadata processing not caught:

abap call MME stfc_connection1 

 MME (en) 

node:internal/process/promises:246
          triggerUncaughtException(err, true /* fromPromise */);
          ^

[UnhandledPromiseRejection: This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). The promise rejected with the reason "RFM not found: STFC_CONNECTION1".] {
  code: 'ERR_UNHANDLED_REJECTION'
}

To Reproduce
Run abap call MME stfc_connection1