Skip to content

Commit

Permalink
Update from SAP DITA CMS (squashed):
Browse files Browse the repository at this point in the history
commit ec26f6118bc288c947da90e2879e6dbaf14ab19a
Author: REDACTED
Date:   Mon Sep 2 11:51:44 2024 +0000

    Update from SAP DITA CMS 2024-09-02 11:51:44
    Project: dita-all/dkl1587758022827
    Project map: bf20decceb934e9492c420e6138a2410.ditamap
    Output: loio042b51923fc64122ac4c1627fb4b42c2
    Language: en-US
    Builddable map: 65817585a1874e8296d5ee9b43edb30f.ditamap

commit 822c8f0b1ff3d519cea09fc102d356d39e66bf92
Author: REDACTED
Date:   Mon Sep 2 09:54:04 2024 +0000

    Update from SAP DITA CMS 2024-09-02 09:54:04
    Project: dita-all/dkl1587758022827
    Project map: bf20decceb934e9492c420e6138a2410.ditamap
    Output: loio042b51923fc64122ac4c1627fb4b42c2
    Language: en-US
    Builddable map: 65817585a1874e8296d5ee9b43edb30f.ditamap

commit 6fd4f43aae75643b93ffe41cebdb023f89a4563a
Author: REDACTED
Date:   Fri Aug 30 11:12:43 2024 +0000

    Update from SAP DITA CMS 2024-08-30 11:12:43
    Project: dita-all/dkl1587758022827
    Project map: bf20decceb934e9492c420e6138a2410.ditamap
    Output: loio042b51923fc64122ac4c1627fb4b42c2
    Language: en-US
    Builddable map: 65817585a1874e8296d5ee9b43edb30f.ditamap

##################################################
[Remaining squash message was removed before commit...]
  • Loading branch information
ditaccms-bot committed Sep 2, 2024
1 parent e0ef490 commit c525b82
Show file tree
Hide file tree
Showing 25 changed files with 126 additions and 93 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@

This section provides information on how to connect your application with a data source during generation.

> ### Note:
> When running SAP Fiori tools in VS Code, you can save the connection information to a remote system and find it under the *SAP Systems* view. For more information, see [Managing System Connection](../../Project-Functions/managing-system-connection-78a82b6.md).
> ### Tip:
> When running SAP Fiori tools in VS Code, you can save the connection information to a remote system. For more information, see [Managing System Connection](../../Project-Functions/managing-system-connection-78a82b6.md).
> ### Tip:
> You can create a UI service for your SAP ABAP system. For more information, see [UI Service Generation](../../Project-Functions/ui-service-generation-1a7aad3.md).


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@



To create an application in VS Code or SAP Business Application Studio, perform the following steps:
To create an application in Visual Studio Code \(VS Code\) or SAP Business Application Studio, perform the following steps:

1. Using **Command Palette** in VS Code \([CMD\]/[CTRL\] + [Shift\] + [P\]\), select `Fiori: Open Application Generator` or *Start from template* in SAP Business Application Studio.
1. Open the Command Palette in Visual Studio Code \([CMD\]/[CTRL\] + [Shift\] + [P\]\) and execute the *Fiori: Open Application Generator* command or *Start from template* in SAP Business Application Studio.

> ### Note:
> In SAP Business Application Studio, use one of the following dev spaces, depending on your development needs:
Expand All @@ -32,7 +32,7 @@ To create an application in VS Code or SAP Business Application Studio, perform


