abap-value-input-help

ABAP Value Input Helps

Usage no npm install needed!

<script type="module">
  import abapValueInputHelp from 'https://cdn.skypack.dev/abap-value-input-help';
</script>

README

Value Input Helps

License npm Slack REUSE status TypeScript code style: prettier

Server component exposing generic Value Input Helps for pattern based applications and ui frameworks supported by Fundamental Library for ABAP. ABAP developers already know how it works (like in SAPGUI):

  • ABAP Fixed Domain Values (FV)
  • ABAP Elementary and complex Search Helps (SH)
  • ABAP Check Tables (CT, CH)
  • Custom input helps

Installation

Server runtime component:

npm install abap-value-input-help

Usage

Add server routes for generic ABAP Search Helps API

Search Help Type route ABAP API
Fixed domain values (FV) /fieldvalues/<path> SHLP_DOMVALUES_GET
Elementary and Complex Search Helps (SH) /helpselect
/search
SHLP_METADATA_GET
SHLP_VALUES_GET
Check Tables (CT) /tabselect CT/CH tables' query
Custom input helps /valuelist/ any ABP RFM

More API details: unit tests

Add custom attribute shlp to input component, like:

<!-- Fixed Domain Values -->
<ui-input data-abap.bind="{ddic:'CHAR', type:'string', length:1}" label="Partial/Final Confirmation"
  value.bind="serviceOrder.confirmation.FIN_CONF"
  shlp.bind="{type:'FV', id:'AUERU_VS'}"
></ui-input>

<!-- Check Tables -->
<ui-combo clear ddic-length="1" ddic-type="CHAR" mid="EQT" label="Equipment category"
  value.bind="equipment.ES_SPECIFIC.EQUICATGRY"
  shlp.bind="{type: 'CT', id: 'T370T'}"
></ui-combo>

<!-- Complex/Elementary Helps Search Helps -->
<ui-input ddic-length="18" ddic-type="CHAR" label="Equipment #"
  value.bind="installDetail.equiId"
  shlp.bind="{type: 'SH', id: 'EQUI', blacklist: 'SH EQUIR', autoselect: 'SH EQUIT'}"
></ui-input>

Custom attribute will add Search Help icon input addon and run the Search Help dialog using abovementioned exposed routes. Input ui component is updated with the Search Help dialog result:

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.

License

Copyright (c) 2018 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file.