generator-shiningteapot

AppStudio: connect to existing HDI service (experimental!)

Overview

This script extracts the currently deployed designtime files from an HDI container linked to a CloudFoundry HDI shared service and generates a project for Business Application Studio.

Installation

The script is implemented as Yeoman generator. Download the repository, then run:

npm install -g generator-shiningteapot

The script can be started with:

$ yo shiningteapot

Usage

In a first step the script will ask you for the CloudFoundry logon credentials:

$ yo shiningteapot
? Enter CloudFoundry API host name: <CF_API_host>
? Enter CloudFoundry user name: <redacted>
? Enter Cloudfoundry password: [hidden]

Next the CloudFoundry organisation, space and service name must be selected. Use the arrow keys to navigate up and down:

$ yo shiningteapot
? Enter CloudFoundry API host name: <CF_API_host>
? Enter CloudFoundry user name: <redacted>
? Enter Cloudfoundry password: [hidden]
[app] connect to CloudFoundry: <redacted>@<CF_API_host> (password provided)
? Select CloudFoundry organisation: (Use arrow keys)
> CF_Test_Org_1
  CF_Test_Org_4
  Teapot_Tests
  Launch_Pad

Last input will be the target path for the extracted and generated project files:

$ yo shiningteapot
? Enter CloudFoundry API host name: <CF_API_host>
? Enter CloudFoundry user name: <redacted>
? Enter Cloudfoundry password: [hidden]
[app] connect to CloudFoundry: <redacted>@<CF_API_host> (password provided)
? Select CloudFoundry organisation: Teapot_Tests
? Select CloudFoundry space: Teapot_Current
? Select CloudFoundry service: demo_mdl007-db01-hdi
? Enter local project root path: (/home/user/projects/SHINING_TEAPOT_DEMO_MDL007-DB01-HDI_20210621140520925)

The script will then connect to the HDI container, extract the designtime files and use them to generate an AppStudio project in the selected location:

$ yo shiningteapot
? Enter CloudFoundry API host name: <CF_API_host>
? Enter CloudFoundry user name: <redacted>
? Enter Cloudfoundry password: [hidden]
[app] connect to CloudFoundry: <redacted>@<CF_API_host> (password provided)
? Select CloudFoundry organisation: Teapot_Tests
? Select CloudFoundry space: Teapot_Current
? Select CloudFoundry service: demo_mdl007-db01-hdi
? Enter local project root path: SHINING_TEAPOT_DEMO_MDL007-DB01-HDI_20210621140520925
[app] processing options
[app]   host: <CF_API_host>
[app]   username: <redacted>
[app]   projectPath: /home/user/projects/SHINING_TEAPOT_DEMO_MDL007-DB01-HDI_20210621140520925
[app]   organisation: Testpot_Tests
[app]   space: Teapot_Current
[app]   service: demo_mdl007-db01-hdi
[app] executing...
[app]  [titor] service name: demo_mdl007-db01-hdi
[app]  [titor] service GUID: <redacted>
[app]  [titor] deployed files:
[app]  [titor]   0: src/ (folder)
[app]  [titor]   1: src/.hdiconfig (3387 bytes)
[app]  [titor]   2: src/.hdinamespace (50 bytes)
[app]  [titor]   3: src/data/ (folder)
[app]  [titor]   4: src/data/MD_ITEM.hdbtabledata (427 bytes)
[app]  [titor]   5: src/data/MD_ITEMGRP.hdbtabledata (433 bytes)
[app]  [titor]   6: src/data/SALES_DATA_SIMPLE.hdbtabledata (447 bytes)
[app]  [titor]   7: src/data/pennybridge_md_item.csv (828 bytes)
[app]  [titor]   8: src/data/pennybridge_md_itemgrp.csv (94 bytes)
[app]  [titor]   9: src/data/pennybridge_sales_data_simple.csv (526352 bytes)
[app]  [titor]   10: src/privileges/ (folder)
[app]  [titor]   11: src/privileges/SALES_DATA_FULL_ACCESS.hdbstructuredprivilege (140 bytes)
[app]  [titor]   12: src/privileges/SALES_DATA_ITEMGRP_GRP001.hdbstructuredprivilege (155 bytes)
[app]  [titor]   13: src/privileges/SALES_DATA_ITEMGRP_GRP002.hdbstructuredprivilege (158 bytes)
[app]  [titor]   14: src/privileges/SALES_DATA_ITEMGRP_GRP003.hdbstructuredprivilege (158 bytes)
[app]  [titor]   15: src/privileges/SALES_DATA_ITEMGRP_GRP004.hdbstructuredprivilege (158 bytes)
[app]  [titor]   16: src/roles/ (folder)
[app]  [titor]   17: src/roles/SALES_DATA_ADMIN.hdbrole (1146 bytes)
[app]  [titor]   18: src/roles/SALES_DATA_CONSUMPTION.hdbrole (360 bytes)
[app]  [titor]   19: src/roles/SALES_DATA_EXT_OO.hdbrole (570 bytes)
[app]  [titor]   20: src/roles/SALES_DATA_REPORTING.hdbrole (679 bytes)
[app]  [titor]   21: src/synonyms/ (folder)
[app]  [titor]   22: src/synonyms/.hdinamespace (46 bytes)
[app]  [titor]   23: src/synonyms/odata.hdbsynonym (577 bytes)
[app]  [titor]   24: src/tables/ (folder)
[app]  [titor]   25: src/tables/MD_ITEM.hdbtable (225 bytes)
[app]  [titor]   26: src/tables/MD_ITEMGRP.hdbtable (119 bytes)
[app]  [titor]   27: src/tables/SALES_DATA_SIMPLE.hdbtable (349 bytes)
[app]  [titor]   28: src/views/ (folder)
[app]  [titor]   29: src/views/CV_SALES_DATA_SIMPLE.hdbcalculationview (14296 bytes)
[app]  [titor]   30: src/views/CV_VH_ITEMID_DIM.hdbcalculationview (2272 bytes)
[app]  [titor] generate Business Application Studio project
[app]  [titor]   project name: demo_mdl007-db01-hdi_20210621140535028
[app]  [titor]   service name: demo_mdl007-db01-hdi
[app]  [titor]   write files to: /home/user/projects/SHINING_TEAPOT_DEMO_MDL007-DB01-HDI_20210621140520925/
[app] finished.

The project's database module is already bound to the selected CloudFoundry service, no further manual actions should be required.

Support

The project is provided "as-is", there is no guarantee any issues found will be answered or addressed in future releases.

License

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

EOF