Skip to content

Commit

Permalink
Update from SAP DITA CMS (squashed):
Browse files Browse the repository at this point in the history
commit 167f9d47c612e50efdd3ed62b8262a95aaa8ea15
Author: REDACTED
Date:   Mon Apr 29 08:07:00 2024 +0000

    Update from SAP DITA CMS 2024-04-29 08:07:00
    Project: dita-all/xkq1563802817335
    Project map: 0ac873786dc24f0184e16fe8fd23a5ed.ditamap
    Output: loio944335a906784d72841362342a572016
    Language: en-US
    Builddable map: e8ee36acbc6e4fc080a1452c2204199b.ditamap

commit b3de25ad8a8e2e04c207d0c5a41b15660568e9c9
Author: REDACTED
Date:   Fri Apr 26 15:03:45 2024 +0000

    Update from SAP DITA CMS 2024-04-26 15:03:45
    Project: dita-all/xkq1563802817335
    Project map: 0ac873786dc24f0184e16fe8fd23a5ed.ditamap
    Output: loio944335a906784d72841362342a572016
    Language: en-US
    Builddable map: e8ee36acbc6e4fc080a1452c2204199b.ditamap

commit fe086bc9c7a190f473401dddee24d3c78f8eee41
Author: REDACTED
Date:   Thu Apr 25 16:00:46 2024 +0000

    Update from SAP DITA CMS 2024-04-25 16:00:46
    Project: dita-all/xkq1563802817335
    Project map: 0ac873786dc24f0184e16fe8fd23a5ed.ditamap
    Output: loio944335a906784d72841362342a572016
    Language: en-US
    Builddable map: e8ee36acbc6e4fc080a1452c2204199b.ditamap

##################################################
[Remaining squash message was removed before commit...]
  • Loading branch information
ditaccms-bot committed Apr 30, 2024
1 parent c4a58ba commit 3e84ab9
Show file tree
Hide file tree
Showing 83 changed files with 1,798 additions and 350 deletions.
30 changes: 16 additions & 14 deletions docs/access-sap-business-application-studio-from-vs-code-6b18cc8.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ Connect securely to SAP Business Application Studio dev spaces directly from a l

**Prerequisites**