> ### Note:
> After the SAP Fiori project is generated, the **Application Information** page opens. You can relaunch the **Application Information** page at any time by executing `Fiori: Open Application Info` command.
> After the SAP Fiori project is generated, the *Application Information* page opens. You can relaunch the *Application Information* page at any time by opening the Command Palette \([CMD\]/[CTRL\] + [Shift\] + [P\]\) and executing the *Fiori: Open Application Info* command.
For MTA deployment, see [Generating an MTA Deployment File](Additional-Configuration/generating-an-mta-deployment-file-9c41152.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

# ABAP Development Tools Integration

You can launch the SAP Fiori generator directly whilst working with ABAP Development Tools \(ADT\) in Eclipse. You can either launch the Application Generator from SAP Fiori tools in SAP Business Application Studio \(BAS\) in your browser, or directly launch Visual Studio Code locally if that is your preferred integrated development environment \(IDE\).
You can launch the SAP Fiori Generator directly whilst working with ABAP Development Tools \(ADT\) in Eclipse. You can either launch the Application Generator from SAP Fiori tools in SAP Business Application Studio in your browser, or directly launch Visual Studio Code \(VS Code\) locally if that is your preferred integrated development environment \(IDE\).

First, you configure the integration between ADT and SAP Fiori tools. This is a one-time setup within ADT for each system you want to integrate. Proceed as follows:

1. Choose the system you want to integrate, right-click it and select *Properties*. Then click *ABAP Development* \> *IDE Configuration*.

2. Select the *Configure the target IDE* checkbox and choose to launch either SAP Business Application Studio or Visual Studio Code.
2. Select the *Configure the target IDE* checkbox and choose to launch either SAP Business Application Studio or VS Code.


After the configuration, a new button is displayed alongside the service details in ADT. *Create Fiori Project* launches your IDE environment and automatically starts the SAP Fiori generator with these system details.
After the configuration, a new button is displayed alongside the service details in ADT. *Create Fiori Project* launches your IDE environment and automatically starts the SAP Fiori Generator with these system details.

When you launch the SAP Fiori generator, the data source selection step is skipped since you’ve already selected your data source in ADT, and the main entity for your template is pre-selected with the entity you chose in ADT.
When you launch the SAP Fiori Generator, the data source selection step is skipped since you’ve already selected your data source in ADT, and the main entity for your template is pre-selected with the entity you chose in ADT.

> ### Note:
> For the integration with Visual Studio Code, please ensure you have saved your ABAP system with the same system URL that is used by ADT. To check, click *SAP Fiori* \(the wrench and pencil icon\) on the activity toolbar from the left side, then click *SAP Systems*. If the saved system cannot be matched after launching from ADT, you can choose any of the existing systems you have already saved.
> For the integration with VS Code, please ensure you have saved your ABAP system with the same system URL that is used by ADT. To check, click *SAP Fiori* \(the wrench and pencil icon\) on the activity toolbar from the left side, then click *SAP Systems*. If the saved system cannot be matched after launching from ADT, you can choose any of the existing systems you have already saved. If you already have any SAP Fiori projects in your workspace that use the same system and main entity, you'll get the option to choose an existing matching SAP Fiori project or to create a new one with the SAP Fiori Generator.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Capabilities Overview

> ### Note:
> To view information on the features available in your application, navigate to the *Command Palette* \> *Fiori: Open Application Info* in VS Code or SAP Business Application Studio. For more information, see [Application Information](../Project-Functions/application-information-c3e0989.md).
> To view information on the features available in your application, open the Command Palette \([CMD/CTRL\] + [Shift\] + [P\] \) and execute the *Fiori: Open Application Info* command in Visual Studio Code \(VS Code\) or SAP Business Application Studio. For more information, see [Application Information](../Project-Functions/application-information-c3e0989.md).
The following table lists the SAP Fiori tools features provided in each template and data source.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The SAP Fiori tools extensions help you create applications, visualize navigatio
- Diagnostics
- Internationalization support

- [**SAP Fiori tools Environment Check**](../Project-Functions/environment-check-75390cf.md). A tool which is designed to run checks against your environment and/or destinations configured in SAP Business Technology Platform.
- [**SAP Fiori tools Environment Check**](../Project-Functions/environment-check-75390cf.md). A tool which is designed to run checks against your environment and/or destinations configured in SAP Business Technology Platform \(SAP BTP\).



Expand All @@ -38,7 +38,7 @@ For supported data sources, see: [Data Source](../Generating-an-Application/SAP-
> ### Note:
> If there are any issues, create an incident in the **SAP Support Portal** for component **CA-UX-IDE**.
SAP Fiori tools is available in two IDEs.
SAP Fiori tools is available in two integrated development environments \(IDEs\).

- [SAP Business Application Studio](sap-business-application-studio-b011040.md)
- [Visual Studio Code](visual-studio-code-17efa21.md#loio17efa217f7f34a9eba53d7b209ca4280)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Importing an Application

You can manually import an existing SAP Fiori application from the SAPUI5 ABAP repository to SAP Business Application Studio or VS Code.
You can manually import an existing SAP Fiori application from the SAPUI5 ABAP repository to SAP Business Application Studio or Visual Studio Code \( VS Code\).



Expand Down Expand Up @@ -71,8 +71,8 @@ To import SAP Fiori apps from the SAPUI5 ABAP repository, perform the following
2. Run the report `/UI5/UI5_REPOSITORY_LOAD`.
3. Provide the name of the SAPUI5 application and click *Download*.
4. Choose an empty folder for the download target.
5. From the resulting view, download all as a zip using the button *Click here to Download* at the end of the page.
6. Extract the zip into the folder `restore-from-exported/webapp`.
5. From the resulting view, download the files as a `.zip` file using the button *Click here to Download* at the end of the page.
6. Extract the `.zip` file into the folder `restore-from-exported/webapp`.
- Verify that the `manifest.json` is located at `restore-from-exported/webapp/manifest.json`.

7. Create a `package.json` in the folder `restore-from-exported`. The `name` value should match the application name in `manifest.json`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Installation

This section contains installation instructions on the following environments:
This section contains installation instructions on the following integrated development environments:

- [SAP Business Application Studio](sap-business-application-studio-b011040.md)

Expand Down
10 changes: 5 additions & 5 deletions docs/Getting-Started-with-SAP-Fiori-Tools/migration-70d41f3.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Migration

SAP Fiori tools provides a migration utility to help move your SAP Fiori projects from other services, such as SAP Web IDE, to VS Code or SAP Business Application Studio. Note that SAP Web IDE can still be used if you have a productive SAP Business Technology Platform global account and have activated SAP Web IDE there. However, it is no longer possible to access SAP Web IDE using an SAP BTP free tier account.
SAP Fiori tools provides a migration utility to help move your SAP Fiori projects from other services, such as SAP Web IDE, to Visual Studio Code \(VS Code\) or SAP Business Application Studio. Note that SAP Web IDE can still be used if you have a productive SAP Business Technology Platform \(SAP BTP\) global account and have activated SAP Web IDE there. However, it is no longer possible to access SAP Web IDE using an SAP BTP free tier account.

Some of the key points for migration:

Expand Down Expand Up @@ -49,7 +49,7 @@ For more information about extensibility, please see [Extending an SAP Fiori App

## Migration Steps

1. Clone your project from git by using the command line or import your project to the workspace as follows:
1. Clone your project from `git` by using the command line or import your project to the workspace as follows:
- Click *File* \> *Open Workspace* and create a workspace in the projects folder.

- Export the project from SAP Web IDE to your computer.
Expand All @@ -61,7 +61,7 @@ For more information about extensibility, please see [Extending an SAP Fiori App
A new *Migration* view opens listing all the projects from your workspace. For each project listed, the type of the project is also displayed. If the tool finds no suitable project for migration in your workspace, a message is shown.

> ### Tip:
> You can also open the Migration view anytime by typing `Fiori: Migrate Project for use in Fiori tools` in the *Command Palette*.
> You can also open the Migration view anytime by opening the Command Palette \([CMD/CTRL\] + [Shift\] + [P\] \) and executing the *Fiori: Migrate Project for use in Fiori tools* command.
3. Select the project that you want to migrate from the list of projects by selecting the corresponding checkbox. You can choose to manually add a project from the filesystem by clicking *Add Project*. If the supplied folder has an application that can be migrated, it's added to your list of projects. At any point, you can click the *Refresh* button to reload the projects from your workspace again.
4. For each listed project, if applicable, fill in the respective columns based on the information provided below:
Expand Down Expand Up @@ -372,11 +372,11 @@ Applies the same changes as the `flpSandbox.html` file but with the mock server

## Verification

1. Review the file changes in the **Source Control** view. Check for any project-specific changes that may be overwritten and consider reapplying as appropriate.
1. Review the file changes in the *Source Control* view. Check for any project-specific changes that may be overwritten and consider reapplying as appropriate.
2. To ensure your SAP Fiori tools application works as expected, launch any of the SAP Fiori tools commands, such as *Page Map*, *Fiori: Open Application Generator*, or *Fiori: Open Guided Development*.

> ### Note:
> Some SAP Fiori apps might be missing files like `metadata.xml` before migration, which can impact some of the SAP Fiori tools features. To avoid this, after migration, make sure that you sync the `OData` service using *Service Manager* as described here: [Managing Service and Annotations Files](../Project-Functions/managing-service-and-annotations-files-8182ff3.md).
> Some SAP Fiori apps might be missing files like `metadata.xml` before migration, which can impact some of the SAP Fiori tools features. To avoid this, after migration, make sure that you sync the `OData` service using *Service Manager*. For more information, see [Managing Service and Annotations Files](../Project-Functions/managing-service-and-annotations-files-8182ff3.md).

**Related Information**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,11 @@ SAP Business Application Studio is a hosted environment which does not require i
SAP Fiori tools are preinstalled and loaded when the dev space is created in SAP Business Application Studio for the following dev space types:

- **SAP Fiori Dev Space**
- **Full Stack Cloud Application Dev Space**. This dev space is intended for services and applications that using SAP Cloud Application Programming Model \(CAP\).
- In SAP Business Application Studio, an SAP Fiori tools **Dev Space** does not include the CDS OData Language Server extension. For more information, see **SAP CDS Language Support** in the [Visual Studio Code](visual-studio-code-17efa21.md#loio17efa217f7f34a9eba53d7b209ca4280) section.
- In SAP Business Application Studio, an SAP Fiori tools**Dev Space** already includes UI5 Language Assistant because it is a mandatory extension that is installed automatically.
- **Full Stack Cloud Application Dev Space** - This dev space is intended for services and applications that using SAP Cloud Application Programming Model \(CAP\).

For more information, see [UI5 Language Assistant Support](https://marketplace.visualstudio.com/items?itemName=SAPOSS.vscode-ui5-language-assistant&ssr=false#overview).
In SAP Business Application Studio, an SAP Fiori tools **Dev Space** does not include the CDS OData Language Server extension. For more information, see **SAP CDS Language Support** in the [Visual Studio Code](visual-studio-code-17efa21.md#loio17efa217f7f34a9eba53d7b209ca4280) section.

In SAP Business Application Studio, an SAP Fiori tools **Dev Space** already includes UI5 Language Assistant because it is a mandatory extension that is installed automatically. For more information, see [UI5 Language Assistant Support](https://marketplace.visualstudio.com/items?itemName=SAPOSS.vscode-ui5-language-assistant&ssr=false#overview).

**Related Information**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ You can enable/disable collection of usage analytics data for SAP Fiori tools. I

To enable/disable telemetry:

- In VS Code or SAP Business Application Studio, execute command *Fiori: Change Telemetry Settings*.
- In Visual Studio Code \(VS Code\) or SAP Business Application Studio, execute command *Fiori: Change Telemetry Settings*.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Visual Studio Code

This chapter describes how you can install and start working with Microsoft Visual Studio Code \(VS Code\) and provides links to important step-by-step procedures.
This chapter describes how you can install and start working with Visual Studio Code \(VS Code\) and provides links to important step-by-step procedures.

<a name="loio002ae80eac034e6588af81827ab97332"/>

Expand All @@ -12,15 +12,15 @@ This chapter describes how you can install and start working with Microsoft Visu

Ensure that the minimum system requirements for installing VS Code are met. For more information, see [Requirements for Visual Studio Code](https://code.visualstudio.com/docs/supporting/requirements).

- Before VS Code installation, you must have Node.js installed. Ensure you’re using a Long Term Supported \(LTS\) version of Node.js. Furthermore, the version of Node.js you install must also have the corresponding version of `npm` installed. See [Node.js releases](https://nodejs.org/en/download/releases/) for details on the versions of Node.js marked as LTS, and their associated `npm` versions.
- You must have Node.js installed. Ensure that you’re using a Long Term Supported \(LTS\) version of Node.js. Furthermore, the version of Node.js you install must also have the corresponding version of `npm` installed. See [Node.js releases](https://nodejs.org/en/download/releases/) for details on the versions of Node.js marked as LTS, and their associated `npm` versions.

> ### Tip:
> To check the version of Node.js installed, type `node -v` in the terminal. Similarly, to check the version of `npm` installed, type `npm -v` in the terminal. Ensure that the `npm` version and Node.js version are compatible.
> To check the version of Node.js installed, type `node -v` in the terminal. Tto check the version of `npm` installed, type `npm -v` in the terminal. Ensure that the `npm` version and Node.js version are compatible.
You can download Node.js here: [https://nodejs.org/en/download/](https://nodejs.org/en/download/).

> ### Note:
> For macOS, several options are available to install a Long Term Supported \(LTS\) version, such as [Homebrew](https://brew.sh/) and Node Version Manager \(NVM\).
> For macOS, several options are available to install a LTS version of Node.js, such as [Homebrew](https://brew.sh/) and Node Version Manager \(NVM\).
- The SAP Fiori application generator requires the [MTA tool](https://www.npmjs.com/package/mta) Node.js package \(version 1.0 or higher\) to be installed globally.

Expand Down Expand Up @@ -64,7 +64,7 @@ If it is set incorrectly to `@sap`, open the **`.npmrc`** file in your home dire
## Set up Visual Studio Code
To set up Visual Studio Code \(VS Code\), you need to perform the following steps:
To set up VS Code, you need to perform the following steps:
1. Download VS Code from the [Visual Studio Code website](https://code.visualstudio.com/download).
Expand All @@ -73,12 +73,12 @@ To set up Visual Studio Code \(VS Code\), you need to perform the following step
2. You must have a working knowledge of VS Code.
Using VS Code requires a working knowledge of this environment. Use the following resources to learn more about VS Code:
Using VS Code requires a working knowledge of this integrated development environment. Use the following resources to learn more about VS Code:
- [Visual Studio Code Basic Layout](https://code.visualstudio.com/docs/getstarted/userinterface#_basic-layout).
- [Visual Studio Code Introductory Videos](https://code.visualstudio.com/docs/getstarted/introvideos).
3. Check if Node.js is already installed. You can check this by executing the following in the VS Code terminal. If you don't get a version number, see above on how to install Node.js.
3. Check if Node.js is already installed. You can check this by executing the following in the VS Code terminal. If you don't receive a version number, see above on how to install Node.js.
```
node -v
Expand Down Expand Up @@ -147,7 +147,7 @@ To install the UI5 Language Assistant Support extension, perform the following s
<!-- loio7b329a74721047808368fca5c28702c3 -->
## Supported Authentication Type
## Supported Authentication Types
The following table lists supported authentication types for SAP Fiori tools running in VS Code:
Expand Down
Loading

0 comments on commit c525b82

Please sign in to comment.