To ensure the best functionality, make sure you are always working \(locally\) on the latest officially released version of VS Code and that you regularly update the *SAP Business Application Studio toolkit* extension to the latest version.
Make sure you have installed the [SAP Business Application Studio toolkit](https://marketplace.visualstudio.com/items?itemName=SAPOSS.app-studio-toolkit) extension.

To ensure the best functionality, make sure you are always working \(locally\) on the latest officially released version of VS Code and that you regularly update the [SAP Business Application Studio toolkit](https://marketplace.visualstudio.com/items?itemName=SAPOSS.app-studio-toolkit) extension to the latest version in the VS Code marketplace.

The remote connection to SAP Business Application Studio allows you to:

- Work in your SAP Business Application Studio tailored dev spaces directly from your local VS Code installation, including the tools and configurations that are not available on your local OS.
- Connect to your different centrally managed SAP environments \(for example, API Business Hub Enterprise, subaccount destinations, etc.\) via theSAP Business Application Studio Service Center.
- Connect to your different centrally managed SAP environments \(for example, API Business Hub Enterprise, subaccount destinations, etc.\) via the SAP Business Application Studio Service Center.
- Develop directly on SAP BTP.
- Separate your development environment to avoid impacting your local machine configuration.
- Access an existing dev space from multiple machines or locations.
Expand All @@ -30,8 +32,8 @@ The remote connection to SAP Business Application Studio allows you to:

## Getting Started

1. Install the *Remote Access for SAP Business Application Studio* extension from the [Visual Studio marketplace](https://marketplace.visualstudio.com/search?term=SAP%20Business%20Application%20Studio&target=VSCode&category=All%20categories&sortBy=Relevance).
2. Click ![SAP Business Application Studio icon](images/bas_view_cff2717.png) in the VS Code activity bar to open the **SAP Business Application Studio** view.
1. Install the [SAP Business Application Studio toolkit](https://marketplace.visualstudio.com/items?itemName=SAPOSS.app-studio-toolkit) extension from the Visual Studio marketplace. This extension pack will automatically install the **Remote Access for SAP Business Application Studio** extension as well.
2. Click ![SAP Business Application Studio icon](images/bas_icon_24cf9b4.png) in the VS Code activity bar to open the **SAP Business Application Studio** view.



Expand All @@ -41,15 +43,15 @@ The remote connection to SAP Business Application Studio allows you to:

1. In the *SAP Business Application Studio* view, click *Connect Landscape* to add the landscape you want to access.

![shows the SAP Business Application Studio view in VS Code and the button to add a landscape](images/Add_a_landscape_6fd8072.png)
![shows the SAP Business Application Studio view in VS Code and the button to add a landscape](images/add_landscape_5f8fd0f.png)

2. In the command palette, enter your landscape URL.

**To add another landscape:**

1. Click ![plus icon](images/plus_sign_dark_theme_5dc9f50.png) in the view's title bar.
1. Click ![plus icon](images/plus_icon_9031137.png) in the view's title bar.

![title bar highlighting the plus icon](images/New_landscape_0efa1b6.png)
![title bar highlighting the plus icon](images/adding_more_landscapes_a92fd82.png)

2. In the command palette, enter the additional landscape URL.

Expand Down Expand Up @@ -78,7 +80,7 @@ All the landscapes you connect to and their respective dev spaces are displayed

## Disconnecting from the Landscapes

1. From the action bar, click ![Accounts icon](images/accounts_a2325b0.png).
1. From the action bar, click ![Accounts icon](images/disconnect_from_vs_code_c211281.png).
2. Select *BAS Access Token \(Business Application Studio\)*.
3. Click *Sign Out*.

Expand All @@ -92,25 +94,25 @@ The **SAP Business Application Studio** view contains all the landscapes you add

- Start a dev space by hovering over the dev space name and clicking Play.

![dev space menu options highlighting the Play icon](images/start_dev_space_7b58bde.png)
![dev space menu options highlighting the Play icon](images/start_dev_space_cc01d6c.png)

A dot appears on the dev space's icon once the status changes to STARTED.

![dev space icon indicating that the dev space's status is STARTED](images/started_icon_6a6a8ab.png)
![dev space icon indicating that the dev space's status is STARTED](images/started_dev_space_a60767f.png)

- Stop a dev space by hovering over the dev space name and clicking Stop.

![dev space menu options highlighting the Stop icon](images/stop_icon_f56482d.png)
![dev space menu options highlighting the Stop icon](images/stop_dev_space_a9cba6a.png)

- Open a dev space by hovering over the dev space name and clicking ![new window icon](images/open_dev_space_a3ba338.png).
- Open a dev space by hovering over the dev space name and clicking ![new window icon](images/open_folder_icon_937a899.png).

![dev space menu options highlighting the New Folder icon](images/open_dev_space_vs_code_9165513.png)
![dev space menu options highlighting the New Folder icon](images/open_dev_space_4619a17.png)

> ### Note:
> You can only have 2 dev spaces running at a time.

The dev space opens in a new tab.

![Open dev space](images/storyboard_in_vs_code_2edddc4.png)
![Open dev space](images/new_tab_9a41514.png)

6 changes: 2 additions & 4 deletions docs/administrator-guide-545ba7d.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@ Here's a checklist for setting up your system so you can develop applications us
- **[Subscribe to SAP Business Application Studio](subscribe-to-sap-business-application-studio-6331319.md "Before you can work in SAP Business Application Studio, the account administrator
must subscribe the subaccount to the SAP Business Application Studio application.")**
Before you can work in SAP Business Application Studio, the account administrator must subscribe the subaccount to the SAP Business Application Studio application.
- **[Application Plans](application-plans-2c72917.md "SAP Business Application Studio provides two types
of application plans in SAP BTP
enterprise accounts: free and standard-edition.")**
SAP Business Application Studio provides two types of application plans in SAP BTP enterprise accounts: free and standard-edition.
- **[Application Plans](application-plans-2c72917.md "SAP Business Application Studio provides three types of application plans in SAP BTP enterprise accounts: standard-edition, free, and build-code.")**
SAP Business Application Studio provides three types of application plans in SAP BTP enterprise accounts: standard-edition, free, and build-code.
- **[Manage Authorizations and Roles](manage-authorizations-and-roles-01e69c5.md "The subaccount administrator can assign the user a role for developing with SAP Business Application Studio or for managing
data.")**
The subaccount administrator can assign the user a role for developing with SAP Business Application Studio or for managing data.
Expand Down
55 changes: 26 additions & 29 deletions docs/api-business-hub-enterprise-service-provider-328519b.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You can add a new system, referring to the API business hub enterprise instance,
> ### Note:
> To add a system, you must meet these criteria:
>
> - You're assigned the *Business\_Application\_Studio\_Administrator* role in the cockpit. See [Manage Authorizations and Roles](manage-authorizations-and-roles-01e69c5.md).
> - You're assigned the *Business\_Application\_Studio\_Administrator* role in the cockpit. See [**Manage Authorizations and Roles**](https://help.sap.com/docs/bas/sap-business-application-studio/manage-authorizations-and-roles?version=Cloud).
> - You're connected to a space with a subscription to the API business hub enterprise.
1. Hover over the subaccount and click ![Add system icon](images/Add_system-_service_center-_plus_icon_3701d6b.jpg) \(Add system\).
Expand All @@ -32,8 +32,7 @@ You can add a new system, referring to the API business hub enterprise instance,
> You can select *Basic Authentication* and enter the username and password for your system. This configuration enables you to view the system information without needing to log in each time.
3. Click *Add*.

1. Create a destination in your SAP Business Application Studio subaccount from the cockpit with the following fields:
4. Create a destination in your SAP Business Application Studio subaccount from the cockpit with the following fields:


<table>
Expand Down Expand Up @@ -151,7 +150,7 @@ You can add a new system, referring to the API business hub enterprise instance,
</tr>
</table>

2. In the *Additional Properties* section, configure the following:
5. In the *Additional Properties* section, configure the following:


<table>
Expand Down Expand Up @@ -300,20 +299,17 @@ You can add a new system, referring to the API business hub enterprise instance,
> ### Note:
> The Service Center only shows API business hub enterprise systems and products with OData services.
1. From the Service Center, click the arrow to display the API business hub enterprise systems.
1. In the Service Center, from the *Select System* dropdown list, select *API business hub enterprise*.

Each system points to an API business hub enterprise instance.

2. Click the arrow next to the system \(![System icon](images/SC_API_Hub_product_icon_a999bc7.png)\) to display the products within it.
2. Select a system from the dropdown list to display the products within it.

Multiple APIs are grouped into a product.

If the product is available and connected \(![Available Product icon](images/SC-_system_connected_icon_1c4c936.png)\), you can search for services within it. Click the search icon \(![Search icon](images/service_center_search_a1d4e5e.png)\) and select the relevant service from the command palette.

3. Click the arrow next to the products \(![Product icon](images/ABHE_product_icon_c456c90.png)\) to display the services \(APIs\).

If the product is available, there's a dot next to the icon \(![Available Product icon](images/ABHE_available_product_icon_db3f35e.png)\).
If the product is available and connected \(![Connected Product icon](images/SC-_system_connected_icon_1c4c936.png)\), you can search for services within it.

3. Click a product \(![Product icon](images/ABHE_product_icon_c456c90.png)\) to display the services \(APIs\).
4. Click a service \(![Service icon](images/SC-_service_icon_fc5c112.png)\) to see its properties, including the service name, protocol, and status.

To see the service details, you must be onboarded to the API business hub enterprise and subscribed to the selected product:
Expand All @@ -338,24 +334,21 @@ You can add a new system, referring to the API business hub enterprise instance,
This section includes the service name, protocol, and status.


If a service is available, there's a dot next to the icon \(![Available Service icon](images/green_dot-_system_available_ac1aa72.jpg)\).
If a service is connected, there's a dot next to the icon \(![Connected Service icon](images/green_dot-_system_available_ac1aa72.jpg)\).

> ### Note:
> - If a service is unavailable and the target endpoint of the service requires authentication, make sure that the target endpoint is configured to be authenticated via [Basic Authentication](https://help.sap.com/docs/SAP_CLOUD_PLATFORM_API_MANAGEMENT/66d066d903c2473f81ec33acfe2ccdb4/693c0d1720644d57918ed77acc6a95ef.html?locale=en-US&version=Cloud). See the "Configure API Management to Use the Basic Authentication Policy" section in this [blog post](https://blogs.sap.com/2019/05/23/securing-your-microservice-on-sap-cloud-platform-using-api-management-with-basic-authentication-for-last-mile-security/).
> - It is recommended to use the [verify API key](https://help.sap.com/docs/SAP_CLOUD_PLATFORM_API_MANAGEMENT/66d066d903c2473f81ec33acfe2ccdb4/4d15a0427494452dbb42a319e9bb420f.html?locale=en-US&version=Cloud) policy to ensure secure access to the service. This policy is added in the PreFlow of the ProxyEndpoint of the corresponding API proxy.
> - We recommend using the [verify API key](https://help.sap.com/docs/SAP_CLOUD_PLATFORM_API_MANAGEMENT/66d066d903c2473f81ec33acfe2ccdb4/4d15a0427494452dbb42a319e9bb420f.html?locale=en-US&version=Cloud) policy to ensure secure access to the service. This policy is added in the PreFlow of the ProxyEndpoint of the corresponding API proxy.
5. Click an entity to see the service details, including entity data and live data:
1. You can see the entity's metadata from the *Entity Details* tab.
2. You can see a preview of the live production data associated with the entity set from the *Live Data* tab.

This helps you choose an entity for your application.
1. You can see the entity's metadata, details, and live data in the *Entities* tab. This helps you choose an entity for your application.

> ### Note:
> The live data only displays:
>
> - Up to 20 rows of data
> - Data for simple data types
> The live data only displays up to 20 rows of data for simple data types.
You can also search for an entity.

2. You can see details about the service in the *Properties* tab.

6. You can click *View Diagram* to see the service entities, their properties, and the relationships between the entities in a new tab.

Expand All @@ -373,7 +366,7 @@ If you don’t have the SAP Business Application Studio Administrator role, the

### Create a Project from a Service

1. Click *Service Actions* \> *Create Project from Service*.
1. Click *Create Project*.

The template wizard displays the projects that you can create from a service. For example, an HTML5 project or an SAP Fiori application. See [Create an HTML5 Project](https://help.sap.com/viewer/0e2ec06ee34742fd9054fabe09c12d35/Cloud/en-US/e46be902c7b54f9baaab1870ca553303.html) or [SAP Fiori Elements](https://help.sap.com/viewer/17d50220bcd848aa854c9c182d65b699/Latest/en-US/1488469a315c442fa116ab4449d4ad27.html) for more information.

Expand Down Expand Up @@ -406,7 +399,7 @@ If you don’t have the SAP Business Application Studio Administrator role, the

You can add a service to an empty SAP Fiori project or to an SAP Fiori project that doesn't have a service:

1. Click *Service Actions* \> *Add External Service to SAP Fiori Project*.
1. Click *Add to SAP Fiori Project*.

If you only have one empty project:

Expand All @@ -423,19 +416,23 @@ You can add a service to an empty SAP Fiori project or to an SAP Fiori project t



### Add an External Data Model to a CAP Project
### Add an External Service to a CAP Project

You can select a service from the Service Center and add it as an external data model to a CAP Node project:
You can select a service from the Service Center and add it as an external service to a CAP Node project:

1. Open a service and click *Service Actions* \> *Add External Data Model to CAP Project*.
2. Select the target CAP Node project to add the external data model to.
1. Open a service and click *Add to CAP Project*.
2. If prompted, select the target CAP Node project to add the external service to.
3. \(Optional\) You can generate a sample service and select the relevant entities.

1. Select *Yes* to add a sample service.
2. Select the entities that you want to add.

> ### Note:
> Sample service generation is only available for a project created in the *Full Stack Cloud Application* dev space. It's not available for a project created in the *Full-Stack Application Using Productivity Tools* dev space.
4. Click *Add*.

You added the external data model to the CAP project. The following changes happen:
You added the external service to the CAP project. The following changes happen:

- The `<service_name>.xml` and `<service_name>.cds` files appear in the *srv* \> *external* folder of the project.
- A service section appears in the `package.json` file of the CAP project, which refers to the *srv* \> *external* \> *<service\_name\>.xml* file. This file has the metadata of the service:
Expand All @@ -451,6 +448,6 @@ You can select a service from the Service Center and add it as an external data
```

- If you added a sample service with the relevant entities, the `<service_name>.cds` and the `<service_name>.js` files appear in the *srv* \> *external* folder of the CAP project.
- The external data model is added to the the storyboard, under *External Resources*.
- The external service is added to the storyboard, under *External Resources*.


Loading

0 comments on commit 3e84ab9

Please sign in to comment.